Categorygithub.com/bwmarrin/discordgo
modulepackage
0.28.1
Repository: https://github.com/bwmarrin/discordgo.git
Documentation: pkg.go.dev

# README

DiscordGo

Go Reference Go Report Card CI Discord Gophers Discord API

DiscordGo logo

DiscordGo is a Go package that provides low level bindings to the Discord chat client API. DiscordGo has nearly complete support for all of the Discord API endpoints, websocket interface, and voice interface.

If you would like to help the DiscordGo package please use this link to add the official DiscordGo test bot dgo to your server. This provides indispensable help to this project.

  • See dgVoice package for an example of additional voice helper functions and features for DiscordGo.

  • See dca for an experimental stand alone tool that wraps ffmpeg to create opus encoded audio appropriate for use with Discord (and DiscordGo).

For help with this package or general Go discussion, please join the Discord Gophers chat server.

Getting Started

Installing

This assumes you already have a working Go environment, if not please see this page first.

go get will always pull the latest tagged release from the master branch.

go get github.com/bwmarrin/discordgo

Usage

Import the package into your project.

import "github.com/bwmarrin/discordgo"

Construct a new Discord client which can be used to access the variety of Discord API functions and to set callback functions for Discord events.

discord, err := discordgo.New("Bot " + "authentication token")

See Documentation and Examples below for more detailed information.

Documentation

NOTICE: This library and the Discord API are unfinished. Because of that there may be major changes to library in the future.

The DiscordGo code is fairly well documented at this point and is currently the only documentation available. Go reference (below) presents that information in a nice format.

  • Go Reference
  • Hand crafted documentation coming eventually.

Examples

Below is a list of examples and other projects using DiscordGo. Please submit an issue if you would like your project added or removed from this list.

Troubleshooting

For help with common problems please reference the Troubleshooting section of the project wiki.

Contributing

Contributions are very welcomed, however please follow the below guidelines.

  • First open an issue describing the bug or enhancement so it can be discussed.
  • Try to match current naming conventions as closely as possible.
  • This package is intended to be a low level direct mapping of the Discord API, so please avoid adding enhancements outside of that scope without first discussing it.
  • Create a Pull Request with your changes against the master branch.

List of Discord APIs

See this chart for a feature comparison and list of other Discord API libraries.

Special Thanks

Chris Rhodes - For the DiscordGo logo and tons of PRs.

# Packages

# Functions

GuildAllChannelsID is a helper function which returns guild_id-1.
MakeIntent used to help convert a gateway intent value for use in the Identify structure; this was useful to help support the use of a pointer type when intents were optional.
MessageComponentFromJSON is a helper function for unmarshaling message components.
MultipartBodyWithJSON returns the contentType and body for a discord request data : The object to encode for payload_json in the multipart request files : Files to include in the request.
New creates a new Discord session with provided token.
NewMessageEdit returns a MessageEdit struct, initialized with the Channel and ID.
NewRatelimiter returns a new RateLimiter.
NewState creates an empty state.
SnowflakeTimestamp returns the creation time of a Snowflake ID relative to the creation of Discord.
VerifyInteraction implements message verification of the discord interactions api signing algorithm, as documented here: https://discord.com/developers/docs/interactions/receiving-and-responding#security-and-authorization.
WithAuditLogReason changes audit log reason associated with the request.
WithClient changes the HTTP client used for the request.
WithContext changes context of the request.
WithHeader sets a header in the request.
WithLocale changes accepted locale of the request.
WithRestRetries changes maximum amount of retries if request fails.
WithRetryOnRatelimit controls whether session will retry the request on rate limit.

# Constants

