FileMessageCreateParams

class FileMessageCreateParams : BaseMessageCreateParams

Represents a file message params.

Since

3.0.52

See also

Constructors

Link copied to clipboard
fun FileMessageCreateParams()

FileMessageParams constructor.

Link copied to clipboard
fun FileMessageCreateParams(fileUrl: String)

FileMessageParams constructor.

Link copied to clipboard
fun FileMessageCreateParams(file: File)

FileMessageParams constructor.

Functions

Link copied to clipboard
fun copy(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, mentionedUsers: List<User>? = this.mentionedUsers, pushNotificationDeliveryOption: PushNotificationDeliveryOption? = this.pushNotificationDeliveryOption, metaArrays: List<MessageMetaArray>? = this.metaArrays, parentMessageId: Long = this.parentMessageId, replyToChannel: Boolean = this.replyToChannel, appleCriticalAlertOptions: AppleCriticalAlertOptions? = this.appleCriticalAlertOptions): FileMessageCreateParams
Link copied to clipboard
open override fun toString(): String

Properties

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

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

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

The custom type of the message. Defaults to null.

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

The data of the message. Defaults to null.

Link copied to clipboard
var file: File?

The file object of the message. Defaults to null. If fileUrl was set after, this will be reset to null.

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

The file's name of the messages. Defaults to null.

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

The file's size of the messages. Defaults to null.

Link copied to clipboard
var fileUrl: String?

The file's url of the message. Defaults to null. If file was set after, this will be reset to null.

Link copied to clipboard
var mentionedUserIds: List<String>?

The mentioned user ids of the message. If it hasn't set before, it returns null. Setting this will overwrite mentionedUsers.

Link copied to clipboard
var mentionedUsers: List<User>?

The mentioned users of the message. If it hasn't set before, it returns null Setting this will overwrite mentionedUserIds.

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

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

Link copied to clipboard
var metaArrays: List<MessageMetaArray>?

The meta arrays of the message. Defaults to null.

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

The file's mime type of the messages. Defaults to null.

Link copied to clipboard
@SerializedName(value = "parentMessageId")
var parentMessageId: Long = 0

The parent message id of the message. Defaults to 0.

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

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

Link copied to clipboard
@SerializedName(value = "replyToChannel")
var replyToChannel: Boolean = false

Whether the message should also be sent to the channel. Defaults to false. Only works when the parentMessageId is set.

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

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