Android-IMLibCore-SDK/io.rong.imlib.model/Message

Message

public class Message

The message object that contains and stores the message information received by the client, corresponding to the message in the chat UI.

Author

rongcloud

Constructors

Message

public void Message()

Default constructor.

public void Message(Parcel in)

Types

MessageDirection

public enum MessageDirection

Message Direction Enumeration.

ReceivedStatus

public class ReceivedStatus

The status of the received message.

SentStatus

public enum SentStatus

The status of the sent message.

Properties

channelId

public String channelId

content

public MessageContent content

conversationType

public ConversationType conversationType

CREATOR

public final static Creator<Message> CREATOR

directedUserIds

public List<String> directedUserIds

expansion

public Map<String, String> expansion

extra

public String extra

isEmptyContent

public boolean isEmptyContent

Indicates whether the content of this message is empty.

isOffline

public boolean isOffline

messageConfig

public MessageConfig messageConfig

messageDirection

public Message.MessageDirection messageDirection

messageId

public int messageId

messagePushConfig

public MessagePushConfig messagePushConfig

objectName

public String objectName

readReceiptInfo

public ReadReceiptInfo readReceiptInfo

readReceiptInfoV4

public ReadReceiptInfoV4 readReceiptInfoV4

Shared by v2 and v4

readTime

public long readTime

receivedStatus

public Message.ReceivedStatus receivedStatus

receivedTime

public long receivedTime

senderUserId

public String senderUserId

sentStatus

public Message.SentStatus sentStatus

sentTime

public long sentTime

targetId

public String targetId

Functions

describeContents

public int describeContents()

equals

public boolean equals(Object o)

getChannelId

public String getChannelId()

Get Channel ID

getContent

public MessageContent getContent()

Retrieves the message content.

getConversationType

public ConversationType getConversationType()

Retrieves the conversation type.

getDirectedUserIds

public List<String> getDirectedUserIds()

Get the list of targeted users Returns empty for one-to-one chat conversation type

getExpansion

public Map<String, String> getExpansion()

List of message extension information

getExtra

public String getExtra()

Retrieves the additional information of the message.

getGroupReadReceiptInfoV2

public GroupReadReceiptInfoV2 getGroupReadReceiptInfoV2()

Get Read Receipt V2 Information

getMessageConfig

public MessageConfig getMessageConfig()

Get Message Configuration

getMessageDirection

public Message.MessageDirection getMessageDirection()

Retrieves the message direction.

getMessageId

public int getMessageId()

Retrieves the unique value (database index unique value) of the locally stored message.

getMessagePushConfig

public MessagePushConfig getMessagePushConfig()

Get Push Notification Configuration

getObjectName

public String getObjectName()

Gets the name of the message object.

getReadReceiptInfo

public ReadReceiptInfo getReadReceiptInfo()

Get the read receipt status

getReadReceiptInfoV4

public ReadReceiptInfoV4 getReadReceiptInfoV4()

Retrieves the Read Receipt V4 information.

getReadTime

public long getReadTime()

getReceivedStatus

public Message.ReceivedStatus getReceivedStatus()

Retrieves the receipt status of the message.

getReceivedTime

public long getReceivedTime()

Gets the message received time (Unix timestamp in milliseconds).

getSenderUserId

public String getSenderUserId()

Retrieves the user ID of the message sender.

getSentStatus

public Message.SentStatus getSentStatus()

Retrieves the sending status of the message.

getSentTime

public long getSentTime()

Get the message sending time (Unix timestamp, in milliseconds).

getTargetId

public String getTargetId()

Retrieves the target ID.

getUId

public String getUId()

Get the unique ID of the server message (globally unique under the same AppKey).

hashCode

public int hashCode()

isCanIncludeExpansion

public boolean isCanIncludeExpansion()

Indicates whether the message can include extended information.

isDisableUpdateLastMessage

public boolean isDisableUpdateLastMessage()

isEmptyContent

public boolean isEmptyContent()

isHasChanged

public boolean isHasChanged()

Indicates whether the message has been modified.

isMayHasMoreMessagesBefore

public boolean isMayHasMoreMessagesBefore()

isOffline

public boolean isOffline()

Indicates whether the message is an offline message.

obtain

public static Message obtain(ConversationIdentifier conversationIdentifier, MessageContent content)

public static Message obtain(String targetId, ConversationType type, MessageContent content)

public static Message obtain(String targetId, ConversationType type, String channelId, MessageContent content)

Constructor.

setCanIncludeExpansion

public void setCanIncludeExpansion(boolean canIncludeExpansion)

Sets whether to include extended information.

setChannelId

public void setChannelId(String channelId)

Sets the channel ID with a maximum length of 20 characters.

setContent

public void setContent(MessageContent content)

Sets the message content.

setConversationType

public void setConversationType(ConversationType conversationType)

Sets the conversation type.

setDirectedUserIds

public void setDirectedUserIds(List<String> directedUserIds)

Set the list of targeted users

setDisableUpdateLastMessage

public void setDisableUpdateLastMessage(boolean disableUpdateLastMessage)

setExpansion

public void setExpansion(HashMap<String, String> expansion)

Set the message extension information list Extension information is only supported for one-to-one chat and group chat.

setExtra

public void setExtra(String extra)

Sets the extra information of the message.

setGroupReadReceiptInfoV2

public void setGroupReadReceiptInfoV2(GroupReadReceiptInfoV2 v2)

Sets the read receipt V2 information.

setHasChanged

public void setHasChanged(boolean hasChanged)

Sets whether the message has been modified.

setMessageConfig

public void setMessageConfig(MessageConfig messageConfig)

Set message configuration

setMessageDirection

public void setMessageDirection(Message.MessageDirection messageDirection)

Sets the message direction.

setMessageId

public void setMessageId(int messageId)

Sets the unique value for the locally stored message (database index unique value).

setMessagePushConfig

public void setMessagePushConfig(MessagePushConfig messagePushConfig)

Set push notification configuration

setObjectName

public void setObjectName(String objectName)

Sets the name of the message object.

setOffline

public void setOffline(boolean offLine)

Sets whether the message is an offline message.

setReadReceiptInfo

public void setReadReceiptInfo(ReadReceiptInfo readReceiptInfo)

Sets the read receipt status

setReadReceiptInfoV4

public void setReadReceiptInfoV4(ReadReceiptInfoV4 readReceiptInfo)

Sets the read receipt V4 information

setReadTime

public void setReadTime(long readTime)

setReceivedStatus

public void setReceivedStatus(Message.ReceivedStatus receivedStatus)

Sets the received status of the message.

setReceivedTime

public void setReceivedTime(long receivedTime)

Sets the message received time (Unix timestamp in milliseconds).

setSenderUserId

public void setSenderUserId(String senderUserId)

Sets the user ID of the message sender.

setSentStatus

public void setSentStatus(Message.SentStatus sentStatus)

Sets the sending status of the message.

setSentTime

public void setSentTime(long sentTime)

Sets the message sending time (Unix timestamp in milliseconds).

setTargetId

public void setTargetId(String targetId)

Sets the target ID.

setUId

public void setUId(String UId)

Sets the unique ID for the server message (globally unique within the same AppKey).

toString

public String toString()

writeToParcel

public void writeToParcel(Parcel dest, int flags)