Modal
Constructors
Constructor
new Modal():
Modal
Returns
Modal
Properties
| Property | Modifier | Type | Default value | Description |
|---|---|---|---|---|
components | public | Row<BaseModalComponent>[] | [] | The components of the modal |
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 |
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. |
title | abstract | string | undefined | The title of the modal |
Methods
run()
abstractrun(interaction,data):unknown
Parameters
| Parameter | Type |
|---|---|
interaction | ModalInteraction |
data | ComponentData |
Returns
unknown
serialize()
serialize():
APIModalInteractionResponseCallbackData
Returns
APIModalInteractionResponseCallbackData