FileMessage class Null safety

Represents media type message, typically serve image or video type message.

Inheritance
Available Extensions
Annotations

Constructors

FileMessage({required String url, String? name, int? size = 0, String? type, List<Thumbnail>? thumbnails, bool requireAuth = false, File? localFile, String? requestId, String? message, required int messageId, MessageSendingStatus? sendingStatus, Sender? sender, required String channelUrl, required ChannelType channelType, List<User> mentionedUsers = const [], List<String>? mentionedUserIds, MentionType? mentionType, List<String>? requestedMentionUserIds, 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, bool replyToChannel = false, Map<String, dynamic>? parentMessage, bool isPinnedMessage = false})
FileMessage.fromJson(Map<String, dynamic> json)
factory
FileMessage.fromParams({required FileMessageParams params, required BaseChannel channel})
factory

Properties

channelType ↔ ChannelType
Channel type of this message
read / writeinherited
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
read / writeinherited
errorCode ↔ int?
The error code of this message. This value generated only when message send fails.
read / writeinherited
extendedMessage ↔ Map<String, dynamic>
Only featured in GroupChannel Message Template used for Sendbird UI KIT
read / writeinherited
forceUpdateLastMessage → bool
True if this message should update last message of its channel
finalinherited
hashCode → int
The hash code for this object.
read-onlyoverride
isOperatorMessage → bool
True if this message was created by an operator.
finalinherited
isPinnedMessage ↔ bool
Pinned Message
read / writeinherited
isSilent → bool
True if this message won't affect unread message count / mention count
finalinherited
localFile ↔ File?
read / write
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.
read / writeinherited
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
read / writeinherited
name → String?
Name of this file message
final
ogMetaData → OGMetaData?
Open graph information in this message. Nullable
finalinherited
parentMessage ↔ BaseMessage?
Retrieve current message's parent information
read / writeinherited
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
reactions ↔ List<Reaction>?
reactions for this message
read / writeinherited
replyToChannel ↔ bool
Option to reply to channel. The default is false
read / writeinherited
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
requireAuth → bool
True if this requires auth to access this media, otherwise false.
final
runtimeType → Type
A representation of the runtime type of the object.
read-onlyinherited
scheduledInfo ↔ ScheduledInfo?
Scheduled message information
read / writeinherited
secureUrl → String?
Secure url address for media that this file message has
read-only
sender ↔ Sender?
Sender of this message
read / writeinherited
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.
read / writeinherited
size → int?
Size of this file message
final
threadInfo ↔ ThreadInfo?
The thread info that belongs to this message object.
read / writeinherited
thumbnails → List<Thumbnail>?
Thumbnails list of this message
final
type → String?
Type of this file message
final
updatedAt → int
Message update time in millisecond(UTC).
finalinherited
url → String
Url address for media that this file message has
final

Methods

applyReactionEvent(ReactionEvent event) → bool
Applies ReactionEvent to this message.
inherited
applyThreadInfoUpdateEvent(ThreadInfoUpdateEvent event) → bool
Applies ThreadInfoUpdateEvent event to this message.
inherited
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
isResendable() → bool
Returns true if this message can be resend.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent 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