ThreadChannel

Extends

ObjectToLower<Omit<APIThreadChannel, "permission_overwrites">>.TextBaseGuildChannel.BaseChannel<ChannelType.PublicThread | ChannelType.AnnouncementThread | ChannelType.PrivateThread>

Constructors

new ThreadChannel(client, data)

1
new ThreadChannel(client: UsingClient, data: APIChannelBase<ChannelType>): ThreadChannel

Parameters

Parameter	Type
`client`	`UsingClient`
`data`	`APIChannelBase`<`ChannelType`>

Properties

Property	Modifier	Type	Inherited from
`appliedTags`	`public`	`string`[]	`ObjectToLower.appliedTags`
`client`	`readonly`	`UsingClient`	`BaseChannel`.`client`
`defaultAutoArchiveDuration`	`public`	`undefined` \| `ThreadAutoArchiveDuration`	`TextBaseGuildChannel`.`defaultAutoArchiveDuration`
`defaultThreadRateLimitPerUser`	`public`	`undefined` \| `number`	`TextBaseGuildChannel`.`defaultThreadRateLimitPerUser`
`flags`	`public`	`undefined` \| `ChannelFlags`	`TextBaseGuildChannel`.`flags`
`guildId`	`public`	`undefined` \| `string`	`TextBaseGuildChannel`.`guildId`
`id`	`public`	`string`	`BaseChannel`.`id`
`lastMessageId`	`public`	`undefined` \| `null` \| `string`	`TextBaseGuildChannel`.`lastMessageId`
`lastPinTimestamp`	`public`	`undefined` \| `null` \| `string`	`TextBaseGuildChannel`.`lastPinTimestamp`
`member`	`public`	`undefined` \| `Object`	`ObjectToLower.member`
`memberCount`	`public`	`undefined` \| `number`	`ObjectToLower.memberCount`
`messageCount`	`public`	`undefined` \| `number`	`ObjectToLower.messageCount`
`messages`	`public`	`Object`	`TextBaseGuildChannel`.`messages`
`messages.crosspost`	`public`	(`messageId`: `string`, `reason`?: `string`) => `Promise`<`Message`>	-
`messages.delete`	`public`	(`messageId`: `string`, `reason`?: `string`) => `Promise`<`void`>	-
`messages.edit`	`public`	(`messageId`: `string`, `body`: `Omit`<`RESTPatchAPIChannelMessageJSONBody`, `"components"` \| `"embeds"`> & `ResolverProps`) => `Promise`<`Message`>	-
`messages.fetch`	`public`	(`messageId`: `string`) => `Promise`<`Message`>	-
`messages.purge`	`public`	(`messages`: `string`[], `reason`?: `string`) => `Promise`<`undefined` \| `void`>	-
`messages.write`	`public`	(`body`: `Omit`<`RESTPostAPIChannelMessageJSONBody`, `"components"` \| `"embeds"` \| `"poll"`> & `SendResolverProps`) => `Promise`<`Message`>	-
`name`	`public`	`string`	`TextBaseGuildChannel`.`name`
`nsfw`	`public`	`undefined` \| `boolean`	`TextBaseGuildChannel`.`nsfw`
`ownerId`	`public`	`undefined` \| `string`	`ObjectToLower.ownerId`
`parentId`	`public`	`undefined` \| `null` \| `string`	`TextBaseGuildChannel`.`parentId`
`permissionOverwrites`	`public`	`Object`	`TextBaseGuildChannel`.`permissionOverwrites`
`permissionOverwrites.fetch`	`public`	() => `ReturnCache`<`undefined` \| `Object`[]>	-
`permissionOverwrites.values`	`public`	() => `Object`[][]	-
`pins`	`public`	`Object`	`TextBaseGuildChannel`.`pins`
`pins.delete`	`public`	(`messageId`: `string`, `reason`?: `string`) => `Promise`<`never`>	-
`pins.fetch`	`public`	() => `Promise`<`Message`[]>	-
`pins.set`	`public`	(`messageId`: `string`, `reason`?: `string`) => `Promise`<`never`>	-
`position`	`public`	`number`	`TextBaseGuildChannel`.`position`
`rateLimitPerUser`	`public`	`undefined` \| `number`	`TextBaseGuildChannel`.`rateLimitPerUser`
`reactions`	`public`	`Object`	`TextBaseGuildChannel`.`reactions`
`reactions.add`	`public`	(`messageId`: `string`, `emoji`: `EmojiResolvable`) => `Promise`<`void`>	-
`reactions.delete`	`public`	(`messageId`: `string`, `emoji`: `EmojiResolvable`, `userId`: `string`) => `Promise`<`void`>	-
`reactions.fetch`	`public`	(`messageId`: `string`, `emoji`: `EmojiResolvable`, `query`?: `RESTGetAPIChannelMessageReactionUsersQuery`) => `Promise`<`User`[]>	-
`reactions.purge`	`public`	(`messageId`: `string`, `emoji`?: `EmojiResolvable`) => `Promise`<`void`>	-
`threadMetadata`	`public`	`undefined` \| `Object`	`ObjectToLower.threadMetadata`
`topic`	`public`	`undefined` \| `null` \| `string`	`TextBaseGuildChannel`.`topic`
`totalMessageSent`	`public`	`undefined` \| `number`	`ObjectToLower.totalMessageSent`
`type`	`public`	`AnnouncementThread` \| `PublicThread` \| `PrivateThread`	`BaseChannel`.`type`
`webhooks`	`public`	`Object`	-
`webhooks.create`	`public`	(`body`: `RESTPostAPIChannelWebhookJSONBody`) => `Promise`<`Webhook`>	-
`webhooks.list`	`public`	() => `Promise`<`Webhook`[]>	-

Accessors

createdAt

1
get createdAt(): Date

createdAt gets the creation Date instace of the current object.

Returns

Date

Source

seyfert/src/structures/extra/DiscordBase.ts:27

createdTimestamp

1
get createdTimestamp(): number

Create a timestamp for the current object.

Returns

number

Source

seyfert/src/structures/extra/DiscordBase.ts:20

url

1
get url(): string

The URL to the channel

Returns

string

Source

seyfert/src/structures/channels.ts:58

Methods

delete()

1
delete(reason?: string): Promise<AllChannels>

Parameters

Parameter	Type
`reason`?	`string`

Returns

Promise<AllChannels>

Inherited from

BaseChannel.delete

Source

seyfert/src/structures/channels.ts:66

edit()

1
edit(body: RESTPatchAPIChannelJSONBody, reason?: string): Promise<AllChannels>

Parameters

Parameter	Type
`body`	`RESTPatchAPIChannelJSONBody`
`reason`?	`string`

Returns

Promise<AllChannels>

Inherited from

BaseChannel.edit

Source

seyfert/src/structures/channels.ts:70

fetch()

1
fetch(force: boolean): Promise<AllChannels>

Parameters

Parameter	Type	Default value
`force`	`boolean`	`false`

Returns

Promise<AllChannels>

Inherited from

BaseChannel.fetch

Source

seyfert/src/structures/channels.ts:62

guild()

1
guild(force: boolean): Promise<Guild<"cached"> | Guild<"api">>

Parameters

Parameter	Type	Default value
`force`	`boolean`	`false`

Returns

Promise<Guild<"cached"> | Guild<"api">>

Inherited from

TextBaseGuildChannel.guild

Source

seyfert/src/structures/channels.ts:190

is()

1
is<T>(channelTypes: T): this is IChannelTypes[T[number]]

Type parameters

Type parameter
`T` extends keyof `IChannelTypes`[]

Parameters

Parameter	Type
`channelTypes`	`T`

Returns

this is IChannelTypes[T[number]]

Inherited from

BaseChannel.is

Source

seyfert/src/structures/channels.ts:133

isCategory()

1
isCategory(): this is CategoryChannel

Returns

this is CategoryChannel

Inherited from

BaseChannel.isCategory

Source

seyfert/src/structures/channels.ts:113

isDM()

1
isDM(): this is DMChannel

Returns

this is DMChannel

Inherited from

BaseChannel.isDM

Source

seyfert/src/structures/channels.ts:89

isDirectory()

1
isDirectory(): this is DirectoryChannel

Returns

this is DirectoryChannel

Inherited from

BaseChannel.isDirectory

Source

seyfert/src/structures/channels.ts:101

isForum()

1
isForum(): this is ForumChannel

Returns

this is ForumChannel

Inherited from

BaseChannel.isForum

Source

seyfert/src/structures/channels.ts:93

isGuildTextable()

1
isGuildTextable(): this is AllGuildTextableChannels

Returns

this is AllGuildTextableChannels

Inherited from

BaseChannel.isGuildTextable

Source

seyfert/src/structures/channels.ts:125

isMedia()

1
isMedia(): this is MediaChannel

Returns

this is MediaChannel

Inherited from

BaseChannel.isMedia

Source

seyfert/src/structures/channels.ts:85

isNews()

1
isNews(): this is NewsChannel

Returns

this is NewsChannel

Inherited from

BaseChannel.isNews

Source

seyfert/src/structures/channels.ts:117

isStage()

1
isStage(): this is StageChannel

Returns

this is StageChannel

Inherited from

BaseChannel.isStage

Source

seyfert/src/structures/channels.ts:81

isTextGuild()

1
isTextGuild(): this is TextGuildChannel

Returns

this is TextGuildChannel

Inherited from

BaseChannel.isTextGuild

Source

seyfert/src/structures/channels.ts:109

isTextable()

1
isTextable(): this is AllTextableChannels

Returns

this is AllTextableChannels

Inherited from

BaseChannel.isTextable

Source

seyfert/src/structures/channels.ts:121

isThread()

1
isThread(): this is ThreadChannel

Returns

this is ThreadChannel

Inherited from

BaseChannel.isThread

Source

seyfert/src/structures/channels.ts:97

isThreadOnly()

1
isThreadOnly(): this is MediaChannel | ForumChannel

Returns

this is MediaChannel | ForumChannel

Inherited from

BaseChannel.isThreadOnly

Source

seyfert/src/structures/channels.ts:129

isVoice()

1
isVoice(): this is VoiceChannel

Returns

this is VoiceChannel

Inherited from

BaseChannel.isVoice

Source

seyfert/src/structures/channels.ts:105

join()

1
join(): Promise<ThreadChannel>

Returns

Promise<ThreadChannel>

Source

seyfert/src/structures/channels.ts:465

leave()

1
leave(): Promise<ThreadChannel>

Returns

Promise<ThreadChannel>

Source

seyfert/src/structures/channels.ts:470

memberPermissions()

1
memberPermissions(member: GuildMember, checkAdmin: boolean): Promise<PermissionsBitField>

Parameters

Parameter	Type	Default value
`member`	`GuildMember`	`undefined`
`checkAdmin`	`boolean`	`true`

Returns

Promise<PermissionsBitField>

Inherited from

TextBaseGuildChannel.memberPermissions

Source

seyfert/src/structures/channels.ts:178

overwritesFor()

1
overwritesFor(member: GuildMember): Promise<Object>

Parameters

Parameter	Type
`member`	`GuildMember`

Returns

Promise<Object>

Member Type Value
everyone undefined | Object everyoneOverwrites
member undefined | Object memberOverwrites
roles Object[] roleOverwrites

Member	Type	Value
`everyone`	`undefined` \| `Object`	everyoneOverwrites
`member`	`undefined` \| `Object`	memberOverwrites
`roles`	`Object`[]	roleOverwrites

Inherited from

TextBaseGuildChannel.overwritesFor

Source

seyfert/src/structures/channels.ts:186

pin()

1
pin(reason?: string): Promise<AllChannels>

Parameters

Parameter	Type
`reason`?	`string`

Returns

Promise<AllChannels>

Source

seyfert/src/structures/channels.ts:479

rolePermissions()

1
rolePermissions(role: GuildRole, checkAdmin: boolean): Promise<PermissionsBitField>

Parameters

Parameter	Type	Default value
`role`	`GuildRole`	`undefined`
`checkAdmin`	`boolean`	`true`

Returns

Promise<PermissionsBitField>

Inherited from

TextBaseGuildChannel.rolePermissions

Source

seyfert/src/structures/channels.ts:182

setArchived()

1
setArchived(archived: boolean, reason?: string): Promise<AllChannels>

Parameters

Parameter	Type	Default value
`archived`	`boolean`	`true`
`reason`?	`string`	`undefined`

Returns

Promise<AllChannels>

Source

seyfert/src/structures/channels.ts:495

setAutoArchiveDuration()

1
setAutoArchiveDuration(auto_archive_duration: StringToNumber<"60" | "1440" | "4320" | "10080">, reason?: string): Promise<AllChannels>

Parameters

Parameter	Type
`auto_archive_duration`	`StringToNumber`<`"60"` \| `"1440"` \| `"4320"` \| `"10080"`>
`reason`?	`string`

Returns

Promise<AllChannels>

