All Implemented Interfaces:

io.getstream.chat.android.models.CustomObject , io.getstream.chat.android.models.querysort.ComparableFieldProvider
```
@Immutable() 
public final class Message
 implements CustomObject, ComparableFieldProvider
                    
```
Model holding data about a message.

Nested Class Summary

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

Field Summary

Fields
Modifier and Type	Field	Description
`public final static String`	`TYPE_REGULAR`
`public final static String`	`TYPE_EPHEMERAL`
`public final static String`	`TYPE_ERROR`
`private final String`	`originalLanguage`
`private final String`	`id`
`private final String`	`cid`
`private final String`	`text`
`private final String`	`html`
`private final String`	`parentId`
`private final String`	`command`
`private final List<Attachment>`	`attachments`
`private final List<String>`	`mentionedUsersIds`
`private final List<User>`	`mentionedUsers`
`private final Integer`	`replyCount`
`private final Integer`	`deletedReplyCount`
`private final Map<String, Integer>`	`reactionCounts`
`private final Map<String, Integer>`	`reactionScores`
`private final Map<String, ReactionGroup>`	`reactionGroups`
`private final SyncStatus`	`syncStatus`
`private final String`	`type`
`private final List<Reaction>`	`latestReactions`
`private final List<Reaction>`	`ownReactions`
`private final Date`	`createdAt`
`private final Date`	`updatedAt`
`private final Date`	`deletedAt`
`private final Date`	`updatedLocallyAt`
`private Date`	`createdLocallyAt`
`private final User`	`user`
`private final Map<String, Object>`	`extraData`
`private final Boolean`	`silent`
`private final Boolean`	`shadowed`
`private final Map<String, String>`	`i18n`
`private final Boolean`	`showInChannel`
`private final ChannelInfo`	`channelInfo`
`private final Message`	`replyTo`
`private final String`	`replyMessageId`
`private final Boolean`	`pinned`
`private final Date`	`pinnedAt`
`private final Date`	`pinExpires`
`private final User`	`pinnedBy`
`private final List<User>`	`threadParticipants`
`private final Boolean`	`skipPushNotification`
`private final Boolean`	`skipEnrichUrl`
`private final MessageModerationDetails`	`moderationDetails`
`private final Moderation`	`moderation`
`private final Date`	`messageTextUpdatedAt`
`private final Poll`	`poll`
`private final List<String>`	`restrictedVisibility`

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, Integer deletedReplyCount, Map<String, Integer> reactionCounts, Map<String, Integer> reactionScores, Map<String, ReactionGroup> reactionGroups, SyncStatus syncStatus, 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, MessageModerationDetails moderationDetails, Moderation moderation, Date messageTextUpdatedAt, Poll poll, List<String> restrictedVisibility)

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getOriginalLanguage()`
`final String`	`getId()`	The unique string identifier of the message.
`final String`	`getCid()`	Channel unique identifier in <type>:<id> format
`final String`	`getText()`	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 String`	`getCommand()`	Contains provided slash command
`final List<Attachment>`	`getAttachments()`	The list of message attachments
`final List<String>`	`getMentionedUsersIds()`	The list of user mentioned in the message
`final List<User>`	`getMentionedUsers()`	The list of user mentioned in the message
`final Integer`	`getReplyCount()`	The number of replies to this message
`final Integer`	`getDeletedReplyCount()`	The number of deleted replies to this message
`final Map<String, Integer>`	`getReactionCounts()`	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 Map<String, ReactionGroup>`	`getReactionGroups()`	A mapping between reaction type and the ReactionGroup.
`final SyncStatus`	`getSyncStatus()`	If the message has been synced to the servers, default is synced
`final String`	`getType()`	Contains type of the message.
`final List<Reaction>`	`getLatestReactions()`	List of the latest reactions to this message
`final List<Reaction>`	`getOwnReactions()`	List of reactions of authenticated user to this message
`final Date`	`getCreatedAt()`	When the message was created
`final Date`	`getUpdatedAt()`	When the message was updated
`final Date`	`getDeletedAt()`	When the message was deleted
`final Date`	`getUpdatedLocallyAt()`	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
`Map<String, Object>`	`getExtraData()`	All the custom data provided for this message
`final Boolean`	`getSilent()`	Whether message is silent or not
`final Boolean`	`getShadowed()`	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 ChannelInfo`	`getChannelInfo()`	Contains information about the channel where the message was sent.
`final Message`	`getReplyTo()`	Contains quoted message
`final String`	`getReplyMessageId()`	The ID of the quoted message, if the message is a quoted reply.
`final Boolean`	`getPinned()`	Whether message is pinned or not
`final Date`	`getPinnedAt()`	Date when the message got pinned
`final Date`	`getPinExpires()`	Date when pinned message expires
`final User`	`getPinnedBy()`	Contains user who pinned the message
`final List<User>`	`getThreadParticipants()`	The list of users who participate in thread
`final Boolean`	`getSkipPushNotification()`	If the message should skip triggering a push notification when sent.
`final Boolean`	`getSkipEnrichUrl()`	If the message should skip enriching the URL.
`final MessageModerationDetails`	`getModerationDetails()`	Contains moderation details of the message.
`final Moderation`	`getModeration()`	Contains moderation details of the message.
`final Date`	`getMessageTextUpdatedAt()`	Date when the message text was updated
`final Poll`	`getPoll()`	Contains poll configuration
`final List<String>`	`getRestrictedVisibility()`	List of user ids that are allowed to see the message
`Comparable<?>`	`getComparableField(String fieldName)`	Gets a comparable fields from a name.
`final String`	`getTranslation(String language)`	Retrieves the translated text message for the given []language].
`final Long`	`identifierHash()`	Identifier of message.
`String`	`toString()`
`final Message.Builder`	`newBuilder()`

