Skip to content

PermissionSet

Defined in: packages/structures/src/permissions.ts:151

Immutable permission bitfield with direct boolean getters.

new PermissionSet(value?): PermissionSet

Defined in: packages/structures/src/permissions.ts:156

Creates a permission set.

PermissionResolvable = 0n

Initial permission bitfield or array of permissions.

PermissionSet

If the value is negative.

If the value is not a valid integer.

readonly bitfield: bigint

Defined in: packages/structures/src/permissions.ts:153

Permission bitfield.

get addReactions(): boolean

Defined in: packages/structures/src/permissions.ts:217

boolean


get administrator(): boolean

Defined in: packages/structures/src/permissions.ts:200

boolean


get attachFiles(): boolean

Defined in: packages/structures/src/permissions.ts:266

boolean


get banMembers(): boolean

Defined in: packages/structures/src/permissions.ts:195

boolean


get bypassSlowmode(): boolean

Defined in: packages/structures/src/permissions.ts:465

boolean


get changeNickname(): boolean

Defined in: packages/structures/src/permissions.ts:320

boolean


get connect(): boolean

Defined in: packages/structures/src/permissions.ts:295

boolean


get createEvents(): boolean

Defined in: packages/structures/src/permissions.ts:427

boolean


get createGuildExpressions(): boolean

Defined in: packages/structures/src/permissions.ts:421

boolean


get createInstantInvite(): boolean

Defined in: packages/structures/src/permissions.ts:184

boolean


get createPrivateThreads(): boolean

Defined in: packages/structures/src/permissions.ts:379

boolean


get createPublicThreads(): boolean

Defined in: packages/structures/src/permissions.ts:373

boolean


get deafenMembers(): boolean

Defined in: packages/structures/src/permissions.ts:306

boolean


get embedLinks(): boolean

Defined in: packages/structures/src/permissions.ts:261

boolean


get kickMembers(): boolean

Defined in: packages/structures/src/permissions.ts:190

boolean


get manageChannels(): boolean

Defined in: packages/structures/src/permissions.ts:206

boolean


get manageEvents(): boolean

Defined in: packages/structures/src/permissions.ts:361

boolean


get manageGuild(): boolean

Defined in: packages/structures/src/permissions.ts:212

boolean


get manageGuildExpressions(): boolean

Defined in: packages/structures/src/permissions.ts:343

boolean


get manageMessages(): boolean

Defined in: packages/structures/src/permissions.ts:255

boolean


get manageNicknames(): boolean

Defined in: packages/structures/src/permissions.ts:326

boolean


get manageRoles(): boolean

Defined in: packages/structures/src/permissions.ts:332

boolean


get manageThreads(): boolean

Defined in: packages/structures/src/permissions.ts:367

boolean


get manageWebhooks(): boolean

Defined in: packages/structures/src/permissions.ts:337

boolean


get mentionEveryone(): boolean

Defined in: packages/structures/src/permissions.ts:277

boolean


get moderateMembers(): boolean

Defined in: packages/structures/src/permissions.ts:403

boolean


get moveMembers(): boolean

Defined in: packages/structures/src/permissions.ts:312

boolean


get muteMembers(): boolean

Defined in: packages/structures/src/permissions.ts:301

boolean


get pinMessages(): boolean

Defined in: packages/structures/src/permissions.ts:460

boolean


get prioritySpeaker(): boolean

Defined in: packages/structures/src/permissions.ts:229

boolean


get readMessageHistory(): boolean

Defined in: packages/structures/src/permissions.ts:271

boolean


get requestToSpeak(): boolean

Defined in: packages/structures/src/permissions.ts:355

boolean


get sendMessages(): boolean

Defined in: packages/structures/src/permissions.ts:243

boolean


get sendMessagesInThreads(): boolean

Defined in: packages/structures/src/permissions.ts:391

boolean


get sendPolls(): boolean

Defined in: packages/structures/src/permissions.ts:445

boolean


get sendTTSMessages(): boolean

Defined in: packages/structures/src/permissions.ts:249

boolean


get sendVoiceMessages(): boolean

Defined in: packages/structures/src/permissions.ts:439

boolean


get setVoiceChannelStatus(): boolean

Defined in: packages/structures/src/permissions.ts:454

boolean


get speak(): boolean

Defined in: packages/structures/src/permissions.ts:298

boolean


get stream(): boolean

Defined in: packages/structures/src/permissions.ts:235

boolean


get useApplicationCommands(): boolean

Defined in: packages/structures/src/permissions.ts:349

boolean


get useEmbeddedActivities(): boolean

Defined in: packages/structures/src/permissions.ts:397

boolean


get useExternalApps(): boolean

Defined in: packages/structures/src/permissions.ts:448

boolean


get useExternalEmojis(): boolean

Defined in: packages/structures/src/permissions.ts:283

boolean


get useExternalSounds(): boolean

Defined in: packages/structures/src/permissions.ts:433

boolean


get useExternalStickers(): boolean

Defined in: packages/structures/src/permissions.ts:385

boolean


get useSoundboard(): boolean

Defined in: packages/structures/src/permissions.ts:415

boolean


get useVAD(): boolean

Defined in: packages/structures/src/permissions.ts:317

boolean


get viewAuditLog(): boolean

Defined in: packages/structures/src/permissions.ts:223

boolean


get viewChannel(): boolean

Defined in: packages/structures/src/permissions.ts:238

boolean


get viewCreatorMonetizationAnalytics(): boolean

Defined in: packages/structures/src/permissions.ts:409

boolean


get viewGuildInsights(): boolean

Defined in: packages/structures/src/permissions.ts:289

boolean

add(…permissions): PermissionSet

Defined in: packages/structures/src/permissions.ts:509

Returns a new set with permissions added.

…PermissionResolvable[]

Permission names or raw bits.

PermissionSet

A new permission set.


any(…permissions): boolean

Defined in: packages/structures/src/permissions.ts:488

Checks whether any supplied permission is present (OR).

…PermissionResolvable[]

Permission names or raw bits.

boolean

True when at least one requested permission is present.


equals(other): boolean

Defined in: packages/structures/src/permissions.ts:529

Checks equality with another permission set or raw bitfield.

string | number | bigint | PermissionSet

Permission set or raw bitfield.

boolean

True when both values are equal.


has(…permissions): boolean

Defined in: packages/structures/src/permissions.ts:473

Checks whether all supplied permissions are present (AND).

…PermissionResolvable[]

Permission names or raw bits.

boolean

True when every requested permission is present.


missing(…permissions): PermissionName[]

Defined in: packages/structures/src/permissions.ts:503

Returns the known permission names from permissions that this set lacks.

…PermissionResolvable[]

Permission names or raw bits.

PermissionName[]


remove(…permissions): PermissionSet

Defined in: packages/structures/src/permissions.ts:519

Returns a new set with permissions removed.

…PermissionResolvable[]

Permission names or raw bits.

PermissionSet

A new permission set.


toArray(): PermissionName[]

Defined in: packages/structures/src/permissions.ts:544

Returns known permission names contained in this set.

PermissionName[]

Names of all enabled known permissions.


toString(): string

Defined in: packages/structures/src/permissions.ts:539

Returns the decimal permission representation.

string

Decimal permission bitfield.