CoreClasses

BaseGuildChannel

Extends

BaseChannel<Type, IsPartial>

Extended by

Type Parameters

Type Parameter	Default type
`Type` extends `GuildChannelType`	-
`IsPartial` extends `boolean`	`false`

Constructors

new BaseGuildChannel()

new BaseGuildChannel<Type, IsPartial>(client, rawDataOrId): BaseGuildChannel<Type, IsPartial>

Parameters

Parameter Type

client Client

rawDataOrId IsPartial extends true ? string : Extract<APIDMChannel, object> | Extract<APIGroupDMChannel, object> | Extract<APIGuildCategoryChannel, object> | Extract<APIGuildForumChannel, object> | Extract<APIGuildMediaChannel, object> | Extract<APIGuildStageVoiceChannel, object> | Extract<APIGuildVoiceChannel, object> | Extract<APINewsChannel, object> | Extract<APITextChannel, object> | Extract<APIThreadChannel, object>

Returns

BaseGuildChannel<Type, IsPartial>

Inherited from

BaseChannel.constructor

Properties

Property	Modifier	Type	Description	Overrides	Inherited from
`client`	`public`	`Client`	-	-	`BaseChannel`.`client`
`id`	`readonly`	`string`	The id of the channel.	-	`BaseChannel`.`id`
`rawData`	`public`	`null` \| `APIGuildChannel`<`Type`>	The raw data of the channel.	`BaseChannel`.`rawData`	-

Accessors

flags

get flags(): IfPartial<IsPartial, undefined | ChannelFlags>

The flags of the channel in a bitfield.

See

https://discord.com/developers/docs/resources/channel#channel-object-channel-flags

Returns

IfPartial<IsPartial, undefined | ChannelFlags>

Inherited from

BaseChannel.flags

guild

get guild(): IfPartial<IsPartial, Guild<true>>

The guild this channel is in

Returns

IfPartial<IsPartial, Guild<true>>

guildId

get guildId(): IfPartial<IsPartial, string>

The ID of the guild this channel is in

Returns

IfPartial<IsPartial, string>

name

get name(): IfPartial<IsPartial, string>

The name of the channel.

Returns

IfPartial<IsPartial, string>

nsfw

get nsfw(): IfPartial<IsPartial, boolean>

Whether the channel is marked as nsfw.

Returns

IfPartial<IsPartial, boolean>

parentId

get parentId(): IfPartial<IsPartial, null | string>

The ID of the parent category for the channel.

Returns

IfPartial<IsPartial, null | string>

partial

get partial(): IsPartial

Whether the channel is a partial channel (meaning it does not have all the data). If this is true, you should use BaseChannel.fetch to get the full data of the channel.

Returns

IsPartial

Inherited from

BaseChannel.partial

position

get position(): IfPartial<IsPartial, number>

The position of the channel in the channel list.

Returns

IfPartial<IsPartial, number>

type

get type(): IfPartial<IsPartial, Type>

The type of the channel.

Returns

IfPartial<IsPartial, Type>

Inherited from

BaseChannel.type

Methods

createInvite()

createInvite(options?): Promise<APIExtendedInvite>

Create an invite for the channel

Parameters

Parameter	Type
`options`?	`RESTPostAPIChannelInviteJSONBody`

Returns

Promise<APIExtendedInvite>

fetch()

fetch(): Promise<void>

Fetches the channel from the API.

Returns

Promise<void>

The channel data.

Inherited from

BaseChannel.fetch

getInvites()

getInvites(): Promise<RESTGetAPIGuildInvitesResult>

Get the invites for the channel

Returns

Promise<RESTGetAPIGuildInvitesResult>

send()

send(message): Promise<void>

Send a message to the channel

Parameters

Parameter	Type
`message`	`MessagePayload`

Returns

Promise<void>

setData()

protected setData(data): void

Parameters

Parameter Type

data Extract<APIDMChannel, object> | Extract<APIGroupDMChannel, object> | Extract<APIGuildCategoryChannel, object> | Extract<APIGuildForumChannel, object> | Extract<APIGuildMediaChannel, object> | Extract<APIGuildStageVoiceChannel, object> | Extract<APIGuildVoiceChannel, object> | Extract<APINewsChannel, object> | Extract<APITextChannel, object> | Extract<APIThreadChannel, object>

Returns

void

Inherited from

BaseChannel.setData

setField()

protected setField(field, value): void

Parameters

Parameter Type

field keyof Extract<APIDMChannel, object> & keyof Extract<APIGroupDMChannel, object> & keyof Extract<APIGuildCategoryChannel, object> & keyof Extract<APIGuildForumChannel, object> & keyof Extract<APIGuildMediaChannel, object> & keyof Extract<APIGuildStageVoiceChannel, object> & keyof Extract<APIGuildVoiceChannel, object> & keyof Extract<APINewsChannel, object> & keyof Extract<APITextChannel, object> & keyof Extract<APIThreadChannel, object>

value unknown

Returns

void

Inherited from

BaseChannel.setField

setName()

setName(name): Promise<void>

Set the name of the channel

Parameters

Parameter	Type	Description
`name`	`string`	The new name of the channel

Returns

Promise<void>

setNsfw()

setNsfw(nsfw): Promise<void>

Set whether the channel is nsfw

Parameters

Parameter	Type	Description
`nsfw`	`boolean`	The new nsfw status of the channel

Returns

Promise<void>

setParent()

setParent(parent): Promise<void>

Set the parent ID of the channel

Parameters

Parameter	Type	Description
`parent`	`string` \| `GuildCategoryChannel`<`false`>	The new category channel or ID to set

Returns

Promise<void>

setPosition()

setPosition(position): Promise<void>

Set the position of the channel

Parameters

Parameter	Type	Description
`position`	`number`	The new position of the channel

Returns

Promise<void>

triggerTyping()

triggerTyping(): Promise<void>

Trigger a typing indicator in the channel (this will expire after 10 seconds)

Returns

Promise<void>

Previous

BaseComponentInteraction

Next

BaseGuildTextChannel