FileMessage class

Object representing a file.

Inheritance

• Object
• RootMessage
• BaseMessage
• FileMessage

Available extensions

• BaseMessageExtensions

Annotations

• @JsonSerializable()

Constructors

FileMessage({required String channelUrl, required ChannelType channelType, required int messageId, required String url, String? name, int? size = 0, String? type, List<Thumbnail>? thumbnails, bool requireAuth = false, File? file, String? requestId, String? message, SendingStatus? sendingStatus, Sender? sender, List<User> mentionedUsers = const [], MentionType mentionType = MentionType.users, int createdAt = 0, int updatedAt = 0, int? parentMessageId, 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>? parentMessage})

FileMessage.fromJson(Map<String, dynamic> json)

factory

FileMessage.fromJsonWithChat(Chat chat, Map<String, dynamic> json)

factory

FileMessage.fromParams({required FileMessageCreateParams params, required BaseChannel channel})

factory

Properties

allMetaArrays ↔ List<MessageMetaArray>?

All MessageMetaArrays of the message.

getter/setter pair, inherited

channelType ↔ ChannelType

The ChannelType of the channel this message belongs to.

getter/setter pair, inherited

channelUrl ↔ String

The channel URL of the channel this message belongs to.

getter/setter pair, inherited

chat ↔ Chat

getter/setter pair, inherited

createdAt ↔ int

The creation time of the message in milliseconds.

getter/setter pair, inherited

customType ↔ String?

The custom type of the message.

getter/setter pair, inherited

data ↔ String?

The custom data of the message.

getter/setter pair, inherited

errorCode ↔ int?

The error code of them message if the sendingStatus is SendingStatus.failed.

getter/setter pair, inherited

extendedMessage ↔ Map<String, dynamic>

extendedMessage is used for Sendbird UiKit. Only featured in GroupChannel

getter/setter pair, inherited

file ↔ File?

getter/setter pair

forceUpdateLastMessage → bool

final, inherited

hashCode → int

The hash code for this object.

no setter, override

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 pair, inherited

isReplyToChannel ↔ bool

Determines whether the current message is a replied message and also a message was replied to the channel.

getter/setter pair, inherited

isSilent ↔ bool

Checks whether the message is silent or not.

getter/setter pair, inherited

mentionedUserIds ↔ List<String>

getter/setter pair, inherited

mentionedUsers ↔ List<User>

The mentioned users of the message.

getter/setter pair, inherited

mentionType ↔ MentionType

The mention type. Refer to MentionType.

getter/setter pair, inherited

message ↔ String

The message text of the message.

getter/setter pair, inherited

messageCreateParams ↔ FileMessageCreateParams?

FileMessageCreateParams object that used for sending this message.

getter/setter pair

messageId ↔ int

The ID of the message.

getter/setter pair, inherited

messageSurvivalSeconds ↔ int?

getter/setter pair, inherited

messageType → MessageType

no setter, inherited

name ↔ String?

Represents the name of the file.

getter/setter pair

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 pair, inherited

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 pair, inherited

parentMessageId ↔ int?

The parent message's ID if this is a reply message.

getter/setter pair, inherited

reactions ↔ List<Reaction>?

The reactions on the message.

getter/setter pair, inherited

requestId ↔ String?

The request ID of the message.

getter/setter pair, inherited

requireAuth ↔ bool

getter/setter pair

rootId → String

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

scheduledInfo ↔ ScheduledInfo?

The scheduled info of the message if this is a scheduled message

getter/setter pair, inherited

secureUrl → String

The secure file URL.

no setter

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 pair, inherited

sendingStatus ↔ SendingStatus?

The sending status of the message.

getter/setter pair, inherited

size ↔ int?

Represents the size of the file.

getter/setter pair

threadInfo ↔ ThreadInfo?

The thread info of the message.

getter/setter pair, inherited

thumbnails ↔ List<Thumbnail>?

Represents the thumbnail information of image file. To make thumbnail of image when you send it, please refer to BaseChannelMessage.sendFileMessage.

getter/setter pair

type ↔ String?

Represents the type of the file. MIME preferred.

getter/setter pair

updatedAt ↔ int

The updated time of the message in milliseconds.

getter/setter pair, inherited

url → String

The file URL.

final

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.

override