Source

seyfert/src/structures/channels.ts:499

setInvitable()

1
setInvitable(invitable: boolean, reason?: string): Promise<AllChannels>

Parameters

Parameter	Type	Default value
`invitable`	`boolean`	`true`
`reason`?	`string`	`undefined`

Returns

Promise<AllChannels>

Source

seyfert/src/structures/channels.ts:503

setLocked()

1
setLocked(locked: boolean, reason?: string): Promise<AllChannels>

Parameters

Parameter	Type	Default value
`locked`	`boolean`	`true`
`reason`?	`string`	`undefined`

Returns

Promise<AllChannels>

Source

seyfert/src/structures/channels.ts:507

setName()

1
setName(name: string, reason?: string): Promise<AllChannels>

Parameters

Parameter	Type
`name`	`string`
`reason`?	`string`

Returns

Promise<AllChannels>

Inherited from

TextBaseGuildChannel.setName

Source

seyfert/src/structures/channels.ts:202

setParent()

1
setParent(parent_id: null | string, reason?: string): Promise<AllChannels>

Parameters

Parameter	Type
`parent_id`	`null` \| `string`
`reason`?	`string`

Returns

Promise<AllChannels>

Inherited from

TextBaseGuildChannel.setParent

Source

seyfert/src/structures/channels.ts:206

setPosition()

1
setPosition(position: number, reason?: string): Promise<AllChannels>

Parameters

Parameter	Type
`position`	`number`
`reason`?	`string`

Returns

Promise<AllChannels>

Inherited from

TextBaseGuildChannel.setPosition

Source

seyfert/src/structures/channels.ts:198

setRatelimitPerUser()

1
setRatelimitPerUser(rate_limit_per_user: undefined | null | number): Promise<AllChannels>

Parameters

Parameter	Type
`rate_limit_per_user`	`undefined` \| `null` \| `number`

Returns

Promise<AllChannels>

Source

seyfert/src/structures/channels.ts:475

setTags()

1
setTags(applied_tags: string[], reason?: string): Promise<AllChannels>

Parameters

Parameter	Type
`applied_tags`	`string`[]
`reason`?	`string`

Returns

Promise<AllChannels>

Source

seyfert/src/structures/channels.ts:487

toString()

1
toString(): string

Returns

string

Inherited from

BaseChannel.toString

Source

seyfert/src/structures/channels.ts:77

typing()

1
typing(): Promise<void>

Returns

Promise<void>

Inherited from

TextBaseGuildChannel.typing

Source

seyfert/src/structures/channels.ts:213

unpin()

1
unpin(reason?: string): Promise<AllChannels>

Parameters

Parameter	Type
`reason`?	`string`

Returns

Promise<AllChannels>

Source

seyfert/src/structures/channels.ts:483

intent()

intent(id)

1
static __intent__(id: "@me"): "DirectMessages"

Parameters

Parameter	Type
`id`	`"@me"`

Returns

"DirectMessages"

Inherited from

BaseChannel.__intent__

Source

seyfert/src/structures/channels.ts:51

intent(id)

1
static __intent__(id: string): "DirectMessages" | "Guilds"

Parameters

Parameter	Type
`id`	`string`

Returns

"DirectMessages" | "Guilds"

Inherited from

BaseChannel.__intent__

Source

seyfert/src/structures/channels.ts:52

allMethods()

1
static allMethods(ctx:     Object): Object

Parameters

Parameter	Type
`ctx`	`Object`
`ctx.client`	`UsingClient`
`ctx.guildId`	`string`

Returns

Object

Member	Type	Value
`create`	(`body`: `RESTPostAPIGuildChannelJSONBody`) => `Promise`<`AllChannels`>	-
`delete`	(`id`: `string`, `reason`?: `string`) => `Promise`<`AllChannels`>	-
`edit`	(`id`: `string`, `body`: `RESTPatchAPIChannelJSONBody`, `reason`?: `string`) => `Promise`<`AllChannels`>	-
`editPositions`	(`body`: `RESTPatchAPIGuildChannelPositionsJSONBody`) => `Promise`<`never`>	-
`fetch`	(`id`: `string`, `force`: `boolean`) => `Promise`<`AllChannels`>	-
`list`	(`force`: `boolean`) => `Promise`<`AllChannels`[]>	-

Inherited from

BaseChannel.allMethods

Source

seyfert/src/structures/channels.ts:137