Class ChatPermissions

Represents a set of chat permissions and provides methods to manage them.

Index

Constructors

Properties

Methods

allow deny equals has toObject isValid

Constructors

constructor

new ChatPermissions(data?: ChatPermissionFlags): ChatPermissions
Constructs a new instance of ChatPermissions with optional initial data.
Parameters
- Optionaldata: ChatPermissionFlags
  An object containing the initial permissions.
Returns ChatPermissions

Properties

`Static`Flags

Flags: Record<ChatPermissionString, number>

A mapping of chat permission strings to their numeric equivalents.

Methods

allow

allow(permissions: ChatPermissionResolvable): ChatPermissions
Grants the specified permissions.
Parameters
- permissions: ChatPermissionResolvable
  The permissions to grant.
Returns ChatPermissions
The updated ChatPermissions instance.

deny

deny(permissions: ChatPermissionResolvable): ChatPermissions
Denies the specified permissions.
Parameters
- permissions: ChatPermissionResolvable
  The permissions to deny.
Returns ChatPermissions
The updated ChatPermissions instance.

equals

equals(other: ChatPermissions): boolean
Checks if this instance is equal to another ChatPermissions instance.
Parameters
- other: ChatPermissions
  The other instance to compare.
Returns boolean
true if both instances are equal, otherwise false.

has

has(permission: ChatPermissionString): boolean
Checks if the specified permission is granted.
Parameters
- permission: ChatPermissionString
  The permission to check.
Returns boolean
true if the permission is granted, otherwise false.

toObject

toObject(): ChatPermissionFlags
Converts the permissions to a plain object representation.

Returns ChatPermissionFlags
An object with permissions and their status.

`Static`isValid

isValid(permission: string): boolean
Checks if the provided permission is valid.
Parameters
- permission: string
  The permission to validate.
Returns boolean
true if the permission is valid, otherwise false.