@buape/carbon 0.2.0 → 0.3.1

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.
Files changed (275) hide show
  1. package/dist/package.json +7 -2
  2. package/dist/src/abstracts/BaseComponentInteraction.d.ts +6 -1
  3. package/dist/src/abstracts/BaseComponentInteraction.d.ts.map +1 -1
  4. package/dist/src/abstracts/BaseComponentInteraction.js +12 -0
  5. package/dist/src/abstracts/BaseComponentInteraction.js.map +1 -1
  6. package/dist/src/abstracts/BaseInteraction.d.ts +10 -1
  7. package/dist/src/abstracts/BaseInteraction.d.ts.map +1 -1
  8. package/dist/src/abstracts/BaseInteraction.js +10 -1
  9. package/dist/src/abstracts/BaseInteraction.js.map +1 -1
  10. package/dist/src/classes/Client.d.ts.map +1 -1
  11. package/dist/src/classes/Client.js +21 -11
  12. package/dist/src/classes/Client.js.map +1 -1
  13. package/dist/src/classes/Embed.d.ts +60 -0
  14. package/dist/src/classes/Embed.d.ts.map +1 -0
  15. package/dist/src/classes/Embed.js +73 -0
  16. package/dist/src/classes/Embed.js.map +1 -0
  17. package/dist/src/index.d.ts +4 -1
  18. package/dist/src/index.d.ts.map +1 -1
  19. package/dist/src/index.js +4 -1
  20. package/dist/src/index.js.map +1 -1
  21. package/dist/src/internals/AutocompleteInteraction.d.ts +1 -1
  22. package/dist/src/internals/FieldsHandler.d.ts +27 -0
  23. package/dist/src/internals/FieldsHandler.d.ts.map +1 -0
  24. package/dist/src/internals/FieldsHandler.js +37 -0
  25. package/dist/src/internals/FieldsHandler.js.map +1 -0
  26. package/dist/src/internals/ModalInteraction.d.ts +3 -4
  27. package/dist/src/internals/ModalInteraction.d.ts.map +1 -1
  28. package/dist/src/internals/ModalInteraction.js +3 -10
  29. package/dist/src/internals/ModalInteraction.js.map +1 -1
  30. package/dist/src/internals/OptionsHandler.d.ts +33 -17
  31. package/dist/src/internals/OptionsHandler.d.ts.map +1 -1
  32. package/dist/src/internals/OptionsHandler.js +52 -58
  33. package/dist/src/internals/OptionsHandler.js.map +1 -1
  34. package/dist/src/utils.d.ts +3 -0
  35. package/dist/src/utils.d.ts.map +1 -1
  36. package/dist/src/utils.js +54 -0
  37. package/dist/src/utils.js.map +1 -1
  38. package/dist/tsconfig.tsbuildinfo +1 -1
  39. package/package.json +6 -1
  40. package/.turbo/turbo-build.log +0 -5
  41. package/.turbo/turbo-dev.log +0 -8
  42. package/.turbo/turbo-docs.log +0 -12
  43. package/CHANGELOG.md +0 -44
  44. package/dist/src/abstracts/ButtonInteraction.d.ts +0 -8
  45. package/dist/src/abstracts/ButtonInteraction.d.ts.map +0 -1
  46. package/dist/src/abstracts/ButtonInteraction.js +0 -18
  47. package/dist/src/abstracts/ButtonInteraction.js.map +0 -1
  48. package/dist/src/abstracts/ChannelSelectMenuInteraction.d.ts +0 -7
  49. package/dist/src/abstracts/ChannelSelectMenuInteraction.d.ts.map +0 -1
  50. package/dist/src/abstracts/ChannelSelectMenuInteraction.js +0 -11
  51. package/dist/src/abstracts/ChannelSelectMenuInteraction.js.map +0 -1
  52. package/dist/src/abstracts/CommandHandler.d.ts +0 -6
  53. package/dist/src/abstracts/CommandHandler.d.ts.map +0 -1
  54. package/dist/src/abstracts/CommandHandler.js +0 -65
  55. package/dist/src/abstracts/CommandHandler.js.map +0 -1
  56. package/dist/src/abstracts/CommandInteraction.d.ts +0 -15
  57. package/dist/src/abstracts/CommandInteraction.d.ts.map +0 -1
  58. package/dist/src/abstracts/CommandInteraction.js +0 -60
  59. package/dist/src/abstracts/CommandInteraction.js.map +0 -1
  60. package/dist/src/abstracts/ComponentHandler.d.ts +0 -6
  61. package/dist/src/abstracts/ComponentHandler.d.ts.map +0 -1
  62. package/dist/src/abstracts/ComponentHandler.js +0 -64
  63. package/dist/src/abstracts/ComponentHandler.js.map +0 -1
  64. package/dist/src/abstracts/MentionableSelectMenuInteraction.d.ts +0 -8
  65. package/dist/src/abstracts/MentionableSelectMenuInteraction.d.ts.map +0 -1
  66. package/dist/src/abstracts/MentionableSelectMenuInteraction.js +0 -15
  67. package/dist/src/abstracts/MentionableSelectMenuInteraction.js.map +0 -1
  68. package/dist/src/abstracts/RoleSelectMenuInteraction.d.ts +0 -8
  69. package/dist/src/abstracts/RoleSelectMenuInteraction.d.ts.map +0 -1
  70. package/dist/src/abstracts/RoleSelectMenuInteraction.js +0 -14
  71. package/dist/src/abstracts/RoleSelectMenuInteraction.js.map +0 -1
  72. package/dist/src/abstracts/StringSelectMenuInteraction.d.ts +0 -8
  73. package/dist/src/abstracts/StringSelectMenuInteraction.d.ts.map +0 -1
  74. package/dist/src/abstracts/StringSelectMenuInteraction.js +0 -14
  75. package/dist/src/abstracts/StringSelectMenuInteraction.js.map +0 -1
  76. package/dist/src/abstracts/UserSelectMenuInteraction.d.ts +0 -8
  77. package/dist/src/abstracts/UserSelectMenuInteraction.d.ts.map +0 -1
  78. package/dist/src/abstracts/UserSelectMenuInteraction.js +0 -14
  79. package/dist/src/abstracts/UserSelectMenuInteraction.js.map +0 -1
  80. package/dist/src/classes/Paginator.d.ts +0 -3
  81. package/dist/src/classes/Paginator.d.ts.map +0 -1
  82. package/dist/src/classes/Paginator.js +0 -3
  83. package/dist/src/classes/Paginator.js.map +0 -1
  84. package/dist/src/internals/ComponentHandler copy.d.ts +0 -17
  85. package/dist/src/internals/ComponentHandler copy.d.ts.map +0 -1
  86. package/dist/src/internals/ComponentHandler copy.js +0 -75
  87. package/dist/src/internals/ComponentHandler copy.js.map +0 -1
  88. package/dist/src/structures/AnySelectMenu.d.ts +0 -31
  89. package/dist/src/structures/AnySelectMenu.d.ts.map +0 -1
  90. package/dist/src/structures/AnySelectMenu.js +0 -19
  91. package/dist/src/structures/AnySelectMenu.js.map +0 -1
  92. package/dist/src/structures/AnySelectMenuInteraction.d.ts +0 -12
  93. package/dist/src/structures/AnySelectMenuInteraction.d.ts.map +0 -1
  94. package/dist/src/structures/AnySelectMenuInteraction.js +0 -21
  95. package/dist/src/structures/AnySelectMenuInteraction.js.map +0 -1
  96. package/dist/src/structures/Base.d.ts +0 -10
  97. package/dist/src/structures/Base.d.ts.map +0 -1
  98. package/dist/src/structures/Base.js +0 -11
  99. package/dist/src/structures/Base.js.map +0 -1
  100. package/dist/src/structures/BaseCommand.d.ts +0 -64
  101. package/dist/src/structures/BaseCommand.d.ts.map +0 -1
  102. package/dist/src/structures/BaseCommand.js +0 -58
  103. package/dist/src/structures/BaseCommand.js.map +0 -1
  104. package/dist/src/structures/BaseComponent.d.ts +0 -34
  105. package/dist/src/structures/BaseComponent.d.ts.map +0 -1
  106. package/dist/src/structures/BaseComponent.js +0 -30
  107. package/dist/src/structures/BaseComponent.js.map +0 -1
  108. package/dist/src/structures/BaseComponentInteraction.d.ts +0 -9
  109. package/dist/src/structures/BaseComponentInteraction.d.ts.map +0 -1
  110. package/dist/src/structures/BaseComponentInteraction.js +0 -14
  111. package/dist/src/structures/BaseComponentInteraction.js.map +0 -1
  112. package/dist/src/structures/BaseInteraction.d.ts +0 -81
  113. package/dist/src/structures/BaseInteraction.d.ts.map +0 -1
  114. package/dist/src/structures/BaseInteraction.js +0 -99
  115. package/dist/src/structures/BaseInteraction.js.map +0 -1
  116. package/dist/src/structures/ButtonInteraction.d.ts +0 -8
  117. package/dist/src/structures/ButtonInteraction.d.ts.map +0 -1
  118. package/dist/src/structures/ButtonInteraction.js +0 -18
  119. package/dist/src/structures/ButtonInteraction.js.map +0 -1
  120. package/dist/src/structures/ChannelSelectMenuInteraction.d.ts +0 -7
  121. package/dist/src/structures/ChannelSelectMenuInteraction.d.ts.map +0 -1
  122. package/dist/src/structures/ChannelSelectMenuInteraction.js +0 -11
  123. package/dist/src/structures/ChannelSelectMenuInteraction.js.map +0 -1
  124. package/dist/src/structures/CommandHandler.d.ts +0 -6
  125. package/dist/src/structures/CommandHandler.d.ts.map +0 -1
  126. package/dist/src/structures/CommandHandler.js +0 -70
  127. package/dist/src/structures/CommandHandler.js.map +0 -1
  128. package/dist/src/structures/CommandInteraction.d.ts +0 -15
  129. package/dist/src/structures/CommandInteraction.d.ts.map +0 -1
  130. package/dist/src/structures/CommandInteraction.js +0 -60
  131. package/dist/src/structures/CommandInteraction.js.map +0 -1
  132. package/dist/src/structures/ComponentHandler.d.ts +0 -6
  133. package/dist/src/structures/ComponentHandler.d.ts.map +0 -1
  134. package/dist/src/structures/ComponentHandler.js +0 -64
  135. package/dist/src/structures/ComponentHandler.js.map +0 -1
  136. package/dist/src/structures/MentionableSelectMenuInteraction.d.ts +0 -8
  137. package/dist/src/structures/MentionableSelectMenuInteraction.d.ts.map +0 -1
  138. package/dist/src/structures/MentionableSelectMenuInteraction.js +0 -15
  139. package/dist/src/structures/MentionableSelectMenuInteraction.js.map +0 -1
  140. package/dist/src/structures/RoleSelectMenuInteraction.d.ts +0 -8
  141. package/dist/src/structures/RoleSelectMenuInteraction.d.ts.map +0 -1
  142. package/dist/src/structures/RoleSelectMenuInteraction.js +0 -14
  143. package/dist/src/structures/RoleSelectMenuInteraction.js.map +0 -1
  144. package/dist/src/structures/StringSelectMenuInteraction.d.ts +0 -8
  145. package/dist/src/structures/StringSelectMenuInteraction.d.ts.map +0 -1
  146. package/dist/src/structures/StringSelectMenuInteraction.js +0 -14
  147. package/dist/src/structures/StringSelectMenuInteraction.js.map +0 -1
  148. package/dist/src/structures/UserSelectMenuInteraction.d.ts +0 -8
  149. package/dist/src/structures/UserSelectMenuInteraction.d.ts.map +0 -1
  150. package/dist/src/structures/UserSelectMenuInteraction.js +0 -14
  151. package/dist/src/structures/UserSelectMenuInteraction.js.map +0 -1
  152. package/dist/src/types.d.ts +0 -31
  153. package/dist/src/types.d.ts.map +0 -1
  154. package/dist/src/types.js +0 -33
  155. package/dist/src/types.js.map +0 -1
  156. package/docs/classes/AnySelectMenu.mdx +0 -114
  157. package/docs/classes/AnySelectMenuInteraction.mdx +0 -175
  158. package/docs/classes/AutocompleteInteraction.mdx +0 -166
  159. package/docs/classes/AutocompleteOptionsHandler.mdx +0 -243
  160. package/docs/classes/BaseChannel.mdx +0 -97
  161. package/docs/classes/BaseCommand.mdx +0 -61
  162. package/docs/classes/BaseComponent.mdx +0 -55
  163. package/docs/classes/BaseComponentInteraction.mdx +0 -160
  164. package/docs/classes/BaseGuildChannel.mdx +0 -262
  165. package/docs/classes/BaseGuildTextChannel.mdx +0 -360
  166. package/docs/classes/BaseInteraction.mdx +0 -137
  167. package/docs/classes/Button.mdx +0 -99
  168. package/docs/classes/ButtonInteraction.mdx +0 -155
  169. package/docs/classes/ChannelSelectMenu.mdx +0 -122
  170. package/docs/classes/ChannelSelectMenuInteraction.mdx +0 -171
  171. package/docs/classes/Client.mdx +0 -48
  172. package/docs/classes/Command.mdx +0 -111
  173. package/docs/classes/CommandHandler.mdx +0 -65
  174. package/docs/classes/CommandInteraction.mdx +0 -155
  175. package/docs/classes/CommandWithSubcommandGroups.mdx +0 -73
  176. package/docs/classes/CommandWithSubcommands.mdx +0 -76
  177. package/docs/classes/ComponentHandler.mdx +0 -49
  178. package/docs/classes/DmChannel.mdx +0 -118
  179. package/docs/classes/GroupDmChannel.mdx +0 -197
  180. package/docs/classes/Guild.mdx +0 -157
  181. package/docs/classes/GuildAnnouncementChannel.mdx +0 -377
  182. package/docs/classes/GuildCategoryChannel.mdx +0 -272
  183. package/docs/classes/GuildForumChannel.mdx +0 -333
  184. package/docs/classes/GuildMediaChannel.mdx +0 -327
  185. package/docs/classes/GuildStageChannel.mdx +0 -276
  186. package/docs/classes/GuildStageOrVoiceChannel.mdx +0 -292
  187. package/docs/classes/GuildTextChannel.mdx +0 -367
  188. package/docs/classes/GuildThreadChannel.mdx +0 -425
  189. package/docs/classes/GuildThreadOnlyChannel.mdx +0 -333
  190. package/docs/classes/GuildVoiceChannel.mdx +0 -276
  191. package/docs/classes/LinkButton.mdx +0 -84
  192. package/docs/classes/MentionableSelectMenu.mdx +0 -120
  193. package/docs/classes/MentionableSelectMenuInteraction.mdx +0 -171
  194. package/docs/classes/Message.mdx +0 -126
  195. package/docs/classes/OptionsHandler.mdx +0 -203
  196. package/docs/classes/PremiumButton.mdx +0 -84
  197. package/docs/classes/Role.mdx +0 -228
  198. package/docs/classes/RoleSelectMenu.mdx +0 -120
  199. package/docs/classes/RoleSelectMenuInteraction.mdx +0 -171
  200. package/docs/classes/Row.mdx +0 -88
  201. package/docs/classes/StringSelectMenu.mdx +0 -120
  202. package/docs/classes/StringSelectMenuInteraction.mdx +0 -171
  203. package/docs/classes/User.mdx +0 -119
  204. package/docs/classes/UserSelectMenu.mdx +0 -120
  205. package/docs/classes/UserSelectMenuInteraction.mdx +0 -171
  206. package/docs/enumerations/ClientMode.mdx +0 -16
  207. package/docs/functions/channelFactory.mdx +0 -16
  208. package/docs/index.mdx +0 -83
  209. package/docs/type-aliases/AnySelectMenuComponentType.mdx +0 -5
  210. package/docs/type-aliases/ClientOptions.mdx +0 -20
  211. package/docs/type-aliases/CommandOptions.mdx +0 -5
  212. package/docs/type-aliases/ComponentAdditionalData.mdx +0 -9
  213. package/docs/type-aliases/InteractionFileData.mdx +0 -15
  214. package/docs/type-aliases/InteractionReplyData.mdx +0 -14
  215. package/docs/type-aliases/InteractionReplyOptions.mdx +0 -13
  216. package/docs/type-aliases/RawOptions.mdx +0 -9
  217. package/docs/type-aliases/meta.json +0 -3
  218. package/src/README.md +0 -7
  219. package/src/abstracts/AnySelectMenu.ts +0 -63
  220. package/src/abstracts/AnySelectMenuInteraction.ts +0 -29
  221. package/src/abstracts/Base.ts +0 -12
  222. package/src/abstracts/BaseChannel.ts +0 -73
  223. package/src/abstracts/BaseCommand.ts +0 -89
  224. package/src/abstracts/BaseComponent.ts +0 -49
  225. package/src/abstracts/BaseComponentInteraction.ts +0 -19
  226. package/src/abstracts/BaseGuildChannel.ts +0 -152
  227. package/src/abstracts/BaseGuildTextChannel.ts +0 -77
  228. package/src/abstracts/BaseInteraction.ts +0 -209
  229. package/src/abstracts/GuildThreadOnlyChannel.ts +0 -71
  230. package/src/classes/Button.ts +0 -95
  231. package/src/classes/ChannelSelectMenu.ts +0 -21
  232. package/src/classes/Client.ts +0 -277
  233. package/src/classes/Command.ts +0 -53
  234. package/src/classes/CommandWithSubcommandGroups.ts +0 -47
  235. package/src/classes/CommandWithSubcommands.ts +0 -35
  236. package/src/classes/MentionableSelectMenu.ts +0 -19
  237. package/src/classes/Modal.ts +0 -38
  238. package/src/classes/RoleSelectMenu.ts +0 -19
  239. package/src/classes/Row.ts +0 -50
  240. package/src/classes/StringSelectMenu.ts +0 -19
  241. package/src/classes/TextInput.ts +0 -65
  242. package/src/classes/UserSelectMenu.ts +0 -19
  243. package/src/factories/channelFactory.ts +0 -43
  244. package/src/index.ts +0 -62
  245. package/src/internals/AutocompleteInteraction.ts +0 -107
  246. package/src/internals/ButtonInteraction.ts +0 -26
  247. package/src/internals/ChannelSelectMenuInteraction.ts +0 -15
  248. package/src/internals/CommandHandler.ts +0 -127
  249. package/src/internals/CommandInteraction.ts +0 -49
  250. package/src/internals/ComponentHandler.ts +0 -92
  251. package/src/internals/MentionableSelectMenuInteraction.ts +0 -21
  252. package/src/internals/ModalHandler.ts +0 -27
  253. package/src/internals/ModalInteraction.ts +0 -25
  254. package/src/internals/OptionsHandler.ts +0 -148
  255. package/src/internals/RoleSelectMenuInteraction.ts +0 -20
  256. package/src/internals/StringSelectMenuInteraction.ts +0 -20
  257. package/src/internals/UserSelectMenuInteraction.ts +0 -20
  258. package/src/structures/DmChannel.ts +0 -31
  259. package/src/structures/GroupDmChannel.ts +0 -132
  260. package/src/structures/Guild.ts +0 -154
  261. package/src/structures/GuildAnnouncementChannel.ts +0 -20
  262. package/src/structures/GuildCategoryChannel.ts +0 -16
  263. package/src/structures/GuildForumChannel.ts +0 -20
  264. package/src/structures/GuildMediaChannel.ts +0 -13
  265. package/src/structures/GuildMember.ts +0 -231
  266. package/src/structures/GuildStageOrVoiceChannel.ts +0 -46
  267. package/src/structures/GuildTextChannel.ts +0 -21
  268. package/src/structures/GuildThreadChannel.ts +0 -150
  269. package/src/structures/Message.ts +0 -124
  270. package/src/structures/Role.ts +0 -201
  271. package/src/structures/User.ts +0 -153
  272. package/src/utils.ts +0 -13
  273. package/tests/index.test.ts +0 -4
  274. package/tsconfig.json +0 -12
  275. package/typedoc.json +0 -9
