AdminMessage class

Object representing an admin message.

Inheritance
Available Extensions
Annotations
  • @JsonSerializable()

Constructors

AdminMessage({required String channelUrl, required ChannelType channelType, required int messageId, required String message, SendingStatus? sendingStatus, String? requestId, List<User> mentionedUsers = const [], MentionType mentionType = MentionType.users, int createdAt = 0, int updatedAt = 0, int? parentMessageId, Map<String, dynamic>? parentMessage, ThreadInfo? threadInfo, List<MessageMetaArray>? metaArrays, String? customType, int? messageSurvivalSeconds, bool forceUpdateLastMessage = false, bool isSilent = false, bool isOperatorMessage = false, String? data, OGMetaData? ogMetaData, List<Reaction>? reactions, bool replyToChannel = false, Map<String, dynamic>? extendedMessage})
AdminMessage.fromJson(Map<String, dynamic> json)
factory
AdminMessage.fromJsonWithChat(Chat chat, Map<String, dynamic> json)
factory

Properties

allMetaArrays List<MessageMetaArray>?
All MessageMetaArrays of the message.
getter/setter pairinherited
channelType ChannelType
The ChannelType of the channel this message belongs to.
getter/setter pairinherited
channelUrl String
The channel URL of the channel this message belongs to.
getter/setter pairinherited
chat ↔ Chat
getter/setter pairinherited
createdAt int
The creation time of the message in milliseconds.
getter/setter pairinherited
customType String?
The custom type of the message.
getter/setter pairinherited
data String?
The custom data of the message.
getter/setter pairinherited
errorCode int?
The error code of them message if the sendingStatus is SendingStatus.failed.
getter/setter pairinherited
extendedMessage Map<String, dynamic>
extendedMessage is used for Sendbird UiKit. Only featured in GroupChannel
getter/setter pairinherited
forceUpdateLastMessage bool
finalinherited
hashCode int
The hash code for this object.
no setterinherited
isOperatorMessage bool
Whether the message was sent from an operator. This value is true if the sender of this message was an operator at the moment this message was sent. Note that Sender.role returns the role of the sender at the current moment (when the server response was sent). So if the sender's operator status changed after sending a message, the value of the property and the result of Sender.role might differ.
getter/setter pairinherited
isReplyToChannel bool
Determines whether the current message is a replied message and also a message was replied to the channel.
getter/setter pairinherited
isSilent bool
Checks whether the message is silent or not.
getter/setter pairinherited
mentionedUserIds List<String>
getter/setter pairinherited
mentionedUsers List<User>
The mentioned users of the message.
getter/setter pairinherited
mentionType MentionType
The mention type. Refer to MentionType.
getter/setter pairinherited
message String
The message text of the message.
getter/setter pairinherited
messageId int
The ID of the message.
getter/setter pairinherited
messageSurvivalSeconds int?
getter/setter pairinherited
messageType MessageType
no setterinherited
ogMetaData OGMetaData?
The OGMetaData of the message. (https://ogp.me/) Might be null if Application does not support OG-TAG. (all new applications support OG-TAG by default) The message does not contain a valid url. The server did not fetch the OG-Tag yet.
getter/setter pairinherited
parentMessage BaseMessage?
The parent message of this message. Only NonNull if this message is a reply message. It does not contain all properties of the parent message. Only contains: BaseMessage.message. BaseMessage.sender. (null if the parent message is an AdminMessage). BaseMessage.createdAt. File information if it's a FileMessage. FileMessage.name. FileMessage.type. FileMessage.url. FileMessage.data. This is only for accessing parent message's information (READ ONLY) and should not to be used to modify the parent message.
getter/setter pairinherited
parentMessageId int?
The parent message's ID if this is a reply message.
getter/setter pairinherited
reactions List<Reaction>?
The reactions on the message.
getter/setter pairinherited
requestId String?
The request ID of the message.
getter/setter pairinherited
rootId String
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
scheduledInfo ScheduledInfo?
The scheduled info of the message if this is a scheduled message
getter/setter pairinherited
sender Sender?
The Sender of the message. If SendbirdChatOptions.useMemberInfoInMessage is set true and this message belongs to a GroupChannel (not a super group channel), the sender information, such as nickname and profile url, is returned as the same with the GroupChannel.members. Otherwise, the sender information will be returned as the value of the message creation time.
getter/setter pairinherited
sendingStatus SendingStatus?
The sending status of the message.
getter/setter pairinherited
threadInfo ThreadInfo?
The thread info of the message.
getter/setter pairinherited
updatedAt int
The updated time of the message in milliseconds.
getter/setter pairinherited

Methods

applyReactionEvent(ReactionEvent event) bool
Applies ReactionEvent to message.
inherited
applyThreadInfoUpdateEvent(ThreadInfoUpdateEvent event) bool
Applies ThreadInfoUpdateEvent to a message.
inherited
getMessageId() → dynamic
inherited
getMetaArrays(List<String> keys) List<MessageMetaArray>
Returns MessageMetaArray list which is filtered by given metaArrayKeys.
inherited
getThreadedMessagesByTimestamp(int timestamp, ThreadedMessageListParams params) Future<ThreadedMessages>
Retrieves the threaded replies of the current message depending on the timestamp. If the current message doesn’t have replies, the result is an empty list. The result is passed to handler as list.
inherited
isResendable() bool
Whether the message is resendable.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
serialize() Uint8List
inherited
set(Chat chat) → void
inherited
toJson() Map<String, dynamic>
override
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited