UserMessageCreateParams

class UserMessageCreateParams @JvmOverloads constructor(message: String) : BaseMessageCreateParams

Represents a user message params.

Since

3.0.52

See also

Constructors

Link copied to clipboard
fun UserMessageCreateParams(message: String = "")

Functions

Link copied to clipboard
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, appleCriticalAlertOptions: AppleCriticalAlertOptions? = this.appleCriticalAlertOptions): UserMessageCreateParams
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
@SerializedName(value = "mentionedMessageTemplate")
var mentionedMessageTemplate: String? = null

The message's mentioned message template of the message. Defaults 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
@SerializedName(value = "message")
var message: String

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

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

The meta arrays of the message. 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 = "pollId")
var pollId: Long? = null

The poll id of the message. Defaults to null.

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 = "translationTargetLanguages")
var translationTargetLanguages: List<String>? = null

The translation target languages. Defaults to null.