com.netease.nimlib.sdk.qchat.param

类 QChatSendMessageParam

java.lang.Object

com.netease.nimlib.sdk.qchat.param.QChatSendMessageParam

public class QChatSendMessageParam
extends java.lang.Object

"发送消息"接口入参

构造器概要

构造器

构造器和说明
QChatSendMessageParam(long serverId, long channelId, MsgTypeEnum type)

方法概要

限定符和类型	方法和说明
QChatMessageAntiSpamOption	getAntiSpamOption() 获取消息反垃圾配置选项
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.util.List<java.lang.String>	getMentionedAccidList() 获取@账号列表
java.util.List<java.lang.Long>	getMentionedRoleIdList() 设置@身份组的RoleId列表
java.lang.String	getPushContent() 获取推送文案
java.util.Map<java.lang.String,java.lang.Object>	getPushPayload() 获取推送payload
java.lang.Long	getServerId() 获取服务器id
java.lang.Integer	getServerStatus() 获取消息服务器状态
java.lang.Integer	getSubType() 获取消息子类型
MsgTypeEnum	getType() 获取消息类型
java.lang.String	getUuid() 获取消息uuid
boolean	isHistoryEnable() 是否消息在云端存储，默认true
boolean	isMentionedAll() 是否@所有人
boolean	isNeedBadge() 是否需要消息计数，默认true
boolean	isNeedPushNick() 是否需要推送昵称，默认true
boolean	isPushEnable() 是否需要推送，默认true
boolean	isRouteEnable() 是否需要抄送，默认true
void	setAntiSpamOption(QChatMessageAntiSpamOption antiSpamOption) 设置消息反垃圾配置选项
void	setAttach(java.lang.String attach) 设置消息附件，通过MsgAttachment#toJson(false)获得
void	setAttachment(MsgAttachment attachment) 设置消息附件
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	setHistoryEnable(boolean historyEnable) 设置是否消息是否存储云端历史
void	setMentionedAccidList(java.util.List<java.lang.String> mentionedAccidList) 设置@账号列表
void	setMentionedAll(boolean mentionedAll) 设置是否@所有人
void	setMentionedRoleIdList(java.util.List<java.lang.Long> mentionedRoleIdList) 设置@身份组的RoleId列表
void	setNeedBadge(boolean needBadge) 设置是否需要消息计数
void	setNeedPushNick(boolean needPushNick) 设置是否需要推送昵称
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	setServerStatus(java.lang.Integer serverStatus) 如果设置状态，状态只能设置成自定义的状态(status>= 10000)，否则提示414参数错误
void	setSubType(java.lang.Integer subType) 设置消息子类型
QChatMessage	toQChatMessage() 将QChatSendMessageParam转换成QChatMessage

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

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

构造器详细资料

QChatSendMessageParam

public QChatSendMessageParam(long serverId,
                             long channelId,
                             MsgTypeEnum type)

参数:

serverId - 消息所属的serverId

channelId - 消息所属的channelId

type - 消息类型

方法详细资料

setBody

public void setBody(java.lang.String body)

设置消息内容

参数:

body - 消息内容

setAttach

public void setAttach(java.lang.String attach)

设置消息附件，通过MsgAttachment#toJson(false)获得

参数:

attach - 消息附件

setAttachment

public void setAttachment(MsgAttachment attachment)

设置消息附件

参数:

attachment - 消息附件类

setExtension

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

设置扩展字段

参数:

extension -

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 -

setMentionedAccidList

public void setMentionedAccidList(java.util.List<java.lang.String> mentionedAccidList)

设置@账号列表

参数:

mentionedAccidList -

setMentionedRoleIdList

public void setMentionedRoleIdList(java.util.List<java.lang.Long> mentionedRoleIdList)

设置@身份组的RoleId列表

参数:

mentionedRoleIdList -

setMentionedAll

public void setMentionedAll(boolean mentionedAll)

设置是否@所有人

参数:

mentionedAll -

setHistoryEnable

public void setHistoryEnable(boolean historyEnable)

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

参数:

historyEnable -

setPushEnable

public void setPushEnable(boolean pushEnable)

设置是否需要推送

参数:

pushEnable -

setNeedBadge

public void setNeedBadge(boolean needBadge)

设置是否需要消息计数

参数:

needBadge -

setNeedPushNick

public void setNeedPushNick(boolean needPushNick)

设置是否需要推送昵称

参数:

needPushNick -

getServerId

public java.lang.Long getServerId()

获取服务器id

返回:

getChannelId

public java.lang.Long getChannelId()

获取频道id

返回:

getType

public MsgTypeEnum getType()

获取消息类型

返回:

getBody

public java.lang.String getBody()

获取消息内容

返回:

getAttach

public java.lang.String getAttach()

获取消息附件字符串

返回:

getExtension

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

获取扩展字段

返回:

getPushPayload

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

获取推送payload

返回:

getPushContent

public java.lang.String getPushContent()

获取推送文案

返回:

getMentionedAccidList

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

获取@账号列表

返回:

getMentionedRoleIdList

public java.util.List<java.lang.Long> getMentionedRoleIdList()

设置@身份组的RoleId列表

返回:

isMentionedAll

public boolean isMentionedAll()

是否@所有人

返回:

isHistoryEnable

public boolean isHistoryEnable()

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

返回:

isPushEnable

public boolean isPushEnable()

是否需要推送，默认true

返回:

isNeedBadge

public boolean isNeedBadge()

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

返回:

isNeedPushNick

public boolean isNeedPushNick()

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

返回:

getUuid

public java.lang.String getUuid()

获取消息uuid

返回:

getServerStatus

public java.lang.Integer getServerStatus()

获取消息服务器状态

返回:

setServerStatus

public void setServerStatus(java.lang.Integer serverStatus)

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

参数:

serverStatus -

getAntiSpamOption

public QChatMessageAntiSpamOption getAntiSpamOption()

获取消息反垃圾配置选项

返回:

setAntiSpamOption

public void setAntiSpamOption(QChatMessageAntiSpamOption antiSpamOption)

设置消息反垃圾配置选项

参数:

antiSpamOption -

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 - 环境变量

getSubType

public java.lang.Integer getSubType()

获取消息子类型

返回:

setSubType

public void setSubType(java.lang.Integer subType)

设置消息子类型

参数:

subType -

toQChatMessage

public QChatMessage toQChatMessage()

将QChatSendMessageParam转换成QChatMessage

返回: