PermissionsBitField
Defined in: packages/structures/src/permissions.ts:590
Permissions bitfield alias.
Extends
Section titled âExtendsâConstructors
Section titled âConstructorsâConstructor
Section titled âConstructorânew PermissionsBitField(
value?):PermissionsBitField
Defined in: packages/structures/src/permissions.ts:597
Creates a permissions bitfield.
Parameters
Section titled âParametersâPermissionResolvable = 0n
Initial permission bitfield or array of permissions.
Returns
Section titled âReturnsâPermissionsBitField
Overrides
Section titled âOverridesâProperties
Section titled âPropertiesâbitfield
Section titled âbitfieldâ
readonlybitfield:bigint
Defined in: packages/structures/src/permissions.ts:153
Permission bitfield.
Inherited from
Section titled âInherited fromâ
readonlystaticAll:object=Permission
Defined in: packages/structures/src/permissions.ts:594
Permission flags constants.
addReactions
Section titled âaddReactionsâ
readonlyaddReactions:bigint
administrator
Section titled âadministratorâ
readonlyadministrator:bigint
attachFiles
Section titled âattachFilesâ
readonlyattachFiles:bigint
banMembers
Section titled âbanMembersâ
readonlybanMembers:bigint
bypassSlowmode
Section titled âbypassSlowmodeâ
readonlybypassSlowmode:bigint
changeNickname
Section titled âchangeNicknameâ
readonlychangeNickname:bigint
connect
Section titled âconnectâ
readonlyconnect:bigint
createEvents
Section titled âcreateEventsâ
readonlycreateEvents:bigint
createGuildExpressions
Section titled âcreateGuildExpressionsâ
readonlycreateGuildExpressions:bigint
createInstantInvite
Section titled âcreateInstantInviteâ
readonlycreateInstantInvite:bigint
createPrivateThreads
Section titled âcreatePrivateThreadsâ
readonlycreatePrivateThreads:bigint
createPublicThreads
Section titled âcreatePublicThreadsâ
readonlycreatePublicThreads:bigint
deafenMembers
Section titled âdeafenMembersâ
readonlydeafenMembers:bigint
embedLinks
Section titled âembedLinksâ
readonlyembedLinks:bigint
kickMembers
Section titled âkickMembersâ
readonlykickMembers:bigint
manageChannels
Section titled âmanageChannelsâ
readonlymanageChannels:bigint
manageEvents
Section titled âmanageEventsâ
readonlymanageEvents:bigint
manageGuild
Section titled âmanageGuildâ
readonlymanageGuild:bigint
manageGuildExpressions
Section titled âmanageGuildExpressionsâ
readonlymanageGuildExpressions:bigint
manageMessages
Section titled âmanageMessagesâ
readonlymanageMessages:bigint
manageNicknames
Section titled âmanageNicknamesâ
readonlymanageNicknames:bigint
manageRoles
Section titled âmanageRolesâ
readonlymanageRoles:bigint
manageThreads
Section titled âmanageThreadsâ
readonlymanageThreads:bigint
manageWebhooks
Section titled âmanageWebhooksâ
readonlymanageWebhooks:bigint
mentionEveryone
Section titled âmentionEveryoneâ
readonlymentionEveryone:bigint
moderateMembers
Section titled âmoderateMembersâ
readonlymoderateMembers:bigint
moveMembers
Section titled âmoveMembersâ
readonlymoveMembers:bigint
muteMembers
Section titled âmuteMembersâ
readonlymuteMembers:bigint
pinMessages
Section titled âpinMessagesâ
readonlypinMessages:bigint
prioritySpeaker
Section titled âprioritySpeakerâ
readonlyprioritySpeaker:bigint
readMessageHistory
Section titled âreadMessageHistoryâ
readonlyreadMessageHistory:bigint
requestToSpeak
Section titled ârequestToSpeakâ
readonlyrequestToSpeak:bigint
sendMessages
Section titled âsendMessagesâ
readonlysendMessages:bigint
sendMessagesInThreads
Section titled âsendMessagesInThreadsâ
readonlysendMessagesInThreads:bigint
sendPolls
Section titled âsendPollsâ
readonlysendPolls:bigint
sendTTSMessages
Section titled âsendTTSMessagesâ
readonlysendTTSMessages:bigint
sendVoiceMessages
Section titled âsendVoiceMessagesâ
readonlysendVoiceMessages:bigint
setVoiceChannelStatus
Section titled âsetVoiceChannelStatusâ
readonlysetVoiceChannelStatus:bigint
readonlyspeak:bigint
readonlystream:bigint
useApplicationCommands
Section titled âuseApplicationCommandsâ
readonlyuseApplicationCommands:bigint
useEmbeddedActivities
Section titled âuseEmbeddedActivitiesâ
readonlyuseEmbeddedActivities:bigint
useExternalApps
Section titled âuseExternalAppsâ
readonlyuseExternalApps:bigint
useExternalEmojis
Section titled âuseExternalEmojisâ
readonlyuseExternalEmojis:bigint
useExternalSounds
Section titled âuseExternalSoundsâ
readonlyuseExternalSounds:bigint
useExternalStickers
Section titled âuseExternalStickersâ
readonlyuseExternalStickers:bigint
useSoundboard
Section titled âuseSoundboardâ
readonlyuseSoundboard:bigint
readonlyuseVAD:bigint
viewAuditLog
Section titled âviewAuditLogâ
readonlyviewAuditLog:bigint
viewChannel
Section titled âviewChannelâ
readonlyviewChannel:bigint
viewCreatorMonetizationAnalytics
Section titled âviewCreatorMonetizationAnalyticsâ
readonlyviewCreatorMonetizationAnalytics:bigint
viewGuildInsights
Section titled âviewGuildInsightsâ
readonlyviewGuildInsights:bigint
readonlystaticFlags:object=PermissionFlagsBits
Defined in: packages/structures/src/permissions.ts:592
Permission flags bits enum.
AddReactions
Section titled âAddReactionsâ
readonlyAddReactions:bigint
Administrator
Section titled âAdministratorâ
readonlyAdministrator:bigint
AttachFiles
Section titled âAttachFilesâ
readonlyAttachFiles:bigint
BanMembers
Section titled âBanMembersâ
readonlyBanMembers:bigint
BypassSlowmode
Section titled âBypassSlowmodeâ
readonlyBypassSlowmode:bigint
ChangeNickname
Section titled âChangeNicknameâ
readonlyChangeNickname:bigint
Connect
Section titled âConnectâ
readonlyConnect:bigint
CreateEvents
Section titled âCreateEventsâ
readonlyCreateEvents:bigint
CreateGuildExpressions
Section titled âCreateGuildExpressionsâ
readonlyCreateGuildExpressions:bigint
CreateInstantInvite
Section titled âCreateInstantInviteâ
readonlyCreateInstantInvite:bigint
CreatePrivateThreads
Section titled âCreatePrivateThreadsâ
readonlyCreatePrivateThreads:bigint
CreatePublicThreads
Section titled âCreatePublicThreadsâ
readonlyCreatePublicThreads:bigint
DeafenMembers
Section titled âDeafenMembersâ
readonlyDeafenMembers:bigint
EmbedLinks
Section titled âEmbedLinksâ
readonlyEmbedLinks:bigint
KickMembers
Section titled âKickMembersâ
readonlyKickMembers:bigint
ManageChannels
Section titled âManageChannelsâ
readonlyManageChannels:bigint
ManageEvents
Section titled âManageEventsâ
readonlyManageEvents:bigint
ManageGuild
Section titled âManageGuildâ
readonlyManageGuild:bigint
ManageGuildExpressions
Section titled âManageGuildExpressionsâ
readonlyManageGuildExpressions:bigint
ManageMessages
Section titled âManageMessagesâ
readonlyManageMessages:bigint
ManageNicknames
Section titled âManageNicknamesâ
readonlyManageNicknames:bigint
ManageRoles
Section titled âManageRolesâ
readonlyManageRoles:bigint
ManageThreads
Section titled âManageThreadsâ
readonlyManageThreads:bigint
ManageWebhooks
Section titled âManageWebhooksâ
readonlyManageWebhooks:bigint
MentionEveryone
Section titled âMentionEveryoneâ
readonlyMentionEveryone:bigint
ModerateMembers
Section titled âModerateMembersâ
readonlyModerateMembers:bigint
MoveMembers
Section titled âMoveMembersâ
readonlyMoveMembers:bigint
MuteMembers
Section titled âMuteMembersâ
readonlyMuteMembers:bigint
PinMessages
Section titled âPinMessagesâ
readonlyPinMessages:bigint
PrioritySpeaker
Section titled âPrioritySpeakerâ
readonlyPrioritySpeaker:bigint
ReadMessageHistory
Section titled âReadMessageHistoryâ
readonlyReadMessageHistory:bigint
RequestToSpeak
Section titled âRequestToSpeakâ
readonlyRequestToSpeak:bigint
SendMessages
Section titled âSendMessagesâ
readonlySendMessages:bigint
SendMessagesInThreads
Section titled âSendMessagesInThreadsâ
readonlySendMessagesInThreads:bigint
SendPolls
Section titled âSendPollsâ
readonlySendPolls:bigint
SendTTSMessages
Section titled âSendTTSMessagesâ
readonlySendTTSMessages:bigint
SendVoiceMessages
Section titled âSendVoiceMessagesâ
readonlySendVoiceMessages:bigint
SetVoiceChannelStatus
Section titled âSetVoiceChannelStatusâ
readonlySetVoiceChannelStatus:bigint
readonlySpeak:bigint
readonlyStream:bigint
UseApplicationCommands
Section titled âUseApplicationCommandsâ
readonlyUseApplicationCommands:bigint
UseEmbeddedActivities
Section titled âUseEmbeddedActivitiesâ
readonlyUseEmbeddedActivities:bigint
UseExternalApps
Section titled âUseExternalAppsâ
readonlyUseExternalApps:bigint
UseExternalEmojis
Section titled âUseExternalEmojisâ
readonlyUseExternalEmojis:bigint
UseExternalSounds
Section titled âUseExternalSoundsâ
readonlyUseExternalSounds:bigint
UseExternalStickers
Section titled âUseExternalStickersâ
readonlyUseExternalStickers:bigint
UseSoundboard
Section titled âUseSoundboardâ
readonlyUseSoundboard:bigint
readonlyUseVAD:bigint
ViewAuditLog
Section titled âViewAuditLogâ
readonlyViewAuditLog:bigint
ViewChannel
Section titled âViewChannelâ
readonlyViewChannel:bigint
ViewCreatorMonetizationAnalytics
Section titled âViewCreatorMonetizationAnalyticsâ
readonlyViewCreatorMonetizationAnalytics:bigint
ViewGuildInsights
Section titled âViewGuildInsightsâ
readonlyViewGuildInsights:bigint
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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâPermissionSet.createGuildExpressions
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
Inherited from
Section titled âInherited fromâPermissionSet.createInstantInvite
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
Inherited from
Section titled âInherited fromâPermissionSet.createPrivateThreads
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
Inherited from
Section titled âInherited fromâPermissionSet.createPublicThreads
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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâPermissionSet.manageGuildExpressions
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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâPermissionSet.readMessageHistory
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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâPermissionSet.sendMessagesInThreads
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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâPermissionSet.sendVoiceMessages
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
Inherited from
Section titled âInherited fromâPermissionSet.setVoiceChannelStatus
Get Signature
Section titled âGet Signatureâget speak():
boolean
Defined in: packages/structures/src/permissions.ts:298
Returns
Section titled âReturnsâboolean
Inherited from
Section titled âInherited fromâGet Signature
Section titled âGet Signatureâget stream():
boolean
Defined in: packages/structures/src/permissions.ts:235
Returns
Section titled âReturnsâboolean
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâPermissionSet.useApplicationCommands
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
Inherited from
Section titled âInherited fromâPermissionSet.useEmbeddedActivities
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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâPermissionSet.useExternalEmojis
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
Inherited from
Section titled âInherited fromâPermissionSet.useExternalSounds
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
Inherited from
Section titled âInherited fromâPermissionSet.useExternalStickers
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
Inherited from
Section titled âInherited fromâGet Signature
Section titled âGet Signatureâget useVAD():
boolean
Defined in: packages/structures/src/permissions.ts:317
Returns
Section titled âReturnsâboolean
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâ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
Inherited from
Section titled âInherited fromâPermissionSet.viewCreatorMonetizationAnalytics
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
Inherited from
Section titled âInherited fromâPermissionSet.viewGuildInsights
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ââŚPermissionResolvable[]
Permission names or raw bits.
Returns
Section titled âReturnsâA new permission set.
Inherited from
Section titled âInherited fromâ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ââŚPermissionResolvable[]
Permission names or raw bits.
Returns
Section titled âReturnsâboolean
True when at least one requested permission is present.
Inherited from
Section titled âInherited fromâ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.
Inherited from
Section titled âInherited fromâ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ââŚPermissionResolvable[]
Permission names or raw bits.
Returns
Section titled âReturnsâboolean
True when every requested permission is present.
Inherited from
Section titled âInherited fromâ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ââŚPermissionResolvable[]
Permission names or raw bits.
Returns
Section titled âReturnsâInherited from
Section titled âInherited fromâ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ââŚPermissionResolvable[]
Permission names or raw bits.
Returns
Section titled âReturnsâA new permission set.
Inherited from
Section titled âInherited fromâ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.
Inherited from
Section titled âInherited fromâ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.