ScheduledUserMessageCreateParams

class ScheduledUserMessageCreateParams(scheduledAt: Long) : ScheduledBaseMessageCreateParams

Represents a scheduled user message params.

Since

4.0.0

See also

Constructors

Link copied to clipboard
fun ScheduledUserMessageCreateParams(scheduledAt: Long)

Functions

Link copied to clipboard
fun copy(scheduledAt: Long = this.scheduledAt, message: String = this.message, translationTargetLanguages: List<String>? = this.translationTargetLanguages, 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): ScheduledUserMessageCreateParams
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.

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

The data of the message.

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

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
@SerializedName(value = "message")
var message: String

The message text of the message.

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

Meta arrays of the message. Defaults to null.

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

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

The translation target languages. Defaults to null.