PermissionSet
Defined in: packages/structures/src/permissions.ts:151
Immutable permission bitfield with direct boolean getters.
Extended by
Section titled “Extended by”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PermissionSet(
value?):PermissionSet
Defined in: packages/structures/src/permissions.ts:156
Creates a permission set.
Parameters
Section titled “Parameters”value?
Section titled “value?”PermissionResolvable = 0n
Initial permission bitfield or array of permissions.
Returns
Section titled “Returns”PermissionSet
Throws
Section titled “Throws”If the value is negative.
Throws
Section titled “Throws”If the value is not a valid integer.
Properties
Section titled “Properties”bitfield
Section titled “bitfield”
readonlybitfield:bigint
Defined in: packages/structures/src/permissions.ts:153
Permission bitfield.
Accessors
Section titled “Accessors”addReactions
Section titled “addReactions”Get Signature
Section titled “Get Signature”get addReactions():
boolean
Defined in: packages/structures/src/permissions.ts:217
Returns
Section titled “Returns”boolean
administrator
Section titled “administrator”Get Signature
Section titled “Get Signature”get administrator():
boolean
Defined in: packages/structures/src/permissions.ts:200
Returns
Section titled “Returns”boolean
attachFiles
Section titled “attachFiles”Get Signature
Section titled “Get Signature”get attachFiles():
boolean
Defined in: packages/structures/src/permissions.ts:266
Returns
Section titled “Returns”boolean
banMembers
Section titled “banMembers”Get Signature
Section titled “Get Signature”get banMembers():
boolean
Defined in: packages/structures/src/permissions.ts:195
Returns
Section titled “Returns”boolean
bypassSlowmode
Section titled “bypassSlowmode”Get Signature
Section titled “Get Signature”get bypassSlowmode():
boolean
Defined in: packages/structures/src/permissions.ts:465
Returns
Section titled “Returns”boolean
changeNickname
Section titled “changeNickname”Get Signature
Section titled “Get Signature”get changeNickname():
boolean
Defined in: packages/structures/src/permissions.ts:320
Returns
Section titled “Returns”boolean
connect
Section titled “connect”Get Signature
Section titled “Get Signature”get connect():
boolean
Defined in: packages/structures/src/permissions.ts:295
Returns
Section titled “Returns”boolean
createEvents
Section titled “createEvents”Get Signature
Section titled “Get Signature”get createEvents():
boolean
Defined in: packages/structures/src/permissions.ts:427
Returns
Section titled “Returns”boolean
createGuildExpressions
Section titled “createGuildExpressions”Get Signature
Section titled “Get Signature”get createGuildExpressions():
boolean
Defined in: packages/structures/src/permissions.ts:421
Returns
Section titled “Returns”boolean
createInstantInvite
Section titled “createInstantInvite”Get Signature
Section titled “Get Signature”get createInstantInvite():
boolean
Defined in: packages/structures/src/permissions.ts:184
Returns
Section titled “Returns”boolean
createPrivateThreads
Section titled “createPrivateThreads”Get Signature
Section titled “Get Signature”get createPrivateThreads():
boolean
Defined in: packages/structures/src/permissions.ts:379
Returns
Section titled “Returns”boolean
createPublicThreads
Section titled “createPublicThreads”Get Signature
Section titled “Get Signature”get createPublicThreads():
boolean
Defined in: packages/structures/src/permissions.ts:373
Returns
Section titled “Returns”boolean
deafenMembers
Section titled “deafenMembers”Get Signature
Section titled “Get Signature”get deafenMembers():
boolean
Defined in: packages/structures/src/permissions.ts:306
Returns
Section titled “Returns”boolean
embedLinks
Section titled “embedLinks”Get Signature
Section titled “Get Signature”get embedLinks():
boolean
Defined in: packages/structures/src/permissions.ts:261
Returns
Section titled “Returns”boolean
kickMembers
Section titled “kickMembers”Get Signature
Section titled “Get Signature”get kickMembers():
boolean
Defined in: packages/structures/src/permissions.ts:190
Returns
Section titled “Returns”boolean
manageChannels
Section titled “manageChannels”Get Signature
Section titled “Get Signature”get manageChannels():
boolean
Defined in: packages/structures/src/permissions.ts:206
Returns
Section titled “Returns”boolean
manageEvents
Section titled “manageEvents”Get Signature
Section titled “Get Signature”get manageEvents():
boolean
Defined in: packages/structures/src/permissions.ts:361
Returns
Section titled “Returns”boolean
manageGuild
Section titled “manageGuild”Get Signature
Section titled “Get Signature”get manageGuild():
boolean
Defined in: packages/structures/src/permissions.ts:212
Returns
Section titled “Returns”boolean
manageGuildExpressions
Section titled “manageGuildExpressions”Get Signature
Section titled “Get Signature”get manageGuildExpressions():
boolean
Defined in: packages/structures/src/permissions.ts:343
Returns
Section titled “Returns”boolean
manageMessages
Section titled “manageMessages”Get Signature
Section titled “Get Signature”get manageMessages():
boolean
Defined in: packages/structures/src/permissions.ts:255
Returns
Section titled “Returns”boolean
manageNicknames
Section titled “manageNicknames”Get Signature
Section titled “Get Signature”get manageNicknames():
boolean
Defined in: packages/structures/src/permissions.ts:326
Returns
Section titled “Returns”boolean
manageRoles
Section titled “manageRoles”Get Signature
Section titled “Get Signature”get manageRoles():
boolean
Defined in: packages/structures/src/permissions.ts:332
Returns
Section titled “Returns”boolean
manageThreads
Section titled “manageThreads”Get Signature
Section titled “Get Signature”get manageThreads():
boolean
Defined in: packages/structures/src/permissions.ts:367
Returns
Section titled “Returns”boolean
manageWebhooks
Section titled “manageWebhooks”Get Signature
Section titled “Get Signature”get manageWebhooks():
boolean
Defined in: packages/structures/src/permissions.ts:337
Returns
Section titled “Returns”boolean
mentionEveryone
Section titled “mentionEveryone”Get Signature
Section titled “Get Signature”get mentionEveryone():
boolean
Defined in: packages/structures/src/permissions.ts:277
Returns
Section titled “Returns”boolean
moderateMembers
Section titled “moderateMembers”Get Signature
Section titled “Get Signature”get moderateMembers():
boolean
Defined in: packages/structures/src/permissions.ts:403
Returns
Section titled “Returns”boolean
moveMembers
Section titled “moveMembers”Get Signature
Section titled “Get Signature”get moveMembers():
boolean
Defined in: packages/structures/src/permissions.ts:312
Returns
Section titled “Returns”boolean
muteMembers
Section titled “muteMembers”Get Signature
Section titled “Get Signature”get muteMembers():
boolean
Defined in: packages/structures/src/permissions.ts:301
Returns
Section titled “Returns”boolean
pinMessages
Section titled “pinMessages”Get Signature
Section titled “Get Signature”get pinMessages():
boolean
Defined in: packages/structures/src/permissions.ts:460
Returns
Section titled “Returns”boolean
prioritySpeaker
Section titled “prioritySpeaker”Get Signature
Section titled “Get Signature”get prioritySpeaker():
boolean
Defined in: packages/structures/src/permissions.ts:229
Returns
Section titled “Returns”boolean
readMessageHistory
Section titled “readMessageHistory”Get Signature
Section titled “Get Signature”get readMessageHistory():
boolean
Defined in: packages/structures/src/permissions.ts:271
Returns
Section titled “Returns”boolean
requestToSpeak
Section titled “requestToSpeak”Get Signature
Section titled “Get Signature”get requestToSpeak():
boolean
Defined in: packages/structures/src/permissions.ts:355
Returns
Section titled “Returns”boolean
sendMessages
Section titled “sendMessages”Get Signature
Section titled “Get Signature”get sendMessages():
boolean
Defined in: packages/structures/src/permissions.ts:243
Returns
Section titled “Returns”boolean
sendMessagesInThreads
Section titled “sendMessagesInThreads”Get Signature
Section titled “Get Signature”get sendMessagesInThreads():
boolean
Defined in: packages/structures/src/permissions.ts:391
Returns
Section titled “Returns”boolean
sendPolls
Section titled “sendPolls”Get Signature
Section titled “Get Signature”get sendPolls():
boolean
Defined in: packages/structures/src/permissions.ts:445
Returns
Section titled “Returns”boolean
sendTTSMessages
Section titled “sendTTSMessages”Get Signature
Section titled “Get Signature”get sendTTSMessages():
boolean
Defined in: packages/structures/src/permissions.ts:249
Returns
Section titled “Returns”boolean
sendVoiceMessages
Section titled “sendVoiceMessages”Get Signature
Section titled “Get Signature”get sendVoiceMessages():
boolean
Defined in: packages/structures/src/permissions.ts:439
Returns
Section titled “Returns”boolean
setVoiceChannelStatus
Section titled “setVoiceChannelStatus”Get Signature
Section titled “Get Signature”get setVoiceChannelStatus():
boolean
Defined in: packages/structures/src/permissions.ts:454
Returns
Section titled “Returns”boolean
Get Signature
Section titled “Get Signature”get speak():
boolean
Defined in: packages/structures/src/permissions.ts:298
Returns
Section titled “Returns”boolean
stream
Section titled “stream”Get Signature
Section titled “Get Signature”get stream():
boolean
Defined in: packages/structures/src/permissions.ts:235
Returns
Section titled “Returns”boolean
useApplicationCommands
Section titled “useApplicationCommands”Get Signature
Section titled “Get Signature”get useApplicationCommands():
boolean
Defined in: packages/structures/src/permissions.ts:349
Returns
Section titled “Returns”boolean
useEmbeddedActivities
Section titled “useEmbeddedActivities”Get Signature
Section titled “Get Signature”get useEmbeddedActivities():
boolean
Defined in: packages/structures/src/permissions.ts:397
Returns
Section titled “Returns”boolean
useExternalApps
Section titled “useExternalApps”Get Signature
Section titled “Get Signature”get useExternalApps():
boolean
Defined in: packages/structures/src/permissions.ts:448
Returns
Section titled “Returns”boolean
useExternalEmojis
Section titled “useExternalEmojis”Get Signature
Section titled “Get Signature”get useExternalEmojis():
boolean
Defined in: packages/structures/src/permissions.ts:283
Returns
Section titled “Returns”boolean
useExternalSounds
Section titled “useExternalSounds”Get Signature
Section titled “Get Signature”get useExternalSounds():
boolean
Defined in: packages/structures/src/permissions.ts:433
Returns
Section titled “Returns”boolean
useExternalStickers
Section titled “useExternalStickers”Get Signature
Section titled “Get Signature”get useExternalStickers():
boolean
Defined in: packages/structures/src/permissions.ts:385
Returns
Section titled “Returns”boolean
useSoundboard
Section titled “useSoundboard”Get Signature
Section titled “Get Signature”get useSoundboard():
boolean
Defined in: packages/structures/src/permissions.ts:415
Returns
Section titled “Returns”boolean
useVAD
Section titled “useVAD”Get Signature
Section titled “Get Signature”get useVAD():
boolean
Defined in: packages/structures/src/permissions.ts:317
Returns
Section titled “Returns”boolean
viewAuditLog
Section titled “viewAuditLog”Get Signature
Section titled “Get Signature”get viewAuditLog():
boolean
Defined in: packages/structures/src/permissions.ts:223
Returns
Section titled “Returns”boolean
viewChannel
Section titled “viewChannel”Get Signature
Section titled “Get Signature”get viewChannel():
boolean
Defined in: packages/structures/src/permissions.ts:238
Returns
Section titled “Returns”boolean
viewCreatorMonetizationAnalytics
Section titled “viewCreatorMonetizationAnalytics”Get Signature
Section titled “Get Signature”get viewCreatorMonetizationAnalytics():
boolean
Defined in: packages/structures/src/permissions.ts:409
Returns
Section titled “Returns”boolean
viewGuildInsights
Section titled “viewGuildInsights”Get Signature
Section titled “Get Signature”get viewGuildInsights():
boolean
Defined in: packages/structures/src/permissions.ts:289
Returns
Section titled “Returns”boolean
Methods
Section titled “Methods”add(…
permissions):PermissionSet
Defined in: packages/structures/src/permissions.ts:509
Returns a new set with permissions added.
Parameters
Section titled “Parameters”permissions
Section titled “permissions”Permission names or raw bits.
Returns
Section titled “Returns”PermissionSet
A new permission set.
any(…
permissions):boolean
Defined in: packages/structures/src/permissions.ts:488
Checks whether any supplied permission is present (OR).
Parameters
Section titled “Parameters”permissions
Section titled “permissions”Permission names or raw bits.
Returns
Section titled “Returns”boolean
True when at least one requested permission is present.
equals()
Section titled “equals()”equals(
other):boolean
Defined in: packages/structures/src/permissions.ts:529
Checks equality with another permission set or raw bitfield.
Parameters
Section titled “Parameters”string | number | bigint | PermissionSet
Permission set or raw bitfield.
Returns
Section titled “Returns”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).
Parameters
Section titled “Parameters”permissions
Section titled “permissions”Permission names or raw bits.
Returns
Section titled “Returns”boolean
True when every requested permission is present.
missing()
Section titled “missing()”missing(…
permissions):PermissionName[]
Defined in: packages/structures/src/permissions.ts:503
Returns the known permission names from permissions that this set lacks.
Parameters
Section titled “Parameters”permissions
Section titled “permissions”Permission names or raw bits.
Returns
Section titled “Returns”remove()
Section titled “remove()”remove(…
permissions):PermissionSet
Defined in: packages/structures/src/permissions.ts:519
Returns a new set with permissions removed.
Parameters
Section titled “Parameters”permissions
Section titled “permissions”Permission names or raw bits.
Returns
Section titled “Returns”PermissionSet
A new permission set.
toArray()
Section titled “toArray()”toArray():
PermissionName[]
Defined in: packages/structures/src/permissions.ts:544
Returns known permission names contained in this set.
Returns
Section titled “Returns”Names of all enabled known permissions.
toString()
Section titled “toString()”toString():
string
Defined in: packages/structures/src/permissions.ts:539
Returns the decimal permission representation.
Returns
Section titled “Returns”string
Decimal permission bitfield.