com.netease.nimlib.sdk.msg.model

类 CustomNotification

java.lang.Object

com.netease.nimlib.sdk.msg.model.CustomNotification

所有已实现的接口:

java.io.Serializable

public class CustomNotification
extends java.lang.Object
implements java.io.Serializable

自定义通知。
区别于IMMessage，SDK仅透传该类型消息，不负责解析和存储。消息内容由第三方APP自由扩展。
自定义通知消息可选择要不要发送给当前不在线的用户。

另请参阅:

序列化表格

构造器概要

构造器

构造器和说明
CustomNotification()

方法概要

限定符和类型	方法和说明
java.lang.String	getApnsText() 获取如果接收方是iOS设备登录，该消息的APNS推送文本内容
CustomNotificationConfig	getConfig()
java.lang.String	getContent() 获取消息具体内容。
java.lang.String	getEnv() 获取环境变量 用于指向不同的抄送，第三方回调等配置
java.lang.String	getFromAccount() 获取该通知的发出者帐号。
NIMAntiSpamOption	getNIMAntiSpamOption() 获取反垃圾配置
java.util.Map<java.lang.String,java.lang.Object>	getPushPayload() 获取第三方自定义的推送属性
java.lang.String	getSessionId() 获取聊天对象的Id（好友帐号，群ID等）。
SessionTypeEnum	getSessionType() 获取会话类型。
long	getTime() 获取消息时间，单位为ms
boolean	isSendToOnlineUserOnly() 该消息是否只发送当前在线的用户/群组。
void	setApnsText(java.lang.String apnsText) 设置如果接收方是iOS设备登录，该消息的APNS推送文本内容
void	setConfig(CustomNotificationConfig config)
void	setContent(java.lang.String content) 设置消息内容。
void	setEnv(java.lang.String env) 设置环境变量 用于指向不同的抄送，第三方回调等配置
void	setFromAccount(java.lang.String fromAccount) 设置该通知的发起者帐号
void	setNIMAntiSpamOption(NIMAntiSpamOption antiSpamOption) 设置反垃圾配置项
void	setPushPayload(java.util.Map<java.lang.String,java.lang.Object> pushPayload) 设置第三方自定义的推送属性
void	setSendToOnlineUserOnly(boolean sendToOnlineUserOnly) 设置该消息是否只发送给当前在线的用户。
void	setSessionId(java.lang.String sessionId) 设置聊天对象ID。
void	setSessionType(SessionTypeEnum sessionType) 设置会话类型。
void	setTime(long time) 设置消息时间
JSONObject	toJsonObj()

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

CustomNotification

public CustomNotification()

方法详细资料

getSessionId

public java.lang.String getSessionId()

获取聊天对象的Id（好友帐号，群ID等）。

返回:

聊天对象ID

setSessionId

public void setSessionId(java.lang.String sessionId)

设置聊天对象ID。

参数:

sessionId - 聊天对象ID

getSessionType

public SessionTypeEnum getSessionType()

获取会话类型。

返回:

会话类型

setSessionType

public void setSessionType(SessionTypeEnum sessionType)

设置会话类型。

参数:

sessionType - 会话类型

getFromAccount

public java.lang.String getFromAccount()

获取该通知的发出者帐号。

返回:

发出者帐号

setFromAccount

public void setFromAccount(java.lang.String fromAccount)

设置该通知的发起者帐号

参数:

fromAccount - 发起者帐号

getTime

public long getTime()

获取消息时间，单位为ms

setTime

public void setTime(long time)

设置消息时间

getContent

public java.lang.String getContent()

获取消息具体内容。

setContent

public void setContent(java.lang.String content)

设置消息内容。

isSendToOnlineUserOnly

public boolean isSendToOnlineUserOnly()

该消息是否只发送当前在线的用户/群组。

setSendToOnlineUserOnly

public void setSendToOnlineUserOnly(boolean sendToOnlineUserOnly)

设置该消息是否只发送给当前在线的用户。
如果该值为true，只有接收方当前在线时，才能收到该消息。
如果该值为false，如果接收方当前在线，会立即收到该消息，如果不在线，会在下一次登录后收到该消息。 设置为false后，该消息和普通IM消息一样保证必达。

参数:

sendToOnlineUserOnly - 是否只发送给在线用户/群组，云信SDK 4.1版本开始支持群组离线自定义通知.

getApnsText

public java.lang.String getApnsText()

获取如果接收方是iOS设备登录，该消息的APNS推送文本内容

返回:

apns推送文本设置

setApnsText

public void setApnsText(java.lang.String apnsText)

设置如果接收方是iOS设备登录，该消息的APNS推送文本内容

参数:

apnsText - apns推送文本设置

getPushPayload

public java.util.Map<java.lang.String,java.lang.Object> getPushPayload()

获取第三方自定义的推送属性

返回:

第三方自定义的推送属性Map

setPushPayload

public void setPushPayload(java.util.Map<java.lang.String,java.lang.Object> pushPayload)

设置第三方自定义的推送属性

参数:

pushPayload - 第三方自定义的推送属性Map，开发者需要保证此Map能够转换为JsonObject，属性内容最大长度2048字节

getConfig

public CustomNotificationConfig getConfig()

setConfig

public void setConfig(CustomNotificationConfig config)

getNIMAntiSpamOption

public NIMAntiSpamOption getNIMAntiSpamOption()

获取反垃圾配置

返回:

setNIMAntiSpamOption

public void setNIMAntiSpamOption(NIMAntiSpamOption antiSpamOption)

设置反垃圾配置项

参数:

antiSpamOption -

getEnv

public java.lang.String getEnv()

获取环境变量 用于指向不同的抄送，第三方回调等配置

返回:

环境变量

setEnv

public void setEnv(java.lang.String env)

设置环境变量 用于指向不同的抄送，第三方回调等配置

参数:

env - 环境变量

toJsonObj

public JSONObject toJsonObj()