ScheduledFileMessageParams class

An object consists a set of parameters to create scheduled user message.

Constructors

ScheduledFileMessageParams.withFile(File file, {String? name, String? data, required int scheduledAt, String? customType, bool requiredAuth = true, bool sendPush = true, bool isSilent = false, bool markAsRead = true, List<MessageMetaArray>? metaArrays, AppleCriticalAlertOptions? appleCriticalAlertOptions, String? apnsBundleId, PushNotificationDeliveryOption pushOption = PushNotificationDeliveryOption.normal, MentionType mentionType = MentionType.users})

ScheduledFileMessageParams.withUrl(String fileUrl, {String? fileType, int? size, String? name, String? data, required int scheduledAt, String? customType, bool requiredAuth = true, bool sendPush = true, bool isSilent = false, bool markAsRead = true, List<MessageMetaArray>? metaArrays, String? apnsBundleId, AppleCriticalAlertOptions? appleCriticalAlertOptions, PushNotificationDeliveryOption pushOption = PushNotificationDeliveryOption.normal, MentionType mentionType = MentionType.users})

Properties

apnsBundleId ↔ String?

Specifies the bundle ID of the client app in order to send a push notification to iOS devices.

getter/setter pair

appleCriticalAlertOptions ↔ AppleCriticalAlertOptions?

Specifies options that support Apple critical alerts and checks whether the message is a critical alert.

getter/setter pair

customType ↔ String?

Specifies a custom message type which is used for message grouping. The length is limited to 128 characters.

getter/setter pair

data ↔ String?

Specifies additional message information such as custom font size, font type or JSON formatted string.

getter/setter pair

dedupId ↔ String?

Specifies the unique message ID created by other system. In general, this property is used to prevent the same message data from getting inserted when migrating the messages of the other system to Sendbird server. If specified, the server performs a duplicate check using the property value.

getter/setter pair

fileType ↔ String?

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

isSilent → bool

Determines whether to send a message without updating some of the channel properties. If set to true, the channel's last_message is updated only for the sender while its unread_message_count remains unchanged for all channel members. Also, a push notification isn't sent to the users who receive the message. If the message is sent to a hidden channel, the channel still remains hidden. (Default: false)

final

markAsRead → bool

Determines whether to mark the message as read for the sender. If set to false, then the sender's unread_count and read_receipt remain unchanged after the message is sent. (Default: true)

final

mentionedUserIds ↔ List<String>?

Specifies an array of one or more IDs of the users who will get a notification for the message.

getter/setter pair

mentionType → MentionType

Specifies the mentioning method which indicates the user scope who will get a notification for the message. If set to channel, all users in the channel will get notified. (Default: users)

final

metaArrays ↔ List<MessageMetaArray>?

Specifies a JSON object of one or more key-values items which store additional message information.

getter/setter pair

name ↔ String?

getter/setter pair

pushOption → PushNotificationDeliveryOption

3 types: default, suppress, force

final

reqId ↔ String?

Additional ID which is sent from the SDK. SDK uses this ID to identify each message.

getter/setter pair

requiredAuth → bool

Determines whether or not the file in the message and generated thumbnail images can be only accessed by the users within the application who are participating in the same open channel, or who are the members of the same group channel.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

scheduledAt → int

The time to send the message, in Unix milliseconds format. Since messages are scheduled in minutes, values less than seconds are discarded. The term between current time and scheduled_at should be between 5 minutes and 30 days.

final

sendPush → bool

Determines whether to send a push notification for the message to the members of the channel (applicable to group channels only). (Default: true)

final

size ↔ int?

getter/setter pair

thumbnailSizes ↔ List<Size>?

Thumbnail sizes. This parameter is the array of Size and works for image file only

getter/setter pair

uploadFile ↔ FileInfo

Binary file data.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited