Interface FileMessageCreateParams

Description

Represents a file message params.

interface FileMessageCreateParams {
    appleCriticalAlertOptions?: AppleCriticalAlertOptions;
    customType?: string;
    data?: string;
    file?: FileCompat;
    fileName?: string;
    fileSize?: number;
    fileUrl?: string;
    isPinnedMessage?: boolean;
    isReplyToChannel?: boolean;
    mentionType?: MentionType;
    mentionedMessageTemplate?: string;
    mentionedUserIds?: string[];
    mentionedUsers?: User[];
    metaArrays?: MessageMetaArray[];
    mimeType?: string;
    parentMessageId?: number;
    pushNotificationDeliveryOption?: PushNotificationDeliveryOption;
    thumbnailSizes?: ThumbnailSize[];
}

Hierarchy (view full)

Properties

appleCriticalAlertOptions? customType? data? file? fileName? fileSize? fileUrl? isPinnedMessage? isReplyToChannel? mentionType? mentionedMessageTemplate? mentionedUserIds? mentionedUsers? metaArrays? mimeType? parentMessageId? pushNotificationDeliveryOption? thumbnailSizes?

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.

Optionalfile

file?: FileCompat

The file object of the message.

OptionalfileName

fileName?: string

The file's name of the message.

OptionalfileSize

fileSize?: number

The file's size of the message.

OptionalfileUrl

fileUrl?: string

The file's url 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)

OptionalmentionType

mentionType?: MentionType

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

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.

OptionalmetaArrays

metaArrays?: MessageMetaArray[]

The meta arrays of the message.

OptionalmimeType

mimeType?: string

The file's mime type of the message.

OptionalparentMessageId

parentMessageId?: number

The parent message ID of the message.

OptionalpushNotificationDeliveryOption

pushNotificationDeliveryOption?: PushNotificationDeliveryOption

The push notification delivery option user of the message.

OptionalthumbnailSizes

thumbnailSizes?: ThumbnailSize[]

The file's thumbnail sizes of the message.

Settings

Member Visibility

On This Page

Properties