io.agora.chat.PushManager类 参考

类
enum	DisplayStyle
enum	EMPushAction
enum	PushRemindType

Public 成员函数
PushConfigs	getPushConfigs ()
PushConfigs	getPushConfigsFromServer () throws ChatException
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	syncSilentModeConversationsFromServer (CallBack 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)
void	reportPushAction (JSONObject json, EMPushAction action, CallBack callBack)

详细描述

离线消息推送管理类，针对 GCM、小米、华为等离线推送以及 APNS。

成员函数说明

asyncUpdatePushDisplayStyle()

void io.agora.chat.PushManager.asyncUpdatePushDisplayStyle	(	DisplayStyle	style,
		CallBack	callback
	)

更新推送消息样式，默认是 DisplayStyle#SimpleBanner。

异步方法。

参考： 同步方法见 updatePushDisplayStyle(DisplayStyle)。

参数

style

推送消息样式。

asyncUpdatePushNickname()

void io.agora.chat.PushManager.asyncUpdatePushNickname	(	String	nickname,
		CallBack	callback
	)

更新当前用户的推送昵称。

异步方法。

离线消息推送的时候可以显示推送昵称而不是用户 ID。 当用户更改昵称（可通过 UserInfoManager#updateOwnInfo(UserInfo, ValueCallBack) 或者 UserInfoManager#updateOwnInfoByAttribute(UserInfo.UserInfoType, String, ValueCallBack) 修改）时，

务必也调用此方法更新到环信服务器，防止显示差异。

 同步方法见 {@link #updatePushNickname(String)}。

参数

nickname

推送昵称，需要与用户属性中的昵称区分开。

bindDeviceToken()

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

clearRemindTypeForConversation()

void io.agora.chat.PushManager.clearRemindTypeForConversation	(	String	conversationId,
		Conversation.ConversationType	type,
		CallBack	callBack
	)

清除会话的离线推送提醒类型设置。 清除之后会话跟随当前登录用户的设置 PushManager#setSilentModeForAll(SilentModeParam, ValueCallBack)。

参数

conversationId	会话 ID。
type	会话类型。
callBack	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

getPreferredNotificationLanguage()

void io.agora.chat.PushManager.getPreferredNotificationLanguage

(

ValueCallBack< String >

callBack

)

获取用户设置的推送翻译语言。

参数

callBack

该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

getPushConfigs()

PushConfigs io.agora.chat.PushManager.getPushConfigs

(

)

从缓存获取推送配置信息。

返回

推送配置信息。

getPushConfigsFromServer()

PushConfigs io.agora.chat.PushManager.getPushConfigsFromServer

(

)

throws ChatException

从服务器获取推送配置信息。

同步方法，会阻塞当前线程。

返回

推送配置信息。

异常

ChatException

如果有异常会在这里抛出，包含异常原因。

getPushTemplate()

void io.agora.chat.PushManager.getPushTemplate

(

ValueCallBack< String >

callBack

)

获取设置的离线推送模板。

参数

callBack

该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

getSilentModeForAll()

void io.agora.chat.PushManager.getSilentModeForAll

(

ValueCallBack< SilentModeResult >

callBack

)

获取当前登录用户的免打扰设置。

参数

callBack

该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

getSilentModeForConversation()

void io.agora.chat.PushManager.getSilentModeForConversation	(	String	conversationId,
		Conversation.ConversationType	type,
		ValueCallBack< SilentModeResult >	callBack
	)

获取会话的免打扰设置。

参数

conversationId	会话 ID。
type	会话类型。
callBack	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

getSilentModeForConversations()

void io.agora.chat.PushManager.getSilentModeForConversations	(	List< Conversation >	conversationList,
		ValueCallBack< Map< String, SilentModeResult > >	callBack
	)

批量获取指定会话的免打扰设置。

参数

conversationList	会话列表。
callBack	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

reportPushAction()

void io.agora.chat.PushManager.reportPushAction	(	JSONObject	json,
		EMPushAction	action,
		CallBack	callBack
	)

上报推送事件。

异步方法。

参数

json	推送数据里携带的 EPush 字段对应的 value。
action	推送事件。
callBack	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

setPreferredNotificationLanguage()

void io.agora.chat.PushManager.setPreferredNotificationLanguage	(	String	languageCode,
		CallBack	callBack
	)

设置用户推送翻译语言。

参数

languageCode	语言 code。
callBack	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

setPushTemplate()

void io.agora.chat.PushManager.setPushTemplate	(	String	templateName,
		CallBack	callBack
	)

设置离线推送的推送模板。

参数

templateName	模板名称。
callBack	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

setSilentModeForAll()

void io.agora.chat.PushManager.setSilentModeForAll	(	SilentModeParam	param,
		ValueCallBack< SilentModeResult >	callBack
	)

设置当前登录用户的免打扰设置。

参数

param	离线推送免打扰参数。
callBack	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

setSilentModeForConversation()

void io.agora.chat.PushManager.setSilentModeForConversation	(	String	conversationId,
		Conversation.ConversationType	type,
		SilentModeParam	param,
		ValueCallBack< SilentModeResult >	callBack
	)

设置会话的免打扰。

参数

conversationId	会话 ID。
type	会话类型。
param	离线推送免打扰参数。
callBack	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

syncSilentModeConversationsFromServer()

void io.agora.chat.PushManager.syncSilentModeConversationsFromServer

(

CallBack

callBack

)

和服务端同步会话免打扰状态，异步方法

参数

callBack

处理结果回调，失败会返回失败原因。详见 CallBack。

updatePushDisplayStyle()

void io.agora.chat.PushManager.updatePushDisplayStyle

(

DisplayStyle

style

)

throws IllegalArgumentException, ChatException

更新推送消息样式，默认是 DisplayStyle#SimpleBanner。

参考： 异步方法见 asyncUpdatePushDisplayStyle(DisplayStyle, CallBack)。

同步方法，会阻塞当前线程。

参数

style

推送消息样式。

updatePushNickname()

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

推送昵称，需要与用户属性中的昵称区分开。

---

该类的文档由以下文件生成:

• io/agora/chat/PushManager.java