BaseModalComponent
Extends
Extended by
Constructors
Constructor
new BaseModalComponent(
data?):BaseModalComponent
Parameters
| Parameter | Type |
|---|---|
data? | { additionalData: ComponentAdditionalData; } |
data.additionalData? | ComponentAdditionalData |
Returns
BaseModalComponent
Overrides
Properties
| Property | Modifier | Type | Default value | Description | Overrides | Inherited from |
|---|---|---|---|---|---|---|
additionalData | public | null | ComponentAdditionalData | null | - | - | - |
customId | abstract | string | undefined | The custom ID of the 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 | false | false | Whether the component is a v2 component and requires the IS_COMPONENTS_V2 flag | BaseComponent.isV2 | - |
serialize | abstract | () => APITextInputComponent | undefined | - | BaseComponent.serialize | - |
type | abstract | TextInput | undefined | The type of the component | BaseComponent.type | - |
Methods
createId()
createId(
additionalData):string
Create a custom ID to use for this component that embeds additional data that you want to be handed
Parameters
| Parameter | Type | Description |
|---|---|---|
additionalData | null | ComponentAdditionalData | The additional data that you want to be passed in this component's custom ID |
Returns
string
The custom ID to use