@buape/carbon 0.1.0

package/docs/classes/GuildThreadChannel.mdx

@@ -0,0 +1,425 @@
+---
+title: GuildThreadChannel
+---
+
+## Extends
+
+- [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel)\<`Type`\>
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `Type` *extends* `ThreadChannelType` |
+
+## Constructors
+
+### new GuildThreadChannel()
+
+> **new GuildThreadChannel**\<`Type`\>(`client`, `rawDataOrId`): [`GuildThreadChannel`](/carbon/api/classes/GuildThreadChannel)\<`Type`\>
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `client` | [`Client`](/carbon/api/classes/Client) |
+| `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`\> |
+
+#### Returns
+
+[`GuildThreadChannel`](/carbon/api/classes/GuildThreadChannel)\<`Type`\>
+
+#### Inherited from
+
+[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`constructor`](/carbon/api/classes/BaseGuildChannel#constructors)
+
+## Properties
+
+| Property | Modifier | Type | Default value | Description | Inherited from |
+| ------ | ------ | ------ | ------ | ------ | ------ |
+| `appliedTags?` | `public` | `string`[] | `undefined` | The tags applied to the thread. | - |
+| `archiveTimestamp?` | `public` | `string` | `undefined` | The timestamp of when the thread was archived. | - |
+| `archived?` | `public` | `boolean` | `undefined` | Whether the thread is archived. | - |
+| `autoArchiveDuration?` | `public` | `number` | `undefined` | The duration until the thread is auto archived. | - |
+| `client` | `public` | [`Client`](/carbon/api/classes/Client) | `undefined` | - | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`client` |
+| `createTimestamp?` | `public` | `string` | `undefined` | The timestamp of when the thread was created. | - |
+| `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` |
+| `guildId?` | `public` | `string` | `undefined` | The ID of the guild this channel is in | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`guildId` |
+| `id` | `public` | `string` | `undefined` | The id of the channel. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`id` |
+| `invitable?` | `public` | `boolean` | `undefined` | Whether non-moderators can add other non-moderators to a thread; only available on private threads | - |
+| `locked?` | `public` | `boolean` | `undefined` | Whether the thread is locked. | - |
+| `memberCount?` | `public` | `number` | `undefined` | The number of members in the thread. **Remarks** This is only accurate until 50, after that, Discord stops counting. | - |
+| `messageCount?` | `public` | `number` | `undefined` | The number of messages in the thread. | - |
+| `name?` | `public` | `string` | `undefined` | The name of the channel. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`name` |
+| `nsfw?` | `public` | `boolean` | `undefined` | Whether the channel is marked as nsfw. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`nsfw` |
+| `ownerId?` | `public` | `string` | `undefined` | The ID of the owner of the thread. | - |
+| `parentId?` | `public` | `null` \| `string` | `undefined` | The ID of the parent category for the channel. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`parentId` |
+| `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` |
+| `position?` | `public` | `number` | `undefined` | The position of the channel in the channel list. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`position` |
+| `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` |
+| `totalMessageSent?` | `public` | `number` | `undefined` | The number of messages sent in the thread. | - |
+| `type?` | `public` | `Type` | `undefined` | The type of the channel. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`type` |
+
+## Accessors
+
+### guild
+
+> `get` **guild**(): [`Guild`](/carbon/api/classes/Guild)
+
+The guild this channel is in
+
+#### Returns
+
+[`Guild`](/carbon/api/classes/Guild)
+
+#### Inherited from
+
+[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`guild`](/carbon/api/classes/BaseGuildChannel#guild)
+
+## Methods
+
+### addMember()
+
+> **addMember**(`userId`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Add a member to the thread
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `userId` | `string` |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+***
+
+### archive()
+
+> **archive**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Archive the thread
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+***
+
+### createInvite()
+
+> **createInvite**(`options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`APIExtendedInvite`\>
+
+Create an invite for the channel
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options`? | `RESTPostAPIChannelInviteJSONBody` |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`APIExtendedInvite`\>
+
+#### Inherited from
+
+[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`createInvite`](/carbon/api/classes/BaseGuildChannel#createinvite)
+
+***
+
+### fetch()
+
+> **fetch**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Fetches the channel from the API.
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+The channel data.
+
+#### Inherited from
+
+[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`fetch`](/carbon/api/classes/BaseGuildChannel#fetch)
+
+***
+
+### getInvites()
+
+> **getInvites**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`RESTGetAPIGuildInvitesResult`\>
+
+Get the invites for the channel
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`RESTGetAPIGuildInvitesResult`\>
+
+#### Inherited from
+
+[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`getInvites`](/carbon/api/classes/BaseGuildChannel#getinvites)
+
+***
+
+### join()
+
+> **join**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Join the thread
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+***
+
+### leave()
+
+> **leave**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Leave the thread
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+***
+
+### lock()
+
+> **lock**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Lock the thread
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+***
+
+### removeMember()
+
+> **removeMember**(`userId`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Get the pinned messages in the thread
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `userId` | `string` |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+***
+
+### send()
+
+> **send**(`message`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Send a message to the channel
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `message` | `APIMessage` |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+#### Inherited from
+
+[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`send`](/carbon/api/classes/BaseGuildChannel#send)
+
+***
+
+### setAutoArchiveDuration()
+
+> **setAutoArchiveDuration**(`duration`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Set the auto archive duration of the thread
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `duration` | `number` |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+***
+
+### setData()
+
+> `protected` **setData**(`data`): `void`
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `data` | `APIGuildChannel`\<`Type`\> |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`setData`](/carbon/api/classes/BaseGuildChannel#setdata)
+
+***
+
+### setName()
+
+> **setName**(`name`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Set the name of the channel
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `name` | `string` | The new name of the channel |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+#### Inherited from
+
+[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`setName`](/carbon/api/classes/BaseGuildChannel#setname)
+
+***
+
+### setNsfw()
+
+> **setNsfw**(`nsfw`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Set whether the channel is nsfw
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `nsfw` | `boolean` | The new nsfw status of the channel |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+#### Inherited from
+
+[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`setNsfw`](/carbon/api/classes/BaseGuildChannel#setnsfw)
+
+***
+
+### setParent()
+
+> **setParent**(`parent`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Set the parent ID of the channel
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `parent` | `string` \| [`GuildCategoryChannel`](/carbon/api/classes/GuildCategoryChannel) | The new category channel or ID to set |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+#### Inherited from
+
+[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`setParent`](/carbon/api/classes/BaseGuildChannel#setparent)
+
+***
+
+### setPosition()
+
+> **setPosition**(`position`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Set the position of the channel
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `position` | `number` | The new position of the channel |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+#### Inherited from
+
+[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`setPosition`](/carbon/api/classes/BaseGuildChannel#setposition)
+
+***
+
+### setSpecificData()
+
+> `protected` **setSpecificData**(`data`): `void`
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `data` | `APIThreadChannel` |
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`setSpecificData`](/carbon/api/classes/BaseGuildChannel#setspecificdata)
+
+***
+
+### triggerTyping()
+
+> **triggerTyping**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Trigger a typing indicator in the channel (this will expire after 10 seconds)
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+#### Inherited from
+
+[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`triggerTyping`](/carbon/api/classes/BaseGuildChannel#triggertyping)
+
+***
+
+### unarchive()
+
+> **unarchive**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Unarchive the thread
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+***
+
+### unlock()
+
+> **unlock**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Unlock the thread
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>