agora_chat_SDK 1.0.6
agora java chat SDK
|
Classes | |
enum | DisplayStyle |
enum | EMPushAction |
enum | PushRemindType |
Public Member Functions | |
void | enableOfflinePush () throws ChatException |
void | disableOfflinePush (int start, int end) throws ChatException |
PushConfigs | getPushConfigs () |
PushConfigs | getPushConfigsFromServer () throws ChatException |
void | updatePushServiceForGroup (List< String > groupIds, boolean noPush) throws ChatException |
void | updatePushServiceForUsers (List< String > userIds, boolean noPush) throws ChatException |
List< String > | getNoPushGroups () |
List< String > | getNoPushUsers () |
boolean | updatePushNickname (String nickname) throws IllegalArgumentException, ChatException |
void | asyncUpdatePushNickname (String nickname, CallBack callback) |
void | updatePushDisplayStyle (DisplayStyle style) throws IllegalArgumentException, ChatException |
void | asyncUpdatePushDisplayStyle (DisplayStyle style, CallBack callback) |
void | asyncReportPushAction (String taskId, String provider, EMPushAction action, CallBack callback) |
void | setSilentModeForConversation (String conversationId, Conversation.ConversationType type, SilentModeParam param, ValueCallBack< SilentModeResult > callBack) |
void | clearRemindTypeForConversation (String conversationId, Conversation.ConversationType type, CallBack callBack) |
void | getSilentModeForConversation (String conversationId, Conversation.ConversationType type, ValueCallBack< SilentModeResult > callBack) |
void | setSilentModeForAll (SilentModeParam param, ValueCallBack< SilentModeResult > callBack) |
void | getSilentModeForAll (ValueCallBack< SilentModeResult > callBack) |
void | getSilentModeForConversations (List< Conversation > conversationList, ValueCallBack< Map< String, SilentModeResult > > callBack) |
void | setPreferredNotificationLanguage (String languageCode, CallBack callBack) |
void | getPreferredNotificationLanguage (ValueCallBack< String > callBack) |
void | bindDeviceToken (String notifierName, String deviceToken, CallBack callBack) |
void | setPushTemplate (String templateName, CallBack callBack) |
void | getPushTemplate (ValueCallBack< String > callBack) |
The message push configuration options.
void io.agora.chat.PushManager.asyncReportPushAction | ( | String | taskId, |
String | provider, | ||
EMPushAction | action, | ||
CallBack | callback | ||
) |
Reports the push events.
This is an asynchronous method.
taskId | Task ID |
provider | Vendor Channel name |
action | Push event |
void io.agora.chat.PushManager.asyncUpdatePushDisplayStyle | ( | DisplayStyle | style, |
CallBack | callback | ||
) |
Update the push message style. The default value is DisplayStyle#SimpleBanner.
This is an asynchronous method.
Reference: The synchronous method see updatePushDisplayStyle(DisplayStyle)
style | The push message style. |
void io.agora.chat.PushManager.asyncUpdatePushNickname | ( | String | nickname, |
CallBack | callback | ||
) |
Update the push display nickname of the current user.
This is an asynchronous method.
This method can be used to set a push nickname, the push nickname will be used for offline push notification. When the user changes the nickname in the user profile(use or UserInfoManager#updateOwnInfoByAttribute(UserInfo.UserInfoType, String, ValueCallBack) to set), be sure to also call this method to update the display nickname to prevent the display differences.
Reference: The synchronous method see updatePushNickname(String).
nickname | The push nickname, which is different from the nickname in user profiles. |
void io.agora.chat.PushManager.clearRemindTypeForConversation | ( | String | conversationId, |
Conversation.ConversationType | type, | ||
CallBack | callBack | ||
) |
清除会话的离线推送提醒类型设置。 清除之后会话跟随当前登录用户的设置 PushManager#setSilentModeForAll(SilentModeParam, ValueCallBack)。
conversationId | 会话id。 |
type | 会话类型。 |
callBack | 完成回调。 |
Clear the setting of offline push notification type for the conversation. After clearing, the session follows the Settings of the current logged-in user PushManager#setSilentModeForAll(SilentModeParam, ValueCallBack).
conversationId | The conversation id. |
type | The conversation type. |
callBack | Complete the callback. |
void io.agora.chat.PushManager.disableOfflinePush | ( | int | start, |
int | end | ||
) | throws ChatException |
Do not push the offline messages 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. |
ChatException | A description of the cause of the exception. |
void io.agora.chat.PushManager.enableOfflinePush | ( | ) | throws ChatException |
Turns on the push notification.
This is a synchronous method and blocks the current thread.
ChatException |
List< String > io.agora.chat.PushManager.getNoPushGroups | ( | ) |
Gets the list of groups which have blocked the push notification.
This is a synchronous method and blocks the current thread.
List< String > io.agora.chat.PushManager.getNoPushUsers | ( | ) |
Gets the list of user ID which have blocked the push notification from the cache.
Note: If you needs to get the latest data, call {@Link EmpushManager# getPushConfigsFromServer()} before calling this method.
void io.agora.chat.PushManager.getPreferredNotificationLanguage | ( | ValueCallBack< String > | callBack | ) |
Gets the push translation language set by the user.
callBack | Complete the callback. |
PushConfigs io.agora.chat.PushManager.getPushConfigs | ( | ) |
Get the push configs from cache.
PushConfigs io.agora.chat.PushManager.getPushConfigsFromServer | ( | ) | throws ChatException |
Get the push configs from the server.
This is a synchronous method and blocks the current thread.
ChatException | A description of the cause of the exception. |
void io.agora.chat.PushManager.getPushTemplate | ( | ValueCallBack< String > | callBack | ) |
Gets the offline push template for Settings.
callBack | Complete the callback. |
void io.agora.chat.PushManager.getSilentModeForAll | ( | ValueCallBack< SilentModeResult > | callBack | ) |
Gets the DND Settings of the current login user.
callBack | Complete the callback. |
void io.agora.chat.PushManager.getSilentModeForConversation | ( | String | conversationId, |
Conversation.ConversationType | type, | ||
ValueCallBack< SilentModeResult > | callBack | ||
) |
Gets the DND setting of the conversation.
conversationId | The conversation id. |
type | The conversation type. |
callBack | Complete the callback. |
void io.agora.chat.PushManager.getSilentModeForConversations | ( | List< Conversation > | conversationList, |
ValueCallBack< Map< String, SilentModeResult > > | callBack | ||
) |
Obtain the DND Settings of specified conversations in batches.
conversationList | The conversation list. |
callBack | Complete the callback. |
void io.agora.chat.PushManager.setPreferredNotificationLanguage | ( | String | languageCode, |
CallBack | callBack | ||
) |
Set user push translation language.
languageCode | language code. |
callBack | Complete the callback. |
void io.agora.chat.PushManager.setPushTemplate | ( | String | templateName, |
CallBack | callBack | ||
) |
Set the push template for offline push.
templateName | template name. |
callBack | Complete the callback. |
void io.agora.chat.PushManager.setSilentModeForAll | ( | SilentModeParam | param, |
ValueCallBack< SilentModeResult > | callBack | ||
) |
Example Set the DND Settings for the current login user.
param | Push DND parameters offline. |
callBack | Complete the callback. |
void io.agora.chat.PushManager.setSilentModeForConversation | ( | String | conversationId, |
Conversation.ConversationType | type, | ||
SilentModeParam | param, | ||
ValueCallBack< SilentModeResult > | callBack | ||
) |
Set the DND of the conversation.
conversationId | The conversation id. |
type | The conversation type. |
param | Push DND parameters offline. |
callBack | Complete the callback. |
void io.agora.chat.PushManager.updatePushDisplayStyle | ( | DisplayStyle | style | ) | throws IllegalArgumentException, ChatException |
Update the push message style. The default value is DisplayStyle#SimpleBanner.
Reference: The asynchronous method see asyncUpdatePushDisplayStyle(DisplayStyle, CallBack)
This is a synchronous method and blocks the current thread.
style | The push message display style. |
boolean io.agora.chat.PushManager.updatePushNickname | ( | String | nickname | ) | throws IllegalArgumentException, ChatException |
Updates the push display nickname of the current user. This method can be used to set a push display nickname, the push display nickname will be used to show for offline push notification. When the app user changes the nickname in the user profile(use or UserInfoManager#updateOwnInfoByAttribute(UserInfo.UserInfoType, String, ValueCallBack) to set}, be sure to also call this method to update to prevent the display differences.
Reference: The asynchronous method see asyncUpdatePushNickname(String, CallBack)
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 io.agora.chat.PushManager.updatePushServiceForGroup | ( | List< String > | groupIds, |
boolean | noPush | ||
) | throws ChatException |
Sets wether to turn on or turn off the push notification for the the specified groups.
This is a synchronous method and blocks the current thread.
groupIds | The list of groups to be set. |
noPush | - true : Turns off the notification;
|
ChatException | A description of the cause of the exception. |
void io.agora.chat.PushManager.updatePushServiceForUsers | ( | List< String > | userIds, |
boolean | noPush | ||
) | throws ChatException |
Sets whether the specified group accepts the offline message notification.
userIds | The list of users to be set. |
noPush | - true :turn off the notification;
|
ChatException | A description of the cause of the exception. |