SendbirdChat/com.sendbird.android.params/UserMessageCreateParams

UserMessageCreateParams

class UserMessageCreateParams @JvmOverloads constructor(var message: String = "") : BaseMessageCreateParams

Represents a user message params.

Since

3.0.52

See also

BaseChannel.sendUserMessage

Constructors

UserMessageCreateParams

constructor(message: String = "")

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.

isPinnedMessage

@SerializedName(value = "isPinnedMessage")

var isPinnedMessage: Boolean

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

mentionedMessageTemplate

@SerializedName(value = "mentionedMessageTemplate")

var mentionedMessageTemplate: String?

The message's mentioned message template of the message. Defaults to null.

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.

@SerializedName(value = "message")

var message: String

The message text of the message. Defaults to an empty string.

var metaArrays: List<MessageMetaArray>?

The meta arrays of the message. Defaults to null.

parentMessageId

@SerializedName(value = "parentMessageId")

var parentMessageId: Long

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

@SerializedName(value = "pollId")

var pollId: Long?

The poll id of the message. Defaults to null.

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.

translationTargetLanguages

@SerializedName(value = "translationTargetLanguages")

var translationTargetLanguages: List<String>?

The translation target languages. Defaults to null.

Functions

fun copy(message: String = this.message, translationTargetLanguages: List<String>? = this.translationTargetLanguages, pollId: Long? = this.pollId, mentionedMessageTemplate: String? = this.mentionedMessageTemplate, 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): UserMessageCreateParams

open override fun toString(): String