@discord-types/permission

Types

Permissions

Raw Type

type Permissions = "CreateInstantInvite" | "KickMembers" | "BanMembers" | "Administrator" | "ManageChannels" | "ManageGuild" | "AddReactions" | "ViewAuditLog" | "PrioritySpeaker" | "Stream" | "ViewChannel" | "SendMessages" | "SendTTSMessages" | "ManageMessages" | "EmbedLinks" | "AttachFiles" | "ReadMessageHistory" | "MentionEveryone" | "UseExternalEmojis" | "ViewGuildInsights" | "Connect" | "Speak" | "MuteMembers" | "DeafenMembers" | "MoveMembers" | "UseVad" | "ChangeNickname" | "ManageNicknames" | "ManageRoles" | "ManageWebhooks" | "ManageGuildExpressions" | "UseApplicationCommands" | "RequestToSpeak" | "ManageEvents" | "ManageThreads" | "CreatePublicThreads" | "CreatePrivateThreads" | "UseExternalStickers" | "SendMessagesInThreads" | "UseEmbeddedActivities" | "ModerateMembers" | "ViewCreatorMonetizationAnalytics" | "UseSoundboard" | "CreateGuildExpressions" | "CreateEvents" | "UseExternalSounds" | "SendVoiceMessages" | "SendPolls" | "UseExternalApps"

Union with variants:

Variant 1

"CreateInstantInvite"

Variant 2

"KickMembers"

Variant 3

"BanMembers"

Variant 4

"Administrator"

Variant 5

"ManageChannels"

Variant 6

"ManageGuild"

Variant 7

"AddReactions"

Variant 8

"ViewAuditLog"

Variant 9

"PrioritySpeaker"

Variant 10

"Stream"

Variant 11

"ViewChannel"

Variant 12

"SendMessages"

Variant 13

"SendTTSMessages"

Variant 14

"ManageMessages"

Variant 15

"EmbedLinks"

Variant 16

"AttachFiles"

Variant 17

"ReadMessageHistory"

Variant 18

"MentionEveryone"

Variant 19

"UseExternalEmojis"

Variant 20

"ViewGuildInsights"

Variant 21

"Connect"

Variant 22

"Speak"

Variant 23

"MuteMembers"

Variant 24

"DeafenMembers"

Variant 25

"MoveMembers"

Variant 26

"UseVad"

Variant 27

"ChangeNickname"

Variant 28

"ManageNicknames"

Variant 29

"ManageRoles"

Variant 30

"ManageWebhooks"

Variant 31

"ManageGuildExpressions"

Variant 32

"UseApplicationCommands"

Variant 33

"RequestToSpeak"

Variant 34

"ManageEvents"

Variant 35

"ManageThreads"

Variant 36

"CreatePublicThreads"

Variant 37

"CreatePrivateThreads"

Variant 38

"UseExternalStickers"

Variant 39

"SendMessagesInThreads"

Variant 40

"UseEmbeddedActivities"

Variant 41

"ModerateMembers"

Variant 42

"ViewCreatorMonetizationAnalytics"

Variant 43

"UseSoundboard"

Variant 44

"CreateGuildExpressions"

Variant 45

"CreateEvents"

Variant 46

"UseExternalSounds"

Variant 47

"SendVoiceMessages"

Variant 48

"SendPolls"

Variant 49

"UseExternalApps"

Functions

fromBitflag

Given a bitflag of permissions, returns a table of permission strings

Function Signature

--- Given a bitflag of permissions, returns a table of permission strings
function fromBitflag(bitflag: typesext.U64Convertibles) -> {Permissions} end

Arguments

bitflag

typesext.U64Convertibles

Returns

ret1

{Permissions}

fromBitflagToSet

Given a bitflag of permissions, returns a set of permission strings

Function Signature

--- Given a bitflag of permissions, returns a set of permission strings
function fromBitflagToSet(bitflag: typesext.U64Convertibles) -> set.Set<Permissions> end

Arguments

bitflag

typesext.U64Convertibles

Returns

ret1

set.Set<Permissions>

toBitflag

Converts a table of permission strings to a bitflag

Function Signature

--- Converts a table of permission strings to a bitflag
function toBitflag(permissions: {Permissions}) -> typesext.U64Convertibles end

Arguments

permissions

{Permissions}

Returns

ret1

typesext.U64Convertibles

toBitflagFromSet

Converts a set of permission strings to a bitflag

Function Signature

--- Converts a set of permission strings to a bitflag
function toBitflagFromSet(permissions: set.Set<Permissions>) -> typesext.U64Convertibles end

Arguments

permissions

set.Set<Permissions>

Returns

ret1

typesext.U64Convertibles

addToPerms

Adds the given permissions to the bitflag

Unlike the other methods here, this method is non-destructive and does not modify the original bitflag.

(e.g. if Discord has new permissions we don't know about, those will still be preserved)

Function Signature

--- Adds the given permissions to the bitflag
---
--- Unlike the other methods here, this method is non-destructive and does not modify the original bitflag.
--- (e.g. if Discord has new permissions we don't know about, those will still be preserved)
function addToPerms(bf: typesext.U64Convertibles, permissions: {Permissions}) -> typesext.U64Convertibles end

Arguments

bf

typesext.U64Convertibles

permissions

{Permissions}

Returns

ret1

typesext.U64Convertibles

removeFromPerms

Removes the given permissions from the bitflag

Unlike the other methods here, this method is non-destructive and does not modify the original bitflag.

(e.g. if Discord has new permissions we don't know about, those will still be preserved)

Function Signature

--- Removes the given permissions from the bitflag
---
--- Unlike the other methods here, this method is non-destructive and does not modify the original bitflag.
--- (e.g. if Discord has new permissions we don't know about, those will still be preserved)
function removeFromPerms(bf: typesext.U64Convertibles, permissions: {Permissions}) -> typesext.U64Convertibles end

@discord-types/permission

On this page