UserMessage class

Represents a basic text message

Inheritance
Available extensions
Annotations
  • @JsonSerializable()

Constructors

UserMessage({required Map<String, String> translations, required int messageId, required String message, required String channelUrl, required ChannelType channelType, Sender? sender, MessageSendingStatus? sendingStatus, String? requestId, List<User> mentionedUsers = const [], MentionType? mentionType, List<String>? requestedMentionUserIds, List<String>? mentionedUserIds, int createdAt = 0, int updatedAt = 0, int? parentMessageId, String? parentMessageText, ThreadInfo? threadInfo, List<MessageMetaArray>? metaArrays, String? customType, int? messageSurvivalSeconds, bool forceUpdateLastMessage = false, bool isSilent = false, int? errorCode, bool isOperatorMessage = false, String? data, OGMetaData? ogMetaData, List<Reaction>? reactions, Map<String, dynamic>? parentMessage, bool replyToChannel = false, Poll? poll, List<String>? translationTargetLanguages, bool isPinnedMessage = false})
UserMessage.fromJson(Map<String, dynamic> res)
factory

Properties

channelType ↔ ChannelType
Channel type of this message
getter/setter pairinherited
channelUrl → String
Channel url of this message.
finalinherited
createdAt → int
Message creation time in millisecond(UTC)
finalinherited
customType → String?
Custom message type
finalinherited
data ↔ String?
data for this message returns null if data is not a string
getter/setter pairinherited
errorCode ↔ int?
The error code of this message. This value generated only when message send fails.
getter/setter pairinherited
extendedMessage ↔ Map<String, dynamic>
Only featured in GroupChannel Message Template used for Sendbird UI KIT
getter/setter pairinherited
forceUpdateLastMessage → bool
True if this message should update last message of its channel
finalinherited
hashCode → int
The hash code for this object.
no setteroverride
isOperatorMessage → bool
True if this message was created by an operator.
finalinherited
isPinnedMessage ↔ bool
Pinned Message
getter/setter pairinherited
isSilent → bool
True if this message won't affect unread message count / mention count
finalinherited
mentionedUserIds → List<String>?
Mention to specific users. If sends a message with this field, the message will be arrived to mentioned users.
finalinherited
mentionedUsers ↔ List<User>
The list of users who was mentioned together with this message.
getter/setter pairinherited
mentionType → MentionType?
Mention type that this message uses
finalinherited
message → String
Message text.
finalinherited
messageId → int
Unique message ID.
finalinherited
messageSurvivalSeconds → int?
Message disappear in seconds, default is -1 and won't disappear
finalinherited
metaArrays ↔ List<MessageMetaArray>?
Gets an array of meta arrays sorted by chronological order. current does not support backward compatibility
getter/setter pairinherited
ogMetaData → OGMetaData?
Open graph information in this message. Nullable
finalinherited
parentMessage ↔ BaseMessage?
Retrieve current message's parent information
getter/setter pairinherited
parentMessageId → int?
The unique ID of the parent message. If the message object is a parent message or a single message without any reply, the value of this property is 0. If the object is a reply, the value is the unique ID of its parent message.
finalinherited
parentMessageText → String?
The written text of the message object’s parent message. If the message object is a parent message, the value of this property is null. If the object is a reply to a parent message and the type of the parent message is UserMessage, the value is message. If it is FileMessage, the value is the name of the uploaded file.
finalinherited
poll ↔ Poll?
linked poll information
getter/setter pair
reactions ↔ List<Reaction>?
reactions for this message
getter/setter pairinherited
replyToChannel ↔ bool
Option to reply to channel. The default is false
getter/setter pairinherited
requestedMentionUserIds → List<String>?
Represents target user ids to mention when success to send this message. This value is valid only when the message is a pending message or failed message. If the message is a succeeded message, see mentionedUserIds
finalinherited
requestId → String?
Request ID for checking ACK.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scheduledInfo ↔ ScheduledInfo?
Scheduled message information
getter/setter pairinherited
sender ↔ Sender?
Sender of this message
getter/setter pairinherited
sendingStatus ↔ MessageSendingStatus?
Represents the dispatch state of this message. If this message is not dispatched completely to the Sendbird server, the value is pending. If failed to send the message, the value is failed. And if success to send the message, the value is succeeded.
getter/setter pairinherited
threadInfo ↔ ThreadInfo?
The thread info that belongs to this message object.
getter/setter pairinherited
translations → Map<String, String>
translation map for this user message. Key is language code and value is translated text
final
translationTargetLanguages → List<String>?
List of target langauges before translating
final
updatedAt → int
Message update time in millisecond(UTC).
finalinherited

Methods

applyReactionEvent(ReactionEvent event) → bool
Applies ReactionEvent to this message.
inherited
applyThreadInfoUpdateEvent(ThreadInfoUpdateEvent event) → bool
Applies ThreadInfoUpdateEvent event to this message.
inherited
containsMentionedUser(User? user) → bool

Available on BaseMessage, provided by the BaseMessageInternal extension

getMetaArrays(List<String> keys) → List<MessageMetaArray>
Retreives list of MessageMetaArray with given keys
inherited
getThreadedMessagesByTimestamp(int timestamp, ThreadedMessageListParams params) → Future<ThreadedMessageResponse>
Retrieves threaded messages (replies) on this message with timestamp and params.
inherited
hasCreatedLaterThan(int time) → bool

Available on BaseMessage, provided by the BaseMessageInternal extension

hasUpdatedLaterThan(int time) → bool

Available on BaseMessage, provided by the BaseMessageInternal extension

isResendable() → bool
Returns true if this message can be resend.
inherited
mentioned({User? user, User? byOtherUser}) → bool

Available on BaseMessage, provided by the BaseMessageInternal extension

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
override