Methods inherited from class io.getstream.chat.android.models.CustomObject
getExtraValue
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, Integer deletedReplyCount, Map<String, Integer> reactionCounts, Map<String, Integer> reactionScores, Map<String, ReactionGroup> reactionGroups, SyncStatus syncStatus, 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, MessageModerationDetails moderationDetails, Moderation moderation, Date messageTextUpdatedAt, Poll poll, List<String> restrictedVisibility)
```
- Method Detail
  - getOriginalLanguage
```
 final String getOriginalLanguage()
```
  - 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.
  - getCid
```
 final String getCid()
```
    Channel unique identifier in <type>:<id> format
  - getText
```
 final String getText()
```
    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
  - getCommand
```
 final String getCommand()
```
    Contains provided slash command
  - getAttachments
```
 final List<Attachment> getAttachments()
```
    The list of message attachments
  - getMentionedUsersIds
```
 final List<String> getMentionedUsersIds()
```
    The list of user mentioned in the message
  - getMentionedUsers
```
 final List<User> getMentionedUsers()
```
    The list of user mentioned in the message
  - getReplyCount
```
 final Integer getReplyCount()
```
    The number of replies to this message
  - getDeletedReplyCount
```
 final Integer getDeletedReplyCount()
```
    The number of deleted replies to this message
  - getReactionCounts
```
 final Map<String, Integer> getReactionCounts()
```
    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
  - getReactionGroups
```
 final Map<String, ReactionGroup> getReactionGroups()
```
    A mapping between reaction type and the ReactionGroup.
  - getSyncStatus
```
 final SyncStatus getSyncStatus()
```
    If the message has been synced to the servers, default is synced
  - getType
```
 final String getType()
```
    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
  - getOwnReactions
```
 final List<Reaction> getOwnReactions()
```
    List of reactions of authenticated user to this message
  - getCreatedAt
```
 final Date getCreatedAt()
```
    When the message was created
  - getUpdatedAt
```
 final Date getUpdatedAt()
```
    When the message was updated
  - getDeletedAt
```
 final Date getDeletedAt()
```
    When the message was deleted
  - getUpdatedLocallyAt
```
 final Date getUpdatedLocallyAt()
```
    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
  - getExtraData
```
 Map<String, Object> getExtraData()
```
    All the custom data provided for this message
  - getSilent
```
 final Boolean getSilent()
```
    Whether message is silent or not
  - getShadowed
```
 final Boolean getShadowed()
```
    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
  - getChannelInfo
```
 final ChannelInfo getChannelInfo()
```
    Contains information about the channel where the message was sent.
  - getReplyTo
```
 final Message getReplyTo()
```
    Contains quoted message
  - getReplyMessageId
```
 final String getReplyMessageId()
```
    The ID of the quoted message, if the message is a quoted reply.
  - getPinned
```
 final Boolean getPinned()
```
    Whether message is pinned or not
  - getPinnedAt
```
 final Date getPinnedAt()
```
    Date when the message got pinned
  - getPinExpires
```
 final Date getPinExpires()
```
    Date when pinned message expires
  - getPinnedBy
```
 final User getPinnedBy()
```
    Contains user who pinned the message
  - getThreadParticipants
```
 final List<User> getThreadParticipants()
```
    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.
  - 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.
  - getModerationDetails
```
 final MessageModerationDetails getModerationDetails()
```
    Contains moderation details of the message. (used by moderation v1)
  - getModeration
```
 final Moderation getModeration()
```
    Contains moderation details of the message. (used by moderation v2)
  - getMessageTextUpdatedAt
```
 final Date getMessageTextUpdatedAt()
```
    Date when the message text was updated
  - getPoll
```
 final Poll getPoll()
```
    Contains poll configuration
  - getRestrictedVisibility
```
 final List<String> getRestrictedVisibility()
```
    List of user ids that are allowed to see the message
  - getComparableField
```
 Comparable<?> getComparableField(String fieldName)
```
    Gets a comparable fields from a name.
    
    Parameters:
    
    fieldName - The name of the field.
  - getTranslation
```
 final String getTranslation(String language)
```
    Retrieves the translated text message for the given []language].
    
    Parameters:
    
    language - The language code for the translation.
    
    Returns:
    
    The translated text message, or empty if the translation is not available.
  - identifierHash
```
 final Long identifierHash()
```
    Identifier of message. The message can't be considered the same if the id of the message AND the id of a quoted message are not the same.
  - toString
```
 String toString()
```
  - newBuilder
```
@SinceKotlin(version = "99999.9") final Message.Builder newBuilder()
```

Class Message

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

Message

Method Detail

getOriginalLanguage

getId

getCid

getText

getHtml

getParentId

getCommand

getAttachments

getMentionedUsersIds

getMentionedUsers

getReplyCount

getDeletedReplyCount

getReactionCounts

getReactionScores

getReactionGroups

getSyncStatus

getType

getLatestReactions

getOwnReactions

getCreatedAt

getUpdatedAt

getDeletedAt

getUpdatedLocallyAt

getCreatedLocallyAt

setCreatedLocallyAt

getUser

getExtraData

getSilent

getShadowed

getI18n

getShowInChannel

getChannelInfo

getReplyTo

getReplyMessageId

getPinned

getPinnedAt

getPinExpires

getPinnedBy

getThreadParticipants

getSkipPushNotification

getSkipEnrichUrl

getModerationDetails

getModeration

getMessageTextUpdatedAt

getPoll

getRestrictedVisibility

getComparableField

getTranslation

identifierHash

toString

newBuilder