IMMessage

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

ChatRoomMessage
```
public interface IMMessage
extends java.io.Serializable
```
NIM message data structure. Third-party apps must not call setting classes. The data will not be persisted after the interface call

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`MsgAttachment`	`getAttachment()` Get the attachment of a message The interface is valid inf the retuned value of `getMsgType()` is not text.
`AttachStatusEnum`	`getAttachStatus()` Get the status of a message attachment
`java.lang.String`	`getAttachStr()` Get the text of an attachment
`java.lang.String`	`getCallbackExtension()` Get the custom extension field returned by a third party callback
`CustomMessageConfig`	`getConfig()` Get the configuration of a message.
`java.lang.String`	`getContent()` Get the content of a message If the message type is `MsgTypeEnum.text`, the text is the message content.
`MsgDirectionEnum`	`getDirect()` Get the message direction: sent or received message
`java.lang.String`	`getEnv()` Get the environment variable Used to point to different types of configurations for message delivery and third-party callbacks.
`java.lang.String`	`getFromAccount()` Get the sender of a message
`int`	`getFromClientType()` Get the sender type
`java.lang.String`	`getFromNick()` Get the nickname of a sender
`java.util.Map<java.lang.String,java.lang.Object>`	`getLocalExtension()` Get the local extension field that is applied locally
`MemberPushOption`	`getMemberPushOption()` Get the push option for specified members
`MsgTypeEnum`	`getMsgType()` Get the message type.
`NIMAntiSpamOption`	`getNIMAntiSpamOption()` Get the GuardEase anti-spam configuration
`java.lang.String`	`getPushContent()` Get the custom push content
`java.util.Map<java.lang.String,java.lang.Object>`	`getPushPayload()` Get the third-party push payload
`long`	`getQuickCommentUpdateTime()` Get the most recent update time of a quick comment.
`java.util.Map<java.lang.String,java.lang.Object>`	`getRemoteExtension()` Get the extension field that will be sent to other clients.
`long`	`getServerId()` Get the server ID of a message
`java.lang.String`	`getSessionId()` Get the ID of the peer (friend account or group ID)
`SessionTypeEnum`	`getSessionType()` Get the session type
`MsgStatusEnum`	`getStatus()` Get the status of a message.
`int`	`getSubtype()` Get the subtype of a message
`int`	`getTeamMsgAckCount()` Get the read count of a group message
`int`	`getTeamMsgUnAckCount()` Get the unread count of a group message
`MsgThreadOption`	`getThreadOption()` Get the thread info
`long`	`getTime()` Get the time when the message was sent.
`java.lang.String`	`getUuid()` Get the UUID of a mesage.
`java.lang.String`	`getYidunAntiCheating()` Get the trigger words of GuardEase anti-spam
`java.lang.String`	`getYidunAntiSpamExt()` Get the extension field of GuardEase anti-spam
`java.lang.String`	`getYidunAntiSpamRes()` Get the result returned by GuardEase
`boolean`	`hasSendAck()` Check if the read receipt of a message is sent
`java.lang.Boolean`	`isChecked()` the select state of a message
`boolean`	`isDeleted()` Check if the message is recalled or deleted from the server
`boolean`	`isInBlackList()` Check if the current user is added to the blacklist by the peer by sending a message.
`boolean`	`isRemoteRead()` Check whether the message sent by the current user is read
`boolean`	`isSessionUpdate()` Specify whether to update the message in a session The parameter takes effect only if the message is saved when the user is offline.
`boolean`	`isTheSame(IMMessage message)` Check if two messages are the same using the message parameter.
`boolean`	`isThread()` Check is the message belongs to a thread.
`boolean`	`needMsgAck()` Specify message receipt for group messages.
`void`	`setAttachment(MsgAttachment attachment)` Set the attachment for a message If the attachment includes a state propertu or belongs to a custom type, developers can update the state based on the business requirements for UI display.
`void`	`setAttachStatus(AttachStatusEnum attachStatus)` Set the status of a message attachment
`void`	`setChecked(java.lang.Boolean isChecked)` Set the select state of a message
`void`	`setClientAntiSpam(boolean hit)` hit by anti-spam rules on the client and handled on the server.
`void`	`setConfig(CustomMessageConfig config)` Set the message configuration
`void`	`setContent(java.lang.String content)` Set the content of a message.
`void`	`setDirect(MsgDirectionEnum direct)` Set the message direction
`void`	`setEnv(java.lang.String env)` Set the environment variable Used to point to different types of configurations for message delivery and third-party callbacks.
`void`	`setForceUploadFile(boolean forceUpload)` If the same file already exists on the server, specify whether to upload the file forcibly.
`void`	`setFromAccount(java.lang.String account)` Set the peer account Edit the `getDirect()` based on the peer account
`void`	`setLocalExtension(java.util.Map<java.lang.String,java.lang.Object> localExtension)` Set a local extension field that is applied locally and is not sent to other clients.
`void`	`setMemberPushOption(MemberPushOption pushOption)` Set the push option for specified members
`void`	`setMsgAck()` Set read receipt for a message
`void`	`setNIMAntiSpamOption(NIMAntiSpamOption nimAntiSpamOption)` Set the GuardEase anti-spam configuration
`void`	`setPushContent(java.lang.String pushContent)` Set custom push content.
`void`	`setPushPayload(java.util.Map<java.lang.String,java.lang.Object> pushPayload)` Set the third-party push payload
`void`	`setRemoteExtension(java.util.Map<java.lang.String,java.lang.Object> remoteExtension)` Set an extension field that will be sent to other clients.
`void`	`setSessionUpdate(boolean sessionUpdate)` Update messages in a session.
`void`	`setStatus(MsgStatusEnum status)` Set the message status
`void`	`setSubtype(int subtype)` Set the message subtype
`void`	`setThreadOption(IMMessage parent)` Set the thread info using the parent message.
`void`	`setYidunAntiCheating(java.lang.String yidunAntiCheating)` Set anti-spam trigger words in JSON format
`void`	`setYidunAntiSpamExt(java.lang.String yidunAntiSpamExt)` Set an extension field for GuardEase anti-spam

