SendbirdChat/com.sendbird.android.params/FileMessageCreateParams

FileMessageCreateParams

class FileMessageCreateParams : BaseMessageCreateParams

Represents a file message params.

Since

3.0.52

See also

BaseChannel.sendFileMessage

Constructors

FileMessageCreateParams

constructor()

FileMessageParams constructor.

constructor(fileUrl: String)

FileMessageParams constructor.

constructor(file: File)

FileMessageParams constructor.

Properties

appleCriticalAlertOptions

@SerializedName(value = "appleCriticalAlertOptions")

var appleCriticalAlertOptions: AppleCriticalAlertOptions?

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

@SerializedName(value = "customType")

var customType: String?

The custom type of the message. Defaults to null.

@SerializedName(value = "data")

var data: String?

The data of the message. Defaults to null.

var file: File?

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

@SerializedName(value = "fileName")

var fileName: String?

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

@SerializedName(value = "fileSize")

var fileSize: Int?

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

var fileUrl: String?

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

isPinnedMessage

@SerializedName(value = "isPinnedMessage")

var isPinnedMessage: Boolean

Whether the message should be pinned to the channel. Defaults to false.

mentionedUserIds

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.

var mentionedUsers: List<User>?

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

@SerializedName(value = "mentionType")

var mentionType: MentionType

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

var metaArrays: List<MessageMetaArray>?

The meta arrays of the message. Defaults to null.

@SerializedName(value = "mimeType")

var mimeType: String?

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

parentMessageId

@SerializedName(value = "parentMessageId")

var parentMessageId: Long

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

pushNotificationDeliveryOption

@SerializedName(value = "pushNotificationDeliveryOption")

var pushNotificationDeliveryOption: PushNotificationDeliveryOption?

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

@SerializedName(value = "replyToChannel")

var replyToChannel: Boolean

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

@SerializedName(value = "thumbnailSizes")

var thumbnailSizes: List<ThumbnailSize>?

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

Functions

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, isPinnedMessage: Boolean = this.isPinnedMessage, appleCriticalAlertOptions: AppleCriticalAlertOptions? = this.appleCriticalAlertOptions, uploadableFileInfo: UploadableFileInfo? = this.uploadableFileInfo): FileMessageCreateParams

open override fun toString(): String