MessageComponent types.
Valid ActivityType values.
Valid ActivityType values.
Valid ActivityType values.
Valid ActivityType values.
Valid ActivityType values.
Valid ActivityType values.
The types of mentions used in MessageAllowedMentions.
The types of mentions used in MessageAllowedMentions.
The types of mentions used in MessageAllowedMentions.
Application command option types.
Application command option types.
Application command option types.
Application command option types.
Application command option types.
Application command option types.
Application command option types.
Application command option types.
Application command option types.
Application command option types.
Application command option types.
Application command permission types.
Application command permission types.
Application command permission types.
Application role connection metadata types.
Application role connection metadata types.
Application role connection metadata types.
Application role connection metadata types.
Application role connection metadata types.
Application role connection metadata types.
Application role connection metadata types.
Application role connection metadata types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
AuditLogChangeKeyAfkChannelID is sent when afk channel changed (snowflake) - guild.
AuditLogChangeKeyAfkTimeout is sent when afk timeout duration changed (int) - guild.
AuditLogChangeKeyAllow is sent when a permission on a text or voice channel was allowed for a role (string) - role.
AudirChangeKeyApplicationID is sent when application id of the added or removed webhook or bot (snowflake) - channel.
AuditLogChangeKeyArchived is sent when thread was archived/unarchived (bool) - thread.
AuditLogChangeKeyAsset is sent when asset is changed (string) - sticker.
AuditLogChangeKeyAutoArchiveDuration is sent when auto archive duration changed (int) - thread.
AuditLogChangeKeyAvailable is sent when availability of sticker changed (bool) - sticker.
AuditLogChangeKeyAvatarHash is sent when user avatar changed (string) - user.
AuditLogChangeKeyBannerHash is sent when guild banner changed (string) - guild.
AuditLogChangeKeyBitrate is sent when voice channel bitrate changed (int) - channel.
AuditLogChangeKeyChannelID is sent when channel for invite code or guild scheduled event changed (snowflake) - invite or guild scheduled event.
AuditLogChangeKeyCode is sent when invite code changed (string) - invite.
AuditLogChangeKeyColor is sent when role color changed (int) - role.
AuditLogChangeKeyCommunicationDisabledUntil is sent when member timeout state changed (ISO8601 timestamp) - member.
AuditLogChangeKeyDeaf is sent when user server deafened/undeafened (bool) - member.
AuditLogChangeKeyDefaultAutoArchiveDuration is sent when default auto archive duration for newly created threads changed (int) - channel.
AuditLogChangeKeyDefaultMessageNotification is sent when default message notification level changed (int) - guild.
AuditLogChangeKeyDeny is sent when a permission on a text or voice channel was denied for a role (string) - role.
AuditLogChangeKeyDescription is sent when description changed (string) - guild, sticker, or guild scheduled event.
AuditLogChangeKeyDiscoverySplashHash is sent when discovery splash changed (string) - guild.
AuditLogChangeKeyEnableEmoticons is sent when integration emoticons enabled/disabled (bool) - integration.
AuditLogChangeKeyEntityType is sent when entity type of guild scheduled event was changed (int) - guild scheduled event.
AuditLogChangeKeyExpireBehavior is sent when integration expiring subscriber behavior changed (int) - integration.
AuditLogChangeKeyExpireGracePeriod is sent when integration expire grace period changed (int) - integration.
AuditLogChangeKeyExplicitContentFilter is sent when change in whose messages are scanned and deleted for explicit content in the server is made (int) - guild.
AuditLogChangeKeyFormatType is sent when format type of sticker changed (int - sticker format type) - sticker.
AuditLogChangeKeyGuildID is sent when guild sticker is in changed (snowflake) - sticker.
AuditLogChangeKeyHoist is sent when role is now displayed/no longer displayed separate from online users (bool) - role.
AuditLogChangeKeyIconHash is sent when icon changed (string) - guild or role.
AuditLogChangeKeyID is sent when the id of the changed entity - sometimes used in conjunction with other keys (snowflake) - any.
AuditLogChangeKeyInvitable is sent when private thread is now invitable/uninvitable (bool) - thread.
AuditLogChangeKeyInviterID is sent when person who created invite code changed (snowflake) - invite.
AuditLogChangeKeyLocation is sent when channel id for guild scheduled event changed (string) - guild scheduled event.
AuditLogChangeKeyLocked is sent when thread was locked/unlocked (bool) - thread.
AuditLogChangeKeyMaxAge is sent when invite code expiration time changed (int) - invite.
AuditLogChangeKeyMaxUses is sent when max number of times invite code can be used changed (int) - invite.
AuditLogChangeKeyMentionable is sent when role is now mentionable/unmentionable (bool) - role.
AuditLogChangeKeyMfaLevel is sent when two-factor auth requirement changed (int - mfa level) - guild.
AuditLogChangeKeyMute is sent when user server muted/unmuted (bool) - member.
AuditLogChangeKeyName is sent when name changed (string) - any.
AuditLogChangeKeyNick is sent when user nickname changed (string) - member.
AuditLogChangeKeyNSFW is sent when channel nsfw restriction changed (bool) - channel.
AuditLogChangeKeyOwnerID is sent when owner changed (snowflake) - guild.
AuditLogChangeKeyPermissionOverwrite is sent when permissions on a channel changed (array of channel overwrite objects) - channel.
AuditLogChangeKeyPermissions is sent when permissions for a role changed (string) - role.
AuditLogChangeKeyPosition is sent when text or voice channel position changed (int) - channel.
AuditLogChangeKeyPreferredLocale is sent when preferred locale changed (string) - guild.
AuditLogChangeKeyPrivacylevel is sent when privacy level of the stage instance changed (integer - privacy level) - stage instance or guild scheduled event.
AuditLogChangeKeyPruneDeleteDays is sent when number of days after which inactive and role-unassigned members are kicked changed (int) - guild.
AuditLogChangeKeyPulibUpdatesChannelID is sent when id of the public updates channel changed (snowflake) - guild.
AuditLogChangeKeyRateLimitPerUser is sent when amount of seconds a user has to wait before sending another message changed (int) - channel.
AuditLogChangeKeyRegion is sent when region changed (string) - guild.
AuditLogChangeKeyRoleAdd is sent when new role added (array of partial role objects) - guild.
AuditLogChangeKeyRoleRemove is sent when role removed (array of partial role objects) - guild.
AuditLogChangeKeyRulesChannelID is sent when id of the rules channel changed (snowflake) - guild.
AuditLogChangeKeySplashHash is sent when invite splash page artwork changed (string) - guild.
AuditLogChangeKeyStatus is sent when status of guild scheduled event was changed (int - guild scheduled event status) - guild scheduled event.
AuditLogChangeKeySystemChannelID is sent when id of the system channel changed (snowflake) - guild.
AuditLogChangeKeyTags is sent when related emoji of sticker changed (string) - sticker.
TODO: remove when compatibility is not required.
AuditLogChangeKeyTemporary is sent when invite code is now temporary or never expires (bool) - invite.
AuditLogChangeKeyTopic is sent when text channel topic or stage instance topic changed (string) - channel or stage instance.
AuditLogChangeKeyType is sent when type of entity created (int or string) - any.
AuditLogChangeKeyUnicodeEmoji is sent when role unicode emoji changed (string) - role.
AuditLogChangeKeyUserLimit is sent when new user limit in a voice channel set (int) - voice channel.
AuditLogChangeKeyUses is sent when number of times invite code used changed (int) - invite.
AuditLogChangeKeyVanityURLCode is sent when guild invite vanity url changed (string) - guild.
AuditLogChangeKeyVerificationLevel is sent when required verification level changed (int - verification level) - guild.
AuditLogChangeKeyWidgetChannelID is sent when channel id of the server widget changed (snowflake) - guild.
AuditLogChangeKeyWidgetEnabled is sent when server widget enabled/disabled (bool) - guild.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Block contains Discord Audit Log Action Types.
Valid Types for AuditLogOptionsType.
Valid Types for AuditLogOptionsType.
AutoModerationEventMessageSend is checked when a member sends or edits a message in the guild.
Auto moderation rule trigger types.
Auto moderation rule trigger types.
Auto moderation rule trigger types.
Auto moderation rule trigger types.
Auto moderation keyword presets.
Auto moderation keyword presets.
Auto moderation keyword presets.
Auto moderation actions types.
Auto moderation actions types.
Auto moderation actions types.
All defined locales in Discord.
MessageComponent types.
ChannelFlagPinned indicates whether the thread is pinned in the forum channel.
ChannelFlagRequireTag indicates whether a tag is required to be specified when creating a thread.
SelectMenu types.
MessageComponent types.
Block contains known ChannelType values.
Block contains known ChannelType values.
Block contains known ChannelType values.
Block contains known ChannelType values.
Block contains known ChannelType values.
Block contains known ChannelType values.
Block contains known ChannelType values.
Block contains known ChannelType values.
Block contains known ChannelType values.
Block contains known ChannelType values.
Block contains known ChannelType values.
Block contains known ChannelType values.
Block contains known ChannelType values.
Block contains known ChannelType values.
ChatApplicationCommand is default command type.
All defined locales in Discord.
All defined locales in Discord.
All defined locales in Discord.
All defined locales in Discord.
DangerButton is a button with red color.
All defined locales in Discord.
All defined locales in Discord.
Block of valid EmbedTypes.
Block of valid EmbedTypes.
Block of valid EmbedTypes.
Block of valid EmbedTypes.
Block of valid EmbedTypes.
Block of valid EmbedTypes.
All defined locales in Discord.
All defined locales in Discord.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block contains Discord JSON Error Response codes.
Block of valid ExpireBehaviors.
Block of valid ExpireBehaviors.
Constants for ExplicitContentFilterLevel levels from 0 to 2 inclusive.
Constants for ExplicitContentFilterLevel levels from 0 to 2 inclusive.
Constants for ExplicitContentFilterLevel levels from 0 to 2 inclusive.
FailedHeartbeatAcks is the Number of heartbeat intervals to wait until forcing a connection restart.
All defined locales in Discord.
ForumLayoutGalleryView displays forum posts as a collection of tiles.
ForumLayoutListView displays forum posts as a list.
ForumLayoutNotSet represents no default layout.
ForumSortOrderCreationDate sorts posts by creation time (from most recent to oldest).
ForumSortOrderLatestActivity sorts posts by activity.
All defined locales in Discord.
All defined locales in Discord.
All defined locales in Discord.
Constants for GuildFeature.
Constants for GuildFeature.
Constants for GuildFeature.
Constants for GuildFeature.
Constants for GuildFeature.
Constants for GuildFeature.
Constants for GuildFeature.
Constants for GuildFeature.
Constants for GuildFeature.
Constants for GuildFeature.
Constants for GuildFeature.
Constants for GuildFeature.
Constants for GuildFeature.
Constants for GuildFeature.
Constants for GuildFeature.
Constants for GuildFeature.
Constants for GuildFeature.
Constants for GuildFeature.
Constants for GuildFeature.
Constants for GuildFeature.
Constants for GuildFeature.
Constants for GuildNSFWLevel levels from 0 to 3 inclusive.
Constants for GuildNSFWLevel levels from 0 to 3 inclusive.
Constants for GuildNSFWLevel levels from 0 to 3 inclusive.
Constants for GuildNSFWLevel levels from 0 to 3 inclusive.
GuildOnboardingModeAdvanced counts default channels and questions towards constraints.
GuildOnboardingModeDefault counts default channels towards constraints.
Block containing known GuildOnboardingPromptType values.
Block containing known GuildOnboardingPromptType values.
GuildScheduledEventEntityTypeExternal represents an external event.
GuildScheduledEventEntityTypeStageInstance represents a stage channel.
GuildScheduledEventEntityTypeVoice represents a voice channel.
GuildScheduledEventPrivacyLevelGuildOnly makes the scheduled event is only accessible to guild members.
GuildScheduledEventStatusActive represents the current event is in active state.
GuildScheduledEventStatusCanceled represents the current event is in canceled state.
GuildScheduledEventStatusCompleted represents the current event is in completed state.
GuildScheduledEventStatusScheduled represents the current event is in scheduled state.
All defined locales in Discord.
All defined locales in Discord.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Constants for the different bit offsets of intents.
Interaction types.
Interaction types.
InteractionApplicationCommandAutocompleteResult shows autocompletion results.
InteractionDeadline is the time allowed to respond to an interaction.
Interaction types.
Interaction types.
Interaction types.
InteractionResponseChannelMessageWithSource is for responding with a message, showing the user's input.
InteractionResponseDeferredChannelMessageWithSource acknowledges that the event was received, and that a follow-up will come later.
InteractionResponseDeferredMessageUpdate acknowledges that the message component interaction event was received, and message will be updated later.
InteractionResponseModal is for responding to an interaction with a modal window.
InteractionResponsePong is for ACK ping event.
InteractionResponseUpdateMessage is for updating the message to which message component was attached.
Invite target types.
Invite target types.
All defined locales in Discord.
All defined locales in Discord.
All defined locales in Discord.
LinkButton is a special type of button which navigates to a URL.
All defined locales in Discord.
LogDebug level is for very detailed non-error activity.
LogError level is used for critical errors that could lead to data loss or panic that would not be returned to a calling function.
LogInformational level is used for normal non-error activity.
LogWarning level is used for very abnormal events and errors that are also returned to a calling function.
MemberFlagBypassesVerification indicates whether the Member is exempt from guild verification requirements.
MemberFlagCompletedOnboarding indicates whether the Member has completed onboarding.
MemberFlagDidRejoin indicates whether the Member has left and rejoined the guild.
MemberFlagStartedOnboarding indicates whether the Member has started onboarding.
Constants for the different stages of the MembershipState.
Constants for the different stages of the MembershipState.
SelectMenu types.
MessageComponent types.
Constants for the different types of Message Activity.
Constants for the different types of Message Activity.
Constants for the different types of Message Activity.
Constants for the different types of Message Activity.
MessageApplicationCommand adds command to message context menu.
MessageFlagsCrossPosted This message has been published to subscribed channels (via Channel Following).
MessageFlagsEphemeral this message is only visible to the user who invoked the Interaction.
MessageFlagsFailedToMentionSomeRolesInThread this message failed to mention some roles and add their members to the thread.
MessageFlagsHasThread this message has an associated thread, with the same id as the message.
MessageFlagsIsCrossPosted this message originated from a message in another channel (via Channel Following).
MessageFlagsIsVoiceMessage this message is a voice message.
MessageFlagsLoading this message is an Interaction Response and the bot is "thinking".
MessageFlagsSourceMessageDeleted the source message for this crosspost has been deleted (via Channel Following).
MessageFlagsSuppressEmbeds do not include any embeds when serializing this message.
MessageFlagsSuppressNotifications this message will not trigger push and desktop notifications.
TODO: deprecated, remove when compatibility is not needed.
MessageFlagsUrgent this message came from the urgent message system.
Block containing known MessageNotifications values.
Block containing known MessageNotifications values.
Block contains the valid known MessageType values.
Block contains the valid known MessageType values.
Block contains the valid known MessageType values.
Block contains the valid known MessageType values.
Block contains the valid known MessageType values.
Block contains the valid known MessageType values.
Block contains the valid known MessageType values.
Block contains the valid known MessageType values.
Block contains the valid known MessageType values.
Block contains the valid known MessageType values.
Block contains the valid known MessageType values.
Block contains the valid known MessageType values.
Block contains the valid known MessageType values.
Block contains the valid known MessageType values.
Block contains the valid known MessageType values.
Block contains the valid known MessageType values.
Block contains the valid known MessageType values.
Block contains the valid known MessageType values.
Block contains the valid known MessageType values.
Block contains the valid known MessageType values.
Constants for MfaLevel levels from 0 to 1 inclusive.
Constants for MfaLevel levels from 0 to 1 inclusive.
All defined locales in Discord.
Constants for the different bit offsets of general permissions.
Constants for the different bit offsets of general permissions.
Constants for the different bit offsets of general permissions.
Constants for the different bit offsets of general permissions.
Constants for the different bit offsets of general permissions.
Constants for the different bit offsets of general permissions.
Constants for the different bit offsets of text channel permissions.
Constants for the different bit offsets of general permissions.
Constants for general management.
Constants for the different bit offsets of general permissions.
Constants for the different bit offsets of text channel permissions.
Constants for the different bit offsets of text channel permissions.
Constants for the different bit offsets of text channel permissions.
Constants for the different bit offsets of general permissions.
Constants for the different bit offsets of general permissions.
Constants for general management.
Constants for general management.
Constants for the different bit offsets of text channel permissions.
Constants for general management.
Constants for general management.
Constants for the different bit offsets of general permissions.
Constants for the different bit offsets of text channel permissions.
Constants for general management.
Constants for the different bit offsets of text channel permissions.
Constants for the different bit offsets of general permissions.
The possible permission overwrite types.
The possible permission overwrite types.
Constants for the different bit offsets of text channel permissions.
Deprecated: PermissionReadMessages has been replaced with PermissionViewChannel for text and voice channels.
Constants for the different bit offsets of text channel permissions.
Constants for the different bit offsets of text channel permissions.
Constants for the different bit offsets of text channel permissions.
Constants for the different bit offsets of voice permissions.
Constants for the different bit offsets of text channel permissions.
Constants for the different bit offsets of text channel permissions.
Constants for the different bit offsets of text channel permissions.
Constants for the different bit offsets of general permissions.
Constants for the different bit offsets of general permissions.
Constants for the different bit offsets of general permissions.
Constants for the different bit offsets of voice permissions.
Constants for the different bit offsets of voice permissions.
Constants for the different bit offsets of voice permissions.
Constants for the different bit offsets of voice permissions.
Constants for the different bit offsets of voice permissions.
Constants for the different bit offsets of voice permissions.
Constants for the different bit offsets of voice permissions.
Constants for the different bit offsets of voice permissions.
Constants for the different bit offsets of voice permissions.
All defined locales in Discord.
All defined locales in Discord.
Constants for PremiumTier levels from 0 to 3 inclusive.
Constants for PremiumTier levels from 0 to 3 inclusive.
Constants for PremiumTier levels from 0 to 3 inclusive.
Constants for PremiumTier levels from 0 to 3 inclusive.
PrimaryButton is a button with blurple color.
RoleFlagInPrompt indicates whether the Role is selectable by members in an onboarding prompt.
SelectMenu types.
MessageComponent types.
All defined locales in Discord.
All defined locales in Discord.
SecondaryButton is a button with grey color.
MessageComponent types.
SelectMenuDefaultValue types.
SelectMenuDefaultValue types.
SelectMenuDefaultValue types.
All defined locales in Discord.
All defined locales in Discord.
StageInstancePrivacyLevelGuildOnly The Stage instance is visible to only guild members.
StageInstancePrivacyLevelPublic The Stage instance is visible publicly.
Constants for Status with the different current available status.
Constants for Status with the different current available status.
Constants for Status with the different current available status.
Constants for Status with the different current available status.
Constants for Status with the different current available status.
Defines all known Sticker types.
Defines all known Sticker types.
Defines all known Sticker types.
Defines all known Sticker types.
Defines Sticker types.
Defines Sticker types.
SelectMenu types.
SuccessButton is a button with green color.
All defined locales in Discord.
Block containing known SystemChannelFlag values.
Block containing known SystemChannelFlag values.
Block containing known SystemChannelFlag values.
Block containing known SystemChannelFlag values.
MessageComponent types.
Text styles.
Text styles.
All defined locales in Discord.
All defined locales in Discord.
All defined locales in Discord.
All defined locales in Discord.
UserApplicationCommand adds command to user context menu.
Valid UserFlags values.
Valid UserFlags values.
Valid UserFlags values.
Valid UserFlags values.
Valid UserFlags values.
Valid UserFlags values.
Valid UserFlags values.
Valid UserFlags values.
Valid UserFlags values.
Valid UserFlags values.
Valid UserFlags values.
Valid UserFlags values.
Valid UserFlags values.
Valid UserFlags values.
Valid UserFlags values.
Valid UserFlags values.
Valid UserPremiumType values.
Valid UserPremiumType values.
Valid UserPremiumType values.
Valid UserPremiumType values.
SelectMenu types.
MessageComponent types.
Constants for VerificationLevel levels from 0 to 4 inclusive.
Constants for VerificationLevel levels from 0 to 4 inclusive.
Constants for VerificationLevel levels from 0 to 4 inclusive.
Constants for VerificationLevel levels from 0 to 4 inclusive.
Constants for VerificationLevel levels from 0 to 4 inclusive.
VERSION of DiscordGo, follows Semantic Versioning.
All defined locales in Discord.
Valid WebhookType values.
Valid WebhookType values.

