Button
Extends
BaseButton
Constructors
Constructor
new Button():
Button
Returns
Button
Inherited from
BaseButton.constructor
Properties
| Property | Modifier | Type | Default value | Description | Inherited from |
|---|---|---|---|---|---|
customId | abstract | string | undefined | The custom ID of the component. If you want to provide a custom ID with additional data, you should either follow the default parser's format or implement your own custom parser. See customIdParser | BaseButton.customId |
customIdParser | public | (id) => ComponentParserResult | parseCustomId | This function is called by the handler when a component is received, and is used to parse the custom ID into a key and data object. By default, the ID is parsed in this format: key:arg1=true;arg2=2;arg3=cheese, where arg1, arg2, and arg3 are the data arguments. It will also automatically parse true and false as booleans, and will parse numbers as numbers. You can override this to parse the ID in a different format as you see fit, but it must follow these rules: - The ID must have a key somewhere in the ID that can be returned by the parser. This key is what Carbon's component handler will use to identify the component and pass an interaction to the correct component. - The data must be able to be arbitrary as far as Carbon's handler is concerned, meaning that any component with the same base key can be treated as the same component with logic within the component's logic methods to handle the data. | BaseButton.customIdParser |
defer | public | boolean | false | Whether the component response should be automatically deferred | BaseButton.defer |
disabled | public | boolean | false | The disabled state of the button | BaseButton.disabled |
emoji? | public | object | undefined | The emoji of the button | BaseButton.emoji |
emoji.animated? | public | boolean | undefined | - | - |
emoji.id? | public | string | undefined | - | - |
emoji.name | public | string | undefined | - | - |
ephemeral | public | boolean | false | Whether the component response should be ephemeral | BaseButton.ephemeral |
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. | BaseButton.id |
isV2 | readonly | false | false | - | BaseButton.isV2 |
label | abstract | string | undefined | The label of the button | BaseButton.label |
style | public | ButtonStyle | ButtonStyle.Primary | The style of the button | BaseButton.style |
type | readonly | Button | undefined | - | BaseButton.type |
Methods
run()
run(
interaction,data):unknown
Parameters
| Parameter | Type |
|---|---|
interaction | ButtonInteraction |
data | ComponentData |
Returns
unknown
Overrides
BaseButton.run
serialize()
serialize():
APIButtonComponent
Returns
APIButtonComponent
Overrides
BaseButton.serialize