hyphenate_SDK4.0 4.8.0
hyphenate java IM SDK
|
Classes | |
enum | DisplayStyle |
enum | EMPushAction |
enum | EMPushRemindType |
Public Member Functions | |
void | enableOfflinePush () throws HyphenateException |
void | disableOfflinePush (int start, int end) throws HyphenateException |
EMPushConfigs | getPushConfigs () |
EMPushConfigs | getPushConfigsFromServer () throws HyphenateException |
void | updatePushServiceForGroup (List< String > groupIds, boolean noPush) throws HyphenateException |
void | updatePushServiceForUsers (List< String > userIds, boolean noPush) throws HyphenateException |
List< String > | getNoPushGroups () |
List< String > | getNoPushUsers () |
boolean | updatePushNickname (String nickname) throws IllegalArgumentException, HyphenateException |
void | asyncUpdatePushNickname (String nickname, EMCallBack callback) |
void | updatePushDisplayStyle (DisplayStyle style) throws IllegalArgumentException, HyphenateException |
void | asyncUpdatePushDisplayStyle (DisplayStyle style, EMCallBack callback) |
void | setSilentModeForConversation (String conversationId, EMConversation.EMConversationType type, EMSilentModeParam param, EMValueCallBack< EMSilentModeResult > callBack) |
void | clearRemindTypeForConversation (String conversationId, EMConversation.EMConversationType type, EMCallBack callBack) |
void | getSilentModeForConversation (String conversationId, EMConversation.EMConversationType type, EMValueCallBack< EMSilentModeResult > callBack) |
void | setSilentModeForAll (EMSilentModeParam param, EMValueCallBack< EMSilentModeResult > callBack) |
void | getSilentModeForAll (EMValueCallBack< EMSilentModeResult > callBack) |
void | getSilentModeForConversations (List< EMConversation > conversationList, EMValueCallBack< Map< String, EMSilentModeResult > > callBack) |
void | syncSilentModeConversationsFromServer (EMCallBack callBack) |
void | setPreferredNotificationLanguage (String languageCode, EMCallBack callBack) |
void | getPreferredNotificationLanguage (EMValueCallBack< String > callBack) |
void | bindDeviceToken (String notifierName, String deviceToken, EMCallBack callBack) |
void | setPushTemplate (String templateName, EMCallBack callBack) |
void | getPushTemplate (EMValueCallBack< String > callBack) |
void | reportPushAction (JSONObject json, EMPushAction action, EMCallBack callBack) |
The offline push manager.
void com.hyphenate.chat.EMPushManager.asyncUpdatePushDisplayStyle | ( | DisplayStyle | style, |
EMCallBack | callback | ||
) |
Updates the display style of push notifications. The default value is DisplayStyle#SimpleBanner.
This is an asynchronous method.
Reference: For the asynchronous method, see updatePushDisplayStyle(DisplayStyle).
style | The display style of push notifications. |
void com.hyphenate.chat.EMPushManager.asyncUpdatePushNickname | ( | String | nickname, |
EMCallBack | callback | ||
) |
Updates the push display nickname of the current user.
This is an asynchronous method.
If no nickname is set, the user ID of the message sender, instead of the nickname, is indicated in the notification bar. The nickname can be different from the nickname in user attributes. However, Agora recommends that you use the same nickname for both. Therefore, if either nickname is updated, the other should be changed at the same time. For example, if you change the nickname in the user profile (EMUserInfoManager#updateOwnInfo(EMUserInfo, EMValueCallBack) or EMUserInfoManager#updateOwnInfoByAttribute(EMUserInfo.EMUserInfoType, String, EMValueCallBack)), remember to call this method to update the push nickname to ensure consistency.
Reference: The synchronous method see updatePushNickname(String).
nickname | The push nickname, which is different from the nickname in user profiles. |
void com.hyphenate.chat.EMPushManager.bindDeviceToken | ( | String | notifierName, |
String | deviceToken, | ||
EMCallBack | callBack | ||
) |
Binds the device token to the chat server. If device token is null or "", the device token is unbound from the chat server.
notifierName | The current device ID: FCM - Sender ID; Hawei - App ID; Xiaomi - App ID; Meizu - App ID; OPPO - App Key; Vivo - App ID + "#" + App Key; |
deviceToken | Device token generated by the device manufacturer. |
callBack |
void com.hyphenate.chat.EMPushManager.clearRemindTypeForConversation | ( | String | conversationId, |
EMConversation.EMConversationType | type, | ||
EMCallBack | callBack | ||
) |
Clears the setting of offline push notification type for the conversation. After clearing, the conversation follows the settings of the current logged-in user EMPushManager#setSilentModeForAll(EMSilentModeParam, EMValueCallBack).
conversationId | The conversation ID. |
type | The conversation type. |
callBack | The completion callback, which contains the description of the cause to the failure. |
void com.hyphenate.chat.EMPushManager.disableOfflinePush | ( | int | start, |
int | end | ||
) | throws HyphenateException |
Disables the offline push within the specified time period (24-hour clock).
This is a synchronous method and blocks the current thread.
start | The start hour. |
end | The end hour. |
HyphenateException | A description of the cause of the exception. |
void com.hyphenate.chat.EMPushManager.enableOfflinePush | ( | ) | throws HyphenateException |
Turns on the offline push notification.
This is a synchronous method and blocks the current thread.
HyphenateException |
List< String > com.hyphenate.chat.EMPushManager.getNoPushGroups | ( | ) |
Gets the list of groups for which the offline push is turned off.
This is a synchronous method and blocks the current thread.
List< String > com.hyphenate.chat.EMPushManager.getNoPushUsers | ( | ) |
Gets the list of user IDs with the offline push notification turned off from the cache.
Note: If you need to get the latest data, call {@Link EmpushManager::getPushConfigsFromServer()} before calling this method.
void com.hyphenate.chat.EMPushManager.getPreferredNotificationLanguage | ( | EMValueCallBack< String > | callBack | ) |
Gets the preferred notification language set by the user.
callBack | The completion callback, which contains the description of the cause to the failure. |
EMPushConfigs com.hyphenate.chat.EMPushManager.getPushConfigs | ( | ) |
Gets the push configurations from the cache.
EMPushConfigs com.hyphenate.chat.EMPushManager.getPushConfigsFromServer | ( | ) | throws HyphenateException |
Gets the push configurations from the server.
This is a synchronous method and blocks the current thread.
HyphenateException | A description of the cause of the exception. |
void com.hyphenate.chat.EMPushManager.getPushTemplate | ( | EMValueCallBack< String > | callBack | ) |
Gets the push template for offline push notifications.
callBack | The completion callback, which contains the description of the cause to the failure. |
void com.hyphenate.chat.EMPushManager.getSilentModeForAll | ( | EMValueCallBack< EMSilentModeResult > | callBack | ) |
Gets the do-not-disturb settings of the current login user.
callBack | The completion callback, which contains the description of the cause to the failure. |
void com.hyphenate.chat.EMPushManager.getSilentModeForConversation | ( | String | conversationId, |
EMConversation.EMConversationType | type, | ||
EMValueCallBack< EMSilentModeResult > | callBack | ||
) |
Gets the do-not-disturb settings of the conversation.
conversationId | The conversation ID. |
type | The conversation type. |
callBack | The completion callback, which contains the description of the cause to the failure. |
void com.hyphenate.chat.EMPushManager.getSilentModeForConversations | ( | List< EMConversation > | conversationList, |
EMValueCallBack< Map< String, EMSilentModeResult > > | callBack | ||
) |
Gets the do-not-disturb settings of specified conversations in batches.
conversationList | The conversation list. |
callBack | The completion callback, which contains the description of the cause to the failure. |
void com.hyphenate.chat.EMPushManager.reportPushAction | ( | JSONObject | json, |
EMPushAction | action, | ||
EMCallBack | callBack | ||
) |
Reports the push events.
This is an asynchronous method.
json | Value The value of the EPush field included in the push data. |
action | Push event. |
callBack | The completion callback, which contains the description of the cause to the failure. |
void com.hyphenate.chat.EMPushManager.setPreferredNotificationLanguage | ( | String | languageCode, |
EMCallBack | callBack | ||
) |
Sets the preferred language for push notifications.
languageCode | The language code. |
callBack | The completion callback, which contains the description of the cause to the failure. |
void com.hyphenate.chat.EMPushManager.setPushTemplate | ( | String | templateName, |
EMCallBack | callBack | ||
) |
Sets the push template for offline push notifications.
templateName | The name of the push template. |
callBack | The completion callback, which contains the description of the cause to the failure. |
void com.hyphenate.chat.EMPushManager.setSilentModeForAll | ( | EMSilentModeParam | param, |
EMValueCallBack< EMSilentModeResult > | callBack | ||
) |
Sets the do-not-disturb mode for the current login user.
param | The do-not-disturb parameter. |
callBack | The completion callback, which contains the description of the cause to the failure. |
void com.hyphenate.chat.EMPushManager.setSilentModeForConversation | ( | String | conversationId, |
EMConversation.EMConversationType | type, | ||
EMSilentModeParam | param, | ||
EMValueCallBack< EMSilentModeResult > | callBack | ||
) |
Sets the do-not-disturb mode of the conversation.
conversationId | The conversation ID. |
type | The conversation type. |
param | The do-not-disturb parameter. |
callBack | The completion callback, which contains the description of the cause to the failure. |
void com.hyphenate.chat.EMPushManager.syncSilentModeConversationsFromServer | ( | EMCallBack | callBack | ) |
Synchronizes the do-not-disturb status of the conversation with the server. Asynchronous method.
callBack | The completion callback, which contains the description of the cause to the failure. |
void com.hyphenate.chat.EMPushManager.updatePushDisplayStyle | ( | DisplayStyle | style | ) | throws IllegalArgumentException, HyphenateException |
Updates the display style of push notifications. The default value is DisplayStyle#SimpleBanner.
Reference: For the asynchronous method, see asyncUpdatePushDisplayStyle(DisplayStyle, EMCallBack).
This is a synchronous method and blocks the current thread.
style | The display style of push notifications. |
boolean com.hyphenate.chat.EMPushManager.updatePushNickname | ( | String | nickname | ) | throws IllegalArgumentException, HyphenateException |
Updates the push display nickname of the current user. The nickname that is displayed in the push notification bar of the recipient's client when a message from the user is pushed. If no nickname is set, the user ID of the message sender, instead of the nickname, is indicated in the notification bar. The nickname can be different from the nickname in user attributes. However, Agora recommends that you use the same nickname for both. Therefore, if either nickname is updated, the other should be changed at the same time. For example, if you change the nickname in the user profile (EMUserInfoManager#updateOwnInfo(EMUserInfo, EMValueCallBack) or EMUserInfoManager#updateOwnInfoByAttribute(EMUserInfo.EMUserInfoType, String, EMValueCallBack)), remember to call this method to update the push nickname to ensure consistency.
For the asynchronous method, see asyncUpdatePushNickname(String, EMCallBack).
This is a synchronous method and blocks the current thread.
nickname | The push display nickname, which is different from the nickname in the user profile. |
void com.hyphenate.chat.EMPushManager.updatePushServiceForGroup | ( | List< String > | groupIds, |
boolean | noPush | ||
) | throws HyphenateException |
Sets whether to turn off the offline push notification for the the specified groups.
This is a synchronous method and blocks the current thread.
groupIds | The list of groups. |
noPush | - true : Turns off the notification;
|
HyphenateException | A description of the cause of the exception. |
void com.hyphenate.chat.EMPushManager.updatePushServiceForUsers | ( | List< String > | userIds, |
boolean | noPush | ||
) | throws HyphenateException |
Sets whether to turn off the offline push for specified users.
userIds | The list of users. |
noPush | - true :turns off the notification;
|
HyphenateException | A description of the cause of the exception. |