ScheduledFileMessageCreateParams

Represents a scheduled file message params.

Since

4.0.0

See also

Constructors

Link copied to clipboard
constructor(scheduledAt: Long)

Properties

Link copied to clipboard
@SerializedName(value = "appleCriticalAlertOptions")
var appleCriticalAlertOptions: AppleCriticalAlertOptions?

The apple critical alert options of the message. Defaults to null.

Link copied to clipboard
@SerializedName(value = "customType")
var customType: String?

The custom type of the message.

Link copied to clipboard
@SerializedName(value = "data")
var data: String?

The data of the message.

Link copied to clipboard
var file: File?

The file of the message. If fileUrl is set after, this file will be invalidated.

Link copied to clipboard
@SerializedName(value = "fileName")
var fileName: String?

The file name of the file of the message. Defaults to null.

Link copied to clipboard
@SerializedName(value = "fileSize")
var fileSize: Int?

The file size of the file of the message. Defaults to null.

Link copied to clipboard

The file url of the message. If file is set after, this url will be invalidated.

Link copied to clipboard

The mentioned user ids of the message. Defaults to null.

Link copied to clipboard
@SerializedName(value = "mentionType")
var mentionType: MentionType

The mention type of the message. Defaults to MentionType.USERS.

Link copied to clipboard

Meta arrays of the message. Defaults to null.

Link copied to clipboard
@SerializedName(value = "mimeType")
var mimeType: String?

The mime type of the file of the message. Defaults to null.

Link copied to clipboard
@SerializedName(value = "pushNotificationDeliveryOption")
var pushNotificationDeliveryOption: PushNotificationDeliveryOption?

The push notification delivery option of the message. Defaults to null.

Link copied to clipboard
@SerializedName(value = "scheduledAt")
val scheduledAt: Long

The schedule time to send the message, in Unix milliseconds format. The messages are scheduled in minutes, and values less than minutes are discarded. The term between current time and scheduledAt should be between 5 minutes (depending on the app attribute minimum_interval_for_scheduling) and 30 days

Link copied to clipboard
@SerializedName(value = "thumbnailSizes")
var thumbnailSizes: List<ThumbnailSize>?

The thumbnail sizes the file's thumbnail of the message. Defaults to null.

Functions

Link copied to clipboard
fun copy(scheduledAt: Long = this.scheduledAt, fileUrl: String? = this.fileUrl, file: File? = this.file, fileName: String? = this.fileName, mimeType: String? = this.mimeType, fileSize: Int? = this.fileSize, thumbnailSizes: List<ThumbnailSize>? = this.thumbnailSizes, data: String? = this.data, customType: String? = this.customType, mentionType: MentionType = this.mentionType, mentionedUserIds: List<String>? = this.mentionedUserIds, metaArrays: List<MessageMetaArray>? = this.metaArrays, appleCriticalAlertOptions: AppleCriticalAlertOptions? = this.appleCriticalAlertOptions, pushNotificationDeliveryOption: PushNotificationDeliveryOption? = this.pushNotificationDeliveryOption): ScheduledFileMessageCreateParams
Link copied to clipboard
open override fun toString(): String