All Implemented Interfaces:

io.getstream.chat.android.client.api.models.querysort.ComparableFieldProvider , io.getstream.chat.android.client.models.CustomObject
```
public final class Message
 implements CustomObject, ComparableFieldProvider
                    
```

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`Message.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private String`	`id`
`private String`	`cid`
`private String`	`text`
`private final String`	`html`
`private String`	`parentId`
`private String`	`command`
`private List<Attachment>`	`attachments`
`private List<String>`	`mentionedUsersIds`
`private List<User>`	`mentionedUsers`
`private Integer`	`replyCount`
`private Map<String, Integer>`	`reactionCounts`
`private Map<String, Integer>`	`reactionScores`
`private SyncStatus`	`syncStatus`
`private MessageSyncDescription`	`syncDescription`
`private String`	`type`
`private List<Reaction>`	`latestReactions`
`private List<Reaction>`	`ownReactions`
`private Date`	`createdAt`
`private Date`	`updatedAt`
`private Date`	`deletedAt`
`private Date`	`updatedLocallyAt`
`private Date`	`createdLocallyAt`
`private User`	`user`
`private Map<String, Object>`	`extraData`
`private Boolean`	`silent`
`private Boolean`	`shadowed`
`private final Map<String, String>`	`i18n`
`private Boolean`	`showInChannel`
`private ChannelInfo`	`channelInfo`
`private Message`	`replyTo`
`private String`	`replyMessageId`
`private Boolean`	`pinned`
`private Date`	`pinnedAt`
`private Date`	`pinExpires`
`private User`	`pinnedBy`
`private List<User>`	`threadParticipants`
`private Boolean`	`skipPushNotification`
`private Boolean`	`skipEnrichUrl`

Constructor Summary

Constructors
Constructor	Description
Message(String id, String cid, String text, String html, String parentId, String command, List<Attachment> attachments, List<String> mentionedUsersIds, List<User> mentionedUsers, Integer replyCount, Map<String, Integer> reactionCounts, Map<String, Integer> reactionScores, SyncStatus syncStatus, MessageSyncDescription syncDescription, String type, List<Reaction> latestReactions, List<Reaction> ownReactions, Date createdAt, Date updatedAt, Date deletedAt, Date updatedLocallyAt, Date createdLocallyAt, User user, Map<String, Object> extraData, Boolean silent, Boolean shadowed, Map<String, String> i18n, Boolean showInChannel, ChannelInfo channelInfo, Message replyTo, String replyMessageId, Boolean pinned, Date pinnedAt, Date pinExpires, User pinnedBy, List<User> threadParticipants, Boolean skipPushNotification, Boolean skipEnrichUrl)

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getId()`	The unique string identifier of the message.
`final Unit`	`setId(String id)`	The unique string identifier of the message.
`final String`	`getCid()`	Channel unique identifier in <type>:<id> format
`final Unit`	`setCid(String cid)`	Channel unique identifier in <type>:<id> format
`final String`	`getText()`	The text of this message
`final Unit`	`setText(String text)`	The text of this message
`final String`	`getHtml()`	The message text formatted as HTML
`final String`	`getParentId()`	The ID of the parent message, if the message is a thread reply
`final Unit`	`setParentId(String parentId)`	The ID of the parent message, if the message is a thread reply
`final String`	`getCommand()`	Contains provided slash command
`final Unit`	`setCommand(String command)`	Contains provided slash command
`final List<Attachment>`	`getAttachments()`	The list of message attachments
`final Unit`	`setAttachments(List<Attachment> attachments)`	The list of message attachments
`final List<String>`	`getMentionedUsersIds()`	The list of user mentioned in the message
`final Unit`	`setMentionedUsersIds(List<String> mentionedUsersIds)`	The list of user mentioned in the message
`final List<User>`	`getMentionedUsers()`	The list of user mentioned in the message
`final Unit`	`setMentionedUsers(List<User> mentionedUsers)`	The list of user mentioned in the message
`final Integer`	`getReplyCount()`	The number of replies to this message
`final Unit`	`setReplyCount(Integer replyCount)`	The number of replies to this message
`final Map<String, Integer>`	`getReactionCounts()`	A mapping between reaction type and the count, ie like:10, heart:4
`final Unit`	`setReactionCounts(Map<String, Integer> reactionCounts)`	A mapping between reaction type and the count, ie like:10, heart:4
`final Map<String, Integer>`	`getReactionScores()`	A mapping between reaction type and the reaction score, ie like:10, heart:4
`final Unit`	`setReactionScores(Map<String, Integer> reactionScores)`	A mapping between reaction type and the reaction score, ie like:10, heart:4
`final SyncStatus`	`getSyncStatus()`	If the message has been synced to the servers, default is synced
`final Unit`	`setSyncStatus(SyncStatus syncStatus)`	If the message has been synced to the servers, default is synced
`final MessageSyncDescription`	`getSyncDescription()`	Contains details related to syncStatus.
`final Unit`	`setSyncDescription(MessageSyncDescription syncDescription)`	Contains details related to syncStatus.
`final String`	`getType()`	Contains type of the message.
`final Unit`	`setType(String type)`	Contains type of the message.
`final List<Reaction>`	`getLatestReactions()`	List of the latest reactions to this message
`final Unit`	`setLatestReactions(List<Reaction> latestReactions)`	List of the latest reactions to this message
`final List<Reaction>`	`getOwnReactions()`	List of reactions of authenticated user to this message
`final Unit`	`setOwnReactions(List<Reaction> ownReactions)`	List of reactions of authenticated user to this message
`final Date`	`getCreatedAt()`	When the message was created
`final Unit`	`setCreatedAt(Date createdAt)`	When the message was created
`final Date`	`getUpdatedAt()`	When the message was updated
`final Unit`	`setUpdatedAt(Date updatedAt)`	When the message was updated
`final Date`	`getDeletedAt()`	When the message was deleted
`final Unit`	`setDeletedAt(Date deletedAt)`	When the message was deleted
`final Date`	`getUpdatedLocallyAt()`	When the message was updated locally
`final Unit`	`setUpdatedLocallyAt(Date updatedLocallyAt)`	When the message was updated locally
`final Date`	`getCreatedLocallyAt()`	When the message was created locally
`final Unit`	`setCreatedLocallyAt(Date createdLocallyAt)`	When the message was created locally
`final User`	`getUser()`	The user who sent the message
`final Unit`	`setUser(User user)`	The user who sent the message
`Map<String, Object>`	`getExtraData()`	All the custom data provided for this message
`Unit`	`setExtraData(Map<String, Object> extraData)`	All the custom data provided for this message
`final Boolean`	`getSilent()`	Whether message is silent or not
`final Unit`	`setSilent(Boolean silent)`	Whether message is silent or not
`final Boolean`	`getShadowed()`	If the message was sent by shadow banned user
`final Unit`	`setShadowed(Boolean shadowed)`	If the message was sent by shadow banned user
`final Map<String, String>`	`getI18n()`	Mapping with translations.
`final Boolean`	`getShowInChannel()`	Whether thread reply should be shown in the channel as well
`final Unit`	`setShowInChannel(Boolean showInChannel)`	Whether thread reply should be shown in the channel as well
`final ChannelInfo`	`getChannelInfo()`
`final Unit`	`setChannelInfo(ChannelInfo channelInfo)`
`final Message`	`getReplyTo()`	Contains quoted message
`final Unit`	`setReplyTo(Message replyTo)`	Contains quoted message
`final String`	`getReplyMessageId()`	The ID of the quoted message, if the message is a quoted reply.
`final Unit`	`setReplyMessageId(String replyMessageId)`	The ID of the quoted message, if the message is a quoted reply.
`final Boolean`	`getPinned()`	Whether message is pinned or not
`final Unit`	`setPinned(Boolean pinned)`	Whether message is pinned or not
`final Date`	`getPinnedAt()`	Date when the message got pinned
`final Unit`	`setPinnedAt(Date pinnedAt)`	Date when the message got pinned
`final Date`	`getPinExpires()`	Date when pinned message expires
`final Unit`	`setPinExpires(Date pinExpires)`	Date when pinned message expires
`final User`	`getPinnedBy()`	Contains user who pinned the message
`final Unit`	`setPinnedBy(User pinnedBy)`	Contains user who pinned the message
`final List<User>`	`getThreadParticipants()`	The list of users who participate in thread
`final Unit`	`setThreadParticipants(List<User> threadParticipants)`	The list of users who participate in thread
`final Boolean`	`getSkipPushNotification()`	If the message should skip triggering a push notification when sent.
`final Unit`	`setSkipPushNotification(Boolean skipPushNotification)`	If the message should skip triggering a push notification when sent.
`final Boolean`	`getSkipEnrichUrl()`	If the message should skip enriching the URL.
`final Unit`	`setSkipEnrichUrl(Boolean skipEnrichUrl)`	If the message should skip enriching the URL.
`Comparable<?>`	`getComparableField(String fieldName)`	Gets a comparable fields from a name.

Methods inherited from class io.getstream.chat.android.client.models.CustomObject
getExtraValue, putExtraValue
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Message
```
Message(String id, String cid, String text, String html, String parentId, String command, List<Attachment> attachments, List<String> mentionedUsersIds, List<User> mentionedUsers, Integer replyCount, Map<String, Integer> reactionCounts, Map<String, Integer> reactionScores, SyncStatus syncStatus, MessageSyncDescription syncDescription, String type, List<Reaction> latestReactions, List<Reaction> ownReactions, Date createdAt, Date updatedAt, Date deletedAt, Date updatedLocallyAt, Date createdLocallyAt, User user, Map<String, Object> extraData, Boolean silent, Boolean shadowed, Map<String, String> i18n, Boolean showInChannel, ChannelInfo channelInfo, Message replyTo, String replyMessageId, Boolean pinned, Date pinnedAt, Date pinExpires, User pinnedBy, List<User> threadParticipants, Boolean skipPushNotification, Boolean skipEnrichUrl)
```
- Method Detail
  - getId
```
 final String getId()
```
    The unique string identifier of the message. This is either created by Stream or set on the client side when the message is added.
  - setId
```
 final Unit setId(String id)
```
    The unique string identifier of the message. This is either created by Stream or set on the client side when the message is added.
  - getCid
```
 final String getCid()
```
    Channel unique identifier in <type>:<id> format
  - setCid
```
 final Unit setCid(String cid)
```
    Channel unique identifier in <type>:<id> format
  - getText
```
 final String getText()
```
    The text of this message
  - setText
```
 final Unit setText(String text)
```
    The text of this message
  - getHtml
```
 final String getHtml()
```
    The message text formatted as HTML
  - getParentId
```
 final String getParentId()
```
    The ID of the parent message, if the message is a thread reply
  - setParentId
```
 final Unit setParentId(String parentId)
```
    The ID of the parent message, if the message is a thread reply
  - getCommand
```
 final String getCommand()
```
    Contains provided slash command
  - setCommand
```
 final Unit setCommand(String command)
```
    Contains provided slash command
  - getAttachments
```
 final List<Attachment> getAttachments()
```
    The list of message attachments
  - setAttachments
```
 final Unit setAttachments(List<Attachment> attachments)
```
    The list of message attachments
  - getMentionedUsersIds
```
 final List<String> getMentionedUsersIds()
```
    The list of user mentioned in the message
  - setMentionedUsersIds
```
 final Unit setMentionedUsersIds(List<String> mentionedUsersIds)
```
    The list of user mentioned in the message
  - getMentionedUsers
```
 final List<User> getMentionedUsers()
```
    The list of user mentioned in the message
  - setMentionedUsers
```
 final Unit setMentionedUsers(List<User> mentionedUsers)
```
    The list of user mentioned in the message
  - getReplyCount
```
 final Integer getReplyCount()
```
    The number of replies to this message
  - setReplyCount
```
 final Unit setReplyCount(Integer replyCount)
```
    The number of replies to this message
  - getReactionCounts
```
 final Map<String, Integer> getReactionCounts()
```
    A mapping between reaction type and the count, ie like:10, heart:4
  - setReactionCounts
```
 final Unit setReactionCounts(Map<String, Integer> reactionCounts)
```
    A mapping between reaction type and the count, ie like:10, heart:4
  - getReactionScores
```
 final Map<String, Integer> getReactionScores()
```
    A mapping between reaction type and the reaction score, ie like:10, heart:4
  - setReactionScores
```
 final Unit setReactionScores(Map<String, Integer> reactionScores)
```
    A mapping between reaction type and the reaction score, ie like:10, heart:4
  - getSyncStatus
```
 final SyncStatus getSyncStatus()
```
    If the message has been synced to the servers, default is synced
  - setSyncStatus
```
 final Unit setSyncStatus(SyncStatus syncStatus)
```
    If the message has been synced to the servers, default is synced
  - getSyncDescription
```
 final MessageSyncDescription getSyncDescription()
```
    Contains details related to syncStatus.
  - setSyncDescription
```
 final Unit setSyncDescription(MessageSyncDescription syncDescription)
```
    Contains details related to syncStatus.
  - getType
```
 final String getType()
```
    Contains type of the message. Can be one of the following: regular, ephemeral, error, reply, system, deleted.
  - setType
```
 final Unit setType(String type)
```
    Contains type of the message. Can be one of the following: regular, ephemeral, error, reply, system, deleted.
  - getLatestReactions
```
 final List<Reaction> getLatestReactions()
```
    List of the latest reactions to this message
  - setLatestReactions
```
 final Unit setLatestReactions(List<Reaction> latestReactions)
```
    List of the latest reactions to this message
  - getOwnReactions
```
 final List<Reaction> getOwnReactions()
```
    List of reactions of authenticated user to this message
  - setOwnReactions
```
 final Unit setOwnReactions(List<Reaction> ownReactions)
```
    List of reactions of authenticated user to this message
  - getCreatedAt
```
 final Date getCreatedAt()
```
    When the message was created
  - setCreatedAt
```
 final Unit setCreatedAt(Date createdAt)
```
    When the message was created
  - getUpdatedAt
```
 final Date getUpdatedAt()
```
    When the message was updated
  - setUpdatedAt
```
 final Unit setUpdatedAt(Date updatedAt)
```
    When the message was updated
  - getDeletedAt
```
 final Date getDeletedAt()
```
    When the message was deleted
  - setDeletedAt
```
 final Unit setDeletedAt(Date deletedAt)
```
    When the message was deleted
  - getUpdatedLocallyAt
```
 final Date getUpdatedLocallyAt()
```
    When the message was updated locally
  - setUpdatedLocallyAt
```
 final Unit setUpdatedLocallyAt(Date updatedLocallyAt)
```
    When the message was updated locally
  - getCreatedLocallyAt
```
 final Date getCreatedLocallyAt()
```
    When the message was created locally
  - setCreatedLocallyAt
```
 final Unit setCreatedLocallyAt(Date createdLocallyAt)
```
    When the message was created locally
  - getUser
```
 final User getUser()
```
    The user who sent the message
  - setUser
```
 final Unit setUser(User user)
```
    The user who sent the message
  - getExtraData
```
 Map<String, Object> getExtraData()
```
    All the custom data provided for this message
  - setExtraData
```
 Unit setExtraData(Map<String, Object> extraData)
```
    All the custom data provided for this message
  - getSilent
```
 final Boolean getSilent()
```
    Whether message is silent or not
  - setSilent
```
 final Unit setSilent(Boolean silent)
```
    Whether message is silent or not
  - getShadowed
```
 final Boolean getShadowed()
```
    If the message was sent by shadow banned user
  - setShadowed
```
 final Unit setShadowed(Boolean shadowed)
```
    If the message was sent by shadow banned user
  - getI18n
```
 final Map<String, String> getI18n()
```
    Mapping with translations. Key language contains the original language key. Other keys contain translations.
  - getShowInChannel
```
 final Boolean getShowInChannel()
```
    Whether thread reply should be shown in the channel as well
  - setShowInChannel
```
 final Unit setShowInChannel(Boolean showInChannel)
```
    Whether thread reply should be shown in the channel as well
  - getChannelInfo
```
 final ChannelInfo getChannelInfo()
```
  - setChannelInfo
```
 final Unit setChannelInfo(ChannelInfo channelInfo)