@@ -1,166 +0,0 @@
1
- ---
2
- title: AutocompleteInteraction
3
- ---
4
-
5
- This is the base type interaction, all interaction types extend from this
6
-
7
- ## Extends
8
-
9
- - [`BaseInteraction`](/carbon/api/classes/BaseInteraction)\<`APIApplicationCommandAutocompleteInteraction`\>
10
-
11
- ## Constructors
12
-
13
- ### new AutocompleteInteraction()
14
-
15
- > **new AutocompleteInteraction**(`client`, `data`, `command`?): [`AutocompleteInteraction`](/carbon/api/classes/AutocompleteInteraction)
16
-
17
- #### Parameters
18
-
19
- | Parameter | Type |
20
- | ------ | ------ |
21
- | `client` | [`Client`](/carbon/api/classes/Client) |
22
- | `data` | `APIApplicationCommandAutocompleteInteraction` |
23
- | `command`? | [`BaseCommand`](/carbon/api/classes/BaseCommand) |
24
-
25
- #### Returns
26
-
27
- [`AutocompleteInteraction`](/carbon/api/classes/AutocompleteInteraction)
28
-
29
- #### Overrides
30
-
31
- [`BaseInteraction`](/carbon/api/classes/BaseInteraction).[`constructor`](/carbon/api/classes/BaseInteraction#constructors)
32
-
33
- ## Properties
34
-
35
- | Property | Type | Default value | Description | Inherited from |
36
- | ------ | ------ | ------ | ------ | ------ |
37
- | `_deferred` | `boolean` | `false` | **`Internal`** Whether the interaction is deferred already | [`BaseInteraction`](/carbon/api/classes/BaseInteraction).`_deferred` |
38
- | `client` | [`Client`](/carbon/api/classes/Client) | `undefined` | - | [`BaseInteraction`](/carbon/api/classes/BaseInteraction).`client` |
39
- | `options?` | [`AutocompleteOptionsHandler`](/carbon/api/classes/AutocompleteOptionsHandler) | `undefined` | This is the options of the commands, parsed from the interaction data. | - |
40
- | `rawData` | `APIApplicationCommandAutocompleteInteraction` | `undefined` | The raw data of the interaction | [`BaseInteraction`](/carbon/api/classes/BaseInteraction).`rawData` |
41
- | `type` | `InteractionType` | `undefined` | The type of interaction | [`BaseInteraction`](/carbon/api/classes/BaseInteraction).`type` |
42
- | `userId` | `undefined` \| `string` | `undefined` | The user who sent the interaction | [`BaseInteraction`](/carbon/api/classes/BaseInteraction).`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
- [`BaseInteraction`](/carbon/api/classes/BaseInteraction).[`channel`](/carbon/api/classes/BaseInteraction#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
- [`BaseInteraction`](/carbon/api/classes/BaseInteraction).[`guild`](/carbon/api/classes/BaseInteraction#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
- [`BaseInteraction`](/carbon/api/classes/BaseInteraction).[`member`](/carbon/api/classes/BaseInteraction#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
- [`BaseInteraction`](/carbon/api/classes/BaseInteraction).[`message`](/carbon/api/classes/BaseInteraction#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
- [`BaseInteraction`](/carbon/api/classes/BaseInteraction).[`user`](/carbon/api/classes/BaseInteraction#user)
113
-
114
- ## Methods
115
-
116
- ### defer()
117
-
118
- > **defer**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
119
-
120
- **`Internal`**
121
-
122
- Defer the interaction response. This is used automatically by commands that are set to defer.
123
- If the interaction is already deferred, this will do nothing.
124
-
125
- #### Returns
126
-
127
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
128
-
129
- #### Overrides
130
-
131
- [`BaseInteraction`](/carbon/api/classes/BaseInteraction).[`defer`](/carbon/api/classes/BaseInteraction#defer)
132
-
133
- ***
134
-
135
- ### reply()
136
-
137
- > **reply**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
138
-
139
- Reply to an interaction.
140
- If the interaction is deferred, this will edit the original response.
141
-
142
- #### Returns
143
-
144
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
145
-
146
- #### Overrides
147
-
148
- [`BaseInteraction`](/carbon/api/classes/BaseInteraction).[`reply`](/carbon/api/classes/BaseInteraction#reply)
149
-
150
- ***
151
-
152
- ### respond()
153
-
154
- > **respond**(`choices`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
155
-
156
- Respond with the choices for an autocomplete interaction
157
-
158
- #### Parameters
159
-
160
- | Parameter | Type |
161
- | ------ | ------ |
162
- | `choices` | `object`[] |
163
-
164
- #### Returns
165
-
166
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
@@ -1,243 +0,0 @@
1
- ---
2
- title: AutocompleteOptionsHandler
3
- ---
4
-
5
- This class is used to parse the options of a command, and provide errors for any missing or invalid options.
6
- It is used internally by the Command class.
7
-
8
- ## Extends
9
-
10
- - [`OptionsHandler`](/carbon/api/classes/OptionsHandler)
11
-
12
- ## Constructors
13
-
14
- ### new AutocompleteOptionsHandler()
15
-
16
- > **new AutocompleteOptionsHandler**(`client`, `options`): [`AutocompleteOptionsHandler`](/carbon/api/classes/AutocompleteOptionsHandler)
17
-
18
- #### Parameters
19
-
20
- | Parameter | Type |
21
- | ------ | ------ |
22
- | `client` | [`Client`](/carbon/api/classes/Client) |
23
- | `options` | `APIApplicationCommandInteractionDataBasicOption`[] |
24
-
25
- #### Returns
26
-
27
- [`AutocompleteOptionsHandler`](/carbon/api/classes/AutocompleteOptionsHandler)
28
-
29
- #### Inherited from
30
-
31
- [`OptionsHandler`](/carbon/api/classes/OptionsHandler).[`constructor`](/carbon/api/classes/OptionsHandler#constructors)
32
-
33
- ## Properties
34
-
35
- | Property | Modifier | Type | Default value | Description | Inherited from |
36
- | ------ | ------ | ------ | ------ | ------ | ------ |
37
- | `client` | `public` | [`Client`](/carbon/api/classes/Client) | `undefined` | - | [`OptionsHandler`](/carbon/api/classes/OptionsHandler).`client` |
38
- | `errors` | `readonly` | `string`[] | `[]` | The errors that were encountered while parsing the options. | [`OptionsHandler`](/carbon/api/classes/OptionsHandler).`errors` |
39
- | `raw` | `readonly` | `APIApplicationCommandInteractionDataBasicOption`[] | `undefined` | The raw options that were in the interaction data, before they were parsed. | [`OptionsHandler`](/carbon/api/classes/OptionsHandler).`raw` |
40
-
41
- ## Methods
42
-
43
- ### getBoolean()
44
-
45
- > **getBoolean**(`key`): `undefined` \| `true`
46
-
47
- Get the value of a boolean option.
48
-
49
- #### Parameters
50
-
51
- | Parameter | Type | Description |
52
- | ------ | ------ | ------ |
53
- | `key` | `string` | The name of the option to get the value of. |
54
-
55
- #### Returns
56
-
57
- `undefined` \| `true`
58
-
59
- The value of the option, or undefined if the option was not provided.
60
-
61
- #### Inherited from
62
-
63
- [`OptionsHandler`](/carbon/api/classes/OptionsHandler).[`getBoolean`](/carbon/api/classes/OptionsHandler#getboolean)
64
-
65
- ***
66
-
67
- ### getChannel()
68
-
69
- > **getChannel**(`key`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`undefined` \| `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)\>
70
-
71
- Get the value of a channel option.
72
-
73
- #### Parameters
74
-
75
- | Parameter | Type | Description |
76
- | ------ | ------ | ------ |
77
- | `key` | `string` | The name of the option to get the value of. |
78
-
79
- #### Returns
80
-
81
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`undefined` \| `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)\>
82
-
83
- The value of the option, or undefined if the option was not provided.
84
-
85
- #### Inherited from
86
-
87
- [`OptionsHandler`](/carbon/api/classes/OptionsHandler).[`getChannel`](/carbon/api/classes/OptionsHandler#getchannel)
88
-
89
- ***
90
-
91
- ### getFocused()
92
-
93
- > **getFocused**(): `undefined` \| `null` \| `string` \| `number` \| `true`
94
-
95
- Get the focused option (the one that is being autocompleted)
96
-
97
- #### Returns
98
-
99
- `undefined` \| `null` \| `string` \| `number` \| `true`
100
-
101
- ***
102
-
103
- ### getInteger()
104
-
105
- > **getInteger**(`key`): `undefined` \| `string` \| `number` \| `true`
106
-
107
- Get the value of an integer option.
108
-
109
- #### Parameters
110
-
111
- | Parameter | Type | Description |
112
- | ------ | ------ | ------ |
113
- | `key` | `string` | The name of the option to get the value of. |
114
-
115
- #### Returns
116
-
117
- `undefined` \| `string` \| `number` \| `true`
118
-
119
- The value of the option, or undefined if the option was not provided.
120
-
121
- #### Inherited from
122
-
123
- [`OptionsHandler`](/carbon/api/classes/OptionsHandler).[`getInteger`](/carbon/api/classes/OptionsHandler#getinteger)
124
-
125
- ***
126
-
127
- ### getMentionable()
128
-
129
- > **getMentionable**(`key`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`undefined` \| [`Role`](/carbon/api/classes/Role) \| [`User`](/carbon/api/classes/User)\>
130
-
131
- Get the value of a mentionable option.
132
-
133
- #### Parameters
134
-
135
- | Parameter | Type | Description |
136
- | ------ | ------ | ------ |
137
- | `key` | `string` | The name of the option to get the value of. |
138
-
139
- #### Returns
140
-
141
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`undefined` \| [`Role`](/carbon/api/classes/Role) \| [`User`](/carbon/api/classes/User)\>
142
-
143
- The value of the option, or undefined if the option was not provided.
144
-
145
- #### Inherited from
146
-
147
- [`OptionsHandler`](/carbon/api/classes/OptionsHandler).[`getMentionable`](/carbon/api/classes/OptionsHandler#getmentionable)
148
-
149
- ***
150
-
151
- ### getNumber()
152
-
153
- > **getNumber**(`key`): `undefined` \| `number`
154
-
155
- Get the value of a number option.
156
-
157
- #### Parameters
158
-
159
- | Parameter | Type | Description |
160
- | ------ | ------ | ------ |
161
- | `key` | `string` | The name of the option to get the value of. |
162
-
163
- #### Returns
164
-
165
- `undefined` \| `number`
166
-
167
- The value of the option, or undefined if the option was not provided.
168
-
169
- #### Inherited from
170
-
171
- [`OptionsHandler`](/carbon/api/classes/OptionsHandler).[`getNumber`](/carbon/api/classes/OptionsHandler#getnumber)
172
-
173
- ***
174
-
175
- ### getRole()
176
-
177
- > **getRole**(`key`): `undefined` \| [`Role`](/carbon/api/classes/Role)
178
-
179
- Get the value of a role option.
180
-
181
- #### Parameters
182
-
183
- | Parameter | Type | Description |
184
- | ------ | ------ | ------ |
185
- | `key` | `string` | The name of the option to get the value of. |
186
-
187
- #### Returns
188
-
189
- `undefined` \| [`Role`](/carbon/api/classes/Role)
190
-
191
- The value of the option, or undefined if the option was not provided.
192
-
193
- #### Inherited from
194
-
195
- [`OptionsHandler`](/carbon/api/classes/OptionsHandler).[`getRole`](/carbon/api/classes/OptionsHandler#getrole)
196
-
197
- ***
198
-
199
- ### getString()
200
-
201
- > **getString**(`key`): `undefined` \| `string`
202
-
203
- Get the value of a string option.
204
-
205
- #### Parameters
206
-
207
- | Parameter | Type | Description |
208
- | ------ | ------ | ------ |
209
- | `key` | `string` | The name of the option to get the value of. |
210
-
211
- #### Returns
212
-
213
- `undefined` \| `string`
214
-
215
- The value of the option, or undefined if the option was not provided.
216
-
217
- #### Inherited from
218
-
219
- [`OptionsHandler`](/carbon/api/classes/OptionsHandler).[`getString`](/carbon/api/classes/OptionsHandler#getstring)
220
-
221
- ***
222
-
223
- ### getUser()
224
-
225
- > **getUser**(`key`): `undefined` \| [`User`](/carbon/api/classes/User)
226
-
227
- Get the value of a user option.
228
-
229
- #### Parameters
230
-
231
- | Parameter | Type | Description |
232
- | ------ | ------ | ------ |
233
- | `key` | `string` | The name of the option to get the value of. |
234
-
235
- #### Returns
236
-
237
- `undefined` \| [`User`](/carbon/api/classes/User)
238
-
239
- The value of the option, or undefined if the option was not provided.
240
-
241
- #### Inherited from
242
-
243
- [`OptionsHandler`](/carbon/api/classes/OptionsHandler).[`getUser`](/carbon/api/classes/OptionsHandler#getuser)
@@ -1,97 +0,0 @@
1
- ---
2
- title: BaseChannel
3
- ---
4
-
5
- ## Extends
6
-
7
- - `Base`
8
-
9
- ## Extended by
10
-
11
- - [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel)
12
- - [`DmChannel`](/carbon/api/classes/DmChannel)
13
- - [`GroupDmChannel`](/carbon/api/classes/GroupDmChannel)
14
-
15
- ## Type Parameters
16
-
17
- | Type Parameter |
18
- | ------ |
19
- | `Type` *extends* `ChannelType` |
20
-
21
- ## Constructors
22
-
23
- ### new BaseChannel()
24
-
25
- > **new BaseChannel**\<`Type`\>(`client`, `rawDataOrId`): [`BaseChannel`](/carbon/api/classes/BaseChannel)\<`Type`\>
26
-
27
- #### Parameters
28
-
29
- | Parameter | Type |
30
- | ------ | ------ |
31
- | `client` | [`Client`](/carbon/api/classes/Client) |
32
- | `rawDataOrId` | `string` \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIDMChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGroupDMChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildCategoryChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildForumChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildMediaChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildStageVoiceChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildVoiceChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APINewsChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APITextChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIThreadChannel`, `object`\> |
33
-
34
- #### Returns
35
-
36
- [`BaseChannel`](/carbon/api/classes/BaseChannel)\<`Type`\>
37
-
38
- #### Overrides
39
-
40
- `Base.constructor`
41
-
42
- ## Properties
43
-
44
- | Property | Modifier | Type | Default value | Description | Inherited from |
45
- | ------ | ------ | ------ | ------ | ------ | ------ |
46
- | `client` | `public` | [`Client`](/carbon/api/classes/Client) | `undefined` | - | `Base.client` |
47
- | `flags?` | `public` | `null` \| `number` | `undefined` | The flags of the channel in a bitfield. **See** https://discord.com/developers/docs/resources/channel#channel-object-channel-flags | - |
48
- | `id` | `public` | `string` | `undefined` | The id of the channel. | - |
49
- | `partial` | `public` | `boolean` | `undefined` | Whether the channel is a partial channel (meaning it does not have all the data). If this is true, you should use [BaseChannel.fetch](/carbon/api/classes/BaseChannel#fetch) to get the full data of the channel. | - |
50
- | `rawData` | `protected` | `null` \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIDMChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGroupDMChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildCategoryChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildForumChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildMediaChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildStageVoiceChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildVoiceChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APINewsChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APITextChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIThreadChannel`, `object`\> | `null` | The raw data of the channel. | - |
51
- | `type?` | `public` | `Type` | `undefined` | The type of the channel. | - |
52
-
53
- ## Methods
54
-
55
- ### fetch()
56
-
57
- > **fetch**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
58
-
59
- Fetches the channel from the API.
60
-
61
- #### Returns
62
-
63
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
64
-
65
- The channel data.
66
-
67
- ***
68
-
69
- ### setData()
70
-
71
- > `protected` **setData**(`data`): `void`
72
-
73
- #### Parameters
74
-
75
- | Parameter | Type |
76
- | ------ | ------ |
77
- | `data` | [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIDMChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGroupDMChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildCategoryChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildForumChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildMediaChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildStageVoiceChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildVoiceChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APINewsChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APITextChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIThreadChannel`, `object`\> |
78
-
79
- #### Returns
80
-
81
- `void`
82
-
83
- ***
84
-
85
- ### setSpecificData()
86
-
87
- > `abstract` `protected` **setSpecificData**(`data`): `void`
88
-
89
- #### Parameters
90
-
91
- | Parameter | Type |
92
- | ------ | ------ |
93
- | `data` | [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIDMChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGroupDMChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildCategoryChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildForumChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildMediaChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildStageVoiceChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildVoiceChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APINewsChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APITextChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIThreadChannel`, `object`\> |
94
-
95
- #### Returns
96
-
97
- `void`
@@ -1,61 +0,0 @@
1
- ---
2
- title: BaseCommand
3
- ---
4
-
5
- Represents the base data of a command that the user creates
6
-
7
- ## Extended by
8
-
9
- - [`Command`](/carbon/api/classes/Command)
10
- - [`CommandWithSubcommands`](/carbon/api/classes/CommandWithSubcommands)
11
-
12
- ## Constructors
13
-
14
- ### new BaseCommand()
15
-
16
- > **new BaseCommand**(): [`BaseCommand`](/carbon/api/classes/BaseCommand)
17
-
18
- #### Returns
19
-
20
- [`BaseCommand`](/carbon/api/classes/BaseCommand)
21
-
22
- ## Properties
23
-
24
- | Property | Modifier | Type | Default value | Description |
25
- | ------ | ------ | ------ | ------ | ------ |
26
- | `components?` | `public` | [`BaseComponent`](/carbon/api/classes/BaseComponent)[] | `[]` | All the components that the command is able to use. You mount these here so the handler can access them |
27
- | `contexts` | `public` | `InteractionContextType`[] | `undefined` | **`Beta`** The contexts this command can be used in API types are not finalized |
28
- | `defer` | `public` | `boolean` | `false` | Whether the command response should be automatically deferred |
29
- | `description` | `abstract` | `string` | `undefined` | A description of the command |
30
- | `ephemeral` | `public` | `boolean` | `false` | Whether the command response should be ephemeral |
31
- | `integrationTypes` | `public` | `ApplicationIntegrationType`[] | `undefined` | **`Beta`** The places this command can be used in API types are not finalized |
32
- | `name` | `abstract` | `string` | `undefined` | The name of the command (e.g. "ping" for /ping) |
33
- | `type` | `abstract` | `ApplicationCommandType` | `undefined` | The type of the command |
34
-
35
- ## Methods
36
-
37
- ### serialize()
38
-
39
- > **serialize**(): `RESTPostAPIChatInputApplicationCommandsJSONBody` \| `RESTPostAPIContextMenuApplicationCommandsJSONBody`
40
-
41
- **`Internal`**
42
-
43
- Serializes the command into a JSON object that can be sent to Discord
44
-
45
- #### Returns
46
-
47
- `RESTPostAPIChatInputApplicationCommandsJSONBody` \| `RESTPostAPIContextMenuApplicationCommandsJSONBody`
48
-
49
- ***
50
-
51
- ### serializeOptions()
52
-
53
- > `abstract` **serializeOptions**(): `AddUndefinedToPossiblyUndefinedPropertiesOfInterface`\<`undefined` \| `APIApplicationCommandOption`[]\>
54
-
55
- **`Internal`**
56
-
57
- Serializes the options of the command into a JSON object that can be sent to Discord
58
-
59
- #### Returns
60
-
61
- `AddUndefinedToPossiblyUndefinedPropertiesOfInterface`\<`undefined` \| `APIApplicationCommandOption`[]\>
@@ -1,55 +0,0 @@
1
- ---
2
- title: BaseComponent
3
- ---
4
-
5
- ## Extended by
6
-
7
- - [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu)
8
-
9
- ## Constructors
10
-
11
- ### new BaseComponent()
12
-
13
- > **new BaseComponent**(`data`?): [`BaseComponent`](/carbon/api/classes/BaseComponent)
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
- [`BaseComponent`](/carbon/api/classes/BaseComponent)
25
-
26
- ## Properties
27
-
28
- | Property | Modifier | Type | Default value | Description |
29
- | ------ | ------ | ------ | ------ | ------ |
30
- | `additionalData` | `public` | `null` \| [`ComponentAdditionalData`](/carbon/api/type-aliases/ComponentAdditionalData) | `null` | - |
31
- | `customId` | `abstract` | `string` | `undefined` | The custom ID of the component |
32
- | `defer` | `public` | `boolean` | `false` | Whether the component response should be automatically deferred |
33
- | `ephemeral` | `public` | `boolean` | `false` | Whether the component response should be ephemeral |
34
- | `serialize` | `abstract` | () => `APIBaseComponent`\<`ComponentType`\> | `undefined` | - |
35
- | `type` | `abstract` | `ComponentType` | `undefined` | The type of the component |
36
-
37
- ## Methods
38
-
39
- ### createId()
40
-
41
- > **createId**(`additionalData`): `string`
42
-
43
- Create a custom ID to use for this component that embeds additional data that you want to be handed
44
-
45
- #### Parameters
46
-
47
- | Parameter | Type | Description |
48
- | ------ | ------ | ------ |
49
- | `additionalData` | `null` \| [`ComponentAdditionalData`](/carbon/api/type-aliases/ComponentAdditionalData) | The additional data that you want to be passed in this component's custom ID |
50
-
51
- #### Returns
52
-
53
- `string`
54
-
55
- The custom ID to use