NIMSDK-AOS 10.3.1-beta
载入中...
搜索中...
未找到
Public 成员函数 | 所有成员列表
com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam类 参考

"发送系统通知"接口入参 更多...

Public 成员函数

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

详细描述

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

在文件 QChatSendSystemNotificationParam.java18 行定义.

构造及析构函数说明

◆ QChatSendSystemNotificationParam() [1/4]

com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.QChatSendSystemNotificationParam ( long  serverId)

通知给服务器

参数
serverId服务器id

在文件 QChatSendSystemNotificationParam.java113 行定义.

◆ QChatSendSystemNotificationParam() [2/4]

com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.QChatSendSystemNotificationParam ( long  serverId,
long  channelId 
)

通知给频道

参数
serverId服务器id
channelId频道id

在文件 QChatSendSystemNotificationParam.java122 行定义.

◆ QChatSendSystemNotificationParam() [3/4]

com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.QChatSendSystemNotificationParam ( long  serverId,
List< String >  toAccids 
)

通知给服务器成员

参数
serverId服务器id
toAccids通知的账号列表

在文件 QChatSendSystemNotificationParam.java131 行定义.

◆ QChatSendSystemNotificationParam() [4/4]

com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.QChatSendSystemNotificationParam ( long  serverId,
long  channelId,
List< String >  toAccids 
)

通知给频道成员

参数
serverId服务器id
channelId频道id
toAccids通知的账号列表

在文件 QChatSendSystemNotificationParam.java141 行定义.

成员函数说明

◆ getAttach()

String com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.getAttach ( )

获取附件字符串

返回

在文件 QChatSendSystemNotificationParam.java244 行定义.

◆ getBody()

String com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.getBody ( )

获取通知内容

返回

在文件 QChatSendSystemNotificationParam.java163 行定义.

◆ getChannelId()

Long com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.getChannelId ( )

获取频道id

返回

在文件 QChatSendSystemNotificationParam.java228 行定义.

◆ getEnv()

String com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.getEnv ( )

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

返回
环境变量

在文件 QChatSendSystemNotificationParam.java382 行定义.

◆ getExtension()

Map< String, Object > com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.getExtension ( )

获取扩展字段

返回

在文件 QChatSendSystemNotificationParam.java252 行定义.

◆ getPushContent()

String com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.getPushContent ( )

获取推送内容

返回

在文件 QChatSendSystemNotificationParam.java276 行定义.

◆ getPushPayload()

Map< String, Object > com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.getPushPayload ( )

获取推送payload

返回

在文件 QChatSendSystemNotificationParam.java268 行定义.

◆ getServerId()

Long com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.getServerId ( )

获取服务器id

返回

在文件 QChatSendSystemNotificationParam.java220 行定义.

◆ getStatus()

Integer com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.getStatus ( )

获取状态

返回

在文件 QChatSendSystemNotificationParam.java260 行定义.

◆ getToAccids()

List< String > com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.getToAccids ( )

获取通知的账号列表

返回

在文件 QChatSendSystemNotificationParam.java236 行定义.

◆ getToType()

Integer com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.getToType ( )

获取通知发送对象类型

返回

在文件 QChatSendSystemNotificationParam.java308 行定义.

◆ getType()

QChatSystemNotificationType com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.getType ( )

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

返回

在文件 QChatSendSystemNotificationParam.java400 行定义.

◆ getUuid()

String com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.getUuid ( )

获取系统通知uuid

返回

在文件 QChatSendSystemNotificationParam.java409 行定义.

◆ isNeedBadge()

boolean com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.isNeedBadge ( )

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

返回

在文件 QChatSendSystemNotificationParam.java332 行定义.

◆ isNeedPushNick()

boolean com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.isNeedPushNick ( )

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

返回

在文件 QChatSendSystemNotificationParam.java348 行定义.

◆ isPersistEnable()

boolean com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.isPersistEnable ( )

是否存离线

返回

在文件 QChatSendSystemNotificationParam.java284 行定义.

◆ isPushEnable()

boolean com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.isPushEnable ( )

是否需要推送,默认true

返回

在文件 QChatSendSystemNotificationParam.java316 行定义.

◆ isRouteEnable()

boolean com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.isRouteEnable ( )

是否需要抄送,默认true

返回

在文件 QChatSendSystemNotificationParam.java364 行定义.

◆ setAttach()

void com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.setAttach ( String  attach)

设置通知附件

参数
attach

在文件 QChatSendSystemNotificationParam.java179 行定义.

◆ setBody()

void com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.setBody ( String  body)

设置通知内容

参数
body

在文件 QChatSendSystemNotificationParam.java171 行定义.

◆ setEnv()

void com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.setEnv ( String  env)

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

参数
env环境变量

在文件 QChatSendSystemNotificationParam.java392 行定义.

◆ setExtension()

void com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.setExtension ( Map< String, Object >  extension)

设置扩展字段

参数
extension

在文件 QChatSendSystemNotificationParam.java187 行定义.

◆ setNeedBadge()

void com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.setNeedBadge ( boolean  needBadge)

设置是否需要消息计数

参数
needBadge

在文件 QChatSendSystemNotificationParam.java340 行定义.

◆ setNeedPushNick()

void com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.setNeedPushNick ( boolean  needPushNick)

设置是否需要推送昵称

参数
needPushNick

在文件 QChatSendSystemNotificationParam.java356 行定义.

◆ setPersistEnable()

void com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.setPersistEnable ( boolean  persistEnable)

设置是否存离线

参数
persistEnable

在文件 QChatSendSystemNotificationParam.java292 行定义.

◆ setPushContent()

void com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.setPushContent ( String  pushContent)

设置推送内容

参数
pushContent

在文件 QChatSendSystemNotificationParam.java211 行定义.

◆ setPushEnable()

void com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.setPushEnable ( boolean  pushEnable)

设置是否需要推送

参数
pushEnable

在文件 QChatSendSystemNotificationParam.java324 行定义.

◆ setPushPayload()

void com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.setPushPayload ( Map< String, Object >  pushPayload)

设置推送payload

参数
pushPayload

在文件 QChatSendSystemNotificationParam.java203 行定义.

◆ setRouteEnable()

void com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.setRouteEnable ( boolean  routeEnable)

设置是否需要抄送

参数
routeEnable

在文件 QChatSendSystemNotificationParam.java372 行定义.

◆ setStatus()

void com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.setStatus ( Integer  status)

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

参数
status

在文件 QChatSendSystemNotificationParam.java195 行定义.

◆ toSystemNotification()

QChatSystemNotification com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam.toSystemNotification ( )

转换成QChatSystemNotification

返回

在文件 QChatSendSystemNotificationParam.java417 行定义.


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