- Method Detail
  - getUuid
```
java.lang.String getUuid()
```
    Get the UUID of a mesage. The field is automatically filled when a message is created.
    
    Returns:
    
    uuid of a message
  - isTheSame
```
boolean isTheSame(IMMessage message)
```
    Check if two messages are the same using the message parameter.
    Check the ID in the database first. If no ID is queried, compare getUuid()
    
    Parameters:
    
    message - Message object
    
    Returns:
    
    the result
  - getSessionId
```
java.lang.String getSessionId()
```
    Get the ID of the peer (friend account or group ID)
    
    Returns:
    
    session ID
  - getSessionType
```
SessionTypeEnum getSessionType()
```
    Get the session type
    
    Returns:
    
    session type
  - getFromNick
```
java.lang.String getFromNick()
```
    Get the nickname of a sender
    
    Returns:
    
    nickname
  - getMsgType
```
MsgTypeEnum getMsgType()
```
    Get the message type.
    
    Returns:
    
    message tyoe
  - getSubtype
```
int getSubtype()
```
    Get the subtype of a message
    
    Returns:
    
    subtype. If the value is less than or equal to 0, no subtype is available.
  - setSubtype
```
void setSubtype(int subtype)
```
    Set the message subtype
    
    Parameters:
    
    subtype. - The subtype of a message. If the value is less than or equal to 0, no subtype is available.
  - getStatus
```
MsgStatusEnum getStatus()
```
    Get the status of a message.
    
    Returns:
    
    message status
  - setStatus
```
void setStatus(MsgStatusEnum status)
```
    Set the message status
    
    Parameters:
    
    status - message status
  - setDirect
```
void setDirect(MsgDirectionEnum direct)
```
    Set the message direction
    
    Parameters:
    
    direct - message direction
  - getDirect
```
MsgDirectionEnum getDirect()
```
    Get the message direction: sent or received message
    
    Returns:
    
    message direction
  - setContent
```
void setContent(java.lang.String content)
```
    Set the content of a message.
    If the message type is MsgTypeEnum.text, the text is the message content. If the message belongs to other types, the text is optional. If a text is set, it will be the push text delivered by APNS push for iOS devices and Android built-in push service for Android devices.
    
    Parameters:
    
    content - Message content or push text
  - getContent
```
java.lang.String getContent()
```
    Get the content of a message
    If the message type is MsgTypeEnum.text, the text is the message content. If the message belongs to other types, the text is optional. If a text is set, it will be the push text delivered by APNS push for iOS devices and Android built-in push service for Android devices (pushContent is recommended for v1.7.0 or later).
    
    Returns:
    
    the message content or push text
  - getTime
```
long getTime()
```
    Get the time when the message was sent. Unit: milliseconds
    
    Returns:
    
    time
  - setFromAccount
```
void setFromAccount(java.lang.String account)
```
    Set the peer account Edit the getDirect() based on the peer account
    
    Parameters:
    
    account - Peer account
  - getFromAccount
