com.netease.nimlib.sdk.msg.model.NIMMessage接口 参考

类 com.netease.nimlib.sdk.msg.model.NIMMessage 继承关系图:

Public 成员函数
String	getUuid ()
	获取消息的uuid, 该域在生成消息时即会填上 更多...
boolean	isTheSame (NIMMessage message)
	判断与参数message是否是同一条消息。 先比较数据库记录ID，如果没有数据库记录ID，则比较getUuid() 更多...
String	getFromNick ()
	获取消息发送者的昵称 更多...
MsgTypeEnum	getMsgType ()
	获取消息类型。 更多...
int	getSubtype ()
	获取消息的子类型 更多...
void	setSubtype (int subtype)
	设置消息的子类型。 更多...
MsgStatusEnum	getStatus ()
	获取消息接收/发送状态。 更多...
void	setStatus (MsgStatusEnum status)
	设置消息状态 更多...
void	setDirect (MsgDirectionEnum direct)
	设置消息方向 更多...
MsgDirectionEnum	getDirect ()
	获取消息方向：发出去的消息还是接收到的消息 更多...
void	setContent (String content)
	设置消息具体内容。 当消息类型com.netease.nimlib.sdk.msg.constant.MsgTypeEnum#text时，该域为消息内容。 当为其他消息类型时，该域为可选项，如果设置，将作为iOS的apns推送文本以及android内置消息推送的显示文本。 更多...
String	getContent ()
	获取消息具体内容。 当消息类型com.netease.nimlib.sdk.msg.constant.MsgTypeEnum#text时，该域为消息内容。 当为其他消息类型时，该域为可选项，如果设置，将作为iOS的apns推送文本以及android内置消息推送的显示文本（1.7.0及以上版本建议使用pushContent）。 更多...
long	getTime ()
	获取消息时间，单位为ms 更多...
void	setFromAccount (String account)
	设置说话方的帐号。消息方向getDirect()根据改之 更多...
String	getFromAccount ()
	获取该条消息发送方的帐号 更多...
void	setAttachment (MsgAttachment attachment)
	设置消息附件对象。 如果附件内部包含状态，或是自定义附件类型，用户可自主更新，以便界面展现。 注意：设置之后，如需持久化到数据库，需要调用com.netease.nimlib.sdk.msg.MsgService#updateIMMessageStatus更新 更多...
MsgAttachment	getAttachment ()
	获取消息附件对象。仅当getMsgType()返回为非text时有效 更多...
String	getAttachStr ()
	获取消息附件文本内容 更多...
AttachStatusEnum	getAttachStatus ()
	获取消息附件接收/发送状态 更多...
void	setAttachStatus (AttachStatusEnum attachStatus)
	设置消息附件状态 更多...
CustomMessageConfig	getConfig ()
	获取消息配置 更多...
void	setConfig (CustomMessageConfig config)
	设置消息配置 更多...
Map< String, Object >	getRemoteExtension ()
	获取扩展字段（该字段会发送到其他端） 更多...
void	setRemoteExtension (Map< String, Object > remoteExtension)
	设置扩展字段（该字段会发送到其他端），最大长度1024字节。 更多...
Map< String, Object >	getLocalExtension ()
	获取本地扩展字段（仅本地有效） 更多...
void	setLocalExtension (Map< String, Object > localExtension)
	设置本地扩展字段（该字段仅在本地使用有效，不会发送给其他端），最大长度1024字节 更多...
String	getCallbackExtension ()
	获取第三方回调回来的自定义扩展字段 更多...
String	getPushContent ()
	获取自定义推送文案 更多...
void	setPushContent (String pushContent)
	设置自定义推送文案（1.7.0及以上版本建议使用此字段，不要使用setContent来设置推送文案），目前长度限制为500字以内 更多...
Map< String, Object >	getPushPayload ()
	获取第三方自定义的推送属性 更多...
void	setPushPayload (Map< String, Object > pushPayload)
	设置第三方自定义的推送属性 更多...
