@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,155 +0,0 @@
1
- ---
2
- title: CommandInteraction
3
- ---
4
-
5
- Represents a command interaction
6
-
7
- ## Extends
8
-
9
- - [`BaseInteraction`](/carbon/api/classes/BaseInteraction)\<`APIApplicationCommandInteraction`\>
10
-
11
- ## Constructors
12
-
13
- ### new CommandInteraction()
14
-
15
- > **new CommandInteraction**(`client`, `data`, `command`?): [`CommandInteraction`](/carbon/api/classes/CommandInteraction)
16
-
17
- #### Parameters
18
-
19
- | Parameter | Type |
20
- | ------ | ------ |
21
- | `client` | [`Client`](/carbon/api/classes/Client) |
22
- | `data` | `APIApplicationCommandInteraction` |
23
- | `command`? | [`BaseCommand`](/carbon/api/classes/BaseCommand) |
24
-
25
- #### Returns
26
-
27
- [`CommandInteraction`](/carbon/api/classes/CommandInteraction)
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?` | [`OptionsHandler`](/carbon/api/classes/OptionsHandler) | `undefined` | This is the options of the commands, parsed from the interaction data. It is only available if the command is a [Command](/carbon/api/classes/Command) class, and the command is a ChatInput command. | - |
40
- | `rawData` | `APIApplicationCommandInteraction` | `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
- #### Inherited from
130
-
131
- [`BaseInteraction`](/carbon/api/classes/BaseInteraction).[`defer`](/carbon/api/classes/BaseInteraction#defer)
132
-
133
- ***
134
-
135
- ### reply()
136
-
137
- > **reply**(`data`, `options`): [`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
- #### Parameters
143
-
144
- | Parameter | Type | Description |
145
- | ------ | ------ | ------ |
146
- | `data` | [`InteractionReplyData`](/carbon/api/type-aliases/InteractionReplyData) | The response data |
147
- | `options` | [`InteractionReplyOptions`](/carbon/api/type-aliases/InteractionReplyOptions) | - |
148
-
149
- #### Returns
150
-
151
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
152
-
153
- #### Inherited from
154
-
155
- [`BaseInteraction`](/carbon/api/classes/BaseInteraction).[`reply`](/carbon/api/classes/BaseInteraction#reply)
@@ -1,73 +0,0 @@
1
- ---
2
- title: CommandWithSubcommandGroups
3
- ---
4
-
5
- Represents a subcommand group command that the user creates.
6
- You make this instead of a [Command](/carbon/api/classes/Command) class when you want to have subcommand groups in your options.
7
-
8
- ## Extends
9
-
10
- - [`CommandWithSubcommands`](/carbon/api/classes/CommandWithSubcommands)
11
-
12
- ## Constructors
13
-
14
- ### new CommandWithSubcommandGroups()
15
-
16
- > **new CommandWithSubcommandGroups**(): [`CommandWithSubcommandGroups`](/carbon/api/classes/CommandWithSubcommandGroups)
17
-
18
- #### Returns
19
-
20
- [`CommandWithSubcommandGroups`](/carbon/api/classes/CommandWithSubcommandGroups)
21
-
22
- #### Inherited from
23
-
24
- [`CommandWithSubcommands`](/carbon/api/classes/CommandWithSubcommands).[`constructor`](/carbon/api/classes/CommandWithSubcommands#constructors)
25
-
26
- ## Properties
27
-
28
- | Property | Modifier | Type | Default value | Description | Overrides | Inherited from |
29
- | ------ | ------ | ------ | ------ | ------ | ------ | ------ |
30
- | `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 | - | [`CommandWithSubcommands`](/carbon/api/classes/CommandWithSubcommands).`components` |
31
- | `contexts` | `public` | `InteractionContextType`[] | `undefined` | **`Beta`** The contexts this command can be used in API types are not finalized | - | [`CommandWithSubcommands`](/carbon/api/classes/CommandWithSubcommands).`contexts` |
32
- | `defer` | `public` | `boolean` | `false` | Whether the command response should be automatically deferred | - | [`CommandWithSubcommands`](/carbon/api/classes/CommandWithSubcommands).`defer` |
33
- | `description` | `abstract` | `string` | `undefined` | A description of the command | - | [`CommandWithSubcommands`](/carbon/api/classes/CommandWithSubcommands).`description` |
34
- | `ephemeral` | `public` | `boolean` | `false` | Whether the command response should be ephemeral | - | [`CommandWithSubcommands`](/carbon/api/classes/CommandWithSubcommands).`ephemeral` |
35
- | `integrationTypes` | `public` | `ApplicationIntegrationType`[] | `undefined` | **`Beta`** The places this command can be used in API types are not finalized | - | [`CommandWithSubcommands`](/carbon/api/classes/CommandWithSubcommands).`integrationTypes` |
36
- | `name` | `abstract` | `string` | `undefined` | The name of the command (e.g. "ping" for /ping) | - | [`CommandWithSubcommands`](/carbon/api/classes/CommandWithSubcommands).`name` |
37
- | `subcommandGroups` | `abstract` | [`CommandWithSubcommands`](/carbon/api/classes/CommandWithSubcommands)[] | `undefined` | The subcommands that the user can use | - | - |
38
- | `subcommands` | `public` | [`Command`](/carbon/api/classes/Command)[] | `[]` | The subcommands that the user can use | [`CommandWithSubcommands`](/carbon/api/classes/CommandWithSubcommands).`subcommands` | - |
39
- | `type` | `public` | `ApplicationCommandType` | `ApplicationCommandType.ChatInput` | The type of the command | - | [`CommandWithSubcommands`](/carbon/api/classes/CommandWithSubcommands).`type` |
40
-
41
- ## Methods
42
-
43
- ### serialize()
44
-
45
- > **serialize**(): `RESTPostAPIChatInputApplicationCommandsJSONBody` \| `RESTPostAPIContextMenuApplicationCommandsJSONBody`
46
-
47
- **`Internal`**
48
-
49
- Serializes the command into a JSON object that can be sent to Discord
50
-
51
- #### Returns
52
-
53
- `RESTPostAPIChatInputApplicationCommandsJSONBody` \| `RESTPostAPIContextMenuApplicationCommandsJSONBody`
54
-
55
- #### Inherited from
56
-
57
- [`CommandWithSubcommands`](/carbon/api/classes/CommandWithSubcommands).[`serialize`](/carbon/api/classes/CommandWithSubcommands#serialize)
58
-
59
- ***
60
-
61
- ### serializeOptions()
62
-
63
- > **serializeOptions**(): (`APIApplicationCommandSubcommandGroupOption` \| `APIApplicationCommandSubcommandOption`)[]
64
-
65
- **`Internal`**
66
-
67
- #### Returns
68
-
69
- (`APIApplicationCommandSubcommandGroupOption` \| `APIApplicationCommandSubcommandOption`)[]
70
-
71
- #### Overrides
72
-
73
- [`CommandWithSubcommands`](/carbon/api/classes/CommandWithSubcommands).[`serializeOptions`](/carbon/api/classes/CommandWithSubcommands#serializeoptions)
@@ -1,76 +0,0 @@
1
- ---
2
- title: CommandWithSubcommands
3
- ---
4
-
5
- Represents a subcommand command that the user creates.
6
- You make this instead of a [Command](/carbon/api/classes/Command) class when you want to have subcommands in your options.
7
-
8
- ## Extends
9
-
10
- - [`BaseCommand`](/carbon/api/classes/BaseCommand)
11
-
12
- ## Extended by
13
-
14
- - [`CommandWithSubcommandGroups`](/carbon/api/classes/CommandWithSubcommandGroups)
15
-
16
- ## Constructors
17
-
18
- ### new CommandWithSubcommands()
19
-
20
- > **new CommandWithSubcommands**(): [`CommandWithSubcommands`](/carbon/api/classes/CommandWithSubcommands)
21
-
22
- #### Returns
23
-
24
- [`CommandWithSubcommands`](/carbon/api/classes/CommandWithSubcommands)
25
-
26
- #### Inherited from
27
-
28
- [`BaseCommand`](/carbon/api/classes/BaseCommand).[`constructor`](/carbon/api/classes/BaseCommand#constructors)
29
-
30
- ## Properties
31
-
32
- | Property | Modifier | Type | Default value | Description | Overrides | Inherited from |
33
- | ------ | ------ | ------ | ------ | ------ | ------ | ------ |
34
- | `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 | - | [`BaseCommand`](/carbon/api/classes/BaseCommand).`components` |
35
- | `contexts` | `public` | `InteractionContextType`[] | `undefined` | **`Beta`** The contexts this command can be used in API types are not finalized | - | [`BaseCommand`](/carbon/api/classes/BaseCommand).`contexts` |
36
- | `defer` | `public` | `boolean` | `false` | Whether the command response should be automatically deferred | - | [`BaseCommand`](/carbon/api/classes/BaseCommand).`defer` |
37
- | `description` | `abstract` | `string` | `undefined` | A description of the command | - | [`BaseCommand`](/carbon/api/classes/BaseCommand).`description` |
38
- | `ephemeral` | `public` | `boolean` | `false` | Whether the command response should be ephemeral | - | [`BaseCommand`](/carbon/api/classes/BaseCommand).`ephemeral` |
39
- | `integrationTypes` | `public` | `ApplicationIntegrationType`[] | `undefined` | **`Beta`** The places this command can be used in API types are not finalized | - | [`BaseCommand`](/carbon/api/classes/BaseCommand).`integrationTypes` |
40
- | `name` | `abstract` | `string` | `undefined` | The name of the command (e.g. "ping" for /ping) | - | [`BaseCommand`](/carbon/api/classes/BaseCommand).`name` |
41
- | `subcommands` | `abstract` | [`Command`](/carbon/api/classes/Command)[] | `undefined` | The subcommands that the user can use | - | - |
42
- | `type` | `public` | `ApplicationCommandType` | `ApplicationCommandType.ChatInput` | The type of the command | [`BaseCommand`](/carbon/api/classes/BaseCommand).`type` | - |
43
-
44
- ## Methods
45
-
46
- ### serialize()
47
-
48
- > **serialize**(): `RESTPostAPIChatInputApplicationCommandsJSONBody` \| `RESTPostAPIContextMenuApplicationCommandsJSONBody`
49
-
50
- **`Internal`**
51
-
52
- Serializes the command into a JSON object that can be sent to Discord
53
-
54
- #### Returns
55
-
56
- `RESTPostAPIChatInputApplicationCommandsJSONBody` \| `RESTPostAPIContextMenuApplicationCommandsJSONBody`
57
-
58
- #### Inherited from
59
-
60
- [`BaseCommand`](/carbon/api/classes/BaseCommand).[`serialize`](/carbon/api/classes/BaseCommand#serialize)
61
-
62
- ***
63
-
64
- ### serializeOptions()
65
-
66
- > **serializeOptions**(): `AddUndefinedToPossiblyUndefinedPropertiesOfInterface`\<`undefined` \| `APIApplicationCommandOption`[]\>
67
-
68
- **`Internal`**
69
-
70
- #### Returns
71
-
72
- `AddUndefinedToPossiblyUndefinedPropertiesOfInterface`\<`undefined` \| `APIApplicationCommandOption`[]\>
73
-
74
- #### Overrides
75
-
76
- [`BaseCommand`](/carbon/api/classes/BaseCommand).[`serializeOptions`](/carbon/api/classes/BaseCommand#serializeoptions)
@@ -1,49 +0,0 @@
1
- ---
2
- title: ComponentHandler
3
- ---
4
-
5
- ## Extends
6
-
7
- - `Base`
8
-
9
- ## Constructors
10
-
11
- ### new ComponentHandler()
12
-
13
- > **new ComponentHandler**(`client`): [`ComponentHandler`](/carbon/api/classes/ComponentHandler)
14
-
15
- #### Parameters
16
-
17
- | Parameter | Type |
18
- | ------ | ------ |
19
- | `client` | [`Client`](/carbon/api/classes/Client) |
20
-
21
- #### Returns
22
-
23
- [`ComponentHandler`](/carbon/api/classes/ComponentHandler)
24
-
25
- #### Inherited from
26
-
27
- `Base.constructor`
28
-
29
- ## Properties
30
-
31
- | Property | Type | Inherited from |
32
- | ------ | ------ | ------ |
33
- | `client` | [`Client`](/carbon/api/classes/Client) | `Base.client` |
34
-
35
- ## Methods
36
-
37
- ### handleInteraction()
38
-
39
- > **handleInteraction**(`data`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`undefined` \| `false`\>
40
-
41
- #### Parameters
42
-
43
- | Parameter | Type |
44
- | ------ | ------ |
45
- | `data` | `APIMessageComponentInteraction` |
46
-
47
- #### Returns
48
-
49
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`undefined` \| `false`\>
@@ -1,118 +0,0 @@
1
- ---
2
- title: DmChannel
3
- ---
4
-
5
- Represents a DM between two users.
6
-
7
- ## Extends
8
-
9
- - [`BaseChannel`](/carbon/api/classes/BaseChannel)\<`ChannelType.DM`\>
10
-
11
- ## Constructors
12
-
13
- ### new DmChannel()
14
-
15
- > **new DmChannel**(`client`, `rawDataOrId`): [`DmChannel`](/carbon/api/classes/DmChannel)
16
-
17
- #### Parameters
18
-
19
- | Parameter | Type |
20
- | ------ | ------ |
21
- | `client` | [`Client`](/carbon/api/classes/Client) |
22
- | `rawDataOrId` | `string` \| `APIDMChannel` |
23
-
24
- #### Returns
25
-
26
- [`DmChannel`](/carbon/api/classes/DmChannel)
27
-
28
- #### Inherited from
29
-
30
- [`BaseChannel`](/carbon/api/classes/BaseChannel).[`constructor`](/carbon/api/classes/BaseChannel#constructors)
31
-
32
- ## Properties
33
-
34
- | Property | Modifier | Type | Default value | Description | Overrides | Inherited from |
35
- | ------ | ------ | ------ | ------ | ------ | ------ | ------ |
36
- | `client` | `public` | [`Client`](/carbon/api/classes/Client) | `undefined` | - | - | [`BaseChannel`](/carbon/api/classes/BaseChannel).`client` |
37
- | `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 | - | [`BaseChannel`](/carbon/api/classes/BaseChannel).`flags` |
38
- | `id` | `public` | `string` | `undefined` | The id of the channel. | - | [`BaseChannel`](/carbon/api/classes/BaseChannel).`id` |
39
- | `name?` | `public` | `null` | `null` | The name of the channel. This is always null for DM channels. | - | - |
40
- | `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. | - | [`BaseChannel`](/carbon/api/classes/BaseChannel).`partial` |
41
- | `rawData` | `protected` | `null` \| `APIDMChannel` | `null` | The raw data of the channel. | - | [`BaseChannel`](/carbon/api/classes/BaseChannel).`rawData` |
42
- | `type` | `public` | `DM` | `ChannelType.DM` | The type of the channel. | [`BaseChannel`](/carbon/api/classes/BaseChannel).`type` | - |
43
-
44
- ## Methods
45
-
46
- ### fetch()
47
-
48
- > **fetch**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
49
-
50
- Fetches the channel from the API.
51
-
52
- #### Returns
53
-
54
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
55
-
56
- The channel data.
57
-
58
- #### Inherited from
59
-
60
- [`BaseChannel`](/carbon/api/classes/BaseChannel).[`fetch`](/carbon/api/classes/BaseChannel#fetch)
61
-
62
- ***
63
-
64
- ### send()
65
-
66
- > **send**(`message`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
67
-
68
- Send a message to the channel
69
-
70
- #### Parameters
71
-
72
- | Parameter | Type |
73
- | ------ | ------ |
74
- | `message` | `APIMessage` |
75
-
76
- #### Returns
77
-
78
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
79
-
80
- ***
81
-
82
- ### setData()
83
-
84
- > `protected` **setData**(`data`): `void`
85
-
86
- #### Parameters
87
-
88
- | Parameter | Type |
89
- | ------ | ------ |
90
- | `data` | `APIDMChannel` |
91
-
92
- #### Returns
93
-
94
- `void`
95
-
96
- #### Inherited from
97
-
98
- [`BaseChannel`](/carbon/api/classes/BaseChannel).[`setData`](/carbon/api/classes/BaseChannel#setdata)
99
-
100
- ***
101
-
102
- ### setSpecificData()
103
-
104
- > `protected` **setSpecificData**(`data`): `void`
105
-
106
- #### Parameters
107
-
108
- | Parameter | Type |
109
- | ------ | ------ |
110
- | `data` | `APIDMChannel` |
111
-
112
- #### Returns
113
-
114
- `void`
115
-
116
- #### Overrides
117
-
118
- [`BaseChannel`](/carbon/api/classes/BaseChannel).[`setSpecificData`](/carbon/api/classes/BaseChannel#setspecificdata)
@@ -1,197 +0,0 @@
1
- ---
2
- title: GroupDmChannel
3
- ---
4
-
5
- Represents a group DM channel.
6
-
7
- ## Extends
8
-
9
- - [`BaseChannel`](/carbon/api/classes/BaseChannel)\<`ChannelType.GroupDM`\>
10
-
11
- ## Constructors
12
-
13
- ### new GroupDmChannel()
14
-
15
- > **new GroupDmChannel**(`client`, `rawDataOrId`): [`GroupDmChannel`](/carbon/api/classes/GroupDmChannel)
16
-
17
- #### Parameters
18
-
19
- | Parameter | Type |
20
- | ------ | ------ |
21
- | `client` | [`Client`](/carbon/api/classes/Client) |
22
- | `rawDataOrId` | `string` \| `APIGroupDMChannel` |
23
-
24
- #### Returns
25
-
26
- [`GroupDmChannel`](/carbon/api/classes/GroupDmChannel)
27
-
28
- #### Inherited from
29
-
30
- [`BaseChannel`](/carbon/api/classes/BaseChannel).[`constructor`](/carbon/api/classes/BaseChannel#constructors)
31
-
32
- ## Properties
33
-
34
- | Property | Modifier | Type | Default value | Description | Overrides | Inherited from |
35
- | ------ | ------ | ------ | ------ | ------ | ------ | ------ |
36
- | `applicationId?` | `public` | `null` \| `string` | `undefined` | The ID of the application that created the channel, if it was created by a bot. | - | - |
37
- | `client` | `public` | [`Client`](/carbon/api/classes/Client) | `undefined` | - | - | [`BaseChannel`](/carbon/api/classes/BaseChannel).`client` |
38
- | `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 | - | [`BaseChannel`](/carbon/api/classes/BaseChannel).`flags` |
39
- | `icon?` | `public` | `null` \| `string` | `undefined` | The icon hash of the channel. | - | - |
40
- | `id` | `public` | `string` | `undefined` | The id of the channel. | - | [`BaseChannel`](/carbon/api/classes/BaseChannel).`id` |
41
- | `lastMessageId?` | `public` | `null` \| `string` | `undefined` | The ID of the last message sent in the channel. **Remarks** This might not always resolve to a message. The ID still stays a part of the channel's data, even if the message is deleted. | - | - |
42
- | `managed?` | `public` | `null` \| `boolean` | `undefined` | Whether the channel is managed by an Oauth2 application. | - | - |
43
- | `name?` | `public` | `null` \| `string` | `undefined` | The name of the channel. | - | - |
44
- | `ownerId?` | `public` | `null` \| `string` | `undefined` | The ID of the user who created the channel. | - | - |
45
- | `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. | - | [`BaseChannel`](/carbon/api/classes/BaseChannel).`partial` |
46
- | `rawData` | `protected` | `null` \| `APIGroupDMChannel` | `null` | The raw data of the channel. | - | [`BaseChannel`](/carbon/api/classes/BaseChannel).`rawData` |
47
- | `recipients?` | `public` | [`User`](/carbon/api/classes/User)[] | `undefined` | The recipients of the channel. | - | - |
48
- | `type` | `public` | `GroupDM` | `ChannelType.GroupDM` | The type of the channel. | [`BaseChannel`](/carbon/api/classes/BaseChannel).`type` | - |
49
-
50
- ## Accessors
51
-
52
- ### iconUrl
53
-
54
- > `get` **iconUrl**(): `null` \| `string`
55
-
56
- Get the URL of the channel's icon.
57
-
58
- #### Returns
59
-
60
- `null` \| `string`
61
-
62
- ***
63
-
64
- ### lastMessage
65
-
66
- > `get` **lastMessage**(): `null` \| [`Message`](/carbon/api/classes/Message)
67
-
68
- The last message sent in the channel.
69
-
70
- #### Remarks
71
-
72
- This might not always resolve to a message. The ID still stays a part of the channel's data, even if the message is deleted.
73
- This will always return a partial message, so you can use [Message.fetch](/carbon/api/classes/Message#fetch) to get the full message data.
74
-
75
- #### Returns
76
-
77
- `null` \| [`Message`](/carbon/api/classes/Message)
78
-
79
- ***
80
-
81
- ### owner
82
-
83
- > `get` **owner**(): [`User`](/carbon/api/classes/User)
84
-
85
- Get the owner of the channel.
86
-
87
- #### Returns
88
-
89
- [`User`](/carbon/api/classes/User)
90
-
91
- ## Methods
92
-
93
- ### addRecipient()
94
-
95
- > **addRecipient**(`user`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
96
-
97
- #### Parameters
98
-
99
- | Parameter | Type |
100
- | ------ | ------ |
101
- | `user` | `string` \| [`User`](/carbon/api/classes/User) |
102
-
103
- #### Returns
104
-
105
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
106
-
107
- ***
108
-
109
- ### fetch()
110
-
111
- > **fetch**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
112
-
113
- Fetches the channel from the API.
114
-
115
- #### Returns
116
-
117
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
118
-
119
- The channel data.
120
-
121
- #### Inherited from
122
-
123
- [`BaseChannel`](/carbon/api/classes/BaseChannel).[`fetch`](/carbon/api/classes/BaseChannel#fetch)
124
-
125
- ***
126
-
127
- ### removeRecipient()
128
-
129
- > **removeRecipient**(`user`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
130
-
131
- #### Parameters
132
-
133
- | Parameter | Type |
134
- | ------ | ------ |
135
- | `user` | `string` \| [`User`](/carbon/api/classes/User) |
136
-
137
- #### Returns
138
-
139
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
140
-
141
- ***
142
-
143
- ### setData()
144
-
145
- > `protected` **setData**(`data`): `void`
146
-
147
- #### Parameters
148
-
149
- | Parameter | Type |
150
- | ------ | ------ |
151
- | `data` | `APIGroupDMChannel` |
152
-
153
- #### Returns
154
-
155
- `void`
156
-
157
- #### Inherited from
158
-
159
- [`BaseChannel`](/carbon/api/classes/BaseChannel).[`setData`](/carbon/api/classes/BaseChannel#setdata)
160
-
161
- ***
162
-
163
- ### setName()
164
-
165
- > **setName**(`name`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
166
-
167
- Set the name of the channel
168
-
169
- #### Parameters
170
-
171
- | Parameter | Type | Description |
172
- | ------ | ------ | ------ |
173
- | `name` | `string` | The new name of the channel |
174
-
175
- #### Returns
176
-
177
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
178
-
179
- ***
180
-
181
- ### setSpecificData()
182
-
183
- > `protected` **setSpecificData**(`data`): `void`
184
-
185
- #### Parameters
186
-
187
- | Parameter | Type |
188
- | ------ | ------ |
189
- | `data` | `APIGroupDMChannel` |
190
-
191
- #### Returns
192
-
193
- `void`
194
-
195
- #### Overrides
196
-
197
- [`BaseChannel`](/carbon/api/classes/BaseChannel).[`setSpecificData`](/carbon/api/classes/BaseChannel#setspecificdata)