LCIMMessage (leancloud sdk 8.2.28 API)

java.lang.Object
- cn.leancloud.im.v2.LCIMMessage

Direct Known Subclasses:

LCIMBinaryMessage, LCIMTypedMessage
```
public class LCIMMessage
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class LCIMMessage.MessageIOType

static class LCIMMessage.MessageStatus

Nested Classes
Modifier and Type	Class and Description
`static class`	`LCIMMessage.MessageIOType`
`static class`	`LCIMMessage.MessageStatus`

Field Summary

Fields
Modifier and Type	Field and Description
`protected byte[]`	`bytes`
`protected String`	`content`
`protected String`	`conversationId`
`protected String`	`currentClient`
`protected long`	`deliveredAt`
`protected String`	`from`
`protected LCIMMessage.MessageIOType`	`ioType`
`protected boolean`	`mentionAll`
`protected List<String>`	`mentionList`
`protected String`	`messageId`
`protected long`	`readAt`
`protected LCIMMessage.MessageStatus`	`status`
`protected long`	`timestamp`
`protected String`	`uniqueToken`
`protected long`	`updateAt`

Constructor Summary

Constructors
Constructor and Description
`LCIMMessage()`
`LCIMMessage(String conversationId, String from)`
`LCIMMessage(String conversationId, String from, long timestamp, long deliveredAt)`
`LCIMMessage(String conversationId, String from, long timestamp, long deliveredAt, long readAt)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Map<String,Object>`	`dumpRawData()`
`boolean`	`equals(Object other)`
`protected void`	`generateUniqueToken()`
`String`	`getContent()` 获取消息体的内容
`String`	`getConversationId()` 获取当前聊天对话对应的id 对应的是AVOSRealtimeConversations表中的objectId
`long`	`getDeliveredAt()` 获取消息成功到达接收方的时间
`String`	`getFrom()` 获取消息的发送者
`List<String>`	`getMentionList()` 获取 mention 用户列表
`String`	`getMentionListString()` 获取 mention 用户列表的字符串（逗号分隔）
`String`	`getMessageId()` 获取消息的全局Id 这个id只有在发送成功或者收到消息时才会有对应的值
`LCIMMessage.MessageIOType`	`getMessageIOType()` 获取消息IO类型
`LCIMMessage.MessageStatus`	`getMessageStatus()` 获取消息当前的状态
`long`	`getReadAt()`
`long`	`getReceiptTimestamp()` Deprecated. Please use `getDeliveredAt()` 获取消息成功到达接收方的时间
`long`	`getTimestamp()` 获取消息发送的时间
`String`	`getUniqueToken()`
`long`	`getUpdateAt()` Deprecated. please use getUpdatedAt instead of.
`long`	`getUpdatedAt()` get the update time of the message
`int`	`hashCode()`
`boolean`	`isMentionAll()` 判断是否 mention 了所有人
`boolean`	`mentioned()` 判断消息里面是否 mention 了当前用户
`static LCIMMessage`	`parseJSON(Map<String,Object> jsonObject)`
`static LCIMMessage`	`parseJSONString(String content)`
`void`	`setContent(String content)` 设置消息体的内容
`void`	`setConversationId(String conversationId)` 设置消息所在的conversationId，本方法一般用于从反序列化时
`void`	`setFrom(String from)` 设置消息的发送者
`void`	`setMentionAll(boolean mentionAll)` 设置是否 mention 所有人
`void`	`setMentionList(List<String> peerIdList)` 设置 mention 用户列表
`void`	`setMentionListString(String content)` 设置 mention 用户列表字符串（逗号分隔），功能与 #setMentionList(List peerIdList) 相同，两者调用一个即可。
`void`	`setMessageId(String messageId)` 仅仅是用于反序列化消息时使用，请不要在其他时候使用
`void`	`setMessageIOType(LCIMMessage.MessageIOType ioType)` 设置消息的IO类型，本方法一般用于反序列化
`void`	`setMessageStatus(LCIMMessage.MessageStatus status)` 设置消息当前的状态，本方法一般用于从反序列化时
`void`	`setReadAt(long readAt)`
`void`	`setReceiptTimestamp(long receiptTimestamp)` Deprecated. Please use `setDeliveredAt(long)`
`void`	`setTimestamp(long timestamp)`
`void`	`setUniqueToken(String uniqueToken)`
`void`	`setUpdateAt(long updateAt)` Deprecated. please use setUpdatedAt instead of.
`void`	`setUpdatedAt(long updateAt)` set the update time of the message
`String`	`toJSONString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - conversationId
```
protected String conversationId
```
  - content
