Interface ScheduledUserMessageCreateParams

Description

Represents a scheduled user message params.

Hierarchy

Properties

appleCriticalAlertOptions? customType? data? isPinnedMessage? isReplyToChannel? mentionType? mentionedMessageTemplate? mentionedUserIds? mentionedUsers? message metaArrays? parentMessageId? pollId? pushNotificationDeliveryOption? scheduledAt? translationTargetLanguages?

Properties

Optional appleCriticalAlertOptions

appleCriticalAlertOptions?: AppleCriticalAlertOptions

The apple critical alert options of the message.

Optional customType

customType?: string

The custom type of the message.

Optional data

data?: string

The data of the message.

Optional isPinnedMessage

isPinnedMessage?: boolean

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

Optional isReplyToChannel

isReplyToChannel?: boolean

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

Optional mentionType

mentionType?: MentionType

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

Optional mentionedMessageTemplate

mentionedMessageTemplate?: string

The mentioned message template.

Optional mentionedUserIds

mentionedUserIds?: string[]

The mentioned user IDs of the message.

Optional mentionedUsers

mentionedUsers?: User[]

The mentioned users of the message.

message

message: string

The message text of the message.

Optional metaArrays

metaArrays?: MessageMetaArray[]

The meta arrays of the message.

Optional parentMessageId

parentMessageId?: number

The parent message ID of the message.

Optional pollId

pollId?: number

The poll id of the message.

Optional pushNotificationDeliveryOption

pushNotificationDeliveryOption?: PushNotificationDeliveryOption

The push notification delivery option user of the message.

Optional scheduledAt

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.

Optional translationTargetLanguages

translationTargetLanguages?: string[]

The translation target languages.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc