APIFileComponent

A File is a top-level component that allows you to display an uploaded file as an attachment to the message and reference it in the component.

Each file component can only display 1 attached file, but you can upload multiple files and add them to different file components within your payload.

Files are only available in messages.

@see

https://discord.com/developers/docs/components/reference#file

Hierarchy

• APIBaseComponent<ComponentType.File>
  • APIFileComponent

Index

Properties

• file
• id
• spoiler
• type

Properties

file

file: APIUnfurledMediaItem

This unfurled media item is unique in that it only support attachment references using the attachment://<filename> syntax

optionalinheritedid

id?: number

Inherited from APIBaseComponent.id

32 bit integer used as an optional identifier for component

The id field is optional and is used to identify components in the response from an interaction that aren't interactive components. The id must be unique within the message and is generated sequentially if left empty. Generation of ids won't use another id that exists in the message if you have one defined for another component.

optionalspoiler

spoiler?: boolean

Whether the media should be a spoiler (or blurred out)

@defaultValue

false

inheritedtype

type: File

Inherited from APIBaseComponent.type

The type of the component