Skip to main content
Version: Next

discord-api-types/payloads/common

Index

Interfaces

Type Aliases

Variables

Type Aliases

LocalizationMap

LocalizationMap: Partial<Record<LocaleString, string | null>>

RESTErrorData

RESTErrorData: RESTErrorFieldInformation | RESTErrorGroupWrapper | string | {}

Variables

constPermissionFlagsBits

PermissionFlagsBits: { AddReactions: bigint; Administrator: bigint; AttachFiles: bigint; BanMembers: bigint; ChangeNickname: bigint; Connect: bigint; CreateEvents: bigint; CreateGuildExpressions: bigint; CreateInstantInvite: bigint; CreatePrivateThreads: bigint; CreatePublicThreads: bigint; DeafenMembers: bigint; EmbedLinks: bigint; KickMembers: bigint; ManageChannels: bigint; ManageEmojisAndStickers: bigint; ManageEvents: bigint; ManageGuild: bigint; ManageGuildExpressions: bigint; ManageMessages: bigint; ManageNicknames: bigint; ManageRoles: bigint; ManageThreads: bigint; ManageWebhooks: bigint; MentionEveryone: bigint; ModerateMembers: bigint; MoveMembers: bigint; MuteMembers: bigint; PrioritySpeaker: bigint; ReadMessageHistory: bigint; RequestToSpeak: bigint; SendMessages: bigint; SendMessagesInThreads: bigint; SendTTSMessages: bigint; SendVoiceMessages: bigint; SetVoiceChannelStatus: bigint; Speak: bigint; Stream: bigint; UseApplicationCommands: bigint; UseEmbeddedActivities: bigint; UseExternalEmojis: bigint; UseExternalSounds: bigint; UseExternalStickers: bigint; UseSoundboard: bigint; UseVAD: bigint; ViewAuditLog: bigint; ViewChannel: bigint; ViewCreatorMonetizationAnalytics: bigint; ViewGuildInsights: bigint } = ...

https://discord.com/developers/docs/topics/permissions#permissions-bitwise-permission-flags

These flags are exported as BigInts and NOT numbers. Wrapping them in Number() may cause issues, try to use BigInts as much as possible or modules that can replicate them in some way

Type declaration

  • AddReactions: bigint

    Allows for the addition of reactions to messages

    Applies to channel types: Text, Voice, Stage

  • Administrator: bigint

    Allows all permissions and bypasses channel permission overwrites

  • AttachFiles: bigint

    Allows for uploading images and files

    Applies to channel types: Text, Voice, Stage

  • BanMembers: bigint

    Allows banning members

  • ChangeNickname: bigint

    Allows for modification of own nickname

  • Connect: bigint

    Allows for joining of a voice channel

    Applies to channel types: Voice, Stage

  • CreateEvents: bigint

    Allows for creating scheduled events, and editing and deleting those created by the current user

    Applies to channel types: Voice, Stage

  • CreateGuildExpressions: bigint

    Allows for creating emojis, stickers, and soundboard sounds, and editing and deleting those created by the current user

  • CreateInstantInvite: bigint

    Allows creation of instant invites

    Applies to channel types: Text, Voice, Stage

  • CreatePrivateThreads: bigint

    Allows for creating private threads

    Applies to channel types: Text

  • CreatePublicThreads: bigint

    Allows for creating public and announcement threads

    Applies to channel types: Text

  • DeafenMembers: bigint

    Allows for deafening of members in a voice channel

    Applies to channel types: Voice

  • EmbedLinks: bigint

    Links sent by users with this permission will be auto-embedded

    Applies to channel types: Text, Voice, Stage

  • KickMembers: bigint

    Allows kicking members

  • ManageChannels: bigint

    Allows management and editing of channels

    Applies to channel types: Text, Voice, Stage

  • ManageEmojisAndStickers: bigint

    Allows management and editing of emojis, stickers, and soundboard sounds

    @deprecated

    This is the old name for PermissionFlagsBits#ManageGuildExpressions

  • ManageEvents: bigint

    Allows for editing and deleting scheduled events created by all users

    Applies to channel types: Voice, Stage

  • ManageGuild: bigint

    Allows management and editing of the guild

  • ManageGuildExpressions: bigint

    Allows for editing and deleting emojis, stickers, and soundboard sounds created by all users

  • ManageMessages: bigint

    Allows for deletion of other users messages

    Applies to channel types: Text, Voice, Stage

  • ManageNicknames: bigint

    Allows for modification of other users nicknames

  • ManageRoles: bigint

    Allows management and editing of roles

    Applies to channel types: Text, Voice, Stage

  • ManageThreads: bigint

    Allows for deleting and archiving threads, and viewing all private threads

    Applies to channel types: Text

  • ManageWebhooks: bigint

    Allows management and editing of webhooks

    Applies to channel types: Text, Voice, Stage

  • MentionEveryone: bigint

    Allows for using the @everyone tag to notify all users in a channel, and the @here tag to notify all online users in a channel

    Applies to channel types: Text, Voice, Stage

  • ModerateMembers: bigint

    Allows for timing out users to prevent them from sending or reacting to messages in chat and threads, and from speaking in voice and stage channels

  • MoveMembers: bigint

    Allows for moving of members between voice channels

    Applies to channel types: Voice, Stage

  • MuteMembers: bigint

    Allows for muting members in a voice channel

    Applies to channel types: Voice, Stage

  • PrioritySpeaker: bigint

    Allows for using priority speaker in a voice channel

    Applies to channel types: Voice

  • ReadMessageHistory: bigint

    Allows for reading of message history

    Applies to channel types: Text, Voice, Stage

  • RequestToSpeak: bigint

    Allows for requesting to speak in stage channels

    Applies to channel types: Stage

  • SendMessages: bigint

    Allows for sending messages in a channel and creating threads in a forum (does not allow sending messages in threads)

    Applies to channel types: Text, Voice, Stage

  • SendMessagesInThreads: bigint

    Allows for sending messages in threads

    Applies to channel types: Text

  • SendTTSMessages: bigint

    Allows for sending of /tts messages

    Applies to channel types: Text, Voice, Stage

  • SendVoiceMessages: bigint

    Allows sending voice messages

    Applies to channel types: Text, Voice, Stage

  • SetVoiceChannelStatus: bigint

    Allows setting voice channel status

    Applies to channel types: Voice

  • Speak: bigint

    Allows for speaking in a voice channel

    Applies to channel types: Voice

  • Stream: bigint

    Allows the user to go live

    Applies to channel types: Voice, Stage

  • UseApplicationCommands: bigint

    Allows members to use application commands, including slash commands and context menu commands

    Applies to channel types: Text, Voice, Stage

  • UseEmbeddedActivities: bigint

    Allows for using Activities (applications with the ApplicationFlags.Embedded flag) in a voice channel

    Applies to channel types: Voice

  • UseExternalEmojis: bigint

    Allows the usage of custom emojis from other servers

    Applies to channel types: Text, Voice, Stage

  • UseExternalSounds: bigint

    Allows the usage of custom soundboard sounds from other servers

    Applies to channel types: Voice

  • UseExternalStickers: bigint

    Allows the usage of custom stickers from other servers

    Applies to channel types: Text, Voice, Stage

  • UseSoundboard: bigint

    Allows for using soundboard in a voice channel

    Applies to channel types: Voice

  • UseVAD: bigint

    Allows for using voice-activity-detection in a voice channel

    Applies to channel types: Voice

  • ViewAuditLog: bigint

    Allows for viewing of audit logs

  • ViewChannel: bigint

    Allows guild members to view a channel, which includes reading messages in text channels and joining voice channels

    Applies to channel types: Text, Voice, Stage

  • ViewCreatorMonetizationAnalytics: bigint

    Allows for viewing role subscription insights

  • ViewGuildInsights: bigint

    Allows for viewing guild insights