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