discord.js | GuildChannelManager

Search...

GuildChannelManager

export class GuildChannelManager extends CachedManager<Snowflake, GuildBasedChannel, GuildChannelResolvable>

export class GuildChannelManager extends CachedManager<Snowflake, GuildBasedChannel, GuildChannelResolvable>

Manages API methods for GuildChannels and stores their cache.

Extends

CachedManager<Snowflake, GuildBasedChannel, GuildChannelResolvable>

Readonly

cache:Collection<K, Holds>

The cache of items for this manager.

Inherited from DataManager

Readonly

channelCountWithoutThreads:number

The number of channels in this managers cache excluding thread channels that do not count towards a guild's maximum channels restriction.

Readonly

client:Client

The client that instantiated this Manager

Inherited from BaseManager

guild:Guild

The guild this Manager belongs to

Readonly

holds:Constructable<Holds>

The data structure belonging to this manager.

Inherited from DataManager

addFollower(channel, targetChannel, reason?):Promise<Snowflake>

Adds the target channel to a channel's followers.

Returns

Returns created target webhook id.

Name	Type	Optional	Description
channel	NewsChannel \| Snowflake	No	The channel to follow
targetChannel	TextChannelResolvable	No	The channel where published announcements will be posted at
reason	string	Yes	Reason for creating the webhook

create(options):Promise<MappedGuildChannelTypes[T]>

Creates a new channel in the guild.

Name	Type	Optional	Description
options	GuildChannelCreateOptions & { type: T }	No	Options for creating the new channel

createWebhook(options):Promise<Webhook>

Creates a webhook for the channel.

Returns

Returns the created Webhook

Name	Type	Optional	Description
options	WebhookCreateOptions	No	Options for creating the webhook

delete(channel, reason?):Promise<void>

Deletes the channel.

Name	Type	Optional	Description
channel	GuildChannelResolvable	No	The channel to delete
reason	string	Yes	Reason for deleting this channel

edit(channel, options):Promise<GuildChannel>

Edits the channel.

Name	Type	Optional	Description
channel	GuildChannelResolvable	No	The channel to edit
options	GuildChannelEditOptions	No	Options for editing the channel

fetch(id, options?):Promise<GuildBasedChannel | null>

Obtains one or more guild channels from Discord, or the channel cache if they're already available.

Name	Type	Optional	Description
id	Snowflake	No	The channel's id
options	BaseFetchOptions	Yes	Additional options for this fetch

fetchActiveThreads(cache?):Promise<FetchedThreads>

Obtains all active thread channels in the guild.

Name	Type	Optional	Description
cache	boolean	Yes	Whether to cache the fetched data

fetchWebhooks(channel):Promise<Collection<Snowflake, Webhook>>

Fetches all webhooks for the channel.

Name	Type	Optional	Description
channel	GuildChannelResolvable	No	The channel to fetch webhooks for

resolve(idOrInstance):Holds

Resolves a data entry to a data Object.

Returns

An instance from this Manager

Name	Type	Optional	Description
idOrInstance	Holds	No	The id or instance of something in this Manager

resolveId(idOrInstance):K

Resolves a data entry to an instance id.

Returns

Name	Type	Optional	Description
idOrInstance	K \| Holds	No	The id or instance of something in this Manager

setPosition(channel, position, options?):Promise<GuildChannel>

Sets a new position for the guild channel.

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

setPositions(channelPositions):Promise<Guild>

Batch-updates the guild's channels' positions. Only one channel's parent can be changed at a time

Name	Type	Optional	Description
channelPositions	readonly ChannelPosition[]	No	Channel positions to update

valueOf():Collection<K, Holds>