NIMMessage

所有超级接口:

java.io.Serializable

所有已知子接口:

ChatRoomMessage, IMMessage, QChatMessage
```
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)` 设置易盾反垃圾扩展字段

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

接口 NIMMessage

方法概要

方法详细资料

getUuid

isTheSame

getFromNick

getMsgType

getSubtype

setSubtype

getStatus

setStatus

setDirect

getDirect

setContent

getContent

getTime

setFromAccount

getFromAccount

setAttachment

getAttachment

getAttachStr

getAttachStatus

setAttachStatus

getConfig

setConfig

getRemoteExtension

setRemoteExtension

getLocalExtension

setLocalExtension

getCallbackExtension

getPushContent

setPushContent

getPushPayload

setPushPayload

getMemberPushOption

setMemberPushOption

isRemoteRead

needMsgAck

setMsgAck

hasSendAck

getTeamMsgAckCount

getTeamMsgUnAckCount

getFromClientType

getNIMAntiSpamOption

setNIMAntiSpamOption

setClientAntiSpam

setForceUploadFile

isInBlackList

getServerId

setChecked

isChecked

isSessionUpdate

setSessionUpdate

getThreadOption

setThreadOption

isThread

getQuickCommentUpdateTime

isDeleted

getYidunAntiCheating

setYidunAntiCheating

getEnv

setEnv

getYidunAntiSpamExt

setYidunAntiSpamExt

getYidunAntiSpamRes