Interface FileMessageCreateParams

Description

Represents a file message params.

Hierarchy

Properties

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

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 file

file?: FileCompat

The file object of the message.

Optional fileName

fileName?: string

The file's name of the message.

Optional fileSize

fileSize?: number

The file's size of the message.

Optional fileUrl

fileUrl?: string

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

Optional metaArrays

metaArrays?: MessageMetaArray[]

The meta arrays of the message.

Optional mimeType

mimeType?: string

The file's mime type of the message.

Optional parentMessageId

parentMessageId?: number

The parent message ID of the message.

Optional pushNotificationDeliveryOption

pushNotificationDeliveryOption?: PushNotificationDeliveryOption

The push notification delivery option user of the message.

Optional thumbnailSizes

thumbnailSizes?: ThumbnailSize[]

The file's thumbnail sizes of the message.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc