Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Permissions

Handles Permission BitFields in Klasa-Core

Hierarchy

Implements

  • BitFieldObject

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

bitfield

bitfield: number

The bitfield data

Static DEFAULT

DEFAULT: number = 104324673

The default permissions granted

Static FLAGS

FLAGS: { [PermissionsFlags.AddReactions]: number; [PermissionsFlags.Administrator]: number; [PermissionsFlags.AttachFiles]: number; [PermissionsFlags.BanMembers]: number; [PermissionsFlags.ChangeNickname]: number; [PermissionsFlags.Connect]: number; [PermissionsFlags.CreateInstantInvite]: number; [PermissionsFlags.DeafenMembers]: number; [PermissionsFlags.EmbedLinks]: number; [PermissionsFlags.KickMembers]: number; [PermissionsFlags.ManageChannels]: number; [PermissionsFlags.ManageEmojis]: number; [PermissionsFlags.ManageGuild]: number; [PermissionsFlags.ManageMessages]: number; [PermissionsFlags.ManageNicknames]: number; [PermissionsFlags.ManageRoles]: number; [PermissionsFlags.ManageWebhooks]: number; [PermissionsFlags.MentionEveryone]: number; [PermissionsFlags.MoveMembers]: number; [PermissionsFlags.MuteMembers]: number; [PermissionsFlags.PrioritySpeaker]: number; [PermissionsFlags.ReadMessageHistory]: number; [PermissionsFlags.SendMessages]: number; [PermissionsFlags.SendTTSMessages]: number; [PermissionsFlags.Speak]: number; [PermissionsFlags.Stream]: number; [PermissionsFlags.UseExternalEmojis]: number; [PermissionsFlags.UseVAD]: number; [PermissionsFlags.ViewAuditLog]: number; [PermissionsFlags.ViewChannel]: number; [PermissionsFlags.ViewGuildInsights]: number } = {[PermissionsFlags.CreateInstantInvite]: 1 << 0,[PermissionsFlags.KickMembers]: 1 << 1,[PermissionsFlags.BanMembers]: 1 << 2,[PermissionsFlags.Administrator]: 1 << 3,[PermissionsFlags.ManageChannels]: 1 << 4,[PermissionsFlags.ManageGuild]: 1 << 5,[PermissionsFlags.AddReactions]: 1 << 6,[PermissionsFlags.ViewAuditLog]: 1 << 7,[PermissionsFlags.PrioritySpeaker]: 1 << 8,[PermissionsFlags.Stream]: 1 << 9,[PermissionsFlags.ViewChannel]: 1 << 10,[PermissionsFlags.SendMessages]: 1 << 11,[PermissionsFlags.SendTTSMessages]: 1 << 12,[PermissionsFlags.ManageMessages]: 1 << 13,[PermissionsFlags.EmbedLinks]: 1 << 14,[PermissionsFlags.AttachFiles]: 1 << 15,[PermissionsFlags.ReadMessageHistory]: 1 << 16,[PermissionsFlags.MentionEveryone]: 1 << 17,[PermissionsFlags.UseExternalEmojis]: 1 << 18,[PermissionsFlags.ViewGuildInsights]: 1 << 19,[PermissionsFlags.Connect]: 1 << 20,[PermissionsFlags.Speak]: 1 << 21,[PermissionsFlags.MuteMembers]: 1 << 22,[PermissionsFlags.DeafenMembers]: 1 << 23,[PermissionsFlags.MoveMembers]: 1 << 24,[PermissionsFlags.UseVAD]: 1 << 25,[PermissionsFlags.ChangeNickname]: 1 << 26,[PermissionsFlags.ManageNicknames]: 1 << 27,[PermissionsFlags.ManageRoles]: 1 << 28,[PermissionsFlags.ManageWebhooks]: 1 << 29,[PermissionsFlags.ManageEmojis]: 1 << 30} as const

The Permissions flags

Type declaration

  • [PermissionsFlags.AddReactions]: number
  • [PermissionsFlags.Administrator]: number
  • [PermissionsFlags.AttachFiles]: number
  • [PermissionsFlags.BanMembers]: number
  • [PermissionsFlags.ChangeNickname]: number
  • [PermissionsFlags.Connect]: number
  • [PermissionsFlags.CreateInstantInvite]: number
  • [PermissionsFlags.DeafenMembers]: number
  • [PermissionsFlags.EmbedLinks]: number
  • [PermissionsFlags.KickMembers]: number
  • [PermissionsFlags.ManageChannels]: number
  • [PermissionsFlags.ManageEmojis]: number
  • [PermissionsFlags.ManageGuild]: number
  • [PermissionsFlags.ManageMessages]: number
  • [PermissionsFlags.ManageNicknames]: number
  • [PermissionsFlags.ManageRoles]: number
  • [PermissionsFlags.ManageWebhooks]: number
  • [PermissionsFlags.MentionEveryone]: number
  • [PermissionsFlags.MoveMembers]: number
  • [PermissionsFlags.MuteMembers]: number
  • [PermissionsFlags.PrioritySpeaker]: number
  • [PermissionsFlags.ReadMessageHistory]: number
  • [PermissionsFlags.SendMessages]: number
  • [PermissionsFlags.SendTTSMessages]: number
  • [PermissionsFlags.Speak]: number
  • [PermissionsFlags.Stream]: number
  • [PermissionsFlags.UseExternalEmojis]: number
  • [PermissionsFlags.UseVAD]: number
  • [PermissionsFlags.ViewAuditLog]: number
  • [PermissionsFlags.ViewChannel]: number
  • [PermissionsFlags.ViewGuildInsights]: number

Static GUILD_SCOPE_PERMISSIONS

GUILD_SCOPE_PERMISSIONS: number = 1275592878

Permissions that cannot be influenced by channel overwrites, even if explicitly set.

Accessors

Static ALL

  • get ALL(): number

  • The value of all bits in this bitfield

    Returns number

Methods

[Symbol.iterator]

  • [Symbol.iterator](): IterableIterator<string>

  • Defines iterable behavior for BitFields

    Returns IterableIterator<string>

add

equals

  • Checks if this BitField matches another bitfield resolvable

    Parameters

    Returns boolean

freeze

  • freeze(): this

  • Freezes this BitField

    Returns this

has

  • Checks if this BitField has a bit or bits

    Parameters

    Returns boolean

mask

missing

  • Returns any bits this BitField is missing

    Parameters

    Returns string[]

remove

serialize

  • serialize(): Record<string, boolean>

  • Returns an object of flags: boolean

    Returns Record<string, boolean>

toArray

  • toArray(): string[]

  • Returns an array of Flags that make up this BitField

    Returns string[]

toJSON

  • toJSON(): number

  • Defines what this Bitfield is when converted to JSON

    Returns number

valueOf

  • valueOf(): number

  • Defines value behavior of this BitField

    Returns number

Static resolve

  • resolve<T>(bit?: T): number

  • Resolves a BitFieldResolvable into a number

    Type parameters

    • T: BitFieldResolvable

    Parameters

    • Optional bit: T

      The bit/s to resolve

    Returns number

Generated using TypeDoc