```
java.lang.String getFromAccount()
```
    Get the sender of a message
  - setAttachment
```
void setAttachment(MsgAttachment attachment)
```
    Set the attachment for a message
    If the attachment includes a state propertu or belongs to a custom type, developers can update the state based on the business requirements for UI display.
    Note: if the attachment need to be persisted to a database, call MsgService.updateIMMessageStatus(com.netease.nimlib.sdk.msg.model.IMMessage).
    
    Parameters:
    
    attachment -
  - getAttachment
```
MsgAttachment getAttachment()
```
    Get the attachment of a message The interface is valid inf the retuned value of getMsgType() is not text.
  - getAttachStr
```
java.lang.String getAttachStr()
```
    Get the text of an attachment
    
    Returns:
  - getAttachStatus
```
AttachStatusEnum getAttachStatus()
```
    Get the status of a message attachment
  - setAttachStatus
```
void setAttachStatus(AttachStatusEnum attachStatus)
```
    Set the status of a message attachment
  - getConfig
```
CustomMessageConfig getConfig()
```
    Get the configuration of a message.
    
    Returns:
    
    message configuration
  - setConfig
```
void setConfig(CustomMessageConfig config)
```
    Set the message configuration
    
    Parameters:
    
    config - message configuration
  - getRemoteExtension
```
java.util.Map<java.lang.String,java.lang.Object> getRemoteExtension()
```
    Get the extension field that will be sent to other clients.
    
    Returns:
    
    extension field Map
  - setRemoteExtension
```
void setRemoteExtension(java.util.Map<java.lang.String,java.lang.Object> remoteExtension)
```
    Set an extension field that will be sent to other clients. The field can contain up to 1024 characters.
    
    Parameters:
    
    remoteExtension - extension field Map. Make sure the Map object can be converted to JsonObject.
  - getLocalExtension
```
java.util.Map<java.lang.String,java.lang.Object> getLocalExtension()
```
    Get the local extension field that is applied locally
    
    Returns:
    
    extension field Map
  - setLocalExtension
```
void setLocalExtension(java.util.Map<java.lang.String,java.lang.Object> localExtension)
```
    Set a local extension field that is applied locally and is not sent to other clients. The field can contain up to 1024 characters.
    
    Parameters:
    
    localExtension -
  - getCallbackExtension
```
java.lang.String getCallbackExtension()
```
    Get the custom extension field returned by a third party callback
    
    Returns:
    
    custom extension field
  - getPushContent
```
java.lang.String getPushContent()
```
    Get the custom push content
    
    Returns:
    
    custom push content
  - setPushContent
```
void setPushContent(java.lang.String pushContent)
```
    Set custom push content. The field is recommended for v1.7.0 or later. Do not use setContent to set the custom push content. The field can contain 500 characheter.
    
    Parameters:
    
    pushContent - Cutom push content
  - getPushPayload
```
java.util.Map<java.lang.String,java.lang.Object> getPushPayload()
```
    Get the third-party push payload
    
    Returns:
    
    the third-party push payload
  - setPushPayload
```
void setPushPayload(java.util.Map<java.lang.String,java.lang.Object> pushPayload)
```
    Set the third-party push payload
    
    Parameters:
    
    pushPayload - Third party custom push payload. Make sure the payload can be converted into JsonObject. The maximum size of the content is 2048 bytes.
  - getMemberPushOption
```
MemberPushOption getMemberPushOption()
```
    Get the push option for specified members
    
    Returns:
    
    Push option for specified members
  - setMemberPushOption
```
void setMemberPushOption(MemberPushOption pushOption)
```
    Set the push option for specified members
    
    Parameters:
    
    pushOption - the push option for specified members
  - isRemoteRead
```
boolean isRemoteRead()
```
    Check whether the message sent by the current user is read
    
    Returns:
    
    true: read; false: unread
  - needMsgAck
```
boolean needMsgAck()
```
    Specify message receipt for group messages.
    
    Returns:
    
    read receipt
  - setMsgAck
```
void setMsgAck()
```
    Set read receipt for a message
  - hasSendAck
```
boolean hasSendAck()
```
    Check if the read receipt of a message is sent
    
    Returns:
    
    the result
  - getTeamMsgAckCount
```
int getTeamMsgAckCount()
```
    Get the read count of a group message
    
    Returns:
    
    read count of a group message
  - getTeamMsgUnAckCount
```
int getTeamMsgUnAckCount()
```
    Get the unread count of a group message
    
    Returns:
    
    the unread count of a group message
  - getFromClientType
```
int getFromClientType()
```
    Get the sender type
    
    Returns:
    
    Client type of a sender
  - getNIMAntiSpamOption
```
NIMAntiSpamOption getNIMAntiSpamOption()
```
    Get the GuardEase anti-spam configuration
    
    Returns:
    
    NIMAntiSpamOption
  - setNIMAntiSpamOption
```
void setNIMAntiSpamOption(NIMAntiSpamOption nimAntiSpamOption)
```
    Set the GuardEase anti-spam configuration
    
    Parameters:
    
    nimAntiSpamOption -
  - setClientAntiSpam
```
void setClientAntiSpam(boolean hit)
```
    hit by anti-spam rules on the client and handled on the server.
    
    Parameters:
    
    hit -
  - setForceUploadFile
```
void setForceUploadFile(boolean forceUpload)
```
    If the same file already exists on the server, specify whether to upload the file forcibly. The default value is false.
    
    Parameters:
    
    forceUpload -
  - isInBlackList
```
boolean isInBlackList()
```
    Check if the current user is added to the blacklist by the peer by sending a message. The message is delivered.
    
    Returns:
  - getServerId
```
long getServerId()
```
    Get the server ID of a message
    
    Returns:
    
    id
  - setChecked
```
void setChecked(java.lang.Boolean isChecked)
```
    Set the select state of a message
    
    Parameters:
    
    isChecked - true: selected; false: unselected; null: Not in multi-select state
  - isChecked
```
java.lang.Boolean isChecked()
```
    the select state of a message
    
    Returns:
    
    true: selected; false: unselected; null: Not in multi-select state
  - isSessionUpdate
```
boolean isSessionUpdate()
```
    Specify whether to update the message in a session The parameter takes effect only if the message is saved when the user is offline. The default value is true
    
    Returns:
    
    true: Yes; false: No
  - setSessionUpdate
```
void setSessionUpdate(boolean sessionUpdate)
```
    Update messages in a session. The parameter takes effect only if the message is saved when the user is offline.
  - getThreadOption
```
MsgThreadOption getThreadOption()
```
    Get the thread info
    
    Returns:
    
    the thread info
  - setThreadOption
```
void setThreadOption(IMMessage parent)
```
    Set the thread info using the parent message.
    
    Parameters:
    
    parent - The parent message of the current message to which the reply is sent.
  - isThread
```
boolean isThread()
```
    Check is the message belongs to a thread.
  - getQuickCommentUpdateTime
```
long getQuickCommentUpdateTime()
```
    Get the most recent update time of a quick comment.
    
    Returns:
    
    The most recent update time of a quick comment
  - isDeleted
```
boolean isDeleted()
```
    Check if the message is recalled or deleted from the server
    
    Returns:
    
    the result
  - getYidunAntiCheating
```
java.lang.String getYidunAntiCheating()
```
    Get the trigger words of GuardEase anti-spam
    
    Returns:
    
    Anti-spam trigger words
  - setYidunAntiCheating
```
void setYidunAntiCheating(java.lang.String yidunAntiCheating)
```
    Set anti-spam trigger words in JSON format
    
    Parameters:
    
    yidunAntiCheating - anti-spam trigger words in JSON format
  - getEnv
```
java.lang.String getEnv()
```
    Get the environment variable Used to point to different types of configurations for message delivery and third-party callbacks. Note: the words will not stored in the database.
    
    Returns:
    
    environment variable
  - setEnv
```
void setEnv(java.lang.String env)
```
    Set the environment variable Used to point to different types of configurations for message delivery and third-party callbacks. Note: the words will not stored in the database.
    
    Parameters:
    
    env - Environment variable
  - getYidunAntiSpamExt
```
java.lang.String getYidunAntiSpamExt()
```
    Get the extension field of GuardEase anti-spam
    
    Returns:
    
    extension field of GuardEase anti-spam
  - setYidunAntiSpamExt
```
void setYidunAntiSpamExt(java.lang.String yidunAntiSpamExt)
```
    Set an extension field for GuardEase anti-spam
    
    Parameters:
    
    yidunAntiSpamExt - extension field for GuardEase anti-spam in JSON.
  - getYidunAntiSpamRes
```
java.lang.String getYidunAntiSpamRes()
```
    Get the result returned by GuardEase
    
    Returns:
    
    result returned by GuardEase

Interface IMMessage

Method Summary

Method Detail

getUuid

isTheSame

getSessionId

getSessionType

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