@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.
- package/dist/package.json +7 -2
- package/dist/src/abstracts/BaseComponentInteraction.d.ts +6 -1
- package/dist/src/abstracts/BaseComponentInteraction.d.ts.map +1 -1
- package/dist/src/abstracts/BaseComponentInteraction.js +12 -0
- package/dist/src/abstracts/BaseComponentInteraction.js.map +1 -1
- package/dist/src/abstracts/BaseInteraction.d.ts +10 -1
- package/dist/src/abstracts/BaseInteraction.d.ts.map +1 -1
- package/dist/src/abstracts/BaseInteraction.js +10 -1
- package/dist/src/abstracts/BaseInteraction.js.map +1 -1
- package/dist/src/classes/Client.d.ts.map +1 -1
- package/dist/src/classes/Client.js +21 -11
- package/dist/src/classes/Client.js.map +1 -1
- package/dist/src/classes/Embed.d.ts +60 -0
- package/dist/src/classes/Embed.d.ts.map +1 -0
- package/dist/src/classes/Embed.js +73 -0
- package/dist/src/classes/Embed.js.map +1 -0
- package/dist/src/index.d.ts +4 -1
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/index.js +4 -1
- package/dist/src/index.js.map +1 -1
- package/dist/src/internals/AutocompleteInteraction.d.ts +1 -1
- package/dist/src/internals/FieldsHandler.d.ts +27 -0
- package/dist/src/internals/FieldsHandler.d.ts.map +1 -0
- package/dist/src/internals/FieldsHandler.js +37 -0
- package/dist/src/internals/FieldsHandler.js.map +1 -0
- package/dist/src/internals/ModalInteraction.d.ts +3 -4
- package/dist/src/internals/ModalInteraction.d.ts.map +1 -1
- package/dist/src/internals/ModalInteraction.js +3 -10
- package/dist/src/internals/ModalInteraction.js.map +1 -1
- package/dist/src/internals/OptionsHandler.d.ts +33 -17
- package/dist/src/internals/OptionsHandler.d.ts.map +1 -1
- package/dist/src/internals/OptionsHandler.js +52 -58
- package/dist/src/internals/OptionsHandler.js.map +1 -1
- package/dist/src/utils.d.ts +3 -0
- package/dist/src/utils.d.ts.map +1 -1
- package/dist/src/utils.js +54 -0
- package/dist/src/utils.js.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +6 -1
- package/.turbo/turbo-build.log +0 -5
- package/.turbo/turbo-dev.log +0 -8
- package/.turbo/turbo-docs.log +0 -12
- package/CHANGELOG.md +0 -44
- package/dist/src/abstracts/ButtonInteraction.d.ts +0 -8
- package/dist/src/abstracts/ButtonInteraction.d.ts.map +0 -1
- package/dist/src/abstracts/ButtonInteraction.js +0 -18
- package/dist/src/abstracts/ButtonInteraction.js.map +0 -1
- package/dist/src/abstracts/ChannelSelectMenuInteraction.d.ts +0 -7
- package/dist/src/abstracts/ChannelSelectMenuInteraction.d.ts.map +0 -1
- package/dist/src/abstracts/ChannelSelectMenuInteraction.js +0 -11
- package/dist/src/abstracts/ChannelSelectMenuInteraction.js.map +0 -1
- package/dist/src/abstracts/CommandHandler.d.ts +0 -6
- package/dist/src/abstracts/CommandHandler.d.ts.map +0 -1
- package/dist/src/abstracts/CommandHandler.js +0 -65
- package/dist/src/abstracts/CommandHandler.js.map +0 -1
- package/dist/src/abstracts/CommandInteraction.d.ts +0 -15
- package/dist/src/abstracts/CommandInteraction.d.ts.map +0 -1
- package/dist/src/abstracts/CommandInteraction.js +0 -60
- package/dist/src/abstracts/CommandInteraction.js.map +0 -1
- package/dist/src/abstracts/ComponentHandler.d.ts +0 -6
- package/dist/src/abstracts/ComponentHandler.d.ts.map +0 -1
- package/dist/src/abstracts/ComponentHandler.js +0 -64
- package/dist/src/abstracts/ComponentHandler.js.map +0 -1
- package/dist/src/abstracts/MentionableSelectMenuInteraction.d.ts +0 -8
- package/dist/src/abstracts/MentionableSelectMenuInteraction.d.ts.map +0 -1
- package/dist/src/abstracts/MentionableSelectMenuInteraction.js +0 -15
- package/dist/src/abstracts/MentionableSelectMenuInteraction.js.map +0 -1
- package/dist/src/abstracts/RoleSelectMenuInteraction.d.ts +0 -8
- package/dist/src/abstracts/RoleSelectMenuInteraction.d.ts.map +0 -1
- package/dist/src/abstracts/RoleSelectMenuInteraction.js +0 -14
- package/dist/src/abstracts/RoleSelectMenuInteraction.js.map +0 -1
- package/dist/src/abstracts/StringSelectMenuInteraction.d.ts +0 -8
- package/dist/src/abstracts/StringSelectMenuInteraction.d.ts.map +0 -1
- package/dist/src/abstracts/StringSelectMenuInteraction.js +0 -14
- package/dist/src/abstracts/StringSelectMenuInteraction.js.map +0 -1
- package/dist/src/abstracts/UserSelectMenuInteraction.d.ts +0 -8
- package/dist/src/abstracts/UserSelectMenuInteraction.d.ts.map +0 -1
- package/dist/src/abstracts/UserSelectMenuInteraction.js +0 -14
- package/dist/src/abstracts/UserSelectMenuInteraction.js.map +0 -1
- package/dist/src/classes/Paginator.d.ts +0 -3
- package/dist/src/classes/Paginator.d.ts.map +0 -1
- package/dist/src/classes/Paginator.js +0 -3
- package/dist/src/classes/Paginator.js.map +0 -1
- package/dist/src/internals/ComponentHandler copy.d.ts +0 -17
- package/dist/src/internals/ComponentHandler copy.d.ts.map +0 -1
- package/dist/src/internals/ComponentHandler copy.js +0 -75
- package/dist/src/internals/ComponentHandler copy.js.map +0 -1
- package/dist/src/structures/AnySelectMenu.d.ts +0 -31
- package/dist/src/structures/AnySelectMenu.d.ts.map +0 -1
- package/dist/src/structures/AnySelectMenu.js +0 -19
- package/dist/src/structures/AnySelectMenu.js.map +0 -1
- package/dist/src/structures/AnySelectMenuInteraction.d.ts +0 -12
- package/dist/src/structures/AnySelectMenuInteraction.d.ts.map +0 -1
- package/dist/src/structures/AnySelectMenuInteraction.js +0 -21
- package/dist/src/structures/AnySelectMenuInteraction.js.map +0 -1
- package/dist/src/structures/Base.d.ts +0 -10
- package/dist/src/structures/Base.d.ts.map +0 -1
- package/dist/src/structures/Base.js +0 -11
- package/dist/src/structures/Base.js.map +0 -1
- package/dist/src/structures/BaseCommand.d.ts +0 -64
- package/dist/src/structures/BaseCommand.d.ts.map +0 -1
- package/dist/src/structures/BaseCommand.js +0 -58
- package/dist/src/structures/BaseCommand.js.map +0 -1
- package/dist/src/structures/BaseComponent.d.ts +0 -34
- package/dist/src/structures/BaseComponent.d.ts.map +0 -1
- package/dist/src/structures/BaseComponent.js +0 -30
- package/dist/src/structures/BaseComponent.js.map +0 -1
- package/dist/src/structures/BaseComponentInteraction.d.ts +0 -9
- package/dist/src/structures/BaseComponentInteraction.d.ts.map +0 -1
- package/dist/src/structures/BaseComponentInteraction.js +0 -14
- package/dist/src/structures/BaseComponentInteraction.js.map +0 -1
- package/dist/src/structures/BaseInteraction.d.ts +0 -81
- package/dist/src/structures/BaseInteraction.d.ts.map +0 -1
- package/dist/src/structures/BaseInteraction.js +0 -99
- package/dist/src/structures/BaseInteraction.js.map +0 -1
- package/dist/src/structures/ButtonInteraction.d.ts +0 -8
- package/dist/src/structures/ButtonInteraction.d.ts.map +0 -1
- package/dist/src/structures/ButtonInteraction.js +0 -18
- package/dist/src/structures/ButtonInteraction.js.map +0 -1
- package/dist/src/structures/ChannelSelectMenuInteraction.d.ts +0 -7
- package/dist/src/structures/ChannelSelectMenuInteraction.d.ts.map +0 -1
- package/dist/src/structures/ChannelSelectMenuInteraction.js +0 -11
- package/dist/src/structures/ChannelSelectMenuInteraction.js.map +0 -1
- package/dist/src/structures/CommandHandler.d.ts +0 -6
- package/dist/src/structures/CommandHandler.d.ts.map +0 -1
- package/dist/src/structures/CommandHandler.js +0 -70
- package/dist/src/structures/CommandHandler.js.map +0 -1
- package/dist/src/structures/CommandInteraction.d.ts +0 -15
- package/dist/src/structures/CommandInteraction.d.ts.map +0 -1
- package/dist/src/structures/CommandInteraction.js +0 -60
- package/dist/src/structures/CommandInteraction.js.map +0 -1
- package/dist/src/structures/ComponentHandler.d.ts +0 -6
- package/dist/src/structures/ComponentHandler.d.ts.map +0 -1
- package/dist/src/structures/ComponentHandler.js +0 -64
- package/dist/src/structures/ComponentHandler.js.map +0 -1
- package/dist/src/structures/MentionableSelectMenuInteraction.d.ts +0 -8
- package/dist/src/structures/MentionableSelectMenuInteraction.d.ts.map +0 -1
- package/dist/src/structures/MentionableSelectMenuInteraction.js +0 -15
- package/dist/src/structures/MentionableSelectMenuInteraction.js.map +0 -1
- package/dist/src/structures/RoleSelectMenuInteraction.d.ts +0 -8
- package/dist/src/structures/RoleSelectMenuInteraction.d.ts.map +0 -1
- package/dist/src/structures/RoleSelectMenuInteraction.js +0 -14
- package/dist/src/structures/RoleSelectMenuInteraction.js.map +0 -1
- package/dist/src/structures/StringSelectMenuInteraction.d.ts +0 -8
- package/dist/src/structures/StringSelectMenuInteraction.d.ts.map +0 -1
- package/dist/src/structures/StringSelectMenuInteraction.js +0 -14
- package/dist/src/structures/StringSelectMenuInteraction.js.map +0 -1
- package/dist/src/structures/UserSelectMenuInteraction.d.ts +0 -8
- package/dist/src/structures/UserSelectMenuInteraction.d.ts.map +0 -1
- package/dist/src/structures/UserSelectMenuInteraction.js +0 -14
- package/dist/src/structures/UserSelectMenuInteraction.js.map +0 -1
- package/dist/src/types.d.ts +0 -31
- package/dist/src/types.d.ts.map +0 -1
- package/dist/src/types.js +0 -33
- package/dist/src/types.js.map +0 -1
- package/docs/classes/AnySelectMenu.mdx +0 -114
- package/docs/classes/AnySelectMenuInteraction.mdx +0 -175
- package/docs/classes/AutocompleteInteraction.mdx +0 -166
- package/docs/classes/AutocompleteOptionsHandler.mdx +0 -243
- package/docs/classes/BaseChannel.mdx +0 -97
- package/docs/classes/BaseCommand.mdx +0 -61
- package/docs/classes/BaseComponent.mdx +0 -55
- package/docs/classes/BaseComponentInteraction.mdx +0 -160
- package/docs/classes/BaseGuildChannel.mdx +0 -262
- package/docs/classes/BaseGuildTextChannel.mdx +0 -360
- package/docs/classes/BaseInteraction.mdx +0 -137
- package/docs/classes/Button.mdx +0 -99
- package/docs/classes/ButtonInteraction.mdx +0 -155
- package/docs/classes/ChannelSelectMenu.mdx +0 -122
- package/docs/classes/ChannelSelectMenuInteraction.mdx +0 -171
- package/docs/classes/Client.mdx +0 -48
- package/docs/classes/Command.mdx +0 -111
- package/docs/classes/CommandHandler.mdx +0 -65
- package/docs/classes/CommandInteraction.mdx +0 -155
- package/docs/classes/CommandWithSubcommandGroups.mdx +0 -73
- package/docs/classes/CommandWithSubcommands.mdx +0 -76
- package/docs/classes/ComponentHandler.mdx +0 -49
- package/docs/classes/DmChannel.mdx +0 -118
- package/docs/classes/GroupDmChannel.mdx +0 -197
- package/docs/classes/Guild.mdx +0 -157
- package/docs/classes/GuildAnnouncementChannel.mdx +0 -377
- package/docs/classes/GuildCategoryChannel.mdx +0 -272
- package/docs/classes/GuildForumChannel.mdx +0 -333
- package/docs/classes/GuildMediaChannel.mdx +0 -327
- package/docs/classes/GuildStageChannel.mdx +0 -276
- package/docs/classes/GuildStageOrVoiceChannel.mdx +0 -292
- package/docs/classes/GuildTextChannel.mdx +0 -367
- package/docs/classes/GuildThreadChannel.mdx +0 -425
- package/docs/classes/GuildThreadOnlyChannel.mdx +0 -333
- package/docs/classes/GuildVoiceChannel.mdx +0 -276
- package/docs/classes/LinkButton.mdx +0 -84
- package/docs/classes/MentionableSelectMenu.mdx +0 -120
- package/docs/classes/MentionableSelectMenuInteraction.mdx +0 -171
- package/docs/classes/Message.mdx +0 -126
- package/docs/classes/OptionsHandler.mdx +0 -203
- package/docs/classes/PremiumButton.mdx +0 -84
- package/docs/classes/Role.mdx +0 -228
- package/docs/classes/RoleSelectMenu.mdx +0 -120
- package/docs/classes/RoleSelectMenuInteraction.mdx +0 -171
- package/docs/classes/Row.mdx +0 -88
- package/docs/classes/StringSelectMenu.mdx +0 -120
- package/docs/classes/StringSelectMenuInteraction.mdx +0 -171
- package/docs/classes/User.mdx +0 -119
- package/docs/classes/UserSelectMenu.mdx +0 -120
- package/docs/classes/UserSelectMenuInteraction.mdx +0 -171
- package/docs/enumerations/ClientMode.mdx +0 -16
- package/docs/functions/channelFactory.mdx +0 -16
- package/docs/index.mdx +0 -83
- package/docs/type-aliases/AnySelectMenuComponentType.mdx +0 -5
- package/docs/type-aliases/ClientOptions.mdx +0 -20
- package/docs/type-aliases/CommandOptions.mdx +0 -5
- package/docs/type-aliases/ComponentAdditionalData.mdx +0 -9
- package/docs/type-aliases/InteractionFileData.mdx +0 -15
- package/docs/type-aliases/InteractionReplyData.mdx +0 -14
- package/docs/type-aliases/InteractionReplyOptions.mdx +0 -13
- package/docs/type-aliases/RawOptions.mdx +0 -9
- package/docs/type-aliases/meta.json +0 -3
- package/src/README.md +0 -7
- package/src/abstracts/AnySelectMenu.ts +0 -63
- package/src/abstracts/AnySelectMenuInteraction.ts +0 -29
- package/src/abstracts/Base.ts +0 -12
- package/src/abstracts/BaseChannel.ts +0 -73
- package/src/abstracts/BaseCommand.ts +0 -89
- package/src/abstracts/BaseComponent.ts +0 -49
- package/src/abstracts/BaseComponentInteraction.ts +0 -19
- package/src/abstracts/BaseGuildChannel.ts +0 -152
- package/src/abstracts/BaseGuildTextChannel.ts +0 -77
- package/src/abstracts/BaseInteraction.ts +0 -209
- package/src/abstracts/GuildThreadOnlyChannel.ts +0 -71
- package/src/classes/Button.ts +0 -95
- package/src/classes/ChannelSelectMenu.ts +0 -21
- package/src/classes/Client.ts +0 -277
- package/src/classes/Command.ts +0 -53
- package/src/classes/CommandWithSubcommandGroups.ts +0 -47
- package/src/classes/CommandWithSubcommands.ts +0 -35
- package/src/classes/MentionableSelectMenu.ts +0 -19
- package/src/classes/Modal.ts +0 -38
- package/src/classes/RoleSelectMenu.ts +0 -19
- package/src/classes/Row.ts +0 -50
- package/src/classes/StringSelectMenu.ts +0 -19
- package/src/classes/TextInput.ts +0 -65
- package/src/classes/UserSelectMenu.ts +0 -19
- package/src/factories/channelFactory.ts +0 -43
- package/src/index.ts +0 -62
- package/src/internals/AutocompleteInteraction.ts +0 -107
- package/src/internals/ButtonInteraction.ts +0 -26
- package/src/internals/ChannelSelectMenuInteraction.ts +0 -15
- package/src/internals/CommandHandler.ts +0 -127
- package/src/internals/CommandInteraction.ts +0 -49
- package/src/internals/ComponentHandler.ts +0 -92
- package/src/internals/MentionableSelectMenuInteraction.ts +0 -21
- package/src/internals/ModalHandler.ts +0 -27
- package/src/internals/ModalInteraction.ts +0 -25
- package/src/internals/OptionsHandler.ts +0 -148
- package/src/internals/RoleSelectMenuInteraction.ts +0 -20
- package/src/internals/StringSelectMenuInteraction.ts +0 -20
- package/src/internals/UserSelectMenuInteraction.ts +0 -20
- package/src/structures/DmChannel.ts +0 -31
- package/src/structures/GroupDmChannel.ts +0 -132
- package/src/structures/Guild.ts +0 -154
- package/src/structures/GuildAnnouncementChannel.ts +0 -20
- package/src/structures/GuildCategoryChannel.ts +0 -16
- package/src/structures/GuildForumChannel.ts +0 -20
- package/src/structures/GuildMediaChannel.ts +0 -13
- package/src/structures/GuildMember.ts +0 -231
- package/src/structures/GuildStageOrVoiceChannel.ts +0 -46
- package/src/structures/GuildTextChannel.ts +0 -21
- package/src/structures/GuildThreadChannel.ts +0 -150
- package/src/structures/Message.ts +0 -124
- package/src/structures/Role.ts +0 -201
- package/src/structures/User.ts +0 -153
- package/src/utils.ts +0 -13
- package/tests/index.test.ts +0 -4
- package/tsconfig.json +0 -12
- package/typedoc.json +0 -9
|
@@ -1,292 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: GuildStageOrVoiceChannel
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
## Extends
|
|
6
|
-
|
|
7
|
-
- [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel)\<`Type`\>
|
|
8
|
-
|
|
9
|
-
## Type Parameters
|
|
10
|
-
|
|
11
|
-
| Type Parameter |
|
|
12
|
-
| ------ |
|
|
13
|
-
| `Type` *extends* `ChannelType.GuildStageVoice` \| `ChannelType.GuildVoice` |
|
|
14
|
-
|
|
15
|
-
## Constructors
|
|
16
|
-
|
|
17
|
-
### new GuildStageOrVoiceChannel()
|
|
18
|
-
|
|
19
|
-
> **new GuildStageOrVoiceChannel**\<`Type`\>(`client`, `rawDataOrId`): [`GuildStageOrVoiceChannel`](/carbon/api/classes/GuildStageOrVoiceChannel)\<`Type`\>
|
|
20
|
-
|
|
21
|
-
#### Parameters
|
|
22
|
-
|
|
23
|
-
| Parameter | Type |
|
|
24
|
-
| ------ | ------ |
|
|
25
|
-
| `client` | [`Client`](/carbon/api/classes/Client) |
|
|
26
|
-
| `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`\> |
|
|
27
|
-
|
|
28
|
-
#### Returns
|
|
29
|
-
|
|
30
|
-
[`GuildStageOrVoiceChannel`](/carbon/api/classes/GuildStageOrVoiceChannel)\<`Type`\>
|
|
31
|
-
|
|
32
|
-
#### Inherited from
|
|
33
|
-
|
|
34
|
-
[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`constructor`](/carbon/api/classes/BaseGuildChannel#constructors)
|
|
35
|
-
|
|
36
|
-
## Properties
|
|
37
|
-
|
|
38
|
-
| Property | Modifier | Type | Default value | Description | Inherited from |
|
|
39
|
-
| ------ | ------ | ------ | ------ | ------ | ------ |
|
|
40
|
-
| `bitrate?` | `public` | `null` \| `number` | `undefined` | The bitrate of the channel. | - |
|
|
41
|
-
| `client` | `public` | [`Client`](/carbon/api/classes/Client) | `undefined` | - | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`client` |
|
|
42
|
-
| `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` |
|
|
43
|
-
| `guildId?` | `public` | `string` | `undefined` | The ID of the guild this channel is in | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`guildId` |
|
|
44
|
-
| `id` | `public` | `string` | `undefined` | The id of the channel. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`id` |
|
|
45
|
-
| `name?` | `public` | `string` | `undefined` | The name of the channel. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`name` |
|
|
46
|
-
| `nsfw?` | `public` | `boolean` | `undefined` | Whether the channel is marked as nsfw. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`nsfw` |
|
|
47
|
-
| `parentId?` | `public` | `null` \| `string` | `undefined` | The ID of the parent category for the channel. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`parentId` |
|
|
48
|
-
| `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` |
|
|
49
|
-
| `position?` | `public` | `number` | `undefined` | The position of the channel in the channel list. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`position` |
|
|
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. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`rawData` |
|
|
51
|
-
| `rtcRegion?` | `public` | `null` \| `string` | `undefined` | The RTC region of the channel. This is automatic when set to `null`. | - |
|
|
52
|
-
| `type?` | `public` | `Type` | `undefined` | The type of the channel. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`type` |
|
|
53
|
-
| `userLimit?` | `public` | `null` \| `number` | `undefined` | The user limit of the channel. | - |
|
|
54
|
-
| `videoQualityMode?` | `public` | `null` \| `VideoQualityMode` | `undefined` | The video quality mode of the channel. 1 when not present. | - |
|
|
55
|
-
|
|
56
|
-
## Accessors
|
|
57
|
-
|
|
58
|
-
### guild
|
|
59
|
-
|
|
60
|
-
> `get` **guild**(): [`Guild`](/carbon/api/classes/Guild)
|
|
61
|
-
|
|
62
|
-
The guild this channel is in
|
|
63
|
-
|
|
64
|
-
#### Returns
|
|
65
|
-
|
|
66
|
-
[`Guild`](/carbon/api/classes/Guild)
|
|
67
|
-
|
|
68
|
-
#### Inherited from
|
|
69
|
-
|
|
70
|
-
[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`guild`](/carbon/api/classes/BaseGuildChannel#guild)
|
|
71
|
-
|
|
72
|
-
## Methods
|
|
73
|
-
|
|
74
|
-
### createInvite()
|
|
75
|
-
|
|
76
|
-
> **createInvite**(`options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`APIExtendedInvite`\>
|
|
77
|
-
|
|
78
|
-
Create an invite for the channel
|
|
79
|
-
|
|
80
|
-
#### Parameters
|
|
81
|
-
|
|
82
|
-
| Parameter | Type |
|
|
83
|
-
| ------ | ------ |
|
|
84
|
-
| `options`? | `RESTPostAPIChannelInviteJSONBody` |
|
|
85
|
-
|
|
86
|
-
#### Returns
|
|
87
|
-
|
|
88
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`APIExtendedInvite`\>
|
|
89
|
-
|
|
90
|
-
#### Inherited from
|
|
91
|
-
|
|
92
|
-
[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`createInvite`](/carbon/api/classes/BaseGuildChannel#createinvite)
|
|
93
|
-
|
|
94
|
-
***
|
|
95
|
-
|
|
96
|
-
### fetch()
|
|
97
|
-
|
|
98
|
-
> **fetch**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
99
|
-
|
|
100
|
-
Fetches the channel from the API.
|
|
101
|
-
|
|
102
|
-
#### Returns
|
|
103
|
-
|
|
104
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
105
|
-
|
|
106
|
-
The channel data.
|
|
107
|
-
|
|
108
|
-
#### Inherited from
|
|
109
|
-
|
|
110
|
-
[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`fetch`](/carbon/api/classes/BaseGuildChannel#fetch)
|
|
111
|
-
|
|
112
|
-
***
|
|
113
|
-
|
|
114
|
-
### getInvites()
|
|
115
|
-
|
|
116
|
-
> **getInvites**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`RESTGetAPIGuildInvitesResult`\>
|
|
117
|
-
|
|
118
|
-
Get the invites for the channel
|
|
119
|
-
|
|
120
|
-
#### Returns
|
|
121
|
-
|
|
122
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`RESTGetAPIGuildInvitesResult`\>
|
|
123
|
-
|
|
124
|
-
#### Inherited from
|
|
125
|
-
|
|
126
|
-
[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`getInvites`](/carbon/api/classes/BaseGuildChannel#getinvites)
|
|
127
|
-
|
|
128
|
-
***
|
|
129
|
-
|
|
130
|
-
### send()
|
|
131
|
-
|
|
132
|
-
> **send**(`message`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
133
|
-
|
|
134
|
-
Send a message to the channel
|
|
135
|
-
|
|
136
|
-
#### Parameters
|
|
137
|
-
|
|
138
|
-
| Parameter | Type |
|
|
139
|
-
| ------ | ------ |
|
|
140
|
-
| `message` | `APIMessage` |
|
|
141
|
-
|
|
142
|
-
#### Returns
|
|
143
|
-
|
|
144
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
145
|
-
|
|
146
|
-
#### Inherited from
|
|
147
|
-
|
|
148
|
-
[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`send`](/carbon/api/classes/BaseGuildChannel#send)
|
|
149
|
-
|
|
150
|
-
***
|
|
151
|
-
|
|
152
|
-
### setData()
|
|
153
|
-
|
|
154
|
-
> `protected` **setData**(`data`): `void`
|
|
155
|
-
|
|
156
|
-
#### Parameters
|
|
157
|
-
|
|
158
|
-
| Parameter | Type |
|
|
159
|
-
| ------ | ------ |
|
|
160
|
-
| `data` | `APIGuildChannel`\<`Type`\> |
|
|
161
|
-
|
|
162
|
-
#### Returns
|
|
163
|
-
|
|
164
|
-
`void`
|
|
165
|
-
|
|
166
|
-
#### Inherited from
|
|
167
|
-
|
|
168
|
-
[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`setData`](/carbon/api/classes/BaseGuildChannel#setdata)
|
|
169
|
-
|
|
170
|
-
***
|
|
171
|
-
|
|
172
|
-
### setName()
|
|
173
|
-
|
|
174
|
-
> **setName**(`name`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
175
|
-
|
|
176
|
-
Set the name of the channel
|
|
177
|
-
|
|
178
|
-
#### Parameters
|
|
179
|
-
|
|
180
|
-
| Parameter | Type | Description |
|
|
181
|
-
| ------ | ------ | ------ |
|
|
182
|
-
| `name` | `string` | The new name of the channel |
|
|
183
|
-
|
|
184
|
-
#### Returns
|
|
185
|
-
|
|
186
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
187
|
-
|
|
188
|
-
#### Inherited from
|
|
189
|
-
|
|
190
|
-
[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`setName`](/carbon/api/classes/BaseGuildChannel#setname)
|
|
191
|
-
|
|
192
|
-
***
|
|
193
|
-
|
|
194
|
-
### setNsfw()
|
|
195
|
-
|
|
196
|
-
> **setNsfw**(`nsfw`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
197
|
-
|
|
198
|
-
Set whether the channel is nsfw
|
|
199
|
-
|
|
200
|
-
#### Parameters
|
|
201
|
-
|
|
202
|
-
| Parameter | Type | Description |
|
|
203
|
-
| ------ | ------ | ------ |
|
|
204
|
-
| `nsfw` | `boolean` | The new nsfw status of the channel |
|
|
205
|
-
|
|
206
|
-
#### Returns
|
|
207
|
-
|
|
208
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
209
|
-
|
|
210
|
-
#### Inherited from
|
|
211
|
-
|
|
212
|
-
[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`setNsfw`](/carbon/api/classes/BaseGuildChannel#setnsfw)
|
|
213
|
-
|
|
214
|
-
***
|
|
215
|
-
|
|
216
|
-
### setParent()
|
|
217
|
-
|
|
218
|
-
> **setParent**(`parent`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
219
|
-
|
|
220
|
-
Set the parent ID of the channel
|
|
221
|
-
|
|
222
|
-
#### Parameters
|
|
223
|
-
|
|
224
|
-
| Parameter | Type | Description |
|
|
225
|
-
| ------ | ------ | ------ |
|
|
226
|
-
| `parent` | `string` \| [`GuildCategoryChannel`](/carbon/api/classes/GuildCategoryChannel) | The new category channel or ID to set |
|
|
227
|
-
|
|
228
|
-
#### Returns
|
|
229
|
-
|
|
230
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
231
|
-
|
|
232
|
-
#### Inherited from
|
|
233
|
-
|
|
234
|
-
[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`setParent`](/carbon/api/classes/BaseGuildChannel#setparent)
|
|
235
|
-
|
|
236
|
-
***
|
|
237
|
-
|
|
238
|
-
### setPosition()
|
|
239
|
-
|
|
240
|
-
> **setPosition**(`position`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
241
|
-
|
|
242
|
-
Set the position of the channel
|
|
243
|
-
|
|
244
|
-
#### Parameters
|
|
245
|
-
|
|
246
|
-
| Parameter | Type | Description |
|
|
247
|
-
| ------ | ------ | ------ |
|
|
248
|
-
| `position` | `number` | The new position of the channel |
|
|
249
|
-
|
|
250
|
-
#### Returns
|
|
251
|
-
|
|
252
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
253
|
-
|
|
254
|
-
#### Inherited from
|
|
255
|
-
|
|
256
|
-
[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`setPosition`](/carbon/api/classes/BaseGuildChannel#setposition)
|
|
257
|
-
|
|
258
|
-
***
|
|
259
|
-
|
|
260
|
-
### setSpecificData()
|
|
261
|
-
|
|
262
|
-
> `protected` **setSpecificData**(`data`): `void`
|
|
263
|
-
|
|
264
|
-
#### Parameters
|
|
265
|
-
|
|
266
|
-
| Parameter | Type |
|
|
267
|
-
| ------ | ------ |
|
|
268
|
-
| `data` | `APIGuildStageVoiceChannel` \| `APIGuildVoiceChannel` |
|
|
269
|
-
|
|
270
|
-
#### Returns
|
|
271
|
-
|
|
272
|
-
`void`
|
|
273
|
-
|
|
274
|
-
#### Overrides
|
|
275
|
-
|
|
276
|
-
[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`setSpecificData`](/carbon/api/classes/BaseGuildChannel#setspecificdata)
|
|
277
|
-
|
|
278
|
-
***
|
|
279
|
-
|
|
280
|
-
### triggerTyping()
|
|
281
|
-
|
|
282
|
-
> **triggerTyping**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
283
|
-
|
|
284
|
-
Trigger a typing indicator in the channel (this will expire after 10 seconds)
|
|
285
|
-
|
|
286
|
-
#### Returns
|
|
287
|
-
|
|
288
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
289
|
-
|
|
290
|
-
#### Inherited from
|
|
291
|
-
|
|
292
|
-
[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`triggerTyping`](/carbon/api/classes/BaseGuildChannel#triggertyping)
|
|
@@ -1,367 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: GuildTextChannel
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
## Extends
|
|
6
|
-
|
|
7
|
-
- [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel)\<`ChannelType.GuildText`\>
|
|
8
|
-
|
|
9
|
-
## Constructors
|
|
10
|
-
|
|
11
|
-
### new GuildTextChannel()
|
|
12
|
-
|
|
13
|
-
> **new GuildTextChannel**(`client`, `rawDataOrId`): [`GuildTextChannel`](/carbon/api/classes/GuildTextChannel)
|
|
14
|
-
|
|
15
|
-
#### Parameters
|
|
16
|
-
|
|
17
|
-
| Parameter | Type |
|
|
18
|
-
| ------ | ------ |
|
|
19
|
-
| `client` | [`Client`](/carbon/api/classes/Client) |
|
|
20
|
-
| `rawDataOrId` | `string` \| `APITextChannel` |
|
|
21
|
-
|
|
22
|
-
#### Returns
|
|
23
|
-
|
|
24
|
-
[`GuildTextChannel`](/carbon/api/classes/GuildTextChannel)
|
|
25
|
-
|
|
26
|
-
#### Inherited from
|
|
27
|
-
|
|
28
|
-
[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`constructor`](/carbon/api/classes/BaseGuildTextChannel#constructors)
|
|
29
|
-
|
|
30
|
-
## Properties
|
|
31
|
-
|
|
32
|
-
| Property | Modifier | Type | Default value | Description | Overrides | Inherited from |
|
|
33
|
-
| ------ | ------ | ------ | ------ | ------ | ------ | ------ |
|
|
34
|
-
| `client` | `public` | [`Client`](/carbon/api/classes/Client) | `undefined` | - | - | [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).`client` |
|
|
35
|
-
| `defaultAutoArchiveDuration?` | `public` | `null` \| `number` | `undefined` | The default auto archive duration of threads in the channel. | - | - |
|
|
36
|
-
| `defaultThreadRateLimitPerUser?` | `public` | `null` \| `number` | `undefined` | The default thread rate limit per user of the channel. | - | - |
|
|
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 | - | [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).`flags` |
|
|
38
|
-
| `guildId?` | `public` | `string` | `undefined` | The ID of the guild this channel is in | - | [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).`guildId` |
|
|
39
|
-
| `id` | `public` | `string` | `undefined` | The id of the channel. | - | [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).`id` |
|
|
40
|
-
| `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. | - | [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).`lastMessageId` |
|
|
41
|
-
| `lastPinTimestamp?` | `public` | `null` \| `string` | `undefined` | The timestamp of the last pin in the channel. | - | [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).`lastPinTimestamp` |
|
|
42
|
-
| `name?` | `public` | `string` | `undefined` | The name of the channel. | - | [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).`name` |
|
|
43
|
-
| `nsfw?` | `public` | `boolean` | `undefined` | Whether the channel is marked as nsfw. | - | [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).`nsfw` |
|
|
44
|
-
| `parentId?` | `public` | `null` \| `string` | `undefined` | The ID of the parent category for the channel. | - | [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).`parentId` |
|
|
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. | - | [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).`partial` |
|
|
46
|
-
| `position?` | `public` | `number` | `undefined` | The position of the channel in the channel list. | - | [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).`position` |
|
|
47
|
-
| `rateLimitPerUser?` | `public` | `null` \| `number` | `undefined` | The rate limit per user for the channel, in seconds. | - | [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).`rateLimitPerUser` |
|
|
48
|
-
| `rawData` | `protected` | `null` \| `APITextChannel` | `null` | The raw data of the channel. | - | [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).`rawData` |
|
|
49
|
-
| `type` | `public` | `GuildText` | `ChannelType.GuildText` | The type of the channel. | [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).`type` | - |
|
|
50
|
-
|
|
51
|
-
## Accessors
|
|
52
|
-
|
|
53
|
-
### guild
|
|
54
|
-
|
|
55
|
-
> `get` **guild**(): [`Guild`](/carbon/api/classes/Guild)
|
|
56
|
-
|
|
57
|
-
The guild this channel is in
|
|
58
|
-
|
|
59
|
-
#### Returns
|
|
60
|
-
|
|
61
|
-
[`Guild`](/carbon/api/classes/Guild)
|
|
62
|
-
|
|
63
|
-
#### Inherited from
|
|
64
|
-
|
|
65
|
-
[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`guild`](/carbon/api/classes/BaseGuildTextChannel#guild)
|
|
66
|
-
|
|
67
|
-
***
|
|
68
|
-
|
|
69
|
-
### lastMessage
|
|
70
|
-
|
|
71
|
-
> `get` **lastMessage**(): `null` \| [`Message`](/carbon/api/classes/Message)
|
|
72
|
-
|
|
73
|
-
The last message sent in the channel.
|
|
74
|
-
|
|
75
|
-
#### Remarks
|
|
76
|
-
|
|
77
|
-
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.
|
|
78
|
-
This will always return a partial message, so you can use [Message.fetch](/carbon/api/classes/Message#fetch) to get the full message data.
|
|
79
|
-
|
|
80
|
-
#### Returns
|
|
81
|
-
|
|
82
|
-
`null` \| [`Message`](/carbon/api/classes/Message)
|
|
83
|
-
|
|
84
|
-
#### Inherited from
|
|
85
|
-
|
|
86
|
-
[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`lastMessage`](/carbon/api/classes/BaseGuildTextChannel#lastmessage)
|
|
87
|
-
|
|
88
|
-
## Methods
|
|
89
|
-
|
|
90
|
-
### createInvite()
|
|
91
|
-
|
|
92
|
-
> **createInvite**(`options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`APIExtendedInvite`\>
|
|
93
|
-
|
|
94
|
-
Create an invite for the channel
|
|
95
|
-
|
|
96
|
-
#### Parameters
|
|
97
|
-
|
|
98
|
-
| Parameter | Type |
|
|
99
|
-
| ------ | ------ |
|
|
100
|
-
| `options`? | `RESTPostAPIChannelInviteJSONBody` |
|
|
101
|
-
|
|
102
|
-
#### Returns
|
|
103
|
-
|
|
104
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`APIExtendedInvite`\>
|
|
105
|
-
|
|
106
|
-
#### Inherited from
|
|
107
|
-
|
|
108
|
-
[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`createInvite`](/carbon/api/classes/BaseGuildTextChannel#createinvite)
|
|
109
|
-
|
|
110
|
-
***
|
|
111
|
-
|
|
112
|
-
### fetch()
|
|
113
|
-
|
|
114
|
-
> **fetch**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
115
|
-
|
|
116
|
-
Fetches the channel from the API.
|
|
117
|
-
|
|
118
|
-
#### Returns
|
|
119
|
-
|
|
120
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
121
|
-
|
|
122
|
-
The channel data.
|
|
123
|
-
|
|
124
|
-
#### Inherited from
|
|
125
|
-
|
|
126
|
-
[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`fetch`](/carbon/api/classes/BaseGuildTextChannel#fetch)
|
|
127
|
-
|
|
128
|
-
***
|
|
129
|
-
|
|
130
|
-
### getInvites()
|
|
131
|
-
|
|
132
|
-
> **getInvites**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`RESTGetAPIGuildInvitesResult`\>
|
|
133
|
-
|
|
134
|
-
Get the invites for the channel
|
|
135
|
-
|
|
136
|
-
#### Returns
|
|
137
|
-
|
|
138
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`RESTGetAPIGuildInvitesResult`\>
|
|
139
|
-
|
|
140
|
-
#### Inherited from
|
|
141
|
-
|
|
142
|
-
[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`getInvites`](/carbon/api/classes/BaseGuildTextChannel#getinvites)
|
|
143
|
-
|
|
144
|
-
***
|
|
145
|
-
|
|
146
|
-
### getPinnedMessages()
|
|
147
|
-
|
|
148
|
-
> **getPinnedMessages**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Message`](/carbon/api/classes/Message)[]\>
|
|
149
|
-
|
|
150
|
-
Get the pinned messages in the channel
|
|
151
|
-
|
|
152
|
-
#### Returns
|
|
153
|
-
|
|
154
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Message`](/carbon/api/classes/Message)[]\>
|
|
155
|
-
|
|
156
|
-
#### Inherited from
|
|
157
|
-
|
|
158
|
-
[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`getPinnedMessages`](/carbon/api/classes/BaseGuildTextChannel#getpinnedmessages)
|
|
159
|
-
|
|
160
|
-
***
|
|
161
|
-
|
|
162
|
-
### send()
|
|
163
|
-
|
|
164
|
-
> **send**(`message`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
165
|
-
|
|
166
|
-
Send a message to the channel
|
|
167
|
-
|
|
168
|
-
#### Parameters
|
|
169
|
-
|
|
170
|
-
| Parameter | Type |
|
|
171
|
-
| ------ | ------ |
|
|
172
|
-
| `message` | `APIMessage` |
|
|
173
|
-
|
|
174
|
-
#### Returns
|
|
175
|
-
|
|
176
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
177
|
-
|
|
178
|
-
#### Inherited from
|
|
179
|
-
|
|
180
|
-
[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`send`](/carbon/api/classes/BaseGuildTextChannel#send)
|
|
181
|
-
|
|
182
|
-
***
|
|
183
|
-
|
|
184
|
-
### setData()
|
|
185
|
-
|
|
186
|
-
> `protected` **setData**(`data`): `void`
|
|
187
|
-
|
|
188
|
-
#### Parameters
|
|
189
|
-
|
|
190
|
-
| Parameter | Type |
|
|
191
|
-
| ------ | ------ |
|
|
192
|
-
| `data` | `APIGuildChannel`\<`GuildText`\> |
|
|
193
|
-
|
|
194
|
-
#### Returns
|
|
195
|
-
|
|
196
|
-
`void`
|
|
197
|
-
|
|
198
|
-
#### Inherited from
|
|
199
|
-
|
|
200
|
-
[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`setData`](/carbon/api/classes/BaseGuildTextChannel#setdata)
|
|
201
|
-
|
|
202
|
-
***
|
|
203
|
-
|
|
204
|
-
### setMoreSpecificData()
|
|
205
|
-
|
|
206
|
-
> `protected` **setMoreSpecificData**(`data`): `void`
|
|
207
|
-
|
|
208
|
-
#### Parameters
|
|
209
|
-
|
|
210
|
-
| Parameter | Type |
|
|
211
|
-
| ------ | ------ |
|
|
212
|
-
| `data` | `APIGuildTextChannel`\<`GuildText`\> |
|
|
213
|
-
|
|
214
|
-
#### Returns
|
|
215
|
-
|
|
216
|
-
`void`
|
|
217
|
-
|
|
218
|
-
#### Overrides
|
|
219
|
-
|
|
220
|
-
[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`setMoreSpecificData`](/carbon/api/classes/BaseGuildTextChannel#setmorespecificdata)
|
|
221
|
-
|
|
222
|
-
***
|
|
223
|
-
|
|
224
|
-
### setName()
|
|
225
|
-
|
|
226
|
-
> **setName**(`name`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
227
|
-
|
|
228
|
-
Set the name of the channel
|
|
229
|
-
|
|
230
|
-
#### Parameters
|
|
231
|
-
|
|
232
|
-
| Parameter | Type | Description |
|
|
233
|
-
| ------ | ------ | ------ |
|
|
234
|
-
| `name` | `string` | The new name 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
|
-
[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`setName`](/carbon/api/classes/BaseGuildTextChannel#setname)
|
|
243
|
-
|
|
244
|
-
***
|
|
245
|
-
|
|
246
|
-
### setNsfw()
|
|
247
|
-
|
|
248
|
-
> **setNsfw**(`nsfw`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
249
|
-
|
|
250
|
-
Set whether the channel is nsfw
|
|
251
|
-
|
|
252
|
-
#### Parameters
|
|
253
|
-
|
|
254
|
-
| Parameter | Type | Description |
|
|
255
|
-
| ------ | ------ | ------ |
|
|
256
|
-
| `nsfw` | `boolean` | The new nsfw status of the channel |
|
|
257
|
-
|
|
258
|
-
#### Returns
|
|
259
|
-
|
|
260
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
261
|
-
|
|
262
|
-
#### Inherited from
|
|
263
|
-
|
|
264
|
-
[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`setNsfw`](/carbon/api/classes/BaseGuildTextChannel#setnsfw)
|
|
265
|
-
|
|
266
|
-
***
|
|
267
|
-
|
|
268
|
-
### setParent()
|
|
269
|
-
|
|
270
|
-
> **setParent**(`parent`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
271
|
-
|
|
272
|
-
Set the parent ID of the channel
|
|
273
|
-
|
|
274
|
-
#### Parameters
|
|
275
|
-
|
|
276
|
-
| Parameter | Type | Description |
|
|
277
|
-
| ------ | ------ | ------ |
|
|
278
|
-
| `parent` | `string` \| [`GuildCategoryChannel`](/carbon/api/classes/GuildCategoryChannel) | The new category channel or ID to set |
|
|
279
|
-
|
|
280
|
-
#### Returns
|
|
281
|
-
|
|
282
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
283
|
-
|
|
284
|
-
#### Inherited from
|
|
285
|
-
|
|
286
|
-
[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`setParent`](/carbon/api/classes/BaseGuildTextChannel#setparent)
|
|
287
|
-
|
|
288
|
-
***
|
|
289
|
-
|
|
290
|
-
### setPosition()
|
|
291
|
-
|
|
292
|
-
> **setPosition**(`position`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
293
|
-
|
|
294
|
-
Set the position of the channel
|
|
295
|
-
|
|
296
|
-
#### Parameters
|
|
297
|
-
|
|
298
|
-
| Parameter | Type | Description |
|
|
299
|
-
| ------ | ------ | ------ |
|
|
300
|
-
| `position` | `number` | The new position of the channel |
|
|
301
|
-
|
|
302
|
-
#### Returns
|
|
303
|
-
|
|
304
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
305
|
-
|
|
306
|
-
#### Inherited from
|
|
307
|
-
|
|
308
|
-
[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`setPosition`](/carbon/api/classes/BaseGuildTextChannel#setposition)
|
|
309
|
-
|
|
310
|
-
***
|
|
311
|
-
|
|
312
|
-
### setSpecificData()
|
|
313
|
-
|
|
314
|
-
> `protected` **setSpecificData**(`data`): `void`
|
|
315
|
-
|
|
316
|
-
#### Parameters
|
|
317
|
-
|
|
318
|
-
| Parameter | Type |
|
|
319
|
-
| ------ | ------ |
|
|
320
|
-
| `data` | `APIGuildTextChannel`\<`GuildText`\> |
|
|
321
|
-
|
|
322
|
-
#### Returns
|
|
323
|
-
|
|
324
|
-
`void`
|
|
325
|
-
|
|
326
|
-
#### Inherited from
|
|
327
|
-
|
|
328
|
-
[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`setSpecificData`](/carbon/api/classes/BaseGuildTextChannel#setspecificdata)
|
|
329
|
-
|
|
330
|
-
***
|
|
331
|
-
|
|
332
|
-
### startThread()
|
|
333
|
-
|
|
334
|
-
> **startThread**(`data`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`GuildThreadChannel`](/carbon/api/classes/GuildThreadChannel)\<`ThreadChannelType`\>\>
|
|
335
|
-
|
|
336
|
-
Start a thread without an associated start message.
|
|
337
|
-
If you want to start a thread with a start message, use [Message.startThread](/carbon/api/classes/Message#startthread)
|
|
338
|
-
|
|
339
|
-
#### Parameters
|
|
340
|
-
|
|
341
|
-
| Parameter | Type |
|
|
342
|
-
| ------ | ------ |
|
|
343
|
-
| `data` | `RESTPostAPIChannelThreadsJSONBody` |
|
|
344
|
-
|
|
345
|
-
#### Returns
|
|
346
|
-
|
|
347
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`GuildThreadChannel`](/carbon/api/classes/GuildThreadChannel)\<`ThreadChannelType`\>\>
|
|
348
|
-
|
|
349
|
-
#### Inherited from
|
|
350
|
-
|
|
351
|
-
[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`startThread`](/carbon/api/classes/BaseGuildTextChannel#startthread)
|
|
352
|
-
|
|
353
|
-
***
|
|
354
|
-
|
|
355
|
-
### triggerTyping()
|
|
356
|
-
|
|
357
|
-
> **triggerTyping**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
358
|
-
|
|
359
|
-
Trigger a typing indicator in the channel (this will expire after 10 seconds)
|
|
360
|
-
|
|
361
|
-
#### Returns
|
|
362
|
-
|
|
363
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
364
|
-
|
|
365
|
-
#### Inherited from
|
|
366
|
-
|
|
367
|
-
[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`triggerTyping`](/carbon/api/classes/BaseGuildTextChannel#triggertyping)
|