discord.js | GuildChannel

Search...

Abstract

GuildChannel

export abstract class GuildChannel extends BaseChannel

export abstract class GuildChannel extends BaseChannel

Represents a guild channel from any of the following: - TextChannel - VoiceChannel - CategoryChannel - NewsChannel - StageChannel - ForumChannel - MediaChannel

Extends

BaseChannel

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

Constructs a new instance of the GuildChannel class

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

Readonly

client:Client<true>

The client that instantiated this

Inherited from Base

Readonly

createdAt:Date

The time the channel was created at

Readonly

createdTimestamp:number

The timestamp the channel was created at

Readonly

deletable:boolean

Whether the channel is deletable by the client user

flags:Readonly<ChannelFlagsBitField>

The flags that are applied to the channel. This is only null in a PartialGroupDMChannel. In all other cases, it is not null.

guild:Guild

The guild the channel is in

guildId:Snowflake

The id of the guild the channel is in

id:Snowflake

The channel's id

Inherited from BaseChannel

Readonly

manageable:boolean

Whether the channel is manageable by the client user

Readonly

members:Collection<Snowflake, GuildMember>

A collection of cached members of this channel, mapped by their ids. Members that can view this channel, if the channel is text-based. Members in the channel, if the channel is voice-based.

name:string

The name of the guild channel

Readonly

parent:CategoryChannel | null

The category parent of this channel

parentId:Snowflake | null

The id of the category parent of this channel

Readonly

partial:false

Whether this Channel is a partial This is always false outside of DM channels.

Inherited from BaseChannel

permissionOverwrites:PermissionOverwriteManager

A manager of permission overwrites that belong to this channel

Readonly

permissionsLocked:boolean | null

If the permissionOverwrites match the parent channel, null if no parent

Readonly

position:number

The position of the channel

rawPosition:number

The raw position of the channel from Discord

type:Exclude<ChannelType, ChannelType.DM | ChannelType.GroupDM>

The type of the channel

Readonly

url:string

The URL to the channel

Inherited from BaseChannel

Readonly

viewable:boolean

Whether the channel is viewable by the client user

clone(options?):Promise<this>

Clones this channel.

Name	Type	Optional	Description
options	GuildChannelCloneOptions	Yes	The options for cloning this channel

delete(reason?):Promise<this>

Deletes this channel.

Name	Type	Optional	Description
reason	string	Yes	Reason for deleting this channel

edit(options):Promise<this>

Edits the channel.

Name	Type	Optional	Description
options	GuildChannelEditOptions	No	The options to provide

equals(channel):boolean

Checks if this channel has the same type, topic, position, name, overwrites, and id as another channel. In most cases, a simple channel.id === channel2.id will do, and is much faster too.

Name	Type	Optional	Description
channel	GuildChannel	No	Channel to compare with

fetch(force?):Promise<this>

Fetches this channel.

Name	Type	Optional	Description
force	boolean	Yes	Whether to skip the cache check and request the API

Inherited from BaseChannel

isDMBased():this is PartialGroupDMChannel | DMChannel | PartialDMChannel

Indicates whether this channel is DM-based (either a DMChannel or a PartialGroupDMChannel).

Inherited from BaseChannel

isTextBased():this is GuildBasedChannel & TextBasedChannel

Indicates whether this channel is .

isThread():this is AnyThreadChannel

Indicates whether this channel is a ThreadChannel.

Inherited from BaseChannel

isThreadOnly():this is ThreadOnlyChannel

Indicates whether this channel is .

Inherited from BaseChannel

isVoiceBased():this is VoiceBasedChannel

Indicates whether this channel is .

Inherited from BaseChannel

lockPermissions():Promise<this>

Locks in the permission overwrites from the parent channel.

permissionsFor(memberOrRole, checkAdmin?):Readonly<PermissionsBitField>

Gets the overall set of permissions for a member or role in this channel, taking into account channel overwrites.

Returns

Name	Type	Optional	Description
memberOrRole	GuildMember \| Role	No	The member or role to obtain the overall permissions for
checkAdmin	boolean	Yes	Whether having the permission will return all permissions

setName(name, reason?):Promise<this>

Sets a new name for the guild channel.

Name	Type	Optional	Description
name	string	No	The new name for the guild channel
reason	string	Yes	Reason for changing the guild channel's name

setParent(channel, options?):Promise<this>

Sets the parent of this channel.

Name	Type	Optional	Description
channel	CategoryChannelResolvable \| null	No	The category channel to set as the parent
options	SetParentOptions	Yes	The options for setting the parent

setPosition(position, options?):Promise<this>

Sets a new position for the guild channel.

Name	Type	Optional	Description
position	number	No	The new position for the guild channel
options	SetChannelPositionOptions	Yes	Options for setting position

toJSON(...props):unknown

Name	Type	Optional	Description
...props	Record<string, boolean \| string>[]	No	None

Inherited from Base

toString():ChannelMention

When concatenated with a string, this automatically returns the channel's mention instead of the Channel object.

valueOf():string