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

"发送消息"接口入参 更多...

Public 成员函数

 QChatSendMessageParam (long serverId, long channelId, @NonNull MsgTypeEnum type)
 
void setBody (String body)
 设置消息内容 更多...
 
void setAttach (String attach)
 设置消息附件,通过MsgAttachment::toJson(false)获得 更多...
 
void setAttachment (MsgAttachment attachment)
 设置消息附件 更多...
 
void setExtension (Map< String, Object > extension)
 设置扩展字段 更多...
 
void setPushPayload (Map< String, Object > pushPayload)
 设置推送payload 更多...
 
void setPushContent (String pushContent)
 设置推送文案 更多...
 
void setMentionedAccidList (List< String > mentionedAccidList)
 设置@账号列表 更多...
 
void setMentionedRoleIdList (List< Long > mentionedRoleIdList)
 设置@身份组的RoleId列表 更多...
 
void setMentionedAll (boolean mentionedAll)
 设置是否@所有人 更多...
 
void setHistoryEnable (boolean historyEnable)
 设置是否消息是否存储云端历史 更多...
 
void setPushEnable (boolean pushEnable)
 设置是否需要推送 更多...
 
void setNeedBadge (boolean needBadge)
 设置是否需要消息计数 更多...
 
void setNeedPushNick (boolean needPushNick)
 设置是否需要推送昵称 更多...
 
Long getServerId ()
 获取服务器id 更多...
 
Long getChannelId ()
 获取频道id 更多...
 
MsgTypeEnum getType ()
 获取消息类型 更多...
 
String getBody ()
 获取消息内容 更多...
 
String getAttach ()
 获取消息附件字符串 更多...
 
Map< String, Object > getExtension ()
 获取扩展字段 更多...
 
Map< String, Object > getPushPayload ()
 获取推送payload 更多...
 
String getPushContent ()
 获取推送文案 更多...
 
List< String > getMentionedAccidList ()
 获取@账号列表 更多...
 
List< Long > getMentionedRoleIdList ()
 设置@身份组的RoleId列表 更多...
 
boolean isMentionedAll ()
 是否@所有人 更多...
 
boolean isHistoryEnable ()
 是否消息在云端存储,默认true 更多...
 
boolean isPushEnable ()
 是否需要推送,默认true 更多...
 
boolean isNeedBadge ()
 是否需要消息计数,默认true 更多...
 
boolean isNeedPushNick ()
 是否需要推送昵称,默认true 更多...
 
String getUuid ()
 获取消息uuid 更多...
 
Integer getServerStatus ()
 获取消息服务器状态 更多...
 
void setServerStatus (Integer serverStatus)
 如果设置状态,状态只能设置成自定义的状态(status>= 10000),否则提示414参数错误 更多...
 
QChatMessageAntiSpamOption getAntiSpamOption ()
 获取消息反垃圾配置选项 更多...
 
void setAntiSpamOption (QChatMessageAntiSpamOption antiSpamOption)
 设置消息反垃圾配置选项 更多...
 
boolean isRouteEnable ()
 是否需要抄送,默认true 更多...
 
void setRouteEnable (boolean routeEnable)
 设置是否需要抄送 更多...
 
String getEnv ()
 获取环境变量 用户可以根据不同的env配置不同的抄送和回调地址 更多...
 
void setEnv (String env)
 设置环境变量 用户可以根据不同的env配置不同的抄送和回调地址 更多...
 
Integer getSubType ()
 获取消息子类型 更多...
 
void setSubType (Integer subType)
 设置消息子类型 更多...
 
synchronized QChatMessage toQChatMessage ()
 将QChatSendMessageParam转换成QChatMessage 更多...
 

详细描述

"发送消息"接口入参

在文件 QChatSendMessageParam.java20 行定义.

构造及析构函数说明

◆ QChatSendMessageParam()

com.netease.nimlib.sdk.qchat.param.QChatSendMessageParam.QChatSendMessageParam ( long  serverId,
long  channelId,
@NonNull MsgTypeEnum  type 
)
参数
serverId消息所属的serverId
channelId消息所属的channelId
type消息类型

在文件 QChatSendMessageParam.java123 行定义.

成员函数说明

◆ getAntiSpamOption()

QChatMessageAntiSpamOption com.netease.nimlib.sdk.qchat.param.QChatSendMessageParam.getAntiSpamOption ( )

获取消息反垃圾配置选项

返回

在文件 QChatSendMessageParam.java385 行定义.

◆ getAttach()

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

获取消息附件字符串

返回

在文件 QChatSendMessageParam.java274 行定义.

◆ getBody()

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

获取消息内容

返回

在文件 QChatSendMessageParam.java266 行定义.

◆ getChannelId()

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

获取频道id

返回

在文件 QChatSendMessageParam.java249 行定义.

◆ getEnv()

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

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

返回
环境变量

在文件 QChatSendMessageParam.java419 行定义.

◆ getExtension()

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

获取扩展字段

返回

在文件 QChatSendMessageParam.java282 行定义.

◆ getMentionedAccidList()

List< String > com.netease.nimlib.sdk.qchat.param.QChatSendMessageParam.getMentionedAccidList ( )

获取@账号列表

返回

在文件 QChatSendMessageParam.java306 行定义.

◆ getMentionedRoleIdList()

List< Long > com.netease.nimlib.sdk.qchat.param.QChatSendMessageParam.getMentionedRoleIdList ( )

设置@身份组的RoleId列表

返回

在文件 QChatSendMessageParam.java314 行定义.

◆ getPushContent()

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

获取推送文案

返回

在文件 QChatSendMessageParam.java298 行定义.

◆ getPushPayload()

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

获取推送payload

返回

