@buape/carbon 0.1.3 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/package.json +7 -2
- package/dist/src/abstracts/BaseCommand.d.ts +1 -6
- package/dist/src/abstracts/BaseCommand.d.ts.map +1 -1
- package/dist/src/abstracts/BaseCommand.js +0 -5
- package/dist/src/abstracts/BaseCommand.js.map +1 -1
- package/dist/src/abstracts/BaseComponentInteraction.d.ts +6 -1
- package/dist/src/abstracts/BaseComponentInteraction.d.ts.map +1 -1
- package/dist/src/abstracts/BaseComponentInteraction.js +12 -0
- package/dist/src/abstracts/BaseComponentInteraction.js.map +1 -1
- package/dist/src/abstracts/BaseInteraction.d.ts +14 -7
- package/dist/src/abstracts/BaseInteraction.d.ts.map +1 -1
- package/dist/src/abstracts/BaseInteraction.js +29 -8
- package/dist/src/abstracts/BaseInteraction.js.map +1 -1
- package/dist/src/classes/Client.d.ts +11 -0
- package/dist/src/classes/Client.d.ts.map +1 -1
- package/dist/src/classes/Client.js +43 -11
- package/dist/src/classes/Client.js.map +1 -1
- package/dist/src/classes/Modal.d.ts +21 -0
- package/dist/src/classes/Modal.d.ts.map +1 -0
- package/dist/src/classes/Modal.js +14 -0
- package/dist/src/classes/Modal.js.map +1 -0
- package/dist/src/classes/Row.d.ts +7 -9
- package/dist/src/classes/Row.d.ts.map +1 -1
- package/dist/src/classes/Row.js +5 -4
- package/dist/src/classes/Row.js.map +1 -1
- package/dist/src/classes/TextInput.d.ts +40 -0
- package/dist/src/classes/TextInput.d.ts.map +1 -0
- package/dist/src/classes/TextInput.js +44 -0
- package/dist/src/classes/TextInput.js.map +1 -0
- package/dist/src/index.d.ts +3 -0
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/index.js +3 -0
- package/dist/src/index.js.map +1 -1
- package/dist/src/internals/AutocompleteInteraction.d.ts +1 -1
- package/dist/src/internals/CommandHandler.d.ts +4 -0
- package/dist/src/internals/CommandHandler.d.ts.map +1 -1
- package/dist/src/internals/CommandHandler.js +4 -0
- package/dist/src/internals/CommandHandler.js.map +1 -1
- package/dist/src/internals/ComponentHandler.d.ts +11 -0
- package/dist/src/internals/ComponentHandler.d.ts.map +1 -1
- package/dist/src/internals/ComponentHandler.js +15 -4
- package/dist/src/internals/ComponentHandler.js.map +1 -1
- package/dist/src/internals/FieldsHandler.d.ts +27 -0
- package/dist/src/internals/FieldsHandler.d.ts.map +1 -0
- package/dist/src/internals/FieldsHandler.js +37 -0
- package/dist/src/internals/FieldsHandler.js.map +1 -0
- package/dist/src/internals/ModalHandler.d.ts +17 -0
- package/dist/src/internals/ModalHandler.d.ts.map +1 -0
- package/dist/src/internals/ModalHandler.js +25 -0
- package/dist/src/internals/ModalHandler.js.map +1 -0
- package/dist/src/internals/ModalInteraction.d.ts +10 -0
- package/dist/src/internals/ModalInteraction.d.ts.map +1 -0
- package/dist/src/internals/ModalInteraction.js +12 -0
- package/dist/src/internals/ModalInteraction.js.map +1 -0
- package/dist/src/internals/OptionsHandler.d.ts +33 -17
- package/dist/src/internals/OptionsHandler.d.ts.map +1 -1
- package/dist/src/internals/OptionsHandler.js +52 -58
- package/dist/src/internals/OptionsHandler.js.map +1 -1
- package/dist/src/utils.d.ts +3 -0
- package/dist/src/utils.d.ts.map +1 -1
- package/dist/src/utils.js +54 -0
- package/dist/src/utils.js.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +6 -1
- package/.turbo/turbo-build.log +0 -5
- package/.turbo/turbo-dev.log +0 -175
- package/.turbo/turbo-docs.log +0 -12
- package/CHANGELOG.md +0 -34
- package/dist/src/abstracts/ButtonInteraction.d.ts +0 -8
- package/dist/src/abstracts/ButtonInteraction.d.ts.map +0 -1
- package/dist/src/abstracts/ButtonInteraction.js +0 -18
- package/dist/src/abstracts/ButtonInteraction.js.map +0 -1
- package/dist/src/abstracts/ChannelSelectMenuInteraction.d.ts +0 -7
- package/dist/src/abstracts/ChannelSelectMenuInteraction.d.ts.map +0 -1
- package/dist/src/abstracts/ChannelSelectMenuInteraction.js +0 -11
- package/dist/src/abstracts/ChannelSelectMenuInteraction.js.map +0 -1
- package/dist/src/abstracts/CommandHandler.d.ts +0 -6
- package/dist/src/abstracts/CommandHandler.d.ts.map +0 -1
- package/dist/src/abstracts/CommandHandler.js +0 -65
- package/dist/src/abstracts/CommandHandler.js.map +0 -1
- package/dist/src/abstracts/CommandInteraction.d.ts +0 -15
- package/dist/src/abstracts/CommandInteraction.d.ts.map +0 -1
- package/dist/src/abstracts/CommandInteraction.js +0 -60
- package/dist/src/abstracts/CommandInteraction.js.map +0 -1
- package/dist/src/abstracts/ComponentHandler.d.ts +0 -6
- package/dist/src/abstracts/ComponentHandler.d.ts.map +0 -1
- package/dist/src/abstracts/ComponentHandler.js +0 -64
- package/dist/src/abstracts/ComponentHandler.js.map +0 -1
- package/dist/src/abstracts/MentionableSelectMenuInteraction.d.ts +0 -8
- package/dist/src/abstracts/MentionableSelectMenuInteraction.d.ts.map +0 -1
- package/dist/src/abstracts/MentionableSelectMenuInteraction.js +0 -15
- package/dist/src/abstracts/MentionableSelectMenuInteraction.js.map +0 -1
- package/dist/src/abstracts/RoleSelectMenuInteraction.d.ts +0 -8
- package/dist/src/abstracts/RoleSelectMenuInteraction.d.ts.map +0 -1
- package/dist/src/abstracts/RoleSelectMenuInteraction.js +0 -14
- package/dist/src/abstracts/RoleSelectMenuInteraction.js.map +0 -1
- package/dist/src/abstracts/StringSelectMenuInteraction.d.ts +0 -8
- package/dist/src/abstracts/StringSelectMenuInteraction.d.ts.map +0 -1
- package/dist/src/abstracts/StringSelectMenuInteraction.js +0 -14
- package/dist/src/abstracts/StringSelectMenuInteraction.js.map +0 -1
- package/dist/src/abstracts/UserSelectMenuInteraction.d.ts +0 -8
- package/dist/src/abstracts/UserSelectMenuInteraction.d.ts.map +0 -1
- package/dist/src/abstracts/UserSelectMenuInteraction.js +0 -14
- package/dist/src/abstracts/UserSelectMenuInteraction.js.map +0 -1
- package/dist/src/classes/Paginator.d.ts +0 -3
- package/dist/src/classes/Paginator.d.ts.map +0 -1
- package/dist/src/classes/Paginator.js +0 -3
- package/dist/src/classes/Paginator.js.map +0 -1
- package/dist/src/structures/AnySelectMenu.d.ts +0 -31
- package/dist/src/structures/AnySelectMenu.d.ts.map +0 -1
- package/dist/src/structures/AnySelectMenu.js +0 -19
- package/dist/src/structures/AnySelectMenu.js.map +0 -1
- package/dist/src/structures/AnySelectMenuInteraction.d.ts +0 -12
- package/dist/src/structures/AnySelectMenuInteraction.d.ts.map +0 -1
- package/dist/src/structures/AnySelectMenuInteraction.js +0 -21
- package/dist/src/structures/AnySelectMenuInteraction.js.map +0 -1
- package/dist/src/structures/Base.d.ts +0 -10
- package/dist/src/structures/Base.d.ts.map +0 -1
- package/dist/src/structures/Base.js +0 -11
- package/dist/src/structures/Base.js.map +0 -1
- package/dist/src/structures/BaseCommand.d.ts +0 -64
- package/dist/src/structures/BaseCommand.d.ts.map +0 -1
- package/dist/src/structures/BaseCommand.js +0 -58
- package/dist/src/structures/BaseCommand.js.map +0 -1
- package/dist/src/structures/BaseComponent.d.ts +0 -34
- package/dist/src/structures/BaseComponent.d.ts.map +0 -1
- package/dist/src/structures/BaseComponent.js +0 -30
- package/dist/src/structures/BaseComponent.js.map +0 -1
- package/dist/src/structures/BaseComponentInteraction.d.ts +0 -9
- package/dist/src/structures/BaseComponentInteraction.d.ts.map +0 -1
- package/dist/src/structures/BaseComponentInteraction.js +0 -14
- package/dist/src/structures/BaseComponentInteraction.js.map +0 -1
- package/dist/src/structures/BaseInteraction.d.ts +0 -81
- package/dist/src/structures/BaseInteraction.d.ts.map +0 -1
- package/dist/src/structures/BaseInteraction.js +0 -99
- package/dist/src/structures/BaseInteraction.js.map +0 -1
- package/dist/src/structures/ButtonInteraction.d.ts +0 -8
- package/dist/src/structures/ButtonInteraction.d.ts.map +0 -1
- package/dist/src/structures/ButtonInteraction.js +0 -18
- package/dist/src/structures/ButtonInteraction.js.map +0 -1
- package/dist/src/structures/ChannelSelectMenuInteraction.d.ts +0 -7
- package/dist/src/structures/ChannelSelectMenuInteraction.d.ts.map +0 -1
- package/dist/src/structures/ChannelSelectMenuInteraction.js +0 -11
- package/dist/src/structures/ChannelSelectMenuInteraction.js.map +0 -1
- package/dist/src/structures/CommandHandler.d.ts +0 -6
- package/dist/src/structures/CommandHandler.d.ts.map +0 -1
- package/dist/src/structures/CommandHandler.js +0 -70
- package/dist/src/structures/CommandHandler.js.map +0 -1
- package/dist/src/structures/CommandInteraction.d.ts +0 -15
- package/dist/src/structures/CommandInteraction.d.ts.map +0 -1
- package/dist/src/structures/CommandInteraction.js +0 -60
- package/dist/src/structures/CommandInteraction.js.map +0 -1
- package/dist/src/structures/ComponentHandler.d.ts +0 -6
- package/dist/src/structures/ComponentHandler.d.ts.map +0 -1
- package/dist/src/structures/ComponentHandler.js +0 -64
- package/dist/src/structures/ComponentHandler.js.map +0 -1
- package/dist/src/structures/MentionableSelectMenuInteraction.d.ts +0 -8
- package/dist/src/structures/MentionableSelectMenuInteraction.d.ts.map +0 -1
- package/dist/src/structures/MentionableSelectMenuInteraction.js +0 -15
- package/dist/src/structures/MentionableSelectMenuInteraction.js.map +0 -1
- package/dist/src/structures/RoleSelectMenuInteraction.d.ts +0 -8
- package/dist/src/structures/RoleSelectMenuInteraction.d.ts.map +0 -1
- package/dist/src/structures/RoleSelectMenuInteraction.js +0 -14
- package/dist/src/structures/RoleSelectMenuInteraction.js.map +0 -1
- package/dist/src/structures/StringSelectMenuInteraction.d.ts +0 -8
- package/dist/src/structures/StringSelectMenuInteraction.d.ts.map +0 -1
- package/dist/src/structures/StringSelectMenuInteraction.js +0 -14
- package/dist/src/structures/StringSelectMenuInteraction.js.map +0 -1
- package/dist/src/structures/UserSelectMenuInteraction.d.ts +0 -8
- package/dist/src/structures/UserSelectMenuInteraction.d.ts.map +0 -1
- package/dist/src/structures/UserSelectMenuInteraction.js +0 -14
- package/dist/src/structures/UserSelectMenuInteraction.js.map +0 -1
- package/dist/src/types.d.ts +0 -31
- package/dist/src/types.d.ts.map +0 -1
- package/dist/src/types.js +0 -33
- package/dist/src/types.js.map +0 -1
- package/docs/classes/AnySelectMenu.mdx +0 -114
- package/docs/classes/AnySelectMenuInteraction.mdx +0 -175
- package/docs/classes/AutocompleteInteraction.mdx +0 -166
- package/docs/classes/AutocompleteOptionsHandler.mdx +0 -243
- package/docs/classes/BaseChannel.mdx +0 -97
- package/docs/classes/BaseCommand.mdx +0 -61
- package/docs/classes/BaseComponent.mdx +0 -55
- package/docs/classes/BaseComponentInteraction.mdx +0 -160
- package/docs/classes/BaseGuildChannel.mdx +0 -262
- package/docs/classes/BaseGuildTextChannel.mdx +0 -360
- package/docs/classes/BaseInteraction.mdx +0 -137
- package/docs/classes/Button.mdx +0 -99
- package/docs/classes/ButtonInteraction.mdx +0 -155
- package/docs/classes/ChannelSelectMenu.mdx +0 -122
- package/docs/classes/ChannelSelectMenuInteraction.mdx +0 -171
- package/docs/classes/Client.mdx +0 -48
- package/docs/classes/Command.mdx +0 -111
- package/docs/classes/CommandHandler.mdx +0 -65
- package/docs/classes/CommandInteraction.mdx +0 -155
- package/docs/classes/CommandWithSubcommandGroups.mdx +0 -73
- package/docs/classes/CommandWithSubcommands.mdx +0 -76
- package/docs/classes/ComponentHandler.mdx +0 -49
- package/docs/classes/DmChannel.mdx +0 -118
- package/docs/classes/GroupDmChannel.mdx +0 -197
- package/docs/classes/Guild.mdx +0 -157
- package/docs/classes/GuildAnnouncementChannel.mdx +0 -377
- package/docs/classes/GuildCategoryChannel.mdx +0 -272
- package/docs/classes/GuildForumChannel.mdx +0 -333
- package/docs/classes/GuildMediaChannel.mdx +0 -327
- package/docs/classes/GuildStageChannel.mdx +0 -276
- package/docs/classes/GuildStageOrVoiceChannel.mdx +0 -292
- package/docs/classes/GuildTextChannel.mdx +0 -367
- package/docs/classes/GuildThreadChannel.mdx +0 -425
- package/docs/classes/GuildThreadOnlyChannel.mdx +0 -333
- package/docs/classes/GuildVoiceChannel.mdx +0 -276
- package/docs/classes/LinkButton.mdx +0 -84
- package/docs/classes/MentionableSelectMenu.mdx +0 -120
- package/docs/classes/MentionableSelectMenuInteraction.mdx +0 -171
- package/docs/classes/Message.mdx +0 -126
- package/docs/classes/OptionsHandler.mdx +0 -203
- package/docs/classes/PremiumButton.mdx +0 -84
- package/docs/classes/Role.mdx +0 -228
- package/docs/classes/RoleSelectMenu.mdx +0 -120
- package/docs/classes/RoleSelectMenuInteraction.mdx +0 -171
- package/docs/classes/Row.mdx +0 -88
- package/docs/classes/StringSelectMenu.mdx +0 -120
- package/docs/classes/StringSelectMenuInteraction.mdx +0 -171
- package/docs/classes/User.mdx +0 -119
- package/docs/classes/UserSelectMenu.mdx +0 -120
- package/docs/classes/UserSelectMenuInteraction.mdx +0 -171
- package/docs/enumerations/ClientMode.mdx +0 -16
- package/docs/functions/channelFactory.mdx +0 -16
- package/docs/index.mdx +0 -83
- package/docs/type-aliases/AnySelectMenuComponentType.mdx +0 -5
- package/docs/type-aliases/ClientOptions.mdx +0 -20
- package/docs/type-aliases/CommandOptions.mdx +0 -5
- package/docs/type-aliases/ComponentAdditionalData.mdx +0 -9
- package/docs/type-aliases/InteractionFileData.mdx +0 -15
- package/docs/type-aliases/InteractionReplyData.mdx +0 -14
- package/docs/type-aliases/InteractionReplyOptions.mdx +0 -13
- package/docs/type-aliases/RawOptions.mdx +0 -9
- package/docs/type-aliases/meta.json +0 -3
- package/src/README.md +0 -7
- package/src/abstracts/AnySelectMenu.ts +0 -63
- package/src/abstracts/AnySelectMenuInteraction.ts +0 -29
- package/src/abstracts/Base.ts +0 -12
- package/src/abstracts/BaseChannel.ts +0 -73
- package/src/abstracts/BaseCommand.ts +0 -99
- package/src/abstracts/BaseComponent.ts +0 -49
- package/src/abstracts/BaseComponentInteraction.ts +0 -19
- package/src/abstracts/BaseGuildChannel.ts +0 -152
- package/src/abstracts/BaseGuildTextChannel.ts +0 -77
- package/src/abstracts/BaseInteraction.ts +0 -177
- package/src/abstracts/GuildThreadOnlyChannel.ts +0 -71
- package/src/classes/Button.ts +0 -95
- package/src/classes/ChannelSelectMenu.ts +0 -21
- package/src/classes/Client.ts +0 -254
- package/src/classes/Command.ts +0 -53
- package/src/classes/CommandWithSubcommandGroups.ts +0 -47
- package/src/classes/CommandWithSubcommands.ts +0 -35
- package/src/classes/MentionableSelectMenu.ts +0 -19
- package/src/classes/RoleSelectMenu.ts +0 -19
- package/src/classes/Row.ts +0 -44
- package/src/classes/StringSelectMenu.ts +0 -19
- package/src/classes/UserSelectMenu.ts +0 -19
- package/src/factories/channelFactory.ts +0 -43
- package/src/index.ts +0 -59
- package/src/internals/AutocompleteInteraction.ts +0 -107
- package/src/internals/ButtonInteraction.ts +0 -26
- package/src/internals/ChannelSelectMenuInteraction.ts +0 -15
- package/src/internals/CommandHandler.ts +0 -123
- package/src/internals/CommandInteraction.ts +0 -49
- package/src/internals/ComponentHandler.ts +0 -81
- package/src/internals/MentionableSelectMenuInteraction.ts +0 -21
- package/src/internals/OptionsHandler.ts +0 -148
- package/src/internals/RoleSelectMenuInteraction.ts +0 -20
- package/src/internals/StringSelectMenuInteraction.ts +0 -20
- package/src/internals/UserSelectMenuInteraction.ts +0 -20
- package/src/structures/DmChannel.ts +0 -31
- package/src/structures/GroupDmChannel.ts +0 -132
- package/src/structures/Guild.ts +0 -154
- package/src/structures/GuildAnnouncementChannel.ts +0 -20
- package/src/structures/GuildCategoryChannel.ts +0 -16
- package/src/structures/GuildForumChannel.ts +0 -20
- package/src/structures/GuildMediaChannel.ts +0 -13
- package/src/structures/GuildMember.ts +0 -231
- package/src/structures/GuildStageOrVoiceChannel.ts +0 -46
- package/src/structures/GuildTextChannel.ts +0 -21
- package/src/structures/GuildThreadChannel.ts +0 -150
- package/src/structures/Message.ts +0 -124
- package/src/structures/Role.ts +0 -201
- package/src/structures/User.ts +0 -153
- package/src/utils.ts +0 -13
- package/tests/index.test.ts +0 -4
- package/tsconfig.json +0 -12
- package/typedoc.json +0 -9
|
@@ -1,84 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: PremiumButton
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
## Extends
|
|
6
|
-
|
|
7
|
-
- `BaseButton`
|
|
8
|
-
|
|
9
|
-
## Constructors
|
|
10
|
-
|
|
11
|
-
### new PremiumButton()
|
|
12
|
-
|
|
13
|
-
> **new PremiumButton**(`data`?): [`PremiumButton`](/carbon/api/classes/PremiumButton)
|
|
14
|
-
|
|
15
|
-
#### Parameters
|
|
16
|
-
|
|
17
|
-
| Parameter | Type |
|
|
18
|
-
| ------ | ------ |
|
|
19
|
-
| `data`? | `object` |
|
|
20
|
-
| `data.additionalData`? | [`ComponentAdditionalData`](/carbon/api/type-aliases/ComponentAdditionalData) |
|
|
21
|
-
|
|
22
|
-
#### Returns
|
|
23
|
-
|
|
24
|
-
[`PremiumButton`](/carbon/api/classes/PremiumButton)
|
|
25
|
-
|
|
26
|
-
#### Inherited from
|
|
27
|
-
|
|
28
|
-
`BaseButton.constructor`
|
|
29
|
-
|
|
30
|
-
## Properties
|
|
31
|
-
|
|
32
|
-
| Property | Modifier | Type | Default value | Description | Overrides | Inherited from |
|
|
33
|
-
| ------ | ------ | ------ | ------ | ------ | ------ | ------ |
|
|
34
|
-
| `additionalData` | `public` | `null` \| [`ComponentAdditionalData`](/carbon/api/type-aliases/ComponentAdditionalData) | `null` | - | - | `BaseButton.additionalData` |
|
|
35
|
-
| `customId` | `abstract` | `string` | `undefined` | The custom ID of the component | - | `BaseButton.customId` |
|
|
36
|
-
| `defer` | `public` | `boolean` | `false` | Whether the component response should be automatically deferred | - | `BaseButton.defer` |
|
|
37
|
-
| `disabled` | `public` | `boolean` | `false` | The disabled state of the button | - | `BaseButton.disabled` |
|
|
38
|
-
| `emoji?` | `public` | `object` | `undefined` | The emoji of the button | - | `BaseButton.emoji` |
|
|
39
|
-
| `emoji.animated?` | `public` | `boolean` | `undefined` | - | - | - |
|
|
40
|
-
| `emoji.id?` | `public` | `string` | `undefined` | - | - | - |
|
|
41
|
-
| `emoji.name` | `public` | `string` | `undefined` | - | - | - |
|
|
42
|
-
| `ephemeral` | `public` | `boolean` | `false` | Whether the component response should be ephemeral | - | `BaseButton.ephemeral` |
|
|
43
|
-
| `label` | `abstract` | `string` | `undefined` | The label of the button | - | `BaseButton.label` |
|
|
44
|
-
| `sku_id` | `abstract` | `string` | `undefined` | The SKU ID of the button | - | - |
|
|
45
|
-
| `style` | `public` | `Premium` | `ButtonStyle.Premium` | The style of the button | `BaseButton.style` | - |
|
|
46
|
-
| `type` | `public` | `ComponentType` | `ComponentType.Button` | The type of the component | - | `BaseButton.type` |
|
|
47
|
-
|
|
48
|
-
## Methods
|
|
49
|
-
|
|
50
|
-
### createId()
|
|
51
|
-
|
|
52
|
-
> **createId**(`additionalData`): `string`
|
|
53
|
-
|
|
54
|
-
Create a custom ID to use for this component that embeds additional data that you want to be handed
|
|
55
|
-
|
|
56
|
-
#### Parameters
|
|
57
|
-
|
|
58
|
-
| Parameter | Type | Description |
|
|
59
|
-
| ------ | ------ | ------ |
|
|
60
|
-
| `additionalData` | `null` \| [`ComponentAdditionalData`](/carbon/api/type-aliases/ComponentAdditionalData) | The additional data that you want to be passed in this component's custom ID |
|
|
61
|
-
|
|
62
|
-
#### Returns
|
|
63
|
-
|
|
64
|
-
`string`
|
|
65
|
-
|
|
66
|
-
The custom ID to use
|
|
67
|
-
|
|
68
|
-
#### Inherited from
|
|
69
|
-
|
|
70
|
-
`BaseButton.createId`
|
|
71
|
-
|
|
72
|
-
***
|
|
73
|
-
|
|
74
|
-
### serialize()
|
|
75
|
-
|
|
76
|
-
> **serialize**(): `APIButtonComponentWithSKUId`
|
|
77
|
-
|
|
78
|
-
#### Returns
|
|
79
|
-
|
|
80
|
-
`APIButtonComponentWithSKUId`
|
|
81
|
-
|
|
82
|
-
#### Overrides
|
|
83
|
-
|
|
84
|
-
`BaseButton.serialize`
|
package/docs/classes/Role.mdx
DELETED
|
@@ -1,228 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Role
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
## Extends
|
|
6
|
-
|
|
7
|
-
- `Base`
|
|
8
|
-
|
|
9
|
-
## Constructors
|
|
10
|
-
|
|
11
|
-
### new Role()
|
|
12
|
-
|
|
13
|
-
> **new Role**(`client`, `rawDataOrId`): [`Role`](/carbon/api/classes/Role)
|
|
14
|
-
|
|
15
|
-
#### Parameters
|
|
16
|
-
|
|
17
|
-
| Parameter | Type |
|
|
18
|
-
| ------ | ------ |
|
|
19
|
-
| `client` | [`Client`](/carbon/api/classes/Client) |
|
|
20
|
-
| `rawDataOrId` | `string` \| `APIRole` |
|
|
21
|
-
|
|
22
|
-
#### Returns
|
|
23
|
-
|
|
24
|
-
[`Role`](/carbon/api/classes/Role)
|
|
25
|
-
|
|
26
|
-
#### Overrides
|
|
27
|
-
|
|
28
|
-
`Base.constructor`
|
|
29
|
-
|
|
30
|
-
## Properties
|
|
31
|
-
|
|
32
|
-
| Property | Type | Description | Inherited from |
|
|
33
|
-
| ------ | ------ | ------ | ------ |
|
|
34
|
-
| `client` | [`Client`](/carbon/api/classes/Client) | - | `Base.client` |
|
|
35
|
-
| `color?` | `null` \| `number` | The color of the role. | - |
|
|
36
|
-
| `flags?` | `null` \| `RoleFlags` | The flags of this role. **See** https://discord.com/developers/docs/topics/permissions#role-object-role-flags | - |
|
|
37
|
-
| `hoisted?` | `null` \| `boolean` | If this role is hoisted. | - |
|
|
38
|
-
| `icon?` | `null` \| `string` | The icon hash of the role. You can use [Role.iconUrl](/carbon/api/classes/Role#iconurl) to get the URL of the icon. | - |
|
|
39
|
-
| `id` | `string` | The ID of the role. | - |
|
|
40
|
-
| `managed?` | `null` \| `boolean` | If this role is managed by an integration. | - |
|
|
41
|
-
| `mentionable?` | `null` \| `boolean` | If this role is mentionable. | - |
|
|
42
|
-
| `name?` | `null` \| `string` | The name of the role. | - |
|
|
43
|
-
| `partial` | `boolean` | Whether the role is a partial role (meaning it does not have all the data). If this is true, you should use [Role.fetch](/carbon/api/classes/Role#fetch) to get the full data of the role. | - |
|
|
44
|
-
| `permissions?` | `null` \| `string` | The permissions of the role. | - |
|
|
45
|
-
| `position?` | `null` \| `number` | The position of the role. | - |
|
|
46
|
-
| `tags?` | `null` \| `APIRoleTags` | The tags of this role. **See** https://discord.com/developers/docs/topics/permissions#role-object-role-tags-structure | - |
|
|
47
|
-
| `unicodeEmoji?` | `null` \| `string` | The unicode emoji for the role. | - |
|
|
48
|
-
|
|
49
|
-
## Accessors
|
|
50
|
-
|
|
51
|
-
### iconUrl
|
|
52
|
-
|
|
53
|
-
> `get` **iconUrl**(): `null` \| `string`
|
|
54
|
-
|
|
55
|
-
Get the URL of the role's icon
|
|
56
|
-
|
|
57
|
-
#### Returns
|
|
58
|
-
|
|
59
|
-
`null` \| `string`
|
|
60
|
-
|
|
61
|
-
## Methods
|
|
62
|
-
|
|
63
|
-
### delete()
|
|
64
|
-
|
|
65
|
-
> **delete**(`guildId`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
66
|
-
|
|
67
|
-
#### Parameters
|
|
68
|
-
|
|
69
|
-
| Parameter | Type |
|
|
70
|
-
| ------ | ------ |
|
|
71
|
-
| `guildId` | `string` |
|
|
72
|
-
|
|
73
|
-
#### Returns
|
|
74
|
-
|
|
75
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
76
|
-
|
|
77
|
-
***
|
|
78
|
-
|
|
79
|
-
### fetch()
|
|
80
|
-
|
|
81
|
-
> **fetch**(`guildId`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
82
|
-
|
|
83
|
-
Fetch updated data for this role.
|
|
84
|
-
If the role is partial, this will fetch all the data for the role and populate the fields.
|
|
85
|
-
If the role is not partial, all fields will be updated with new values from Discord.
|
|
86
|
-
|
|
87
|
-
#### Parameters
|
|
88
|
-
|
|
89
|
-
| Parameter | Type |
|
|
90
|
-
| ------ | ------ |
|
|
91
|
-
| `guildId` | `string` |
|
|
92
|
-
|
|
93
|
-
#### Returns
|
|
94
|
-
|
|
95
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
96
|
-
|
|
97
|
-
***
|
|
98
|
-
|
|
99
|
-
### setColor()
|
|
100
|
-
|
|
101
|
-
> **setColor**(`guildId`, `color`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
102
|
-
|
|
103
|
-
Set the color of the role
|
|
104
|
-
|
|
105
|
-
#### Parameters
|
|
106
|
-
|
|
107
|
-
| Parameter | Type |
|
|
108
|
-
| ------ | ------ |
|
|
109
|
-
| `guildId` | `string` |
|
|
110
|
-
| `color` | `number` |
|
|
111
|
-
|
|
112
|
-
#### Returns
|
|
113
|
-
|
|
114
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
115
|
-
|
|
116
|
-
***
|
|
117
|
-
|
|
118
|
-
### setHoisted()
|
|
119
|
-
|
|
120
|
-
> **setHoisted**(`guildId`, `hoisted`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
121
|
-
|
|
122
|
-
Set the hoisted status of the role
|
|
123
|
-
|
|
124
|
-
#### Parameters
|
|
125
|
-
|
|
126
|
-
| Parameter | Type |
|
|
127
|
-
| ------ | ------ |
|
|
128
|
-
| `guildId` | `string` |
|
|
129
|
-
| `hoisted` | `boolean` |
|
|
130
|
-
|
|
131
|
-
#### Returns
|
|
132
|
-
|
|
133
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
134
|
-
|
|
135
|
-
***
|
|
136
|
-
|
|
137
|
-
### setIcon()
|
|
138
|
-
|
|
139
|
-
> **setIcon**(`guildId`, `icon`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
140
|
-
|
|
141
|
-
Set the icon of the role
|
|
142
|
-
|
|
143
|
-
#### Parameters
|
|
144
|
-
|
|
145
|
-
| Parameter | Type | Description |
|
|
146
|
-
| ------ | ------ | ------ |
|
|
147
|
-
| `guildId` | `string` | - |
|
|
148
|
-
| `icon` | `string` | The unicode emoji or icon URL to set |
|
|
149
|
-
|
|
150
|
-
#### Returns
|
|
151
|
-
|
|
152
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
153
|
-
|
|
154
|
-
***
|
|
155
|
-
|
|
156
|
-
### setMentionable()
|
|
157
|
-
|
|
158
|
-
> **setMentionable**(`guildId`, `mentionable`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
159
|
-
|
|
160
|
-
Set the mentionable status of the role
|
|
161
|
-
|
|
162
|
-
#### Parameters
|
|
163
|
-
|
|
164
|
-
| Parameter | Type |
|
|
165
|
-
| ------ | ------ |
|
|
166
|
-
| `guildId` | `string` |
|
|
167
|
-
| `mentionable` | `boolean` |
|
|
168
|
-
|
|
169
|
-
#### Returns
|
|
170
|
-
|
|
171
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
172
|
-
|
|
173
|
-
***
|
|
174
|
-
|
|
175
|
-
### setName()
|
|
176
|
-
|
|
177
|
-
> **setName**(`guildId`, `name`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
178
|
-
|
|
179
|
-
Set the name of the role
|
|
180
|
-
|
|
181
|
-
#### Parameters
|
|
182
|
-
|
|
183
|
-
| Parameter | Type |
|
|
184
|
-
| ------ | ------ |
|
|
185
|
-
| `guildId` | `string` |
|
|
186
|
-
| `name` | `string` |
|
|
187
|
-
|
|
188
|
-
#### Returns
|
|
189
|
-
|
|
190
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
191
|
-
|
|
192
|
-
***
|
|
193
|
-
|
|
194
|
-
### setPermissions()
|
|
195
|
-
|
|
196
|
-
> **setPermissions**(`guildId`, `permissions`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
197
|
-
|
|
198
|
-
Set the permissions of the role
|
|
199
|
-
|
|
200
|
-
#### Parameters
|
|
201
|
-
|
|
202
|
-
| Parameter | Type | Description |
|
|
203
|
-
| ------ | ------ | ------ |
|
|
204
|
-
| `guildId` | `string` | - |
|
|
205
|
-
| `permissions` | `string` | The permissions to set as a BitField string, until a better permission structure is implemented |
|
|
206
|
-
|
|
207
|
-
#### Returns
|
|
208
|
-
|
|
209
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
210
|
-
|
|
211
|
-
***
|
|
212
|
-
|
|
213
|
-
### setPosition()
|
|
214
|
-
|
|
215
|
-
> **setPosition**(`guildId`, `position`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
216
|
-
|
|
217
|
-
Set the position of the role
|
|
218
|
-
|
|
219
|
-
#### Parameters
|
|
220
|
-
|
|
221
|
-
| Parameter | Type |
|
|
222
|
-
| ------ | ------ |
|
|
223
|
-
| `guildId` | `string` |
|
|
224
|
-
| `position` | `number` |
|
|
225
|
-
|
|
226
|
-
#### Returns
|
|
227
|
-
|
|
228
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
@@ -1,120 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: RoleSelectMenu
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
## Extends
|
|
6
|
-
|
|
7
|
-
- [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu)
|
|
8
|
-
|
|
9
|
-
## Constructors
|
|
10
|
-
|
|
11
|
-
### new RoleSelectMenu()
|
|
12
|
-
|
|
13
|
-
> **new RoleSelectMenu**(`data`?): [`RoleSelectMenu`](/carbon/api/classes/RoleSelectMenu)
|
|
14
|
-
|
|
15
|
-
#### Parameters
|
|
16
|
-
|
|
17
|
-
| Parameter | Type |
|
|
18
|
-
| ------ | ------ |
|
|
19
|
-
| `data`? | `object` |
|
|
20
|
-
| `data.additionalData`? | [`ComponentAdditionalData`](/carbon/api/type-aliases/ComponentAdditionalData) |
|
|
21
|
-
|
|
22
|
-
#### Returns
|
|
23
|
-
|
|
24
|
-
[`RoleSelectMenu`](/carbon/api/classes/RoleSelectMenu)
|
|
25
|
-
|
|
26
|
-
#### Inherited from
|
|
27
|
-
|
|
28
|
-
[`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).[`constructor`](/carbon/api/classes/AnySelectMenu#constructors)
|
|
29
|
-
|
|
30
|
-
## Properties
|
|
31
|
-
|
|
32
|
-
| Property | Modifier | Type | Default value | Description | Overrides | Inherited from |
|
|
33
|
-
| ------ | ------ | ------ | ------ | ------ | ------ | ------ |
|
|
34
|
-
| `additionalData` | `public` | `null` \| [`ComponentAdditionalData`](/carbon/api/type-aliases/ComponentAdditionalData) | `null` | - | - | [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).`additionalData` |
|
|
35
|
-
| `customId` | `abstract` | `string` | `undefined` | The custom ID of the component | - | [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).`customId` |
|
|
36
|
-
| `defaultValues?` | `public` | `APISelectMenuDefaultValue`\<`Role`\>[] | `undefined` | - | - | - |
|
|
37
|
-
| `defer` | `public` | `boolean` | `false` | Whether the component response should be automatically deferred | - | [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).`defer` |
|
|
38
|
-
| `disabled?` | `public` | `boolean` | `undefined` | - | - | [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).`disabled` |
|
|
39
|
-
| `ephemeral` | `public` | `boolean` | `false` | Whether the component response should be ephemeral | - | [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).`ephemeral` |
|
|
40
|
-
| `maxValues?` | `public` | `number` | `undefined` | - | - | [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).`maxValues` |
|
|
41
|
-
| `minValues?` | `public` | `number` | `undefined` | - | - | [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).`minValues` |
|
|
42
|
-
| `placeholder?` | `public` | `string` | `undefined` | - | - | [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).`placeholder` |
|
|
43
|
-
| `type` | `public` | `RoleSelect` | `ComponentType.RoleSelect` | The type of the component | [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).`type` | - |
|
|
44
|
-
|
|
45
|
-
## Methods
|
|
46
|
-
|
|
47
|
-
### createId()
|
|
48
|
-
|
|
49
|
-
> **createId**(`additionalData`): `string`
|
|
50
|
-
|
|
51
|
-
Create a custom ID to use for this component that embeds additional data that you want to be handed
|
|
52
|
-
|
|
53
|
-
#### Parameters
|
|
54
|
-
|
|
55
|
-
| Parameter | Type | Description |
|
|
56
|
-
| ------ | ------ | ------ |
|
|
57
|
-
| `additionalData` | `null` \| [`ComponentAdditionalData`](/carbon/api/type-aliases/ComponentAdditionalData) | The additional data that you want to be passed in this component's custom ID |
|
|
58
|
-
|
|
59
|
-
#### Returns
|
|
60
|
-
|
|
61
|
-
`string`
|
|
62
|
-
|
|
63
|
-
The custom ID to use
|
|
64
|
-
|
|
65
|
-
#### Inherited from
|
|
66
|
-
|
|
67
|
-
[`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).[`createId`](/carbon/api/classes/AnySelectMenu#createid)
|
|
68
|
-
|
|
69
|
-
***
|
|
70
|
-
|
|
71
|
-
### run()
|
|
72
|
-
|
|
73
|
-
> `abstract` **run**(`interaction`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
74
|
-
|
|
75
|
-
#### Parameters
|
|
76
|
-
|
|
77
|
-
| Parameter | Type |
|
|
78
|
-
| ------ | ------ |
|
|
79
|
-
| `interaction` | [`RoleSelectMenuInteraction`](/carbon/api/classes/RoleSelectMenuInteraction) |
|
|
80
|
-
|
|
81
|
-
#### Returns
|
|
82
|
-
|
|
83
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
84
|
-
|
|
85
|
-
#### Overrides
|
|
86
|
-
|
|
87
|
-
[`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).[`run`](/carbon/api/classes/AnySelectMenu#run)
|
|
88
|
-
|
|
89
|
-
***
|
|
90
|
-
|
|
91
|
-
### serialize()
|
|
92
|
-
|
|
93
|
-
> **serialize**(): `APISelectMenuComponent`
|
|
94
|
-
|
|
95
|
-
#### Returns
|
|
96
|
-
|
|
97
|
-
`APISelectMenuComponent`
|
|
98
|
-
|
|
99
|
-
#### Inherited from
|
|
100
|
-
|
|
101
|
-
[`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).[`serialize`](/carbon/api/classes/AnySelectMenu#serialize)
|
|
102
|
-
|
|
103
|
-
***
|
|
104
|
-
|
|
105
|
-
### serializeOptions()
|
|
106
|
-
|
|
107
|
-
> **serializeOptions**(): `object`
|
|
108
|
-
|
|
109
|
-
#### Returns
|
|
110
|
-
|
|
111
|
-
`object`
|
|
112
|
-
|
|
113
|
-
| Name | Type |
|
|
114
|
-
| ------ | ------ |
|
|
115
|
-
| `default_values` | `undefined` \| `APISelectMenuDefaultValue`\<`Role`\>[] |
|
|
116
|
-
| `type` | `RoleSelect` |
|
|
117
|
-
|
|
118
|
-
#### Overrides
|
|
119
|
-
|
|
120
|
-
[`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).[`serializeOptions`](/carbon/api/classes/AnySelectMenu#serializeoptions)
|
|
@@ -1,171 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: RoleSelectMenuInteraction
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
This is the base type interaction, all interaction types extend from this
|
|
6
|
-
|
|
7
|
-
## Extends
|
|
8
|
-
|
|
9
|
-
- [`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction)
|
|
10
|
-
|
|
11
|
-
## Constructors
|
|
12
|
-
|
|
13
|
-
### new RoleSelectMenuInteraction()
|
|
14
|
-
|
|
15
|
-
> **new RoleSelectMenuInteraction**(`client`, `data`): [`RoleSelectMenuInteraction`](/carbon/api/classes/RoleSelectMenuInteraction)
|
|
16
|
-
|
|
17
|
-
#### Parameters
|
|
18
|
-
|
|
19
|
-
| Parameter | Type |
|
|
20
|
-
| ------ | ------ |
|
|
21
|
-
| `client` | [`Client`](/carbon/api/classes/Client) |
|
|
22
|
-
| `data` | `APIMessageComponentSelectMenuInteraction` |
|
|
23
|
-
|
|
24
|
-
#### Returns
|
|
25
|
-
|
|
26
|
-
[`RoleSelectMenuInteraction`](/carbon/api/classes/RoleSelectMenuInteraction)
|
|
27
|
-
|
|
28
|
-
#### Overrides
|
|
29
|
-
|
|
30
|
-
[`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).[`constructor`](/carbon/api/classes/AnySelectMenuInteraction#constructors)
|
|
31
|
-
|
|
32
|
-
## Properties
|
|
33
|
-
|
|
34
|
-
| Property | Type | Default value | Description | Inherited from |
|
|
35
|
-
| ------ | ------ | ------ | ------ | ------ |
|
|
36
|
-
| `_deferred` | `boolean` | `false` | **`Internal`** Whether the interaction is deferred already | [`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).`_deferred` |
|
|
37
|
-
| `client` | [`Client`](/carbon/api/classes/Client) | `undefined` | - | [`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).`client` |
|
|
38
|
-
| `componentType` | `ComponentType` | `undefined` | - | [`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).`componentType` |
|
|
39
|
-
| `customId` | `string` | `undefined` | - | [`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).`customId` |
|
|
40
|
-
| `rawData` | `APIMessageComponentInteraction` | `undefined` | The raw data of the interaction | [`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).`rawData` |
|
|
41
|
-
| `type` | `InteractionType` | `undefined` | The type of interaction | [`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).`type` |
|
|
42
|
-
| `userId` | `undefined` \| `string` | `undefined` | The user who sent the interaction | [`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).`userId` |
|
|
43
|
-
|
|
44
|
-
## Accessors
|
|
45
|
-
|
|
46
|
-
### channel
|
|
47
|
-
|
|
48
|
-
> `get` **channel**(): `null` \| [`DmChannel`](/carbon/api/classes/DmChannel) \| [`GroupDmChannel`](/carbon/api/classes/GroupDmChannel) \| [`GuildTextChannel`](/carbon/api/classes/GuildTextChannel) \| [`GuildVoiceChannel`](/carbon/api/classes/GuildVoiceChannel) \| [`GuildCategoryChannel`](/carbon/api/classes/GuildCategoryChannel) \| [`GuildAnnouncementChannel`](/carbon/api/classes/GuildAnnouncementChannel) \| [`GuildThreadChannel`](/carbon/api/classes/GuildThreadChannel)\<`ThreadChannelType`\> \| [`GuildStageChannel`](/carbon/api/classes/GuildStageChannel) \| [`GuildForumChannel`](/carbon/api/classes/GuildForumChannel) \| [`GuildMediaChannel`](/carbon/api/classes/GuildMediaChannel)
|
|
49
|
-
|
|
50
|
-
#### Returns
|
|
51
|
-
|
|
52
|
-
`null` \| [`DmChannel`](/carbon/api/classes/DmChannel) \| [`GroupDmChannel`](/carbon/api/classes/GroupDmChannel) \| [`GuildTextChannel`](/carbon/api/classes/GuildTextChannel) \| [`GuildVoiceChannel`](/carbon/api/classes/GuildVoiceChannel) \| [`GuildCategoryChannel`](/carbon/api/classes/GuildCategoryChannel) \| [`GuildAnnouncementChannel`](/carbon/api/classes/GuildAnnouncementChannel) \| [`GuildThreadChannel`](/carbon/api/classes/GuildThreadChannel)\<`ThreadChannelType`\> \| [`GuildStageChannel`](/carbon/api/classes/GuildStageChannel) \| [`GuildForumChannel`](/carbon/api/classes/GuildForumChannel) \| [`GuildMediaChannel`](/carbon/api/classes/GuildMediaChannel)
|
|
53
|
-
|
|
54
|
-
#### Inherited from
|
|
55
|
-
|
|
56
|
-
[`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).[`channel`](/carbon/api/classes/AnySelectMenuInteraction#channel)
|
|
57
|
-
|
|
58
|
-
***
|
|
59
|
-
|
|
60
|
-
### guild
|
|
61
|
-
|
|
62
|
-
> `get` **guild**(): `null` \| [`Guild`](/carbon/api/classes/Guild)
|
|
63
|
-
|
|
64
|
-
#### Returns
|
|
65
|
-
|
|
66
|
-
`null` \| [`Guild`](/carbon/api/classes/Guild)
|
|
67
|
-
|
|
68
|
-
#### Inherited from
|
|
69
|
-
|
|
70
|
-
[`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).[`guild`](/carbon/api/classes/AnySelectMenuInteraction#guild)
|
|
71
|
-
|
|
72
|
-
***
|
|
73
|
-
|
|
74
|
-
### member
|
|
75
|
-
|
|
76
|
-
> `get` **member**(): `null` \| `GuildMember`
|
|
77
|
-
|
|
78
|
-
#### Returns
|
|
79
|
-
|
|
80
|
-
`null` \| `GuildMember`
|
|
81
|
-
|
|
82
|
-
#### Inherited from
|
|
83
|
-
|
|
84
|
-
[`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).[`member`](/carbon/api/classes/AnySelectMenuInteraction#member)
|
|
85
|
-
|
|
86
|
-
***
|
|
87
|
-
|
|
88
|
-
### message
|
|
89
|
-
|
|
90
|
-
> `get` **message**(): `null` \| [`Message`](/carbon/api/classes/Message)
|
|
91
|
-
|
|
92
|
-
#### Returns
|
|
93
|
-
|
|
94
|
-
`null` \| [`Message`](/carbon/api/classes/Message)
|
|
95
|
-
|
|
96
|
-
#### Inherited from
|
|
97
|
-
|
|
98
|
-
[`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).[`message`](/carbon/api/classes/AnySelectMenuInteraction#message)
|
|
99
|
-
|
|
100
|
-
***
|
|
101
|
-
|
|
102
|
-
### user
|
|
103
|
-
|
|
104
|
-
> `get` **user**(): `null` \| [`User`](/carbon/api/classes/User)
|
|
105
|
-
|
|
106
|
-
#### Returns
|
|
107
|
-
|
|
108
|
-
`null` \| [`User`](/carbon/api/classes/User)
|
|
109
|
-
|
|
110
|
-
#### Inherited from
|
|
111
|
-
|
|
112
|
-
[`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).[`user`](/carbon/api/classes/AnySelectMenuInteraction#user)
|
|
113
|
-
|
|
114
|
-
***
|
|
115
|
-
|
|
116
|
-
### values
|
|
117
|
-
|
|
118
|
-
> `get` **values**(): `string`[]
|
|
119
|
-
|
|
120
|
-
The raw IDs of the selected options (either role/string/channel IDs or the IDs you provided in your options)
|
|
121
|
-
|
|
122
|
-
#### Returns
|
|
123
|
-
|
|
124
|
-
`string`[]
|
|
125
|
-
|
|
126
|
-
#### Overrides
|
|
127
|
-
|
|
128
|
-
[`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).[`values`](/carbon/api/classes/AnySelectMenuInteraction#values)
|
|
129
|
-
|
|
130
|
-
## Methods
|
|
131
|
-
|
|
132
|
-
### defer()
|
|
133
|
-
|
|
134
|
-
> **defer**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
135
|
-
|
|
136
|
-
**`Internal`**
|
|
137
|
-
|
|
138
|
-
Defer the interaction response. This is used automatically by commands that are set to defer.
|
|
139
|
-
If the interaction is already deferred, this will do nothing.
|
|
140
|
-
|
|
141
|
-
#### Returns
|
|
142
|
-
|
|
143
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
144
|
-
|
|
145
|
-
#### Inherited from
|
|
146
|
-
|
|
147
|
-
[`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).[`defer`](/carbon/api/classes/AnySelectMenuInteraction#defer)
|
|
148
|
-
|
|
149
|
-
***
|
|
150
|
-
|
|
151
|
-
### reply()
|
|
152
|
-
|
|
153
|
-
> **reply**(`data`, `options`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
154
|
-
|
|
155
|
-
Reply to an interaction.
|
|
156
|
-
If the interaction is deferred, this will edit the original response.
|
|
157
|
-
|
|
158
|
-
#### Parameters
|
|
159
|
-
|
|
160
|
-
| Parameter | Type | Description |
|
|
161
|
-
| ------ | ------ | ------ |
|
|
162
|
-
| `data` | [`InteractionReplyData`](/carbon/api/type-aliases/InteractionReplyData) | The response data |
|
|
163
|
-
| `options` | [`InteractionReplyOptions`](/carbon/api/type-aliases/InteractionReplyOptions) | - |
|
|
164
|
-
|
|
165
|
-
#### Returns
|
|
166
|
-
|
|
167
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
168
|
-
|
|
169
|
-
#### Inherited from
|
|
170
|
-
|
|
171
|
-
[`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).[`reply`](/carbon/api/classes/AnySelectMenuInteraction#reply)
|
package/docs/classes/Row.mdx
DELETED
|
@@ -1,88 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Row
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
## Constructors
|
|
6
|
-
|
|
7
|
-
### new Row()
|
|
8
|
-
|
|
9
|
-
> **new Row**(`components`): [`Row`](/carbon/api/classes/Row)
|
|
10
|
-
|
|
11
|
-
#### Parameters
|
|
12
|
-
|
|
13
|
-
| Parameter | Type |
|
|
14
|
-
| ------ | ------ |
|
|
15
|
-
| `components` | [`BaseComponent`](/carbon/api/classes/BaseComponent)[] |
|
|
16
|
-
|
|
17
|
-
#### Returns
|
|
18
|
-
|
|
19
|
-
[`Row`](/carbon/api/classes/Row)
|
|
20
|
-
|
|
21
|
-
## Properties
|
|
22
|
-
|
|
23
|
-
| Property | Type | Description |
|
|
24
|
-
| ------ | ------ | ------ |
|
|
25
|
-
| `components` | [`BaseComponent`](/carbon/api/classes/BaseComponent)[] | The components in the action row |
|
|
26
|
-
|
|
27
|
-
## Methods
|
|
28
|
-
|
|
29
|
-
### addComponent()
|
|
30
|
-
|
|
31
|
-
> **addComponent**(`component`): `void`
|
|
32
|
-
|
|
33
|
-
Add a component to the action row
|
|
34
|
-
|
|
35
|
-
#### Parameters
|
|
36
|
-
|
|
37
|
-
| Parameter | Type | Description |
|
|
38
|
-
| ------ | ------ | ------ |
|
|
39
|
-
| `component` | [`BaseComponent`](/carbon/api/classes/BaseComponent) | The component to add |
|
|
40
|
-
|
|
41
|
-
#### Returns
|
|
42
|
-
|
|
43
|
-
`void`
|
|
44
|
-
|
|
45
|
-
***
|
|
46
|
-
|
|
47
|
-
### removeAllComponents()
|
|
48
|
-
|
|
49
|
-
> **removeAllComponents**(): `void`
|
|
50
|
-
|
|
51
|
-
Remove all components from the action row
|
|
52
|
-
|
|
53
|
-
#### Returns
|
|
54
|
-
|
|
55
|
-
`void`
|
|
56
|
-
|
|
57
|
-
***
|
|
58
|
-
|
|
59
|
-
### removeComponent()
|
|
60
|
-
|
|
61
|
-
> **removeComponent**(`component`): `void`
|
|
62
|
-
|
|
63
|
-
Remove a component from the action row
|
|
64
|
-
|
|
65
|
-
#### Parameters
|
|
66
|
-
|
|
67
|
-
| Parameter | Type | Description |
|
|
68
|
-
| ------ | ------ | ------ |
|
|
69
|
-
| `component` | [`BaseComponent`](/carbon/api/classes/BaseComponent) | The component to remove |
|
|
70
|
-
|
|
71
|
-
#### Returns
|
|
72
|
-
|
|
73
|
-
`void`
|
|
74
|
-
|
|
75
|
-
***
|
|
76
|
-
|
|
77
|
-
### serialize()
|
|
78
|
-
|
|
79
|
-
> **serialize**(): `object`
|
|
80
|
-
|
|
81
|
-
#### Returns
|
|
82
|
-
|
|
83
|
-
`object`
|
|
84
|
-
|
|
85
|
-
| Name | Type | Default value |
|
|
86
|
-
| ------ | ------ | ------ |
|
|
87
|
-
| `components` | `APIBaseComponent`\<`ComponentType`\>[] | - |
|
|
88
|
-
| `type` | `number` | 1 |
|