# Variables

APIVersion is the Discord API version used for the REST and Websocket API.
EmojiRegex is the regex used to find and identify emojis in messages.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
TODO: Deprecated, remove in the next release.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
Known Discord API Endpoints.
All error constants.
All error constants.
All error constants.
ErrMessageIncompletePermissions is returned when the message requested for permissions does not contain enough data to generate the permissions.
ErrNilState is returned when the state is nil.
All error constants.
ErrStateNotFound is returned when the state cache requested is not found.
All error constants.
All error constants.
All error constants.
ErrWSAlreadyOpen is thrown when you attempt to open a websocket that already is open.
ErrWSNotFound is thrown when you attempt to use a websocket that doesn't exist.
ErrWSShardBounds is thrown when you try to use a shard ID that is more than the total shard count.
Locales is a map of all the languages codes to their names.
Logger can be used to replace the standard logging for discordgo.
Marshal defines function used to encode JSON payloads.
Unmarshal defines function used to decode JSON payloads.

# Structs

ActionsRow is a container for components within one row.
Activity defines the Activity sent with GatewayStatusUpdate https://discord.com/developers/docs/topics/gateway#activity-object.
AddedThreadMember holds information about the user who was added to the thread.
An APIErrorMessage is an api error message returned from discord.
Application stores values for a Discord Application.
ApplicationCommand represents an application's slash command.
ApplicationCommandInteractionData contains the data of application command interaction.
ApplicationCommandInteractionDataOption represents an option of a slash command.
ApplicationCommandInteractionDataResolved contains resolved data of command execution.
ApplicationCommandOption represents an option/subcommand/subcommands group.
ApplicationCommandOptionChoice represents a slash command option choice.
ApplicationCommandPermissions represents a single user or role permission for a command.
ApplicationCommandPermissionsList represents a list of ApplicationCommandPermissions, needed for serializing to JSON.
ApplicationCommandPermissionsUpdate is the data for an ApplicationCommandPermissionsUpdate event.
ApplicationRoleConnection represents the role connection that an application has attached to a user.
ApplicationRoleConnectionMetadata stores application role connection metadata.
Asset struct stores values for an asset of an application.
An Assets struct contains assets and labels used in the rich presence "playing .." Game.
AuditLogChange for an AuditLogEntry.
AuditLogEntry for a GuildAuditLog https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-audit-log-entry-structure.
AuditLogOptions optional data for the AuditLog https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-optional-audit-entry-info.
AutoModerationAction stores data for an auto moderation action.
AutoModerationActionExecution is the data for an AutoModerationActionExecution event.
AutoModerationActionMetadata represents additional metadata needed during execution for a specific action type.
AutoModerationRule stores data for an auto moderation rule.
AutoModerationRuleCreate is the data for an AutoModerationRuleCreate event.
AutoModerationRuleDelete is the data for an AutoModerationRuleDelete event.
AutoModerationRuleUpdate is the data for an AutoModerationRuleUpdate event.
AutoModerationTriggerMetadata represents additional metadata used to determine whether rule should be triggered.
Bucket represents a ratelimit bucket, each bucket gets ratelimited individually (-global ratelimits).
Button represents button component.
A Channel holds all data related to an individual Discord channel.
ChannelCreate is the data for a ChannelCreate event.
ChannelDelete is the data for a ChannelDelete event.
A ChannelEdit holds Channel Field data for a channel edit.
A ChannelFollow holds data returned after following a news channel.
ChannelPinsUpdate stores data for a ChannelPinsUpdate event.
ChannelUpdate is the data for a ChannelUpdate event.
ClientStatus stores the online, offline, idle, or dnd status of each device of a Guild member.
ComponentEmoji represents button emoji, if it does have one.
Connect is the data for a Connect event.
Disconnect is the data for a Disconnect event.
Emoji struct holds data related to Emoji's.
EmojiParams represents parameters needed to create or update an Emoji.
Event provides a basic initial struct for all websocket events.
File stores info about files you e.g.
ForumDefaultReaction specifies emoji to use as the default reaction to a forum post.
ForumTag represents a tag that is able to be applied to a thread in a forum channel.
GatewayBotResponse stores the data for the gateway/bot response.
GatewayStatusUpdate is sent by the client to indicate a presence or status update https://discord.com/developers/docs/topics/gateway#update-status-gateway-status-update-structure.
A Guild holds all data related to a specific Discord Guild.
GuildApplicationCommandPermissions represents all permissions for a single guild command.
A GuildAuditLog stores data for a guild audit log.
GuildAuditLogEntryCreate is the data for a GuildAuditLogEntryCreate event.
A GuildBan stores data for a guild ban.
GuildBanAdd is the data for a GuildBanAdd event.
GuildBanRemove is the data for a GuildBanRemove event.
GuildChannelCreateData is provided to GuildChannelCreateComplex.
GuildCreate is the data for a GuildCreate event.
GuildDelete is the data for a GuildDelete event.
A GuildEmbed stores data for a guild embed.
A GuildEmojisUpdate is the data for a guild emoji update event.
GuildIntegrationsUpdate is the data for a GuildIntegrationsUpdate event.
GuildMemberAdd is the data for a GuildMemberAdd event.
GuildMemberAddParams stores data needed to add a user to a guild.
GuildMemberParams stores data needed to update a member https://discord.com/developers/docs/resources/guild#modify-guild-member.
GuildMemberRemove is the data for a GuildMemberRemove event.
A GuildMembersChunk is the data for a GuildMembersChunk event.
GuildMemberUpdate is the data for a GuildMemberUpdate event.
GuildOnboarding represents the onboarding flow for a guild.
GuildOnboardingPrompt is a prompt shown during onboarding and in the customize community (Channels & Roles) tab.
GuildOnboardingPromptOption is an option available within an onboarding prompt.
A GuildParams stores all the data needed to update discord guild settings.
A GuildPreview holds data related to a specific public Discord Guild, even if the user is not in the guild.
A GuildRole stores data for guild roles.
GuildRoleCreate is the data for a GuildRoleCreate event.
A GuildRoleDelete is the data for a GuildRoleDelete event.
GuildRoleUpdate is the data for a GuildRoleUpdate event.
GuildScheduledEvent is a representation of a scheduled event in a guild.
GuildScheduledEventCreate is the data for a GuildScheduledEventCreate event.
GuildScheduledEventDelete is the data for a GuildScheduledEventDelete event.
GuildScheduledEventEntityMetadata holds additional metadata for guild scheduled event.
GuildScheduledEventParams are the parameters allowed for creating or updating a scheduled event https://discord.com/developers/docs/resources/guild-scheduled-event#create-guild-scheduled-event.
GuildScheduledEventUpdate is the data for a GuildScheduledEventUpdate event.
GuildScheduledEventUser is a user subscribed to a scheduled event.
GuildScheduledEventUserAdd is the data for a GuildScheduledEventUserAdd event.
GuildScheduledEventUserRemove is the data for a GuildScheduledEventUserRemove event.
A GuildTemplate represents a replicable template for guild creation.
GuildTemplateParams stores the data needed to create or update a GuildTemplate.
GuildUpdate is the data for a GuildUpdate event.
Identify is sent during initial handshake with the discord gateway.
IdentifyProperties contains the "properties" portion of an Identify packet https://discord.com/developers/docs/topics/gateway#identify-identify-connection-properties.
Integration stores integration information.
IntegrationAccount is integration account information sent by the UserConnections endpoint.
Interaction represents data of an interaction.
InteractionCreate is the data for a InteractionCreate event.
InteractionResponse represents a response for an interaction event.
InteractionResponseData is response data for an interaction.
A Invite stores all data related to a specific Discord Guild or Channel invite.
InviteCreate is the data for a InviteCreate event.
InviteDelete is the data for a InviteDelete event.
A Member stores user information for Guild members.
A Message stores all data related to a specific Discord message.
MessageActivity is sent with Rich Presence-related chat embeds.
MessageAllowedMentions allows the user to specify which mentions Discord is allowed to parse in this message.
MessageApplication is sent with Rich Presence-related chat embeds.
A MessageAttachment stores data for message attachments.
MessageComponentInteractionData contains the data of message component interaction.
MessageComponentInteractionDataResolved contains the resolved data of selected option.
MessageCreate is the data for a MessageCreate event.
MessageDelete is the data for a MessageDelete event.
MessageDeleteBulk is the data for a MessageDeleteBulk event.
MessageEdit is used to chain parameters via ChannelMessageEditComplex, which is also where you should get the instance from.
An MessageEmbed stores data for message embeds.
MessageEmbedAuthor is a part of a MessageEmbed struct.
MessageEmbedField is a part of a MessageEmbed struct.
MessageEmbedFooter is a part of a MessageEmbed struct.
MessageEmbedImage is a part of a MessageEmbed struct.
MessageEmbedProvider is a part of a MessageEmbed struct.
MessageEmbedThumbnail is a part of a MessageEmbed struct.
MessageEmbedVideo is a part of a MessageEmbed struct.
MessageInteraction contains information about the application command interaction which generated the message.
MessageReaction stores the data for a message reaction.
MessageReactionAdd is the data for a MessageReactionAdd event.
MessageReactionRemove is the data for a MessageReactionRemove event.
MessageReactionRemoveAll is the data for a MessageReactionRemoveAll event.
MessageReactions holds a reactions object for a message.
MessageReference contains reference data sent with crossposted messages.
MessageSend stores all parameters you can send with ChannelMessageSendComplex.
MessageUpdate is the data for a MessageUpdate event.
ModalSubmitInteractionData contains the data of modal submit interaction.
A Packet contains the headers and content of a received voice packet.
Party defines the Party field in the Activity struct https://discord.com/developers/docs/topics/gateway#activity-object.
A PermissionOverwrite holds permission overwrite data for a Channel.
A Presence stores the online, offline, or idle and game status of Guild members.
PresenceUpdate is the data for a PresenceUpdate event.
RateLimit is the data for a RateLimit event.
RateLimiter holds all ratelimit buckets.
RateLimitError is returned when a request exceeds a rate limit and ShouldRetryOnRateLimit is false.
A ReadState stores data on the read state of channels.
A Ready stores all data for the websocket READY event.
RequestConfig is an HTTP request configuration.
RESTError stores error information about a request with a bad response code.
Resumed is the data for a Resumed event.
A Role stores information about Discord guild member roles.
RoleParams represents the parameters needed to create or update a Role.
Secrets defines the Secrets field for the Activity struct https://discord.com/developers/docs/topics/gateway#activity-object.
SelectMenu represents select menu component.
SelectMenuDefaultValue represents an entity selected by default in auto-populated select menus.
SelectMenuOption represents an option for a select menu.
A Session represents a connection to the Discord API.
SessionInformation provides the information for max concurrency sharding.
StageInstance holds information about a live stage.
StageInstanceEventCreate is the data for a StageInstanceEventCreate event.
StageInstanceEventDelete is the data for a StageInstanceEventDelete event.
StageInstanceEventUpdate is the data for a StageInstanceEventUpdate event.
StageInstanceParams represents the parameters needed to create or edit a stage instance.
A State contains the current known state.
Sticker represents a sticker object that can be sent in a Message.
StickerItem represents the smallest amount of data required to render a sticker.
StickerPack represents a pack of standard stickers.
A Team struct stores the members of a Discord Developer Team as well as some metadata about it.
A TeamMember struct stores values for a single Team Member, extending the normal User data - note that the user field is partial.
TextInput represents text input component.
ThreadCreate is the data for a ThreadCreate event.
ThreadDelete is the data for a ThreadDelete event.
ThreadListSync is the data for a ThreadListSync event.
ThreadMember is used to indicate whether a user has joined a thread or not.
ThreadMembersUpdate is the data for a ThreadMembersUpdate event.
ThreadMemberUpdate is the data for a ThreadMemberUpdate event.
ThreadMetadata contains a number of thread-specific channel fields that are not needed by other channel types.
ThreadsList represents a list of threads alongisde with thread member objects for the current user.
ThreadStart stores all parameters you can use with MessageThreadStartComplex or ThreadStartComplex.
ThreadUpdate is the data for a ThreadUpdate event.
A TimeStamps struct contains start and end times used in the rich presence "playing .." Game.
A TooManyRequests struct holds information received from Discord when receiving a HTTP 429 response.
TypingStart is the data for a TypingStart event.
UpdateStatusData is provided to UpdateStatusComplex().
A User stores all data for an individual Discord user.
UserConnection is a Connection returned from the UserConnections endpoint.
A UserGuild holds a brief version of a Guild.
UserUpdate is the data for a UserUpdate event.
A VoiceConnection struct holds all the data and functions related to a Discord Voice Connection.
A VoiceRegion stores data for a specific voice region server.
VoiceServerUpdate is the data for a VoiceServerUpdate event.
VoiceSpeakingUpdate is a struct for a VoiceSpeakingUpdate event.
A VoiceState stores the voice states of Guilds.
VoiceStateUpdate is the data for a VoiceStateUpdate event.
Webhook stores the data for a webhook.
WebhookEdit stores data for editing of a webhook message.
WebhookParams is a struct for webhook params, used in the WebhookExecute command.
WebhooksUpdate is the data for a WebhooksUpdate event.