```
protected String content
```
  - bytes
```
protected byte[] bytes
```
  - from
```
protected String from
```
  - timestamp
```
protected long timestamp
```
  - deliveredAt
```
protected long deliveredAt
```
  - readAt
```
protected long readAt
```
  - updateAt
```
protected long updateAt
```
  - mentionList
```
protected List<String> mentionList
```
  - mentionAll
```
protected boolean mentionAll
```
  - currentClient
```
protected String currentClient
```
  - messageId
```
protected String messageId
```
  - uniqueToken
```
protected String uniqueToken
```
  - status
```
protected LCIMMessage.MessageStatus status
```
  - ioType
```
protected LCIMMessage.MessageIOType ioType
```
- Constructor Detail
  - LCIMMessage
```
public LCIMMessage()
```
  - LCIMMessage
```
public LCIMMessage(String conversationId,
                   String from)
```
  - LCIMMessage
```
public LCIMMessage(String conversationId,
                   String from,
                   long timestamp,
                   long deliveredAt)
```
  - LCIMMessage
```
public LCIMMessage(String conversationId,
                   String from,
                   long timestamp,
                   long deliveredAt,
                   long readAt)
```
- Method Detail
  - getConversationId
```
public String getConversationId()
```
    获取当前聊天对话对应的id 对应的是AVOSRealtimeConversations表中的objectId
    
    Returns:
    
    conversation id.
    
    Since:
    
    3.0
  - setConversationId
```
public void setConversationId(String conversationId)
```
    设置消息所在的conversationId，本方法一般用于从反序列化时
    
    Parameters:
    
    conversationId - conversation id.
  - getContent
```
public String getContent()
```
    获取消息体的内容
    
    Returns:
    
    message content.
    
    Since:
    
    3.0
  - setContent
```
public void setContent(String content)
```
    设置消息体的内容
    
    Parameters:
    
    content - message content.
    
    Since:
    
    3.0
  - getFrom
```
public String getFrom()
```
    获取消息的发送者
    
    Returns:
    
    message sender
  - setFrom
```
public void setFrom(String from)
```
    设置消息的发送者
    
    Parameters:
    
    from - message sender
    
    Since:
    
    3.7.3
  - getTimestamp
```
public long getTimestamp()
```
    获取消息发送的时间
    
    Returns:
    
    message send timestamp
  - setTimestamp
```
public void setTimestamp(long timestamp)
```
  - getReceiptTimestamp
```
public long getReceiptTimestamp()
```
    Deprecated. Please use getDeliveredAt() 获取消息成功到达接收方的时间
    
    Returns:
    
    message receipt timestamp
  - setReceiptTimestamp
```
public void setReceiptTimestamp(long receiptTimestamp)
```
    Deprecated. Please use setDeliveredAt(long)
    
    Parameters:
    
    receiptTimestamp - message receipt timestamp
  - getDeliveredAt
```
public long getDeliveredAt()
```
    获取消息成功到达接收方的时间
    
    Returns:
    
    message delivered timestamp
  - setReadAt
```
public void setReadAt(long readAt)
```
  - getReadAt
```
public long getReadAt()
```
  - setUpdateAt
```
public void setUpdateAt(long updateAt)
```
    Deprecated. please use setUpdatedAt instead of.
    
    set the update time of the message
    
    Parameters:
    
    updateAt - message updated timestamp
  - setUpdatedAt
```
public void setUpdatedAt(long updateAt)
```
    set the update time of the message
    
    Parameters:
    
    updateAt - message updated timestamp
  - getUpdateAt