MemberPushOption	getMemberPushOption ()
	获取指定成员推送选项 更多...
void	setMemberPushOption (MemberPushOption pushOption)
	设置指定成员推送选项 更多...
boolean	isRemoteRead ()
	判断自己发送的消息对方是否已读 更多...
boolean	needMsgAck ()
	是否需要消息已读（主要针对群消息） 更多...
void	setMsgAck ()
	设置该消息为需要消息已读的 更多...
boolean	hasSendAck ()
	是否已经发送过群消息已读回执 更多...
int	getTeamMsgAckCount ()
	返回群消息已读回执的已读数 更多...
int	getTeamMsgUnAckCount ()
	返回群消息已读回执的未读数 更多...
int	getFromClientType ()
	获取消息发送方类型 更多...
NIMAntiSpamOption	getNIMAntiSpamOption ()
	获取易盾反垃圾配置项 更多...
void	setNIMAntiSpamOption (NIMAntiSpamOption nimAntiSpamOption)
	设置易盾反垃圾选项 更多...
void	setClientAntiSpam (boolean hit)
	命中了客户端反垃圾，服务器处理 更多...
void	setForceUploadFile (boolean forceUpload)
	如果服务器存在相同的附件文件，是否强制重新上传文件 ，默认false 更多...
boolean	isInBlackList ()
	发送消息给对方， 是不是被对方拉黑了（消息本身是发送成功的） 更多...
long	getServerId ()
	获取服务端消息id 更多...
void	setChecked (Boolean isChecked)
	设置消息的选中状态 更多...
Boolean	isChecked ()
	消息的选中状态 更多...
boolean	isSessionUpdate ()
	消息是否需要刷新到session服务 只有消息存离线的情况下，才会判断该参数，默认：是 更多...
void	setSessionUpdate (boolean sessionUpdate)
	设置消息是否需要刷新到session服务 只有消息存离线的情况下，才会判断该参数 更多...
MsgThreadOption	getThreadOption ()
	获取消息的thread信息 更多...
void	setThreadOption (NIMMessage parent)
	通过此消息的父消息设置消息的thread信息 更多...
boolean	isThread ()
	此消息是不是一条thread消息 更多...
long	getQuickCommentUpdateTime ()
	获取快捷评论的最后更新时间 更多...
boolean	isDeleted ()
	该消息是否已经被从服务端撤回或删除 更多...
MessageKey	getMessageKey ()
	获取消息的关键信息 更多...
String	getYidunAntiCheating ()
	获取易盾反垃圾字段 更多...
void	setYidunAntiCheating (String yidunAntiCheating)
	设置易盾反垃圾字段，要求是Json格式 更多...
String	getEnv ()
	获取环境变量 用于指向不同的抄送，第三方回调等配置 注意：数据库不会保存此字段 更多...
void	setEnv (String env)
	设置环境变量 用于指向不同的抄送，第三方回调等配置 注意：数据库不会保存此字段 更多...
String	getYidunAntiSpamExt ()
	获取易盾反垃圾扩展字段 更多...
void	setYidunAntiSpamExt (String yidunAntiSpamExt)
	设置易盾反垃圾扩展字段 更多...
String	getYidunAntiSpamRes ()
	获取易盾反垃圾返回的结果 更多...

详细描述

在文件 NIMMessage.java 第 12 行定义.

成员函数说明

MsgAttachment com.netease.nimlib.sdk.msg.model.NIMMessage.getAttachment

(

)

获取消息附件对象。仅当getMsgType()返回为非text时有效

AttachStatusEnum com.netease.nimlib.sdk.msg.model.NIMMessage.getAttachStatus

(

)

获取消息附件接收/发送状态

String com.netease.nimlib.sdk.msg.model.NIMMessage.getAttachStr

(

)

获取消息附件文本内容

返回

String com.netease.nimlib.sdk.msg.model.NIMMessage.getCallbackExtension

(

)

获取第三方回调回来的自定义扩展字段

返回

第三方回调回来的自定义扩展字段