# Interfaces

EventHandler is an interface for Discord events.
EventInterfaceProvider is an interface for providing empty interfaces for Discord events.
InteractionData is a common interface for all types of interaction data.
MessageComponent is a base interface for all message components.

# Type aliases

ActivityType is the type of Activity (see ActivityType* consts) in the Activity struct https://discord.com/developers/docs/topics/gateway#activity-object-activity-types.
AllowedMentionType describes the types of mentions used in the MessageAllowedMentions type.
ApplicationCommandOptionType indicates the type of a slash command's option.
ApplicationCommandPermissionType indicates whether a permission is user or role based.
ApplicationCommandType represents the type of application command.
ApplicationRoleConnectionMetadataType represents the type of application role connection metadata.
AuditLogAction is the Action of the AuditLog (see AuditLogAction* consts) https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-audit-log-events.
AuditLogChangeKey value for AuditLogChange https://discord.com/developers/docs/resources/audit-log#audit-log-change-object-audit-log-change-key.
AuditLogOptionsType of the AuditLogOption https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-optional-audit-entry-info.
AutoModerationActionType represents an action which will execute whenever a rule is triggered.
AutoModerationKeywordPreset represents an internally pre-defined wordset.
AutoModerationRuleEventType indicates in what event context a rule should be checked.
AutoModerationRuleTriggerType represents the type of content which can trigger the rule.
ButtonStyle is style of button.
ChannelFlags represent flags of a channel/thread.
ChannelType is the type of a Channel.
ComponentType is type of component.
EmbedType is the type of embed https://discord.com/developers/docs/resources/channel#embed-object-embed-types.
ExpireBehavior of Integration https://discord.com/developers/docs/resources/guild#integration-object-integration-expire-behaviors.
ExplicitContentFilterLevel type definition.
ForumLayout represents layout of a forum channel.
ForumSortOrderType represents sort order of a forum channel.
GuildFeature indicates the presence of a feature in a guild.
GuildNSFWLevel type definition.
GuildOnboardingMode defines the criteria used to satisfy constraints that are required for enabling onboarding.
GuildOnboardingPromptType is the type of an onboarding prompt.
GuildScheduledEventEntityType is the type of entity associated with a guild scheduled event.
GuildScheduledEventPrivacyLevel is the privacy level of a scheduled event.
GuildScheduledEventStatus is the status of a scheduled event Valid Guild Scheduled Event Status Transitions : SCHEDULED --> ACTIVE --> COMPLETED SCHEDULED --> CANCELED https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-status.
Intent is the type of a Gateway Intent https://discord.com/developers/docs/topics/gateway#gateway-intents.
InteractionResponseType is type of interaction response.
InteractionType indicates the type of an interaction event.
InviteTargetType indicates the type of target of an invite https://discord.com/developers/docs/resources/invite#invite-object-invite-target-types.
Locale represents the accepted languages for Discord.
MemberFlags represent flags of a guild member.
The MembershipState represents whether the user is in the team or has been invited into it.
MessageActivityType is the type of message activity.
MessageFlags is the flags of "message" (see MessageFlags* consts) https://discord.com/developers/docs/resources/channel#message-object-message-flags.
MessageNotifications is the notification level for a guild https://discord.com/developers/docs/resources/guild#guild-object-default-message-notification-level.
MessageType is the type of Message https://discord.com/developers/docs/resources/channel#message-object-message-types.
MfaLevel type definition.
PermissionOverwriteType represents the type of resource on which a permission overwrite acts.
PremiumTier type definition.
PresencesReplace is the data for a PresencesReplace event.
RequestOption is a function which mutates request configuration.
RoleFlags represent the flags of a Role.
Roles are a collection of Role.
SelectMenuDefaultValueType represents the type of an entity selected by default in auto-populated select menus.
SelectMenuType represents select menu type.
StageInstancePrivacyLevel represents the privacy level of a Stage instance https://discord.com/developers/docs/resources/stage-instance#stage-instance-object-privacy-level.
Status type definition.
StickerFormat is the file format of the Sticker.
StickerType is the type of sticker.
SystemChannelFlag is the type of flags in the system channel (see SystemChannelFlag* consts) https://discord.com/developers/docs/resources/guild#guild-object-system-channel-flags.
TextInputStyle is style of text in TextInput component.
UserFlags is the flags of "user" (see UserFlags* consts) https://discord.com/developers/docs/resources/user#user-object-user-flags.
UserPremiumType is the type of premium (nitro) subscription a user has (see UserPremiumType* consts).
VerificationLevel type definition.
VoiceSpeakingUpdateHandler type provides a function definition for the VoiceSpeakingUpdate event.
WebhookType is the type of Webhook (see WebhookType* consts) in the Webhook struct https://discord.com/developers/docs/resources/webhook#webhook-object-webhook-types.