在文件 QChatSendMessageParam.java290 行定义.

◆ getServerId()

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

获取服务器id

返回

在文件 QChatSendMessageParam.java240 行定义.

◆ getServerStatus()

Integer com.netease.nimlib.sdk.qchat.param.QChatSendMessageParam.getServerStatus ( )

获取消息服务器状态

返回

在文件 QChatSendMessageParam.java370 行定义.

◆ getSubType()

Integer com.netease.nimlib.sdk.qchat.param.QChatSendMessageParam.getSubType ( )

获取消息子类型

返回

在文件 QChatSendMessageParam.java437 行定义.

◆ getType()

MsgTypeEnum com.netease.nimlib.sdk.qchat.param.QChatSendMessageParam.getType ( )

获取消息类型

返回

在文件 QChatSendMessageParam.java258 行定义.

◆ getUuid()

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

获取消息uuid

返回

在文件 QChatSendMessageParam.java362 行定义.

◆ isHistoryEnable()

boolean com.netease.nimlib.sdk.qchat.param.QChatSendMessageParam.isHistoryEnable ( )

是否消息在云端存储,默认true

返回

在文件 QChatSendMessageParam.java330 行定义.

◆ isMentionedAll()

boolean com.netease.nimlib.sdk.qchat.param.QChatSendMessageParam.isMentionedAll ( )

是否@所有人

返回

在文件 QChatSendMessageParam.java322 行定义.

◆ isNeedBadge()

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

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

返回

在文件 QChatSendMessageParam.java346 行定义.

◆ isNeedPushNick()

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

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

返回

在文件 QChatSendMessageParam.java354 行定义.

◆ isPushEnable()

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

是否需要推送,默认true

返回

在文件 QChatSendMessageParam.java338 行定义.

◆ isRouteEnable()

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

是否需要抄送,默认true

返回

在文件 QChatSendMessageParam.java401 行定义.

◆ setAntiSpamOption()

void com.netease.nimlib.sdk.qchat.param.QChatSendMessageParam.setAntiSpamOption ( QChatMessageAntiSpamOption  antiSpamOption)

设置消息反垃圾配置选项

参数
antiSpamOption

在文件 QChatSendMessageParam.java393 行定义.

◆ setAttach()

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

设置消息附件,通过MsgAttachment::toJson(false)获得

参数
attach消息附件

在文件 QChatSendMessageParam.java143 行定义.

◆ setAttachment()

void com.netease.nimlib.sdk.qchat.param.QChatSendMessageParam.setAttachment ( MsgAttachment  attachment)

设置消息附件

参数
attachment消息附件类

在文件 QChatSendMessageParam.java151 行定义.

◆ setBody()

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

设置消息内容

参数
body消息内容

在文件 QChatSendMessageParam.java135 行定义.

◆ setEnv()

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

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

参数
env环境变量

在文件 QChatSendMessageParam.java429 行定义.

◆ setExtension()

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

设置扩展字段

参数
extension

在文件 QChatSendMessageParam.java159 行定义.

◆ setHistoryEnable()

void com.netease.nimlib.sdk.qchat.param.QChatSendMessageParam.setHistoryEnable ( boolean  historyEnable)

设置是否消息是否存储云端历史

参数
historyEnable

在文件 QChatSendMessageParam.java207 行定义.

◆ setMentionedAccidList()

void com.netease.nimlib.sdk.qchat.param.QChatSendMessageParam.setMentionedAccidList ( List< String >  mentionedAccidList)

设置@账号列表

参数
mentionedAccidList

在文件 QChatSendMessageParam.java183 行定义.

◆ setMentionedAll()

void com.netease.nimlib.sdk.qchat.param.QChatSendMessageParam.setMentionedAll ( boolean  mentionedAll)

设置是否@所有人

参数
mentionedAll

在文件 QChatSendMessageParam.java199 行定义.

◆ setMentionedRoleIdList()

void com.netease.nimlib.sdk.qchat.param.QChatSendMessageParam.setMentionedRoleIdList ( List< Long >  mentionedRoleIdList)

设置@身份组的RoleId列表

参数
mentionedRoleIdList

在文件 QChatSendMessageParam.java191 行定义.

◆ setNeedBadge()

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

设置是否需要消息计数

参数
needBadge

在文件 QChatSendMessageParam.java223 行定义.

◆ setNeedPushNick()

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

设置是否需要推送昵称

参数
needPushNick

在文件 QChatSendMessageParam.java231 行定义.

◆ setPushContent()

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

设置推送文案

参数
pushContent

在文件 QChatSendMessageParam.java175 行定义.

◆ setPushEnable()

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

设置是否需要推送

参数
pushEnable

在文件 QChatSendMessageParam.java215 行定义.

◆ setPushPayload()

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

设置推送payload

参数
pushPayload

在文件 QChatSendMessageParam.java167 行定义.

◆ setRouteEnable()

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

设置是否需要抄送

参数
routeEnable

在文件 QChatSendMessageParam.java409 行定义.

◆ setServerStatus()

void com.netease.nimlib.sdk.qchat.param.QChatSendMessageParam.setServerStatus ( Integer  serverStatus)

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

参数
serverStatus

在文件 QChatSendMessageParam.java377 行定义.

◆ setSubType()

void com.netease.nimlib.sdk.qchat.param.QChatSendMessageParam.setSubType ( Integer  subType)

设置消息子类型

参数
subType

在文件 QChatSendMessageParam.java445 行定义.

◆ toQChatMessage()

synchronized QChatMessage com.netease.nimlib.sdk.qchat.param.QChatSendMessageParam.toQChatMessage ( )

将QChatSendMessageParam转换成QChatMessage

返回

在文件 QChatSendMessageParam.java455 行定义.


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