```
  - getReplyTo
```
 final Message getReplyTo()
```
    Contains quoted message
  - setReplyTo
```
 final Unit setReplyTo(Message replyTo)
```
    Contains quoted message
  - getReplyMessageId
```
 final String getReplyMessageId()
```
    The ID of the quoted message, if the message is a quoted reply.
  - setReplyMessageId
```
 final Unit setReplyMessageId(String replyMessageId)
```
    The ID of the quoted message, if the message is a quoted reply.
  - getPinned
```
 final Boolean getPinned()
```
    Whether message is pinned or not
  - setPinned
```
 final Unit setPinned(Boolean pinned)
```
    Whether message is pinned or not
  - getPinnedAt
```
 final Date getPinnedAt()
```
    Date when the message got pinned
  - setPinnedAt
```
 final Unit setPinnedAt(Date pinnedAt)
```
    Date when the message got pinned
  - getPinExpires
```
 final Date getPinExpires()
```
    Date when pinned message expires
  - setPinExpires
```
 final Unit setPinExpires(Date pinExpires)
```
    Date when pinned message expires
  - getPinnedBy
```
 final User getPinnedBy()
```
    Contains user who pinned the message
  - setPinnedBy
```
 final Unit setPinnedBy(User pinnedBy)
```
    Contains user who pinned the message
  - getThreadParticipants
```
 final List<User> getThreadParticipants()
```
    The list of users who participate in thread
  - setThreadParticipants
```
 final Unit setThreadParticipants(List<User> threadParticipants)
```
    The list of users who participate in thread
  - getSkipPushNotification
```
 final Boolean getSkipPushNotification()
```
    If the message should skip triggering a push notification when sent. Used when sending a new message. False by default.
    Note: This property is local only, it is not sent to the backend.
  - setSkipPushNotification
```
 final Unit setSkipPushNotification(Boolean skipPushNotification)
```
    If the message should skip triggering a push notification when sent. Used when sending a new message. False by default.
    Note: This property is local only, it is not sent to the backend.
  - getSkipEnrichUrl
```
 final Boolean getSkipEnrichUrl()
```
    If the message should skip enriching the URL. If URl is not enriched, it will not be displayed as a link attachment. Used when sending or updating a message. False by default.
    Note: This property is local only, it is not sent to the backend.
  - setSkipEnrichUrl
```
 final Unit setSkipEnrichUrl(Boolean skipEnrichUrl)
```
    If the message should skip enriching the URL. If URl is not enriched, it will not be displayed as a link attachment. Used when sending or updating a message. False by default.
    Note: This property is local only, it is not sent to the backend.
  - getComparableField
```
 Comparable<?> getComparableField(String fieldName)
```
    Gets a comparable fields from a name.
    
    Parameters:
    
    fieldName - The name of the field.

Class Message

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class io.getstream.chat.android.client.models.CustomObject

Methods inherited from class java.lang.Object

Constructor Detail

Message

Method Detail

getId

setId

getCid

setCid

getText

setText

getHtml

getParentId

setParentId

getCommand

setCommand

getAttachments

setAttachments

getMentionedUsersIds

setMentionedUsersIds

getMentionedUsers

setMentionedUsers

getReplyCount

setReplyCount

getReactionCounts

setReactionCounts

getReactionScores

setReactionScores

getSyncStatus

setSyncStatus

getSyncDescription

setSyncDescription

getType

setType

getLatestReactions

setLatestReactions

getOwnReactions

setOwnReactions

getCreatedAt

setCreatedAt

getUpdatedAt

setUpdatedAt

getDeletedAt

setDeletedAt

getUpdatedLocallyAt

setUpdatedLocallyAt

getCreatedLocallyAt

setCreatedLocallyAt

getUser

setUser

getExtraData

setExtraData

getSilent

setSilent

getShadowed

setShadowed

getI18n

getShowInChannel

setShowInChannel

getChannelInfo

setChannelInfo

getReplyTo

setReplyTo

getReplyMessageId

setReplyMessageId

getPinned

setPinned

getPinnedAt

setPinnedAt

getPinExpires

setPinExpires

getPinnedBy

setPinnedBy

getThreadParticipants