@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,272 +0,0 @@
1
- ---
2
- title: GuildCategoryChannel
3
- ---
4
-
5
- Represents a guild category channel.
6
-
7
- ## Extends
8
-
9
- - [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel)\<`ChannelType.GuildCategory`\>
10
-
11
- ## Constructors
12
-
13
- ### new GuildCategoryChannel()
14
-
15
- > **new GuildCategoryChannel**(`client`, `rawDataOrId`): [`GuildCategoryChannel`](/carbon/api/classes/GuildCategoryChannel)
16
-
17
- #### Parameters
18
-
19
- | Parameter | Type |
20
- | ------ | ------ |
21
- | `client` | [`Client`](/carbon/api/classes/Client) |
22
- | `rawDataOrId` | `string` \| `APIGuildCategoryChannel` |
23
-
24
- #### Returns
25
-
26
- [`GuildCategoryChannel`](/carbon/api/classes/GuildCategoryChannel)
27
-
28
- #### Inherited from
29
-
30
- [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`constructor`](/carbon/api/classes/BaseGuildChannel#constructors)
31
-
32
- ## Properties
33
-
34
- | Property | Modifier | Type | Default value | Description | Inherited from |
35
- | ------ | ------ | ------ | ------ | ------ | ------ |
36
- | `client` | `public` | [`Client`](/carbon/api/classes/Client) | `undefined` | - | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`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 | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`flags` |
38
- | `guildId?` | `public` | `string` | `undefined` | The ID of the guild this channel is in | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`guildId` |
39
- | `id` | `public` | `string` | `undefined` | The id of the channel. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`id` |
40
- | `name?` | `public` | `string` | `undefined` | The name of the channel. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`name` |
41
- | `nsfw?` | `public` | `boolean` | `undefined` | Whether the channel is marked as nsfw. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`nsfw` |
42
- | `parentId?` | `public` | `null` \| `string` | `undefined` | The ID of the parent category for the channel. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`parentId` |
43
- | `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. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`partial` |
44
- | `position?` | `public` | `number` | `undefined` | The position of the channel in the channel list. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`position` |
45
- | `rawData` | `protected` | `null` \| `APIGuildCategoryChannel` | `null` | The raw data of the channel. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`rawData` |
46
- | `type?` | `public` | `GuildCategory` | `undefined` | The type of the channel. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`type` |
47
-
48
- ## Accessors
49
-
50
- ### guild
51
-
52
- > `get` **guild**(): [`Guild`](/carbon/api/classes/Guild)
53
-
54
- The guild this channel is in
55
-
56
- #### Returns
57
-
58
- [`Guild`](/carbon/api/classes/Guild)
59
-
60
- #### Inherited from
61
-
62
- [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`guild`](/carbon/api/classes/BaseGuildChannel#guild)
63
-
64
- ## Methods
65
-
66
- ### createInvite()
67
-
68
- > **createInvite**(`options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`APIExtendedInvite`\>
69
-
70
- Create an invite for the channel
71
-
72
- #### Parameters
73
-
74
- | Parameter | Type |
75
- | ------ | ------ |
76
- | `options`? | `RESTPostAPIChannelInviteJSONBody` |
77
-
78
- #### Returns
79
-
80
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`APIExtendedInvite`\>
81
-
82
- #### Inherited from
83
-
84
- [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`createInvite`](/carbon/api/classes/BaseGuildChannel#createinvite)
85
-
86
- ***
87
-
88
- ### fetch()
89
-
90
- > **fetch**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
91
-
92
- Fetches the channel from the API.
93
-
94
- #### Returns
95
-
96
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
97
-
98
- The channel data.
99
-
100
- #### Inherited from
101
-
102
- [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`fetch`](/carbon/api/classes/BaseGuildChannel#fetch)
103
-
104
- ***
105
-
106
- ### getInvites()
107
-
108
- > **getInvites**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`RESTGetAPIGuildInvitesResult`\>
109
-
110
- Get the invites for the channel
111
-
112
- #### Returns
113
-
114
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`RESTGetAPIGuildInvitesResult`\>
115
-
116
- #### Inherited from
117
-
118
- [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`getInvites`](/carbon/api/classes/BaseGuildChannel#getinvites)
119
-
120
- ***
121
-
122
- ### send()
123
-
124
- > **send**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
125
-
126
- You cannot send a message to a category channel, so this method throws an error
127
-
128
- #### Returns
129
-
130
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
131
-
132
- #### Overrides
133
-
134
- [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`send`](/carbon/api/classes/BaseGuildChannel#send)
135
-
136
- ***
137
-
138
- ### setData()
139
-
140
- > `protected` **setData**(`data`): `void`
141
-
142
- #### Parameters
143
-
144
- | Parameter | Type |
145
- | ------ | ------ |
146
- | `data` | `APIGuildChannel`\<`GuildCategory`\> |
147
-
148
- #### Returns
149
-
150
- `void`
151
-
152
- #### Inherited from
153
-
154
- [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`setData`](/carbon/api/classes/BaseGuildChannel#setdata)
155
-
156
- ***
157
-
158
- ### setName()
159
-
160
- > **setName**(`name`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
161
-
162
- Set the name of the channel
163
-
164
- #### Parameters
165
-
166
- | Parameter | Type | Description |
167
- | ------ | ------ | ------ |
168
- | `name` | `string` | The new name of the channel |
169
-
170
- #### Returns
171
-
172
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
173
-
174
- #### Inherited from
175
-
176
- [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`setName`](/carbon/api/classes/BaseGuildChannel#setname)
177
-
178
- ***
179
-
180
- ### setNsfw()
181
-
182
- > **setNsfw**(`nsfw`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
183
-
184
- Set whether the channel is nsfw
185
-
186
- #### Parameters
187
-
188
- | Parameter | Type | Description |
189
- | ------ | ------ | ------ |
190
- | `nsfw` | `boolean` | The new nsfw status of the channel |
191
-
192
- #### Returns
193
-
194
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
195
-
196
- #### Inherited from
197
-
198
- [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`setNsfw`](/carbon/api/classes/BaseGuildChannel#setnsfw)
199
-
200
- ***
201
-
202
- ### setParent()
203
-
204
- > **setParent**(`parent`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
205
-
206
- Set the parent ID of the channel
207
-
208
- #### Parameters
209
-
210
- | Parameter | Type | Description |
211
- | ------ | ------ | ------ |
212
- | `parent` | `string` \| [`GuildCategoryChannel`](/carbon/api/classes/GuildCategoryChannel) | The new category channel or ID to set |
213
-
214
- #### Returns
215
-
216
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
217
-
218
- #### Inherited from
219
-
220
- [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`setParent`](/carbon/api/classes/BaseGuildChannel#setparent)
221
-
222
- ***
223
-
224
- ### setPosition()
225
-
226
- > **setPosition**(`position`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
227
-
228
- Set the position of the channel
229
-
230
- #### Parameters
231
-
232
- | Parameter | Type | Description |
233
- | ------ | ------ | ------ |
234
- | `position` | `number` | The new position of the channel |
235
-
236
- #### Returns
237
-
238
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
239
-
240
- #### Inherited from
241
-
242
- [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`setPosition`](/carbon/api/classes/BaseGuildChannel#setposition)
243
-
244
- ***
245
-
246
- ### setSpecificData()
247
-
248
- > `protected` **setSpecificData**(): `void`
249
-
250
- #### Returns
251
-
252
- `void`
253
-
254
- #### Overrides
255
-
256
- [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`setSpecificData`](/carbon/api/classes/BaseGuildChannel#setspecificdata)
257
-
258
- ***
259
-
260
- ### triggerTyping()
261
-
262
- > **triggerTyping**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
263
-
264
- Trigger a typing indicator in the channel (this will expire after 10 seconds)
265
-
266
- #### Returns
267
-
268
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
269
-
270
- #### Inherited from
271
-
272
- [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`triggerTyping`](/carbon/api/classes/BaseGuildChannel#triggertyping)
@@ -1,333 +0,0 @@
1
- ---
2
- title: GuildForumChannel
3
- ---
4
-
5
- Represents a guild forum channel.
6
-
7
- ## Extends
8
-
9
- - [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel)\<`ChannelType.GuildForum`\>
10
-
11
- ## Constructors
12
-
13
- ### new GuildForumChannel()
14
-
15
- > **new GuildForumChannel**(`client`, `rawDataOrId`): [`GuildForumChannel`](/carbon/api/classes/GuildForumChannel)
16
-
17
- #### Parameters
18
-
19
- | Parameter | Type |
20
- | ------ | ------ |
21
- | `client` | [`Client`](/carbon/api/classes/Client) |
22
- | `rawDataOrId` | `string` \| `APIGuildForumChannel` |
23
-
24
- #### Returns
25
-
26
- [`GuildForumChannel`](/carbon/api/classes/GuildForumChannel)
27
-
28
- #### Inherited from
29
-
30
- [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).[`constructor`](/carbon/api/classes/GuildThreadOnlyChannel#constructors)
31
-
32
- ## Properties
33
-
34
- | Property | Modifier | Type | Default value | Description | Inherited from |
35
- | ------ | ------ | ------ | ------ | ------ | ------ |
36
- | `availableTags?` | `public` | `APIGuildForumTag`[] | `undefined` | The available tags to set on posts in the channel. | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`availableTags` |
37
- | `client` | `public` | [`Client`](/carbon/api/classes/Client) | `undefined` | - | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`client` |
38
- | `defaultAutoArchiveDuration?` | `public` | `null` \| `number` | `undefined` | The default auto archive duration of the channel. | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`defaultAutoArchiveDuration` |
39
- | `defaultForumLayout?` | `public` | `ForumLayoutType` | `undefined` | The default forum layout of the channel. | - |
40
- | `defaultReactionEmoji?` | `public` | `null` \| `APIGuildForumDefaultReactionEmoji` | `undefined` | The default reaction emoji for the channel. | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`defaultReactionEmoji` |
41
- | `defaultSortOrder?` | `public` | `null` \| `SortOrderType` | `undefined` | The default sort order for the channel, by latest activity or by creation date. | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`defaultSortOrder` |
42
- | `defaultThreadRateLimitPerUser?` | `public` | `null` \| `number` | `undefined` | The default thread rate limit per user for the channel. | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`defaultThreadRateLimitPerUser` |
43
- | `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 | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`flags` |
44
- | `guildId?` | `public` | `string` | `undefined` | The ID of the guild this channel is in | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`guildId` |
45
- | `id` | `public` | `string` | `undefined` | The id of the channel. | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`id` |
46
- | `name?` | `public` | `string` | `undefined` | The name of the channel. | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`name` |
47
- | `nsfw?` | `public` | `boolean` | `undefined` | Whether the channel is marked as nsfw. | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`nsfw` |
48
- | `parentId?` | `public` | `null` \| `string` | `undefined` | The ID of the parent category for the channel. | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`parentId` |
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. | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`partial` |
50
- | `position?` | `public` | `number` | `undefined` | The position of the channel in the channel list. | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`position` |
51
- | `rawData` | `protected` | `null` \| `APIGuildForumChannel` | `null` | The raw data of the channel. | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`rawData` |
52
- | `topic?` | `public` | `null` \| `string` | `undefined` | The topic of the channel. | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`topic` |
53
- | `type?` | `public` | `GuildForum` | `undefined` | The type of the channel. | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`type` |
54
-
55
- ## Accessors
56
-
57
- ### guild
58
-
59
- > `get` **guild**(): [`Guild`](/carbon/api/classes/Guild)
60
-
61
- The guild this channel is in
62
-
63
- #### Returns
64
-
65
- [`Guild`](/carbon/api/classes/Guild)
66
-
67
- #### Inherited from
68
-
69
- [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).[`guild`](/carbon/api/classes/GuildThreadOnlyChannel#guild)
70
-
71
- ## Methods
72
-
73
- ### createInvite()
74
-
75
- > **createInvite**(`options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`APIExtendedInvite`\>
76
-
77
- Create an invite for the channel
78
-
79
- #### Parameters
80
-
81
- | Parameter | Type |
82
- | ------ | ------ |
83
- | `options`? | `RESTPostAPIChannelInviteJSONBody` |
84
-
85
- #### Returns
86
-
87
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`APIExtendedInvite`\>
88
-
89
- #### Inherited from
90
-
91
- [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).[`createInvite`](/carbon/api/classes/GuildThreadOnlyChannel#createinvite)
92
-
93
- ***
94
-
95
- ### fetch()
96
-
97
- > **fetch**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
98
-
99
- Fetches the channel from the API.
100
-
101
- #### Returns
102
-
103
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
104
-
105
- The channel data.
106
-
107
- #### Inherited from
108
-
109
- [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).[`fetch`](/carbon/api/classes/GuildThreadOnlyChannel#fetch)
110
-
111
- ***
112
-
113
- ### getInvites()
114
-
115
- > **getInvites**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`RESTGetAPIGuildInvitesResult`\>
116
-
117
- Get the invites for the channel
118
-
119
- #### Returns
120
-
121
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`RESTGetAPIGuildInvitesResult`\>
122
-
123
- #### Inherited from
124
-
125
- [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).[`getInvites`](/carbon/api/classes/GuildThreadOnlyChannel#getinvites)
126
-
127
- ***
128
-
129
- ### send()
130
-
131
- > **send**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
132
-
133
- You cannot send a message directly to a forum or media channel, so this method throws an error.
134
- Use [GuildThreadChannel.send](/carbon/api/classes/GuildThreadChannel#send) instead, or the alias [GuildThreadOnlyChannel.sendToPost](/carbon/api/classes/GuildThreadOnlyChannel#sendtopost) instead, to send a message to the channel's posts.
135
-
136
- #### Returns
137
-
138
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
139
-
140
- #### Inherited from
141
-
142
- [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).[`send`](/carbon/api/classes/GuildThreadOnlyChannel#send)
143
-
144
- ***
145
-
146
- ### sendToPost()
147
-
148
- > **sendToPost**(`message`, `postId`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
149
-
150
- Send a message to a post in the channel
151
-
152
- #### Parameters
153
-
154
- | Parameter | Type |
155
- | ------ | ------ |
156
- | `message` | `APIMessage` |
157
- | `postId` | `string` |
158
-
159
- #### Returns
160
-
161
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
162
-
163
- #### Remarks
164
-
165
- This is an alias for [GuildThreadChannel.send](/carbon/api/classes/GuildThreadChannel#send) that will fetch the channel, but if you already have the channel, you can use [GuildThreadChannel.send](/carbon/api/classes/GuildThreadChannel#send) instead.
166
-
167
- #### Inherited from
168
-
169
- [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).[`sendToPost`](/carbon/api/classes/GuildThreadOnlyChannel#sendtopost)
170
-
171
- ***
172
-
173
- ### setData()
174
-
175
- > `protected` **setData**(`data`): `void`
176
-
177
- #### Parameters
178
-
179
- | Parameter | Type |
180
- | ------ | ------ |
181
- | `data` | `APIGuildChannel`\<`GuildForum`\> |
182
-
183
- #### Returns
184
-
185
- `void`
186
-
187
- #### Inherited from
188
-
189
- [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).[`setData`](/carbon/api/classes/GuildThreadOnlyChannel#setdata)
190
-
191
- ***
192
-
193
- ### setMoreSpecificData()
194
-
195
- > `protected` **setMoreSpecificData**(`data`): `void`
196
-
197
- #### Parameters
198
-
199
- | Parameter | Type |
200
- | ------ | ------ |
201
- | `data` | `APIGuildForumChannel` |
202
-
203
- #### Returns
204
-
205
- `void`
206
-
207
- #### Overrides
208
-
209
- [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).[`setMoreSpecificData`](/carbon/api/classes/GuildThreadOnlyChannel#setmorespecificdata)
210
-
211
- ***
212
-
213
- ### setName()
214
-
215
- > **setName**(`name`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
216
-
217
- Set the name of the channel
218
-
219
- #### Parameters
220
-
221
- | Parameter | Type | Description |
222
- | ------ | ------ | ------ |
223
- | `name` | `string` | The new name of the channel |
224
-
225
- #### Returns
226
-
227
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
228
-
229
- #### Inherited from
230
-
231
- [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).[`setName`](/carbon/api/classes/GuildThreadOnlyChannel#setname)
232
-
233
- ***
234
-
235
- ### setNsfw()
236
-
237
- > **setNsfw**(`nsfw`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
238
-
239
- Set whether the channel is nsfw
240
-
241
- #### Parameters
242
-
243
- | Parameter | Type | Description |
244
- | ------ | ------ | ------ |
245
- | `nsfw` | `boolean` | The new nsfw status of the channel |
246
-
247
- #### Returns
248
-
249
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
250
-
251
- #### Inherited from
252
-
253
- [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).[`setNsfw`](/carbon/api/classes/GuildThreadOnlyChannel#setnsfw)
254
-
255
- ***
256
-
257
- ### setParent()
258
-
259
- > **setParent**(`parent`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
260
-
261
- Set the parent ID of the channel
262
-
263
- #### Parameters
264
-
265
- | Parameter | Type | Description |
266
- | ------ | ------ | ------ |
267
- | `parent` | `string` \| [`GuildCategoryChannel`](/carbon/api/classes/GuildCategoryChannel) | The new category channel or ID to set |
268
-
269
- #### Returns
270
-
271
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
272
-
273
- #### Inherited from
274
-
275
- [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).[`setParent`](/carbon/api/classes/GuildThreadOnlyChannel#setparent)
276
-
277
- ***
278
-
279
- ### setPosition()
280
-
281
- > **setPosition**(`position`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
282
-
283
- Set the position of the channel
284
-
285
- #### Parameters
286
-
287
- | Parameter | Type | Description |
288
- | ------ | ------ | ------ |
289
- | `position` | `number` | The new position of the channel |
290
-
291
- #### Returns
292
-
293
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
294
-
295
- #### Inherited from
296
-
297
- [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).[`setPosition`](/carbon/api/classes/GuildThreadOnlyChannel#setposition)
298
-
299
- ***
300
-
301
- ### setSpecificData()
302
-
303
- > `protected` **setSpecificData**(`data`): `void`
304
-
305
- #### Parameters
306
-
307
- | Parameter | Type |
308
- | ------ | ------ |
309
- | `data` | `APIThreadOnlyChannel`\<`GuildForum`\> |
310
-
311
- #### Returns
312
-
313
- `void`
314
-
315
- #### Inherited from
316
-
317
- [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).[`setSpecificData`](/carbon/api/classes/GuildThreadOnlyChannel#setspecificdata)
318
-
319
- ***
320
-
321
- ### triggerTyping()
322
-
323
- > **triggerTyping**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
324
-
325
- Trigger a typing indicator in the channel (this will expire after 10 seconds)
326
-
327
- #### Returns
328
-
329
- [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
330
-
331
- #### Inherited from
332
-
333
- [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).[`triggerTyping`](/carbon/api/classes/GuildThreadOnlyChannel#triggertyping)