CustomMessageConfig com.netease.nimlib.sdk.msg.model.NIMMessage.getConfig

(

)

获取消息配置

返回

消息配置

String com.netease.nimlib.sdk.msg.model.NIMMessage.getContent

(

)

获取消息具体内容。
当消息类型com.netease.nimlib.sdk.msg.constant.MsgTypeEnum#text时，该域为消息内容。 当为其他消息类型时，该域为可选项，如果设置，将作为iOS的apns推送文本以及android内置消息推送的显示文本（1.7.0及以上版本建议使用pushContent）。

返回

消息内容/推送文本

MsgDirectionEnum com.netease.nimlib.sdk.msg.model.NIMMessage.getDirect

(

)

获取消息方向：发出去的消息还是接收到的消息

返回

消息方向

String com.netease.nimlib.sdk.msg.model.NIMMessage.getEnv

(

)

获取环境变量 用于指向不同的抄送，第三方回调等配置 注意：数据库不会保存此字段

返回

环境变量

String com.netease.nimlib.sdk.msg.model.NIMMessage.getFromAccount

(

)

获取该条消息发送方的帐号

int com.netease.nimlib.sdk.msg.model.NIMMessage.getFromClientType

(

)

获取消息发送方类型

返回

发送方的客户端类型，与ClientType类比较

String com.netease.nimlib.sdk.msg.model.NIMMessage.getFromNick

(

)

获取消息发送者的昵称

返回

用户的昵称

Map<String, Object> com.netease.nimlib.sdk.msg.model.NIMMessage.getLocalExtension

(

)

获取本地扩展字段（仅本地有效）

返回

扩展字段Map

MemberPushOption com.netease.nimlib.sdk.msg.model.NIMMessage.getMemberPushOption

(

)

获取指定成员推送选项

返回

指定成员推送选项

MessageKey com.netease.nimlib.sdk.msg.model.NIMMessage.getMessageKey

(

)

获取消息的关键信息

返回

消息的关键信息

MsgTypeEnum com.netease.nimlib.sdk.msg.model.NIMMessage.getMsgType

(

)

获取消息类型。

返回

消息类型

NIMAntiSpamOption com.netease.nimlib.sdk.msg.model.NIMMessage.getNIMAntiSpamOption

(

)

获取易盾反垃圾配置项

返回

NIMAntiSpamOption

String com.netease.nimlib.sdk.msg.model.NIMMessage.getPushContent

(

)

获取自定义推送文案

返回

自定义推送文案

Map<String, Object> com.netease.nimlib.sdk.msg.model.NIMMessage.getPushPayload

(

)

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

返回

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

long com.netease.nimlib.sdk.msg.model.NIMMessage.getQuickCommentUpdateTime

(

)

获取快捷评论的最后更新时间

返回

快捷评论最后更新时间

Map<String, Object> com.netease.nimlib.sdk.msg.model.NIMMessage.getRemoteExtension

(

)

获取扩展字段（该字段会发送到其他端）

返回

扩展字段Map

long com.netease.nimlib.sdk.msg.model.NIMMessage.getServerId

(

)

获取服务端消息id

返回

id

MsgStatusEnum com.netease.nimlib.sdk.msg.model.NIMMessage.getStatus

(

)

获取消息接收/发送状态。

返回

消息状态

int com.netease.nimlib.sdk.msg.model.NIMMessage.getSubtype

(

)

获取消息的子类型

返回

子类型，小于等于0表示没有子类型

int com.netease.nimlib.sdk.msg.model.NIMMessage.getTeamMsgAckCount

(

)

返回群消息已读回执的已读数

返回

群里多少人已读了该消息

int com.netease.nimlib.sdk.msg.model.NIMMessage.getTeamMsgUnAckCount

(

)

返回群消息已读回执的未读数

返回

群里多少人还未读该消息

MsgThreadOption com.netease.nimlib.sdk.msg.model.NIMMessage.getThreadOption

(

)

获取消息的thread信息

返回

消息的thread信息

long com.netease.nimlib.sdk.msg.model.NIMMessage.getTime

(

)

获取消息时间，单位为ms

返回

时间

String com.netease.nimlib.sdk.msg.model.NIMMessage.getUuid

(

)

获取消息的uuid, 该域在生成消息时即会填上

返回

消息uuid

String com.netease.nimlib.sdk.msg.model.NIMMessage.getYidunAntiCheating

(

)

获取易盾反垃圾字段

返回

反垃圾字段

String com.netease.nimlib.sdk.msg.model.NIMMessage.getYidunAntiSpamExt

(

)

获取易盾反垃圾扩展字段

返回

易盾反垃圾扩展字段

String com.netease.nimlib.sdk.msg.model.NIMMessage.getYidunAntiSpamRes

(

)

获取易盾反垃圾返回的结果

返回

易盾反垃圾返回的结果

boolean com.netease.nimlib.sdk.msg.model.NIMMessage.hasSendAck

(

)

是否已经发送过群消息已读回执

返回

是否已经发送过已读回执

Boolean com.netease.nimlib.sdk.msg.model.NIMMessage.isChecked

(

)

消息的选中状态

返回

true:被选中状态; false: 未被选中状态; null: 不在多选状态

boolean com.netease.nimlib.sdk.msg.model.NIMMessage.isDeleted

(

)

该消息是否已经被从服务端撤回或删除

返回

是否已经被撤回或删除

boolean com.netease.nimlib.sdk.msg.model.NIMMessage.isInBlackList

(

)

发送消息给对方， 是不是被对方拉黑了（消息本身是发送成功的）

返回

boolean com.netease.nimlib.sdk.msg.model.NIMMessage.isRemoteRead

(

)

判断自己发送的消息对方是否已读

返回

true：对方已读；false：对方未读

boolean com.netease.nimlib.sdk.msg.model.NIMMessage.isSessionUpdate

(

)

消息是否需要刷新到session服务 只有消息存离线的情况下，才会判断该参数，默认：是

返回

true: 是; false: 否

boolean com.netease.nimlib.sdk.msg.model.NIMMessage.isTheSame

(

NIMMessage

message

)

判断与参数message是否是同一条消息。
先比较数据库记录ID，如果没有数据库记录ID，则比较getUuid()

参数

message

消息对象

返回

两条消息是否相同

boolean com.netease.nimlib.sdk.msg.model.NIMMessage.isThread

(

)

此消息是不是一条thread消息

boolean com.netease.nimlib.sdk.msg.model.NIMMessage.needMsgAck

(

)

是否需要消息已读（主要针对群消息）

返回

该消息是否需要发送已读确认

void com.netease.nimlib.sdk.msg.model.NIMMessage.setAttachment

(

MsgAttachment

attachment

)

设置消息附件对象。
如果附件内部包含状态，或是自定义附件类型，用户可自主更新，以便界面展现。
注意：设置之后，如需持久化到数据库，需要调用com.netease.nimlib.sdk.msg.MsgService#updateIMMessageStatus更新

参数

attachment

void com.netease.nimlib.sdk.msg.model.NIMMessage.setAttachStatus

(

AttachStatusEnum

attachStatus

)

设置消息附件状态

void com.netease.nimlib.sdk.msg.model.NIMMessage.setChecked

(

Boolean

isChecked

)

设置消息的选中状态

参数

isChecked

true:被选中状态; false: 未被选中状态; null: 不在多选状态

void com.netease.nimlib.sdk.msg.model.NIMMessage.setClientAntiSpam

(

boolean

hit

)

命中了客户端反垃圾，服务器处理

参数

hit

void com.netease.nimlib.sdk.msg.model.NIMMessage.setConfig

(

CustomMessageConfig

config

)

设置消息配置

参数

config

消息配置

void com.netease.nimlib.sdk.msg.model.NIMMessage.setContent

(

String

content

)

设置消息具体内容。
当消息类型com.netease.nimlib.sdk.msg.constant.MsgTypeEnum#text时，该域为消息内容。 当为其他消息类型时，该域为可选项，如果设置，将作为iOS的apns推送文本以及android内置消息推送的显示文本。

参数

content

消息内容/推送文本

void com.netease.nimlib.sdk.msg.model.NIMMessage.setDirect

(

MsgDirectionEnum

direct

)

设置消息方向

参数

direct

消息方向

void com.netease.nimlib.sdk.msg.model.NIMMessage.setEnv

(

String

env

)

设置环境变量 用于指向不同的抄送，第三方回调等配置 注意：数据库不会保存此字段

参数

env

环境变量

void com.netease.nimlib.sdk.msg.model.NIMMessage.setForceUploadFile

(

boolean

forceUpload

)

如果服务器存在相同的附件文件，是否强制重新上传文件 ，默认false

参数

forceUpload

void com.netease.nimlib.sdk.msg.model.NIMMessage.setFromAccount

(

String

account

)

设置说话方的帐号。消息方向getDirect()根据改之

参数

account

帐号

void com.netease.nimlib.sdk.msg.model.NIMMessage.setLocalExtension

(

Map< String, Object >

localExtension

)

设置本地扩展字段（该字段仅在本地使用有效，不会发送给其他端），最大长度1024字节

参数

localExtension

void com.netease.nimlib.sdk.msg.model.NIMMessage.setMemberPushOption

(

MemberPushOption

pushOption

)

设置指定成员推送选项

参数

pushOption

指定成员推送选项

void com.netease.nimlib.sdk.msg.model.NIMMessage.setMsgAck

(

)

设置该消息为需要消息已读的

void com.netease.nimlib.sdk.msg.model.NIMMessage.setNIMAntiSpamOption

(

NIMAntiSpamOption

nimAntiSpamOption

)

设置易盾反垃圾选项

参数

nimAntiSpamOption

void com.netease.nimlib.sdk.msg.model.NIMMessage.setPushContent

(

String

pushContent

)

设置自定义推送文案（1.7.0及以上版本建议使用此字段，不要使用setContent来设置推送文案），目前长度限制为500字以内

参数

pushContent

自定义推送文案

void com.netease.nimlib.sdk.msg.model.NIMMessage.setPushPayload

(

Map< String, Object >

pushPayload

)

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

参数

pushPayload

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

void com.netease.nimlib.sdk.msg.model.NIMMessage.setRemoteExtension

(

Map< String, Object >

remoteExtension

)

设置扩展字段（该字段会发送到其他端），最大长度1024字节。

参数

remoteExtension

扩展字段Map，开发者需要保证此Map能够转换为JsonObject

void com.netease.nimlib.sdk.msg.model.NIMMessage.setSessionUpdate

(

boolean

sessionUpdate

)

设置消息是否需要刷新到session服务 只有消息存离线的情况下，才会判断该参数

void com.netease.nimlib.sdk.msg.model.NIMMessage.setStatus

(

MsgStatusEnum

status

)

设置消息状态

参数

status

消息状态

void com.netease.nimlib.sdk.msg.model.NIMMessage.setSubtype

(

int

subtype

)

设置消息的子类型。

参数

subtype

子类型，小于等于0表示没有子类型

void com.netease.nimlib.sdk.msg.model.NIMMessage.setThreadOption

(

NIMMessage

parent

)

通过此消息的父消息设置消息的thread信息

参数

parent

当前消息的父消息，即当前消息的回复对象

void com.netease.nimlib.sdk.msg.model.NIMMessage.setYidunAntiCheating

(

String

yidunAntiCheating

)

设置易盾反垃圾字段，要求是Json格式

参数

yidunAntiCheating

反垃圾字段，要求是Json格式

void com.netease.nimlib.sdk.msg.model.NIMMessage.setYidunAntiSpamExt

(

String

yidunAntiSpamExt

)

设置易盾反垃圾扩展字段

参数

yidunAntiSpamExt

易盾反垃圾扩展字段，限制json

---

该接口的文档由以下文件生成:

• basesdk/src/com/netease/nimlib/sdk/msg/model/NIMMessage.java