FileMessageParams class Null safety
An object consists a set of parameters for file message.
- Inheritance
-
- Object
- BaseMessageParams
- FileMessageParams
Constructors
- FileMessageParams.withFile(File file, {String? name})
- NOTE: Not supported for Web
- FileMessageParams.withFileBytes(Uint8List data, {String? name, String? fileExtensionType})
- FileMessageParams.withMessage(FileMessage fileMessage, {bool? deepCopy})
- NOTE: should use this constructor when updating message
- FileMessageParams.withUrl(String fileUrl, {String? mimeType, int? size, String? name})
Properties
- customType ↔ String?
-
Customize message's type to filter
read / writeinherited
- data ↔ String?
-
Message data. The default value is
null
read / writeinherited - hashCode → int
-
The hash code for this object.
read-onlyinherited
- isPinnedMessage ↔ bool
-
Pinned Message
read / writeinherited
-
mentionedUserIds
↔ List<
String> ? -
Mention to specific users. If sends a message with this field,
the message will be arrived to mentioned users.
read / writeinherited
-
mentionedUsers
↔ List<
User> ? -
The list of users who was mentioned together with this message.
read / writeinherited
- mentionType ↔ MentionType?
-
Mention type
read / writeinherited
-
metaArrays
↔ List<
MessageMetaArray> ? -
Meta array with keys and values
read / writeinherited
- parentMessageId ↔ int?
-
The unique ID of a parent message. A parent message is a message
that has a thread of replies. If the message sent through the
BaseChannel.sendUserMessage
orBaseChannel.sendFileMessage
method is a parent message, the value of this property is 0. If the message is a reply to a parent message, the value is the message ID of the parent message.read / writeinherited - pushOption ↔ PushNotificationDeliveryOption
-
The push notification delivery option that determines how to deliver
the push notification when sending a user or a file message.
read / writeinherited
- replyToChannel ↔ bool
-
Allow Reply to Channel The default is
false
read / writeinherited - runtimeType → Type
-
A representation of the runtime type of the object.
read-onlyinherited
-
thumbnailSizes
↔ List<
Size> ? -
Thumbnail sizes. This parameter is the array of
Size
and works for image file onlyread / write - uploadFile ↔ FileInfo
-
Binary file data.
read / write
Methods
-
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.
inherited