Interface UserMessageCreateParams

Represents a user message params.

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

Hierarchy (view full)

Properties

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

Properties

OptionalappleCriticalAlertOptions

appleCriticalAlertOptions?: AppleCriticalAlertOptions

The apple critical alert options of the message.

OptionalcustomType

customType?: string

The custom type of the message.

Optionaldata

data?: string

The data of the message.

OptionalisPinnedMessage

isPinnedMessage?: boolean

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

OptionalisReplyToChannel

isReplyToChannel?: boolean

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

OptionalmentionedMessageTemplate

mentionedMessageTemplate?: string

The mentioned message template.

OptionalmentionedUserIds

mentionedUserIds?: string[]

The mentioned user IDs of the message.

OptionalmentionedUsers

mentionedUsers?: User[]

The mentioned users of the message.

OptionalmentionType

mentionType?: MentionType

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

message

message: string

The message text of the message.

OptionalmetaArrays

metaArrays?: MessageMetaArray[]

The meta arrays of the message.

OptionalparentMessageId

parentMessageId?: number

The parent message ID of the message.

OptionalpollId

pollId?: number

The poll id of the message.

OptionalpushNotificationDeliveryOption

pushNotificationDeliveryOption?: PushNotificationDeliveryOption

The push notification delivery option user of the message.

OptionaltranslationTargetLanguages

translationTargetLanguages?: string[]

The translation target languages.

Settings

Member Visibility

On This Page

Properties