Class ChannelPermissionsController

Interface for a guild channel's permission overwrites cache. The permission overwrites are mapped by their Permissible's ID

Hierarchy

BaseDeleteController<PermissionOverwrite>
- ChannelPermissionsController

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ChannelPermissionsController(channel: GuildChannel): ChannelPermissionsController

Overrides BaseController.constructor
- Defined in src/controllers/channel/ChannelPermissionsController.ts:15
Parameters
- channel: GuildChannel
Returns ChannelPermissionsController

Properties

cache

cache: ControllerCache<PermissionOverwrite>

The cached data this controller contains

channel

channel: GuildChannel

The guild channel this controller is associated to

Methods

delete

delete(id: Snowflake): Promise<void>

Overrides BaseDeleteController.delete
- Defined in src/controllers/channel/ChannelPermissionsController.ts:43
Deletes a channel permission overwrite for a user or role in a guild channel. Requires the Permission.ManageRoles permission

Parameters
- id: Snowflake
  
  The ID of the user or role you wish to delete from the channel's permission overwrites
Returns Promise<void>

modify

modify(permissible: Permissible, flags: PermissionOverwriteFlags): Promise<PermissionOverwrite>

- Defined in src/controllers/channel/ChannelPermissionsController.ts:30
Modifies the channel permission overwrites for a member or a role. Requires the Permission.ManageRoles permission

Parameters
- permissible: Permissible
  
  Data for the member or role
- flags: PermissionOverwriteFlags
  
  The permissions flags you wish to modify
Returns Promise<PermissionOverwrite>

Generated using TypeDoc