discord.js | PermissionOverwrites

Search...

PermissionOverwrites

export class PermissionOverwrites extends Base

export class PermissionOverwrites extends Base

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

Extends

Base

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 or a Role id

type:OverwriteType

The type of this overwrite

delete(reason?):Promise<PermissionOverwrites>

Deletes this Permission Overwrite.

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

edit(options, reason?):Promise<PermissionOverwrites>

Edits this Permission Overwrite.

Example

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

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

Name	Type	Optional	Description
options	PermissionOverwriteOptions	No	The options for the update
reason	string	Yes	Reason for creating/editing this overwrite

Static

resolve(overwrite, guild):APIOverwrite

Resolves an overwrite into APIOverwrite.

Name	Type	Optional	Description
overwrite	OverwriteResolvable	No	The overwrite-like data to resolve
guild	Guild	No	The guild to resolve from

Static

resolveOverwriteOptions(options, initialPermissions):ResolvedOverwriteOptions

Resolves bitfield permissions overwrites from an object.

Name	Type	Optional	Description
options	PermissionOverwriteOptions	No	The options for the update
initialPermissions	{ allow?: PermissionResolvable; deny?: PermissionResolvable }	No	The initial permissions

toJSON():unknown

valueOf():string