com.netease.nimlib.sdk.qchat.param

类 QChatSendSystemNotificationParam

java.lang.Object

com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam

public class QChatSendSystemNotificationParam
extends java.lang.Object

"发送系统通知"接口入参

构造器概要

构造器

构造器和说明
QChatSendSystemNotificationParam(long serverId) 通知给服务器
QChatSendSystemNotificationParam(long serverId, java.util.List<java.lang.String> toAccids) 通知给服务器成员
QChatSendSystemNotificationParam(long serverId, long channelId) 通知给频道
QChatSendSystemNotificationParam(long serverId, long channelId, java.util.List<java.lang.String> toAccids) 通知给频道成员

方法概要

限定符和类型	方法和说明
java.lang.String	getAttach() 获取附件字符串
java.lang.String	getBody() 获取通知内容
java.lang.Long	getChannelId() 获取频道id
java.lang.String	getEnv() 获取环境变量 用户可以根据不同的env配置不同的抄送和回调地址
java.util.Map<java.lang.String,java.lang.Object>	getExtension() 获取扩展字段
java.lang.String	getPushContent() 获取推送内容
java.util.Map<java.lang.String,java.lang.Object>	getPushPayload() 获取推送payload
java.lang.Long	getServerId() 获取服务器id
java.lang.Integer	getStatus() 获取状态
java.util.List<java.lang.String>	getToAccids() 获取通知的账号列表
java.lang.Integer	getToType() 获取通知发送对象类型
QChatSystemNotificationType	getType() 获取系统通知类型，用户发送的系统通知一定是 QChatSystemMsgType.CUSTOM
java.lang.String	getUuid() 获取系统通知uuid
boolean	isNeedBadge() 是否需要消息计数，默认true
boolean	isNeedPushNick() 是否需要推送昵称，默认true
boolean	isPersistEnable() 是否存离线
boolean	isPushEnable() 是否需要推送，默认true
boolean	isRouteEnable() 是否需要抄送，默认true
void	setAttach(java.lang.String attach) 设置通知附件
void	setBody(java.lang.String body) 设置通知内容
void	setEnv(java.lang.String env) 设置环境变量 用户可以根据不同的env配置不同的抄送和回调地址
void	setExtension(java.util.Map<java.lang.String,java.lang.Object> extension) 设置扩展字段
void	setNeedBadge(boolean needBadge) 设置是否需要消息计数
void	setNeedPushNick(boolean needPushNick) 设置是否需要推送昵称
void	setPersistEnable(boolean persistEnable) 设置是否存离线
void	setPushContent(java.lang.String pushContent) 设置推送内容
void	setPushEnable(boolean pushEnable) 设置是否需要推送
void	setPushPayload(java.util.Map<java.lang.String,java.lang.Object> pushPayload) 设置推送payload
void	setRouteEnable(boolean routeEnable) 设置是否需要抄送
void	setStatus(java.lang.Integer status) 如果设置状态，状态只能设置成自定义的状态(status>= 10000)，否则提示414参数错误
QChatSystemNotification	toSystemNotification() 转换成QChatSystemNotification

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

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

构造器详细资料

QChatSendSystemNotificationParam

public QChatSendSystemNotificationParam(long serverId)

通知给服务器

参数:

serverId - 服务器id

QChatSendSystemNotificationParam

public QChatSendSystemNotificationParam(long serverId,
                                        long channelId)

通知给频道

参数:

serverId - 服务器id

channelId - 频道id

QChatSendSystemNotificationParam

public QChatSendSystemNotificationParam(long serverId,
                                        java.util.List<java.lang.String> toAccids)

通知给服务器成员

参数:

serverId - 服务器id

toAccids - 通知的账号列表

QChatSendSystemNotificationParam

public QChatSendSystemNotificationParam(long serverId,
                                        long channelId,
                                        java.util.List<java.lang.String> toAccids)

通知给频道成员

参数:

serverId - 服务器id

channelId - 频道id

toAccids - 通知的账号列表

方法详细资料

getBody

public java.lang.String getBody()

获取通知内容

返回:

setBody

public void setBody(java.lang.String body)

设置通知内容

参数:

body -

setAttach

public void setAttach(java.lang.String attach)

设置通知附件

参数:

attach -

setExtension

public void setExtension(java.util.Map<java.lang.String,java.lang.Object> extension)

设置扩展字段

参数:

extension -

setStatus

public void setStatus(java.lang.Integer status)

如果设置状态，状态只能设置成自定义的状态(status>= 10000)，否则提示414参数错误

参数:

status -

setPushPayload

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

设置推送payload

参数:

pushPayload -

setPushContent

public void setPushContent(java.lang.String pushContent)

设置推送内容

参数:

pushContent -

getServerId

public java.lang.Long getServerId()

获取服务器id

返回:

getChannelId

public java.lang.Long getChannelId()

获取频道id

返回:

getToAccids

public java.util.List<java.lang.String> getToAccids()

获取通知的账号列表

返回:

getAttach

public java.lang.String getAttach()

获取附件字符串

返回:

getExtension

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

获取扩展字段

返回:

getStatus

public java.lang.Integer getStatus()

获取状态

返回:

getPushPayload

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

获取推送payload

返回:

getPushContent

public java.lang.String getPushContent()

获取推送内容

返回:

isPersistEnable

public boolean isPersistEnable()

是否存离线

返回:

setPersistEnable

public void setPersistEnable(boolean persistEnable)

设置是否存离线

参数:

persistEnable -

getToType

public java.lang.Integer getToType()

获取通知发送对象类型

返回:

isPushEnable

public boolean isPushEnable()

是否需要推送，默认true

返回:

setPushEnable

public void setPushEnable(boolean pushEnable)

设置是否需要推送

参数:

pushEnable -

isNeedBadge

public boolean isNeedBadge()

是否需要消息计数，默认true

返回:

setNeedBadge

public void setNeedBadge(boolean needBadge)

设置是否需要消息计数

参数:

needBadge -

isNeedPushNick

public boolean isNeedPushNick()

是否需要推送昵称，默认true

返回:

setNeedPushNick

public void setNeedPushNick(boolean needPushNick)

设置是否需要推送昵称

参数:

needPushNick -

isRouteEnable

public boolean isRouteEnable()

是否需要抄送，默认true

返回:

setRouteEnable

public void setRouteEnable(boolean routeEnable)

设置是否需要抄送

参数:

routeEnable -

getEnv

public java.lang.String getEnv()

获取环境变量 用户可以根据不同的env配置不同的抄送和回调地址

返回:

环境变量

setEnv

public void setEnv(java.lang.String env)

设置环境变量 用户可以根据不同的env配置不同的抄送和回调地址

参数:

env - 环境变量

getType

public QChatSystemNotificationType getType()

获取系统通知类型，用户发送的系统通知一定是 QChatSystemMsgType.CUSTOM

返回:

getUuid

public java.lang.String getUuid()

获取系统通知uuid

返回:

toSystemNotification

public QChatSystemNotification toSystemNotification()

转换成QChatSystemNotification

返回: