Preview environment

class PermissionOverwrites

extends

Base
export class PermissionOverwrites extends Base

Represents a permission overwrite for a role or member in a guild channel.

allow : Readonly<PermissionsBitField>

The permissions that are allowed for the user or role.

readonly
channel : NonThreadGuildBasedChannel

The GuildChannel this overwrite is for

readonly
client : Client<true>

The client that instantiated this

Inherited from: Base

deny : Readonly<PermissionsBitField>

The permissions that are denied for the user or role.

id : Snowflake

The overwrite's id, either a User or a Role id

type : OverwriteType

The type of this overwrite

delete(
reason?: string
) : Promise<PermissionOverwrites>

Deletes this Permission Overwrite.

edit(
options: PermissionOverwriteOptions
reason?: string
) : Promise<PermissionOverwrites>

Edits this Permission Overwrite.

Examples:
// Update permission overwrites
permissionOverwrites.edit({
  SendMessages: false
})
  .then(channel => console.log(channel.permissionOverwrites.get(message.author.id)))
  .catch(console.error);

static
resolve(
overwrite: OverwriteResolvable
guild: Guild
) : APIOverwrite

Resolves an overwrite into APIOverwrite.

static
resolveOverwriteOptions(
options: PermissionOverwriteOptions
initialPermissions: { allow?: PermissionResolvable; deny?: PermissionResolvable }
) : ResolvedOverwriteOptions

Resolves bitfield permissions overwrites from an object.

toJSON() : unknown

valueOf() : string

Inherited from: Base