discord.js | BaseGuildTextChannel

Search...

BaseGuildTextChannel

export class BaseGuildTextChannel extends TextBasedChannelMixin(GuildChannel, true)

export class BaseGuildTextChannel extends TextBasedChannelMixin(GuildChannel, true)

Represents a text-based guild channel on Discord.

TextBasedChannelMixin(GuildChannel, true)

constructor(guild, data?, client?, immediatePatch?)

Constructs a new instance of the BaseGuildTextChannel class

Name	Type	Optional	Description
guild	Guild	No	None
data	RawGuildChannelData	Yes	None
client	Client<true>	Yes	None
immediatePatch	boolean	Yes	None

defaultAutoArchiveDuration?:ThreadAutoArchiveDuration

The default auto archive duration for newly created threads in this channel

defaultThreadRateLimitPerUser:number | null

The initial rate limit per user (slowmode) to set on newly created threads in a channel.

nsfw:boolean

If the guild considers this channel NSFW

rateLimitPerUser:number | null

A manager of the threads belonging to this channel

topic:string | null

The topic of the text channel

createInvite(options?):Promise<Invite>

Creates an invite to this guild channel.

Name	Type	Optional	Description
options	InviteCreateOptions	Yes	The options for creating the invite

fetchInvites(cache?):Promise<Collection<string, Invite>>

Fetches a collection of invites to this guild channel. Resolves with a collection mapping invites by their codes.

Name	Type	Optional	Description
cache	boolean	Yes	Whether or not to cache the fetched invites

setDefaultAutoArchiveDuration(defaultAutoArchiveDuration, reason?):Promise<this>

Sets the default auto archive duration for all newly created threads in this channel.

Name	Type	Optional	Description
defaultAutoArchiveDuration	ThreadAutoArchiveDuration	No	The new default auto archive duration
reason	string	Yes	Reason for changing the channel's default auto archive duration

setTopic(topic, reason?):Promise<this>

Sets a new topic for the guild channel.

Name	Type	Optional	Description
topic	string \| null	No	The new topic for the guild channel
reason	string	Yes	Reason for changing the guild channel's topic

setType(type, reason?):Promise<TextChannel>

Sets the type of this channel. Only conversion between TextChannel and NewsChannel is supported.

Name	Type	Optional	Description
type	ChannelType.GuildText	No	The new channel type
reason	string	Yes	Reason for changing the channel's type