discord.js | PermissionOverwriteManager

Search...

PermissionOverwriteManager

export class PermissionOverwriteManager extends CachedManager<
  Snowflake,
  PermissionOverwrites,
  PermissionOverwriteResolvable
>

export class PermissionOverwriteManager extends CachedManager<
  Snowflake,
  PermissionOverwrites,
  PermissionOverwriteResolvable
>

Manages API methods for guild channel permission overwrites and stores their cache.

Readonly

cache:Collection<K, Holds>

The cache of items for this manager.

Inherited from DataManager

Readonly

client:Client

The client that instantiated this Manager

Inherited from BaseManager

Readonly

The data structure belonging to this manager.

Inherited from DataManager

create(userOrRole, options, overwriteOptions?):Promise<NonThreadGuildBasedChannel>

Creates permission overwrites for a user or role in this channel, or replaces them if already present.

Name	Type	Optional	Description
userOrRole	RoleResolvable \| UserResolvable	No	The user or role to update
options	PermissionOverwriteOptions	No	The options for the update
overwriteOptions	GuildChannelOverwriteOptions	Yes	The extra information for the update

delete(userOrRole, reason?):Promise<NonThreadGuildBasedChannel>

Deletes permission overwrites for a user or role in this channel.

Name	Type	Optional	Description
userOrRole	RoleResolvable \| UserResolvable	No	The user or role to delete
reason	string	Yes	The reason for deleting the overwrite

edit(userOrRole, options, overwriteOptions?):Promise<NonThreadGuildBasedChannel>

Edits permission overwrites for a user or role in this channel, or creates an entry if not already present.

Name	Type	Optional	Description
userOrRole	RoleResolvable \| UserResolvable	No	The user or role to update
options	PermissionOverwriteOptions	No	The options for the update
overwriteOptions	GuildChannelOverwriteOptions	Yes	The extra information for the update

resolve(idOrInstance):Holds

Resolves a data entry to a data Object.

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.

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

set(overwrites, reason?):Promise<NonThreadGuildBasedChannel>

Replaces the permission overwrites in this channel.

Name	Type	Optional	Description
overwrites	readonly OverwriteResolvable[] \| Collection<Snowflake, OverwriteResolvable>	No	Permission overwrites the channel gets updated with
reason	string	Yes	Reason for updating the channel overwrites

valueOf():Collection<K, Holds>