TIMMessage

java.lang.Object
- com.tencent.imsdk.TIMMessage

```
public class TIMMessage
extends java.lang.Object
```
TIMMessage 由多个消息元素（TIMElem）组成，每个 TIMElem 可以是文本和图片，也就是说每一条消息可包含多个文本和多张图片。详情请参考官网文档 [消息收发](https://cloud.tencent.com/document/product/269/9232)

构造器概要

构造器
构造器和说明

TIMMessage()

构造器
构造器和说明
`TIMMessage()`

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`int`	`addElement(TIMElem elem)` 增加消息元素
`boolean`	`checkEquals(TIMMessageLocator locator)` 是否为 locator 对应的消息
`boolean`	`convertToImportedMsg()` 将消息导入到本地只有调用这个接口，才能去修改消息的时间戳和发送方
`boolean`	`copyFrom(TIMMessage srcMsg)` 复制消息内容到当前消息（Elem, priority, online, offlinePushInfo等）
`TIMConversation`	`getConversation()` 获取会话
`int`	`getCustomInt()` 获取自定义整数
`java.lang.String`	`getCustomStr()` 获取自定义数据内容的值
`TIMElem`	`getElement(int i)` 获取对应索引的 Elem
`int`	`getElementCount()` 获取 Elem 数量
`java.util.List<java.lang.String>`	`getGroupAtUserList()`
`TIMMessageLocator`	`getMessageLocator()` 消息定位符如果是自己创建的 TIMMessage，需要等到消息发送成功后才能获取到 TIMMessageLocator 里面的具体信息
`java.lang.String`	`getMsgId()` 消息 ID 当消息生成时就已经固定，全局唯一，会贯穿整个发送以及接收过程。
`long`	`getMsgUniqueId()` 消息 uniqueId 对于发送成功的消息或者从服务器接收到的消息，uniqueId 能保证全局唯一，需要在同一个会话内判断。
`TIMMessageOfflinePushSettings`	`getOfflinePushSettings()` 获取消息离线推送配置
`TIMMessagePriority`	`getPriority()` 获取消息的优先级（仅对群组消息有效）
`long`	`getRand()` 获取当前消息的随机码
`TIMGroupReceiveMessageOpt`	`getRecvFlag()` 已过时。
`java.lang.String`	`getSender()` 获取消息的发送方
`java.lang.String`	`getSenderFaceUrl()` 获取消息的发送方头像 url 注意：在 C2C 场景下，陌生人的头像不会更新，建议在 UI 上点击陌生人信息的时候主动调用 TIMFriendshipManager -> getUsersProfile（forceUpdate 设置为 YES）去拉取资料，拉取成功后，SDK 会更新本地头像，下次 getSenderFaceURL 会拿到更新后的头像，注意请不要在收到每条消息都去 getUsersProfile，会严重影响程序性能。
`TIMGroupMemberInfo`	`getSenderGroupMemberProfile()` 获取发送者群内资料目前仅能获取字段：member，nameCard，其他的字段获取建议通过其他的字段获取建议通过`TIMGroupManager.getGroupMembers(String, TIMValueCallBack)` 获取
`java.lang.String`	`getSenderNickname()` 获取消息的发送方昵称
`void`	`getSenderProfile(TIMValueCallBack<TIMUserProfile> callBack)` 获取发送者资料如果本地有发送者资料，会在 callBack 回调里面立即同步返回发送者资料，如果本地没有发送者资料，SDK 内部会向服务器拉取发送者资料，并在 callBack 回调里面返回发送者资料。
`long`	`getSeq()` 获取当前消息的序列号
`boolean`	`isPeerReaded()` 对方是否已读（仅 C2C 消息有效）
`boolean`	`isRead()` 自己是否已读
`boolean`	`isSelf()` 是否为发送方
`boolean`	`remove()` 已过时。
`void`	`setCustomInt(int value)` 设置自定义整数，默认为0（此属性仅本地使用） 1.此自定义字段仅存储于本地，不会同步到 Server，用户卸载应用或则更换终端后无法获取。
`void`	`setCustomStr(java.lang.String str)` 设置自定义数据内容，默认为""（此属性仅本地使用）此自定义字段仅存储于本地，不会同步到 Server，用户卸载应用或则更换终端后无法获取。
`boolean`	`setGroupAtUserList(java.util.List<java.lang.String> userList)` 设置消息 @ 用户列表
`void`	`setOfflinePushSettings(TIMMessageOfflinePushSettings settings)` 设置消息离线推送配置
`void`	`setPriority(TIMMessagePriority priority)` 设置消息的优先级（仅对群组消息有效）对于直播场景，会有点赞和发红包功能，点赞相对优先级较低，红包消息优先级较高，具体消息内容可以使用 TIMCustomElem 进行定义，发送消息时，可设置消息优先级。
`boolean`	`setSender(java.lang.String sender)` 设置消息发送方 ID 需要先将消息到导入到本地，调用 convertToImportedMsg 方法
`boolean`	`setTimestamp(long timestamp)` 设置消息时间需要先将消息到导入到本地，调用 convertToImportedMsg 方法
`TIMMessageStatus`	`status()` 查询消息状态
`long`	`timestamp()` 获取当前消息的时间戳当消息还没发送成功，此时间为根据 Server 时间校准过的本地时间，发送成功后会改为准确的 Server 时间
`java.lang.String`	`toString()` 消息打印

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 构造器详细资料
  - TIMMessage
```
public TIMMessage()
```
- 方法详细资料
  - addElement
```
public int addElement(TIMElem elem)
```
    增加消息元素
    
    参数:
    
    elem - 消息元素
    
    返回:
    
    0:成功 1:失败
  - getElement
```
public TIMElem getElement(int i)
```
    获取对应索引的 Elem
    
    参数:
    
    i - 元素索引
    
    返回:
    
    消息元素
  - getElementCount
```
public int getElementCount()
```
    获取 Elem 数量
    
    返回:
    
    元素个数
  - status
```
public TIMMessageStatus status()
```
    查询消息状态
    
    返回:
    
    消息发送状态 TIMMessageStatus
  - isSelf
```
public boolean isSelf()
```
    是否为发送方
    
    返回:
    
    是否为发送方
  - getSender
```
public java.lang.String getSender()
```
    获取消息的发送方
    
    返回:
    
    消息发送方 userID
  - getSenderNickname
```
public java.lang.String getSenderNickname()
```
    获取消息的发送方昵称
    
    返回:
    
    消息发送方昵称
  - getSenderFaceUrl
```
public java.lang.String getSenderFaceUrl()
```
    获取消息的发送方头像 url
    注意：在 C2C 场景下，陌生人的头像不会更新，建议在 UI 上点击陌生人信息的时候主动调用 TIMFriendshipManager -> getUsersProfile（forceUpdate 设置为 YES）去拉取资料，拉取成功后，SDK 会更新本地头像，下次 getSenderFaceURL 会拿到更新后的头像，注意请不要在收到每条消息都去 getUsersProfile，会严重影响程序性能。
    
    返回:
    
    消息发送方头像 url
  - getMsgId
```
public java.lang.String getMsgId()
```
    消息 ID
    当消息生成时就已经固定，全局唯一，会贯穿整个发送以及接收过程。
    
    返回:
    
    消息唯一标识
  - getMsgUniqueId
```
public long getMsgUniqueId()
```
    消息 uniqueId
    对于发送成功的消息或者从服务器接收到的消息，uniqueId 能保证全局唯一，需要在同一个会话内判断。
    
    返回:
    
    消息在会话内的唯一标识
  - timestamp
```
public long timestamp()
```
    获取当前消息的时间戳
    当消息还没发送成功，此时间为根据 Server 时间校准过的本地时间，发送成功后会改为准确的 Server 时间
    
    返回:
    
    时间戳(秒)
  - isRead
```
public boolean isRead()
```
    自己是否已读
    
    返回:
    
    是否已读
  - isPeerReaded
```
public boolean isPeerReaded()
```
    对方是否已读（仅 C2C 消息有效）
    
    返回:
    
    true - 对方已读， false - 对方未读
  - getMessageLocator
```
public TIMMessageLocator getMessageLocator()
```
    消息定位符
    如果是自己创建的 TIMMessage，需要等到消息发送成功后才能获取到 TIMMessageLocator 里面的具体信息
    
    返回:
    
    当前消息的消息定位符
  - checkEquals
```
public boolean checkEquals(@NonNull
                           TIMMessageLocator locator)
```
    是否为 locator 对应的消息
    
    参数:
    
    locator - 消息定位符
    
    返回:
    
    true - 表示是同一条消息； false - 表示不是同一条消息
    
    从以下版本开始:
    
    3.1.0
  - remove
```
@Deprecated
public boolean remove()
```
    已过时。
    
    删除消息
    目前暂不支持 Server 消息删除，只能在本地删除。删除后使用 getMessage 拉取本地消息，不会返回被删除的消息。
    
    返回:
    
    成功或失败
    该接口待废弃，删除消息请调用 TIMConversation -> deleteMessages 接口，此接口支持服务器删除消息。
  - getConversation
```
public TIMConversation getConversation()
```
    获取会话
    
    返回:
    
    会话
  - getSenderProfile
```
public void getSenderProfile(@NonNull
                             TIMValueCallBack<TIMUserProfile> callBack)
```
    获取发送者资料
    如果本地有发送者资料，会在 callBack 回调里面立即同步返回发送者资料，如果本地没有发送者资料，SDK 内部会向服务器拉取发送者资料，并在 callBack 回调里面返回发送者资料。
    
    参数:
    
    callBack - 回调
  - getSenderGroupMemberProfile
```
public TIMGroupMemberInfo getSenderGroupMemberProfile()
```
    获取发送者群内资料
    目前仅能获取字段：member，nameCard，其他的字段获取建议通过其他的字段获取建议通过TIMGroupManager.getGroupMembers(String, TIMValueCallBack) 获取
    
    返回:
    
    发送者群内资料，null表示没有获取到资料或者不是群消息
  - getPriority
```
public TIMMessagePriority getPriority()
```
    获取消息的优先级（仅对群组消息有效）
    
    返回:
    
    优先级
  - setPriority
```
public void setPriority(TIMMessagePriority priority)
```
    设置消息的优先级（仅对群组消息有效）
    对于直播场景，会有点赞和发红包功能，点赞相对优先级较低，红包消息优先级较高，具体消息内容可以使用 TIMCustomElem 进行定义，发送消息时，可设置消息优先级。
    
    参数:
    
    priority - 消息优先级
  - getOfflinePushSettings
```
public TIMMessageOfflinePushSettings getOfflinePushSettings()
```
    获取消息离线推送配置
    
    返回:
    
    离线推送配置，如果发送方没有设置的情况下，返回null
  - setOfflinePushSettings
```
public void setOfflinePushSettings(TIMMessageOfflinePushSettings settings)
```
    设置消息离线推送配置
    
    参数:
    
    settings - 离线推送配置
  - getCustomInt
```
public int getCustomInt()
```
    获取自定义整数
    
    返回:
    
    返回自定义整数的值
  - setCustomInt
```
public void setCustomInt(int value)
```
    设置自定义整数，默认为0（此属性仅本地使用）
    1.此自定义字段仅存储于本地，不会同步到 Server，用户卸载应用或则更换终端后无法获取。
    2.可以根据这个字段设置语音消息是否已经播放，如 customInt 的值 0 表示未播放，1 表示播放，当用户单击播放后可设置 customInt 的值为 1。
    
    参数:
    
    value - 自定义整数值
  - getCustomStr
```
public java.lang.String getCustomStr()
```
    获取自定义数据内容的值
    
    返回:
    
    自定义数据内容的值
  - setCustomStr
```
public void setCustomStr(java.lang.String str)
```
    设置自定义数据内容，默认为""（此属性仅本地使用）
    此自定义字段仅存储于本地，不会同步到 Server，用户卸载应用或则更换终端后无法获取。
    
    参数:
    
    str - 自定义数据内容的值
  - copyFrom
```
public boolean copyFrom(@NonNull
                        TIMMessage srcMsg)
```
    复制消息内容到当前消息（Elem, priority, online, offlinePushInfo等）
    
    参数:
    
    srcMsg - 源消息
    
    返回:
    
    true 复制成功
  - convertToImportedMsg
```
public boolean convertToImportedMsg()
```
    将消息导入到本地
    只有调用这个接口，才能去修改消息的时间戳和发送方
    
    返回:
    
    返回设置结果，true - 成功， false - 失败
  - setTimestamp
```
public boolean setTimestamp(long timestamp)
```
    设置消息时间
    需要先将消息到导入到本地，调用 convertToImportedMsg 方法
    
    参数:
    
    timestamp - 消息时间
    
    返回:
    
    返回设置结果，true - 成功， false - 失败
  - setSender
```
public boolean setSender(java.lang.String sender)
```
    设置消息发送方 ID
    需要先将消息到导入到本地，调用 convertToImportedMsg 方法
    
    参数:
    
    sender - 发送方ID
    
    返回:
    
    返回设置结果，true - 成功， false - 失败
  - getRecvFlag
```
@Deprecated
public TIMGroupReceiveMessageOpt getRecvFlag()
```
    已过时。
    
    获取消息通知类型（已废弃）
    
    返回:
    
    消息通知类型
  - getRand
```
public long getRand()
```
    获取当前消息的随机码
    
    返回:
    
    当前消息的随机码
  - getSeq
```
public long getSeq()
```
    获取当前消息的序列号
    
    返回:
    
    当前消息的序列号
  - setGroupAtUserList
```
public boolean setGroupAtUserList(java.util.List<java.lang.String> userList)
```
    设置消息 @ 用户列表
    
    返回:
    
    true：成功；false：失败
  - getGroupAtUserList
```
public java.util.List<java.lang.String> getGroupAtUserList()
```
  - toString
```
public java.lang.String toString()
```
    消息打印
    
    覆盖:
    
    toString 在类中 java.lang.Object
    
    返回:
    
    打印的部分消息参数值

类 TIMMessage

构造器概要

方法概要

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

构造器详细资料

TIMMessage

方法详细资料

addElement

getElement

getElementCount

status

isSelf

getSender

getSenderNickname

getSenderFaceUrl

getMsgId

getMsgUniqueId

timestamp

isRead

isPeerReaded

getMessageLocator

checkEquals

remove

getConversation

getSenderProfile

getSenderGroupMemberProfile

getPriority

setPriority

getOfflinePushSettings

setOfflinePushSettings

getCustomInt

setCustomInt

getCustomStr

setCustomStr

copyFrom

convertToImportedMsg

setTimestamp

setSender

getRecvFlag

getRand

getSeq

setGroupAtUserList

getGroupAtUserList

toString