```
public long getUpdateAt()
```
    Deprecated. please use getUpdatedAt instead of.
    
    get the update time of the message
    
    Returns:
    
    message updated timestamp
  - getUpdatedAt
```
public long getUpdatedAt()
```
    get the update time of the message
    
    Returns:
    
    message updated timestamp
  - setMessageStatus
```
public void setMessageStatus(LCIMMessage.MessageStatus status)
```
    设置消息当前的状态，本方法一般用于从反序列化时
    
    Parameters:
    
    status - message status
  - getMessageStatus
```
public LCIMMessage.MessageStatus getMessageStatus()
```
    获取消息当前的状态
    
    Returns:
    
    message status
  - getMessageIOType
```
public LCIMMessage.MessageIOType getMessageIOType()
```
    获取消息IO类型
    
    Returns:
    
    message io type
  - setMessageIOType
```
public void setMessageIOType(LCIMMessage.MessageIOType ioType)
```
    设置消息的IO类型，本方法一般用于反序列化
    
    Parameters:
    
    ioType - message io type
  - getMessageId
```
public String getMessageId()
```
    获取消息的全局Id 这个id只有在发送成功或者收到消息时才会有对应的值
    
    Returns:
    
    message id
  - setMessageId
```
public void setMessageId(String messageId)
```
    仅仅是用于反序列化消息时使用，请不要在其他时候使用
    
    Parameters:
    
    messageId - message id
  - mentioned
```
public boolean mentioned()
```
    判断消息里面是否 mention 了当前用户
    
    Returns:
    
    flag indicating message mentions current user or not.
  - setMentionList
```
public void setMentionList(List<String> peerIdList)
```
    设置 mention 用户列表
    
    Parameters:
    
    peerIdList - mention peer id list
  - getMentionList
```
public List<String> getMentionList()
```
    获取 mention 用户列表
    
    Returns:
    
    mention peer id list
  - getMentionListString
```
public String getMentionListString()
```
    获取 mention 用户列表的字符串（逗号分隔）
    
    Returns:
    
    mention peer id list string
  - setMentionListString
```
public void setMentionListString(String content)
```
    设置 mention 用户列表字符串（逗号分隔），功能与 #setMentionList(List peerIdList) 相同，两者调用一个即可。
    
    Parameters:
    
    content - mention peer id list string
  - isMentionAll
```
public boolean isMentionAll()
```
    判断是否 mention 了所有人
    
    Returns:
    
    flag indicating mentioned all or not
  - setMentionAll
```
public void setMentionAll(boolean mentionAll)
```
    设置是否 mention 所有人
    
    Parameters:
    
    mentionAll - flag indicating mentioned all or not
  - generateUniqueToken
```
protected void generateUniqueToken()
```
  - setUniqueToken
```
public void setUniqueToken(String uniqueToken)
```
  - getUniqueToken
```
public String getUniqueToken()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - dumpRawData
```
public Map<String,Object> dumpRawData()
```
  - toJSONString
```
public String toJSONString()
```
  - parseJSON
```
public static LCIMMessage parseJSON(Map<String,Object> jsonObject)
```
  - parseJSONString
```
public static LCIMMessage parseJSONString(String content)
```

Class LCIMMessage

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

conversationId

content

bytes

from

timestamp

deliveredAt

readAt

updateAt

mentionList

mentionAll

currentClient

messageId

uniqueToken

status

ioType

Constructor Detail

LCIMMessage

LCIMMessage

LCIMMessage

LCIMMessage

Method Detail

getConversationId

setConversationId

getContent

setContent

getFrom

setFrom

getTimestamp

setTimestamp

getReceiptTimestamp

setReceiptTimestamp

getDeliveredAt

setReadAt

getReadAt

setUpdateAt

setUpdatedAt

getUpdateAt

getUpdatedAt

setMessageStatus

getMessageStatus

getMessageIOType

setMessageIOType

getMessageId

setMessageId

mentioned

setMentionList

getMentionList

getMentionListString

setMentionListString

isMentionAll

setMentionAll

generateUniqueToken

setUniqueToken

getUniqueToken

hashCode

equals

dumpRawData

toJSONString

parseJSON

parseJSONString