File
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.
Extends
Constructors
Constructor
new File(
file,spoiler?):File
Parameters
| Parameter | Type |
|---|---|
file | `attachment://${string}` |
spoiler? | boolean |
Returns
File
Overrides
Properties
| Property | Modifier | Type | Default value | Description | Overrides | Inherited from |
|---|---|---|---|---|---|---|
file | public | `attachment://${string}` | undefined | The attachment to display in the file component. | - | - |
id? | public | number | undefined | 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 by Discord if left empty. Generation of ids won't use another id that exists in the message if you have one defined for another component. | - | BaseComponent.id |
isV2 | readonly | true | true | Whether the component is a v2 component and requires the IS_COMPONENTS_V2 flag | BaseComponent.isV2 | - |
spoiler | public | boolean | false | Whether the file should be displayed as a spoiler. | - | - |
type | readonly | File | undefined | The type of the component | BaseComponent.type | - |
Methods
serialize()
serialize():
APIFileComponent
Returns
APIFileComponent
Overrides
BaseComponent.serialize