类 | |
enum | DisplayStyle |
enum | EMPushAction |
enum | PushRemindType |
Public 成员函数 | |
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 | 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) |
synchronized void | bindDeviceToken (String notifierName, String deviceToken, CallBack callBack) |
void | setPushTemplate (String templateName, CallBack callBack) |
void | getPushTemplate (ValueCallBack< String > callBack) |
void | reportPushAction (JSONObject json, EMPushAction action, CallBack callBack) |
离线消息推送管理类,针对 GCM、小米、华为等离线推送以及 APNS。
void io.agora.chat.PushManager.asyncUpdatePushDisplayStyle | ( | DisplayStyle | style, |
CallBack | callback | ||
) |
更新推送消息样式,默认是 DisplayStyle#SimpleBanner。
异步方法。
参考: 同步方法见 updatePushDisplayStyle(DisplayStyle)。
style | 推送消息样式。 |
void io.agora.chat.PushManager.asyncUpdatePushNickname | ( | String | nickname, |
CallBack | callback | ||
) |
更新当前用户的推送昵称。
异步方法。
离线消息推送的时候可以显示推送昵称而不是用户 ID。 当用户更改昵称(可通过 UserInfoManager#updateOwnInfo(UserInfo, ValueCallBack) 或者 UserInfoManager#updateOwnInfoByAttribute(UserInfo.UserInfoType, String, ValueCallBack) 修改)时,
务必也调用此方法更新到环信服务器,防止显示差异。
参考: 同步方法见 updatePushNickname(String)。
nickname | 推送昵称,需要与用户属性中的昵称区分开。 |
synchronized void io.agora.chat.PushManager.bindDeviceToken | ( | String | notifierName, |
String | deviceToken, | ||
CallBack | callBack | ||
) |
绑定设备token到服务器。 当deviceToken为空时,表示从服务器解绑当前设备的deviceToken
notifierName | 表示当前设备的ID,具体如下: FCM - Sender ID; 华为 - App ID; 小米 - App ID; 魅族 - App ID; OPPO - App Key; Vivo - App ID + "#" + App Key; |
deviceToken | 当前设备返回的设备 Token . |
callBack |
void io.agora.chat.PushManager.clearRemindTypeForConversation | ( | String | conversationId, |
Conversation.ConversationType | type, | ||
CallBack | callBack | ||
) |
清除会话的离线推送提醒类型设置。 清除之后会话跟随当前登录用户的设置 PushManager#setSilentModeForAll(SilentModeParam, ValueCallBack)。
conversationId | 会话id。 |
type | 会话类型。 |
callBack | 完成回调。 |
void io.agora.chat.PushManager.disableOfflinePush | ( | int | start, |
int | end | ||
) | throws ChatException |
在指定的时间段(24 小时制)内,不推送离线消息。
同步方法,会阻塞当前线程。
start | 开始时间。 |
end | 结束时间。 |
ChatException | 如果有异常会在这里抛出,包含异常原因。 |
void io.agora.chat.PushManager.enableOfflinePush | ( | ) | throws ChatException |
开启离线消息推送。
同步方法,会阻塞当前线程。
ChatException |
List< String > io.agora.chat.PushManager.getNoPushGroups | ( | ) |
获取关闭了离线消息推送的群组。
同步方法,会阻塞当前线程。
List< String > io.agora.chat.PushManager.getNoPushUsers | ( | ) |
从缓存中获取关闭了离线消息推送的用户。
注意: 如果需要获取最新的数据可先调用 PushManager#getPushConfigsFromServer() 后,再调用本方法。
void io.agora.chat.PushManager.getPreferredNotificationLanguage | ( | ValueCallBack< String > | callBack | ) |
获取用户设置的推送翻译语言。
callBack | 完成回调。 |
PushConfigs io.agora.chat.PushManager.getPushConfigs | ( | ) |
从缓存获取推送配置信息。
PushConfigs io.agora.chat.PushManager.getPushConfigsFromServer | ( | ) | throws ChatException |
从服务器获取推送配置信息。
同步方法,会阻塞当前线程。
ChatException | 如果有异常会在这里抛出,包含异常原因。 |
void io.agora.chat.PushManager.getPushTemplate | ( | ValueCallBack< String > | callBack | ) |
获取设置的离线推送模版。
callBack | 完成回调。 |
void io.agora.chat.PushManager.getSilentModeForAll | ( | ValueCallBack< SilentModeResult > | callBack | ) |
获取当前登录用户的免打扰设置。
callBack | 完成回调。 |
void io.agora.chat.PushManager.getSilentModeForConversation | ( | String | conversationId, |
Conversation.ConversationType | type, | ||
ValueCallBack< SilentModeResult > | callBack | ||
) |
获取会话的免打扰设置。
conversationId | 会话id。 |
type | 会话类型。 |
callBack | 完成回调。 |
void io.agora.chat.PushManager.getSilentModeForConversations | ( | List< Conversation > | conversationList, |
ValueCallBack< Map< String, SilentModeResult > > | callBack | ||
) |
批量获取指定会话的免打扰设置。
conversationList | 会话列表。 |
callBack | 完成回调。 |
void io.agora.chat.PushManager.reportPushAction | ( | JSONObject | json, |
EMPushAction | action, | ||
CallBack | callBack | ||
) |
上报推送事件。
异步方法。
json | 推送数据里携带的EPush字段对应的value。 |
action | 推送事件 |
callBack | 完成回调。 |
void io.agora.chat.PushManager.setPreferredNotificationLanguage | ( | String | languageCode, |
CallBack | callBack | ||
) |
设置用户推送翻译语言。
languageCode | 语言code。 |
callBack | 完成回调。 |
void io.agora.chat.PushManager.setPushTemplate | ( | String | templateName, |
CallBack | callBack | ||
) |
设置离线推送的推送模版。
templateName | 模版名称。 |
callBack | 完成回调。 |
void io.agora.chat.PushManager.setSilentModeForAll | ( | SilentModeParam | param, |
ValueCallBack< SilentModeResult > | callBack | ||
) |
设置当前登录用户的免打扰设置。
param | 离线推送免打扰参数。 |
callBack | 完成回调。 |
void io.agora.chat.PushManager.setSilentModeForConversation | ( | String | conversationId, |
Conversation.ConversationType | type, | ||
SilentModeParam | param, | ||
ValueCallBack< SilentModeResult > | callBack | ||
) |
设置会话的免打扰。
conversationId | 会话id。 |
type | 会话类型。 |
param | 离线推送免打扰参数。 |
callBack | 完成回调。 |
void io.agora.chat.PushManager.updatePushDisplayStyle | ( | DisplayStyle | style | ) | throws IllegalArgumentException, ChatException |
更新推送消息样式,默认是 DisplayStyle#SimpleBanner。
参考: 异步方法见 asyncUpdatePushDisplayStyle(DisplayStyle, CallBack)。
同步方法,会阻塞当前线程。
style | 推送消息样式。 |
boolean io.agora.chat.PushManager.updatePushNickname | ( | String | nickname | ) | throws IllegalArgumentException, ChatException |
更新当前用户的推送昵称。 离线消息推送的时候可以显示推送昵称而不是用户 ID。 当用户更改昵称(可通过 UserInfoManager#updateOwnInfo(UserInfo, ValueCallBack) 或者 UserInfoManager#updateOwnInfoByAttribute(UserInfo.UserInfoType, String, ValueCallBack) 修改)时, 务必也调用此方法更新到 Chat 服务器,防止显示差异。
参考: 异步方法见 asyncUpdatePushNickname(String, CallBack)
同步方法,会阻塞当前线程。
nickname | 推送昵称,需要与用户属性中的昵称区分开。 |
void io.agora.chat.PushManager.updatePushServiceForGroup | ( | List< String > | groupIds, |
boolean | noPush | ||
) | throws ChatException |
设置指定的群组是否接受离线消息推送。
同步方法,会阻塞当前线程。
groupIds | 要设置的群组列表。 |
noPush | - true :不接收离线消息推送;
|
ChatException | 如果有异常会在这里抛出,包含异常原因。 |
void io.agora.chat.PushManager.updatePushServiceForUsers | ( | List< String > | userIds, |
boolean | noPush | ||
) | throws ChatException |
设置指定的用户是否接收离线消息推送。
userIds | 要设置的用户列表。 |
noPush | - true :不接收离线消息推送;
|
ChatException | 如果有异常会在这里抛出,包含异常原因。 |