Represents a scheduled user message params.

interface ScheduledUserMessageCreateParams {
    appleCriticalAlertOptions?: AppleCriticalAlertOptions;
    customType?: string;
    data?: string;
    isPinnedMessage?: boolean;
    isReplyToChannel?: boolean;
    mentionType?: MentionType;
    mentionedMessageTemplate?: string;
    mentionedUserIds?: string[];
    mentionedUsers?: User[];
    message: string;
    metaArrays?: MessageMetaArray[];
    parentMessageId?: number;
    pollId?: number;
    pushNotificationDeliveryOption?: PushNotificationDeliveryOption;
    scheduledAt?: number;
    translationTargetLanguages?: string[];
}

Hierarchy (view full)

Properties

appleCriticalAlertOptions?: AppleCriticalAlertOptions

The apple critical alert options of the message.

customType?: string

The custom type of the message.

data?: string

The data of the message.

isPinnedMessage?: boolean

Whether the message should be pinned to the channel. (default: false)

isReplyToChannel?: boolean

Whether the message should also be sent to the channel. (default: false)

mentionType?: MentionType

The mention type of the message. (default: MentionType.USERS).

mentionedMessageTemplate?: string

The mentioned message template.

mentionedUserIds?: string[]

The mentioned user IDs of the message.

mentionedUsers?: User[]

The mentioned users of the message.

message: string

The message text of the message.

metaArrays?: MessageMetaArray[]

The meta arrays of the message.

parentMessageId?: number

The parent message ID of the message.

pollId?: number

The poll id of the message.

pushNotificationDeliveryOption?: PushNotificationDeliveryOption

The push notification delivery option user of the message.

scheduledAt?: number

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.

translationTargetLanguages?: string[]

The translation target languages.