Class PermissionOverwriteManager

Hierarchy

CachedManager<Snowflake, PermissionOverwrites, PermissionOverwriteResolvable>
- PermissionOverwriteManager

Index

Constructors

`Private` constructor

new PermissionOverwriteManager(client, iterable?): PermissionOverwriteManager
Parameters
- client: Client<true>
- Optional iterable: Iterable<RawPermissionOverwriteData>
Returns PermissionOverwriteManager
Overrides CachedManager.constructor
- Defined in node_modules/discord.js/typings/index.d.ts:4535

Properties

`Readonly` client

client: Client<boolean>

`Readonly` holds

holds: Constructable<PermissionOverwrites>

Accessors

cache

get cache(): Collection<Key, Holds>
Returns Collection<Key, Holds>
Inherited from CachedManager.cache
- Defined in node_modules/discord.js/typings/index.d.ts:4094

Methods

create

create(userOrRole, options, overwriteOptions?): Promise<NonThreadGuildBasedChannel>
Parameters
- userOrRole: string | GuildMember | Role | User | Message<boolean> | ThreadMember<boolean>
- options: Partial<Record<"CreateInstantInvite" | "KickMembers" | "BanMembers" | "Administrator" | "ManageChannels" | "ManageGuild" | "AddReactions" | "ViewAuditLog" | "PrioritySpeaker" | "Stream" | "ViewChannel" | "SendMessages" | "SendTTSMessages" | "ManageMessages" | "EmbedLinks" | "AttachFiles" | "ReadMessageHistory" | "MentionEveryone" | "UseExternalEmojis" | "ViewGuildInsights" | "Connect" | "Speak" | "MuteMembers" | "DeafenMembers" | "MoveMembers" | "UseVAD" | "ChangeNickname" | "ManageNicknames" | "ManageRoles" | "ManageWebhooks" | "ManageEmojisAndStickers" | "ManageGuildExpressions" | "UseApplicationCommands" | "RequestToSpeak" | "ManageEvents" | "ManageThreads" | "CreatePublicThreads" | "CreatePrivateThreads" | "UseExternalStickers" | "SendMessagesInThreads" | "UseEmbeddedActivities" | "ModerateMembers" | "ViewCreatorMonetizationAnalytics" | "UseSoundboard" | "CreateGuildExpressions" | "CreateEvents" | "UseExternalSounds" | "SendVoiceMessages" | "SendPolls" | "UseExternalApps", null | boolean>>
- Optional overwriteOptions: GuildChannelOverwriteOptions
Returns Promise<NonThreadGuildBasedChannel>
- Defined in node_modules/discord.js/typings/index.d.ts:4546

delete

delete(userOrRole, reason?): Promise<NonThreadGuildBasedChannel>
Parameters
- userOrRole: string | GuildMember | Role | User | Message<boolean> | ThreadMember<boolean>
- Optional reason: string
Returns Promise<NonThreadGuildBasedChannel>
- Defined in node_modules/discord.js/typings/index.d.ts:4556

edit

edit(userOrRole, options, overwriteOptions?): Promise<NonThreadGuildBasedChannel>
Parameters
- userOrRole: string | GuildMember | Role | User | Message<boolean> | ThreadMember<boolean>
- options: Partial<Record<"CreateInstantInvite" | "KickMembers" | "BanMembers" | "Administrator" | "ManageChannels" | "ManageGuild" | "AddReactions" | "ViewAuditLog" | "PrioritySpeaker" | "Stream" | "ViewChannel" | "SendMessages" | "SendTTSMessages" | "ManageMessages" | "EmbedLinks" | "AttachFiles" | "ReadMessageHistory" | "MentionEveryone" | "UseExternalEmojis" | "ViewGuildInsights" | "Connect" | "Speak" | "MuteMembers" | "DeafenMembers" | "MoveMembers" | "UseVAD" | "ChangeNickname" | "ManageNicknames" | "ManageRoles" | "ManageWebhooks" | "ManageEmojisAndStickers" | "ManageGuildExpressions" | "UseApplicationCommands" | "RequestToSpeak" | "ManageEvents" | "ManageThreads" | "CreatePublicThreads" | "CreatePrivateThreads" | "UseExternalStickers" | "SendMessagesInThreads" | "UseEmbeddedActivities" | "ModerateMembers" | "ViewCreatorMonetizationAnalytics" | "UseSoundboard" | "CreateGuildExpressions" | "CreateEvents" | "UseExternalSounds" | "SendVoiceMessages" | "SendPolls" | "UseExternalApps", null | boolean>>
- Optional overwriteOptions: GuildChannelOverwriteOptions
Returns Promise<NonThreadGuildBasedChannel>
- Defined in node_modules/discord.js/typings/index.d.ts:4551

resolve

resolve(resolvable): PermissionOverwrites
Parameters
- resolvable: PermissionOverwrites
Returns PermissionOverwrites
Inherited from CachedManager.resolve
- Defined in node_modules/discord.js/typings/index.d.ts:4095
resolve(resolvable): null | PermissionOverwrites
Parameters
- resolvable: PermissionOverwriteResolvable
Returns null | PermissionOverwrites
Inherited from CachedManager.resolve
- Defined in node_modules/discord.js/typings/index.d.ts:4096

resolveId

resolveId(resolvable): string
Parameters
- resolvable: string | PermissionOverwrites
Returns string
Inherited from CachedManager.resolveId
- Defined in node_modules/discord.js/typings/index.d.ts:4097
resolveId(resolvable): null | string
Parameters
- resolvable: PermissionOverwriteResolvable
Returns null | string
Inherited from CachedManager.resolveId
- Defined in node_modules/discord.js/typings/index.d.ts:4098

set

set(overwrites, reason?): Promise<NonThreadGuildBasedChannel>
Parameters
- overwrites: readonly OverwriteResolvable[] | ReadonlyCollection<string, OverwriteResolvable>
- Optional reason: string
Returns Promise<NonThreadGuildBasedChannel>
- Defined in node_modules/discord.js/typings/index.d.ts:4536

`Private` upsert

upsert(userOrRole, options, overwriteOptions?, existing?): Promise<NonThreadGuildBasedChannel>
Parameters
- userOrRole: string | GuildMember | Role | User | Message<boolean> | ThreadMember<boolean>
- options: Partial<Record<"CreateInstantInvite" | "KickMembers" | "BanMembers" | "Administrator" | "ManageChannels" | "ManageGuild" | "AddReactions" | "ViewAuditLog" | "PrioritySpeaker" | "Stream" | "ViewChannel" | "SendMessages" | "SendTTSMessages" | "ManageMessages" | "EmbedLinks" | "AttachFiles" | "ReadMessageHistory" | "MentionEveryone" | "UseExternalEmojis" | "ViewGuildInsights" | "Connect" | "Speak" | "MuteMembers" | "DeafenMembers" | "MoveMembers" | "UseVAD" | "ChangeNickname" | "ManageNicknames" | "ManageRoles" | "ManageWebhooks" | "ManageEmojisAndStickers" | "ManageGuildExpressions" | "UseApplicationCommands" | "RequestToSpeak" | "ManageEvents" | "ManageThreads" | "CreatePublicThreads" | "CreatePrivateThreads" | "UseExternalStickers" | "SendMessagesInThreads" | "UseEmbeddedActivities" | "ModerateMembers" | "ViewCreatorMonetizationAnalytics" | "UseSoundboard" | "CreateGuildExpressions" | "CreateEvents" | "UseExternalSounds" | "SendVoiceMessages" | "SendPolls" | "UseExternalApps", null | boolean>>
- Optional overwriteOptions: GuildChannelOverwriteOptions
- Optional existing: PermissionOverwrites
Returns Promise<NonThreadGuildBasedChannel>
- Defined in node_modules/discord.js/typings/index.d.ts:4540

valueOf

valueOf(): Collection<string, PermissionOverwrites>
Returns Collection<string, PermissionOverwrites>
Inherited from CachedManager.valueOf
- Defined in node_modules/discord.js/typings/index.d.ts:4099

Class PermissionOverwriteManager

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Private constructor

Parameters

client: Client<true>

Optional iterable: Iterable<RawPermissionOverwriteData>

Returns PermissionOverwriteManager

Properties

Readonly client

Readonly holds

Accessors

cache

Returns Collection<Key, Holds>

Methods

create

Parameters

userOrRole: string | GuildMember | Role | User | Message<boolean> | ThreadMember<boolean>

Optional overwriteOptions: GuildChannelOverwriteOptions

Returns Promise<NonThreadGuildBasedChannel>

delete

Parameters

userOrRole: string | GuildMember | Role | User | Message<boolean> | ThreadMember<boolean>

Optional reason: string

Returns Promise<NonThreadGuildBasedChannel>

edit

Parameters

userOrRole: string | GuildMember | Role | User | Message<boolean> | ThreadMember<boolean>

Optional overwriteOptions: GuildChannelOverwriteOptions

Returns Promise<NonThreadGuildBasedChannel>

resolve

Parameters

resolvable: PermissionOverwrites

Returns PermissionOverwrites

Parameters

resolvable: PermissionOverwriteResolvable

Returns null | PermissionOverwrites

resolveId

Parameters

resolvable: string | PermissionOverwrites

Returns string

Parameters

resolvable: PermissionOverwriteResolvable

Returns null | string

set

Parameters

overwrites: readonly OverwriteResolvable[] | ReadonlyCollection<string, OverwriteResolvable>

Optional reason: string

Returns Promise<NonThreadGuildBasedChannel>

Private upsert

Parameters

userOrRole: string | GuildMember | Role | User | Message<boolean> | ThreadMember<boolean>

Optional overwriteOptions: GuildChannelOverwriteOptions

Optional existing: PermissionOverwrites

Returns Promise<NonThreadGuildBasedChannel>

valueOf

Returns Collection<string, PermissionOverwrites>

Settings

Member Visibility

Theme

On This Page

`Private` constructor

`Optional` iterable: Iterable<RawPermissionOverwriteData>

`Readonly` client

`Readonly` holds

`Optional` overwriteOptions: GuildChannelOverwriteOptions

`Optional` reason: string

`Optional` overwriteOptions: GuildChannelOverwriteOptions

`Optional` reason: string

`Private` upsert

`Optional` overwriteOptions: GuildChannelOverwriteOptions

`Optional` existing: PermissionOverwrites