nyxx library

Classes

ActionMetadata
Additional metadata associated with an AutoModerationAction.
ActionMetadataBuilder
ActionRowBuilder
ActionRowComponent
A MessageComponent that contains multiple child MessageComponents.
ActionType
The type of action for an AutoModerationAction.
Activity
A Rich Presence activity.
ActivityAssets
Information about an Activity's displayed assets.
ActivityBuilder
ActivityButton
A button displayed in an activity.
ActivityFlags
Information about the data in an Activity instance.
ActivityParty
Information about an Activity's party.
ActivitySecrets
Information about an Activity's secrets.
ActivityTimestamps
Information about an Activity's timings.
ActivityType
The type of an activity.
AllowedMentions
AnnouncementThread
ApiOptions
Options for connecting to the Discord API.
Application
An OAuth2 application.
ApplicationCommand
A command that can be executed by users and is displayed in the Discord client UI.
ApplicationCommandAutocompleteInteraction
An application command autocomplete interaction.
ApplicationCommandBuilder
ApplicationCommandInteraction
An application command interaction.
ApplicationCommandInteractionData
The data sent in an ApplicationCommandInteraction or an ApplicationCommandAutocompleteInteraction.
ApplicationCommandManager
A Manager for ApplicationCommands.
ApplicationCommandPermissionsUpdateEvent
Emitted when the permissions for an application command are updated.
ApplicationCommandType
The type of an ApplicationCommand.
ApplicationCommandUpdateBuilder
ApplicationFlags
Flags for an Application.
ApplicationIntegrationType
ApplicationIntegrationTypeConfiguration
ApplicationIntegrationTypeConfigurationBuilder
ApplicationManager
A manager for Applications.
ApplicationRoleConnection
A role connection an application has attached to a user.
ApplicationRoleConnectionMetadata
Metadata for an app's role connections.
ApplicationRoleConnectionUpdateBuilder
ApplicationUpdateBuilder
Attachment
An attachment in a Message.
AttachmentBuilder
AttachmentFlags
The flags for an Attachment.
AuditLogChange
A change to an object's field in an AuditLogEntry.
AuditLogEntry
An entry in a Guild's audit log.
AuditLogEntryInfo
Extra information associated with an AuditLogEntry.
AuditLogEvent
The type of event an AuditLogEntry represents.
AuditLogManager
AutoModerationAction
Describes an action to take when an AutoModerationRule is triggered.
AutoModerationActionBuilder
AutoModerationActionExecutionEvent
Emitted when an auto moderation action is taken.
AutoModerationEventType
The type of event on which an AutoModerationRule triggers.
AutoModerationManager
AutoModerationRule
A rule use for auto-moderation in a Guild.
AutoModerationRuleBuilder
AutoModerationRuleCreateEvent
Emitted when an auto moderation rule is created.
AutoModerationRuleDeleteEvent
Emitted when an auto moderation rule is deleted.
AutoModerationRuleUpdateBuilder
AutoModerationRuleUpdateEvent
Emitted when an auto moderation rule is updated.
Ban
A ban in a Guild.
BaseRequest
The base class for HTTP requests.
BaseResponse
The base class for HTTP responses.
BasicRequest
An HttpRequest with a JSON body.
Builder<T>
BulkBanResponse
ButtonBuilder
ButtonComponent
A clickable button.
ButtonStyle
The style of a ButtonComponent.
Cache<T>
A simple cache for SnowflakeEntitys.
CacheConfig<T>
The configuration for a Cache instance.
CdnAsset
An asset, most commonly an image, on Discord's CDN.
CdnRequest
A request to Discord's CDN.
Channel
A channel of any type.
ChannelCreateEvent
Emitted when a channel is created.
ChannelDeleteEvent
Emitted when a channel is deleted.
ChannelFlags
A set of flags applied to channels.
ChannelManager
A manager for Channels.
ChannelMention
A channel mentioned in a Message.
ChannelPinsUpdateEvent
Emitted when the pinned messages in a channel are changed.
ChannelPositionBuilder
ChannelType
The type of a channel.
ChannelUpdateEvent
Emitted when a channel is updated.
ClientOptions
Options for controlling the behavior of a Nyxx client.
ClientStatus
The status of a client on multiple platforms.
CliIntegration
A plugin that lets clients close their session gracefully when the process is terminated.
CommandOption
An option in an ApplicationCommand with a type of ApplicationCommandType.chatInput.
CommandOptionBuilder
CommandOptionChoice
A choice for a CommandOption.
CommandOptionChoiceBuilder<T>
CommandOptionMentionable<T extends CommandOptionMentionable<T>>
A common superclass for entities that can be passed in options of type CommandOptionType.mentionable.
CommandOptionType
The type of a CommandOption.
CommandPermission
The permission for a role, user or channel to use an ApplicationCommand.
CommandPermissions
The permissions for an ApplicationCommand in a guild.
CommandPermissionType
The type of a CommandPermission.
Connection
A link to an account on a service other than Discord.
ConnectionMetadataType
The type of an ApplicationRoleConnectionMetadata.
ConnectionVisibility
The visibility level of a connection.
CreateBuilder<T>
Credentials
Credentials that prove that a client is allowed to access a resource on the resource owner's behalf.
CurrentMemberUpdateBuilder
CurrentUserVoiceStateUpdateBuilder
DefaultReaction
A default reaction in a ForumChannel.
DefaultValue<T extends SnowflakeEntity<T>>
DirectoryChannel
A directory channel.
Disconnecting
A shard message sent when the shard is going to disconnect permanently.
DiscordColor
A 24-bit RGB color.
DispatchEvent
The base class for all events sent by dispatch.
Dispose
A gateway message sent to instruct the shard to disconnect & stop handling any further messages.
DmChannel
A DM channel.
DmRecipientBuilder
Embed
Rich content that can be embedded into a message, such as a video, image or custom text.
EmbedAuthor
An author for an Embed.
EmbedAuthorBuilder
EmbedBuilder
EmbedField
A field in an Embed.
EmbedFieldBuilder
EmbedFooter
A footer in an Embed.
EmbedFooterBuilder
EmbedImage
An image in an Embed.
EmbedImageBuilder
EmbedProvider
A provider for an Embed.
EmbedThumbnail
A thumbnail in an Embed.
EmbedThumbnailBuilder
EmbedType
The type of an embed.
EmbedVideo
A video in an Embed.
Emoji
An emoji. Either a TextEmoji or a GuildEmoji.
EmojiBuilder
EmojiManager
EmojiUpdateBuilder
Entitlement
Premium access a user or guild has for an application.
EntitlementCreateEvent
Emitted when an entitlement is created.
EntitlementDeleteEvent
Emitted when an entitlement is deleted.
EntitlementManager
A Manager for Entitlements.
EntitlementType
The type of an Entitlement.
EntitlementUpdateEvent
Emitted when an entitlement is updated.
EntityMetadata
Additional metadata associated with a ScheduledEvent.
ErrorReceived
A shard message sent when the shard encounters an error.
EventReceived
A shard message sent when an event is received on the Gateway.
EventStatus
The status of a ScheduledEvent.
ExplicitContentFilterLevel
The level of explicit content filtering in a guild.
FieldError
Information about an error associated with a specific field in a request.
Flag<T extends Flags<T>>
A flag within a set of Flags.
Flags<T extends Flags<T>>
A set of flags that can be either enabled or disabled.
FollowedChannel
Information about a channel which has been followed.
FormDataRequest
ForumChannel
A forum channel.
ForumChannelBuilder
ForumChannelUpdateBuilder
ForumLayout
The layout in a ForumChannel.
ForumSort
The sorting order in a ForumChannel.
ForumTag
A tag in a forum channel.
ForumTagBuilder
ForumThreadBuilder
Gateway
Handles the connection to Discord's Gateway with shards, manages the client's cache based on Gateway events and provides an interface to the Gateway.
GatewayApiOptions
Options for connecting to the Discord API for making HTTP requests and connecting to the Gateway with a bot token.
GatewayBot
Information about how to connect to the Gateway, with client-specific information.
GatewayClientOptions
Options for controlling the behavior of a NyxxGateway client.
GatewayConfiguration
Information about how to connect to the Gateway.
GatewayEvent
The base class for all events received from the Gateway.
GatewayIntents
Flags used to set the intents when opening a Gateway session.
GatewayManager
A Manager for gateway information.
GatewayMessage
The base class for all control messages sent from the client to the shard.
GatewayVoiceStateBuilder
GlobalApplicationCommandManager
An ApplicationCommandManager for an application's global commands.
GlobalSticker
A sticker that can be sent in messages. Represents global stickers (default stickers)
GlobalStickerManager
GroupDmChannel
A DM channel with multiple recipients.
GroupDmUpdateBuilder
Guild
A collection of channels & users.
GuildAnnouncementChannel
An announcement channel in a Guild.
GuildAnnouncementChannelBuilder
GuildAnnouncementChannelUpdateBuilder
GuildApplicationCommandManager
An ApplicationCommandManager for the commands in a guild.
GuildAuditLogCreateEvent
Emitted when an audit log entry is created in a guild.
GuildBanAddEvent
Emitted when a user is banned in a guild.
GuildBanRemoveEvent
Emitted when a user is unbanned in a guild.
GuildBuilder
GuildCategory
A category for organizing other Channels in a Guild.
GuildCategoryBuilder
GuildCategoryUpdateBuilder
GuildChannel
A channel in a Guild.
GuildChannelBuilder<T extends GuildChannel>
GuildChannelUpdateBuilder<T extends GuildChannel>
GuildCreateEvent
Emitted when a client is added to a guild or when initially receiving guilds over the Gateway.
GuildDeleteEvent
Emitted when the client is removed from a guild.
GuildEmoji
A custom guild emoji.
GuildEmojisUpdateEvent
Emitted when a guild's emojis are updated.
GuildFeatures
Features that can be enabled in certain guilds.
GuildIntegrationsUpdateEvent
Emitted when a guild's integrations are updated.
GuildManager
A manager for Guilds.
GuildMediaChannel
A channel in a guild in which threads can be posted, similarly to a ForumChannel.
GuildMemberAddEvent
Emitted when a member joins a guild.
GuildMemberRemoveEvent
Emitted when a member is removed from a guild.
GuildMembersChunkEvent
Emitted as a response to Gateway.listGuildMembers.
GuildMemberUpdateEvent
Emitted when a guild member is updated.
GuildPreview
A preview of a Guild.
GuildRoleCreateEvent
Emitted when a role is created in a guild.
GuildRoleDeleteEvent
Emitted when a role is deleted in a guild.
GuildRoleUpdateEvent
Emitted when a role is updated in a guild
GuildScheduledEventCreateEvent
Emitted when a scheduled event is created.
GuildScheduledEventDeleteEvent
Emitted when a scheduled event is deleted.
GuildScheduledEventUpdateEvent
Emitted when a scheduled event is updated.
GuildScheduledEventUserAddEvent
Emitted when a user is added to a scheduled event.
GuildScheduledEventUserRemoveEvent
Emitted when a user is removed from a scheduled event.
GuildStageChannel
A stage channel.
GuildStageChannelBuilder
GuildStageChannelUpdateBuilder
GuildSticker
A sticker that can be sent in messages. Represent stickers added to guild
GuildStickerManager
GuildStickersUpdateEvent
Emitted when a guild's stickers are updated.
GuildTemplate
A snapshot of a Guild that can be used to create a new guild.
GuildTemplateBuilder
GuildTemplateUpdateBuilder
GuildTextChannel
A TextChannel in a Guild.
GuildTextChannelBuilder
GuildTextChannelUpdateBuilder
GuildUpdateBuilder
GuildUpdateEvent
Emitted when a guild is updated.
GuildVoiceChannel
A VoiceChannel in a Guild.
GuildVoiceChannelBuilder
GuildVoiceChannelUpdateBuilder
GuildWidget
A Guild's widget.
HasThreadsChannel
A channel which can have threads.
HeartbeatAckEvent
Emitted when the server acknowledges the client's heartbeat.
HeartbeatEvent
Emitted when the client receives a request to heartbeat.
HelloEvent
Emitted when the client first establishes a connection to the gateway.
HttpBucket
A rate limit bucket tracking requests.
HttpErrorData
Information about an error from the API.
HttpHandler
A handler for making HTTP requests to the Discord API.
HttpRequest
An HTTP request to be made against the API.
HttpResponse
A response to a HttpRequest from the Discord API.
HttpResponseSuccess
A successful HttpResponse.
HttpRoute
A route within the Discord API.
HttpRouteParam
A parameter in a HttpRoutePart.
HttpRoutePart
A part of a HttpRoute.
Identify
A gateway message sent as a response to RequestingIdentify to allow the shard to identify.
IgnoreExceptions
A plugin that prevents errors from crashing the program, instead logging them to the console.
ImageBuilder
InstallationParameters
Configuration for an Application's authorization link.
Integration
An integration in a Guild.
IntegrationAccount
Information about an integration's account.
IntegrationApplication
Information about an integration's application.
IntegrationCreateEvent
Emitted when an integration is created.
IntegrationDeleteEvent
Emitted when an integration is deleted.
IntegrationExpireBehavior
The behavior of an integration when a member's subscription expires.
IntegrationManager
A Manager for Integrations.
IntegrationUpdateEvent
Emitted when an integration is updated.
Interaction<T>
An interaction sent by Discord when a user interacts with an ApplicationCommand, a MessageComponent or a ModalBuilder.
InteractionContextType
A context indicating whether command can be used in DMs, groups, or guilds.
InteractionCreateEvent<T extends Interaction>
Emitted when an interaction is received by the client.
InteractionManager
A Manager for Interactions.
InteractionOption
The value of a command option passed in an ApplicationCommandInteraction.
InteractionResponseBuilder
InteractionType
The type of an interaction.
InvalidSessionEvent
Emitted when the client's session is invalid.
Invite
An invite to a Guild or Channel. If the invite is to a Channel, this will be a GroupDmChannel.
InviteBuilder
InviteCreateEvent
Emitted when an invite is created.
InviteDeleteEvent
Emitted when an invite is deleted.
InviteManager
A manager for Invites.
InviteType
The type of an Invite.
InviteWithMetadata
KeywordPresetType
A preset list of trigger keywords for an AutoModerationRule.
Level
Levels to control logging output. Logging can be enabled to include all levels above certain Level. Levels are ordered using an integer value Level.value. The predefined Level constants below are sorted as follows (in descending order): Level.SHOUT, Level.SEVERE, Level.WARNING, Level.INFO, Level.CONFIG, Level.FINE, Level.FINER, Level.FINEST, and Level.ALL.
Logger
Use a Logger to log debug messages.
Logging
A plugin that outputs a client's logs to stdout and stderr.
ManagedSnowflakeEntity<T extends ManagedSnowflakeEntity<T>>
The base class for all SnowflakeEntity's that have a dedicated ReadOnlyManager.
Manager<T extends WritableSnowflakeEntity<T>>
Provides the means to interact with the API for a given entity type.
Member
The representation of a User in a Guild.
MemberBuilder
MemberFlags
Flags that can be applied to a Member.
MemberManager
A manager for Members.
MemberUpdateBuilder
Message
Represents a message sent in a TextChannel.
MessageActivity
Activity data for rich presence related messages.
MessageActivityType
The type of a message activity.
MessageAuthor
An author of a message.
MessageBuilder
MessageBulkDeleteEvent
Emitted when multiple messages are bulk deleted.
MessageCall
Information about a call in a private channel.
MessageComponent
A component in a Message.
MessageComponentBuilder
MessageComponentInteraction
A message component interaction.
MessageComponentInteractionData
The data sent in a MessageComponentInteraction.
MessageComponentType
The type of a MessageComponent.
MessageCreateEvent
Emitted when a message is sent.
MessageDeleteEvent
Emitted when a message is deleted.
MessageFlags
Flags that can be applied to a Message.
MessageInteraction
Information about an interaction associated with a message.
MessageInteractionMetadata
Metadata about the interaction, including the source of the interaction and relevant server and user IDs.
MessageManager
A manager for Messages in a TextChannel.
MessageNotificationLevel
The level at which message notifications are sent in a guild.
MessagePollVoteAddEvent
Emitted when user votes on a poll. If the poll allows multiple selection, one event will be sent per answer.
MessagePollVoteRemoveEvent
Emitted when user removes their vote on a poll. If the poll allows for multiple selections, one event will be sent per answer.
MessageReactionAddEvent
Emitted when a reaction is added to a message.
MessageReactionRemoveAllEvent
Emitted when all reactions are removed from a message.
MessageReactionRemoveEmojiEvent
Emitted when all reactions of a specific emoji are removed from a message.
MessageReactionRemoveEvent
Emitted when a reaction is removed from a message.
MessageReference
A reference to an external entity contained in a message.
MessageReferenceBuilder
MessageReferenceType
MessageSnapshot
A limited set of fields of a Message.
MessageType
The type of a message.
MessageUpdateBuilder
MessageUpdateEvent
Emitted when a message is updated.
MfaLevel
The MFA level required for moderators of a guild.
ModalBuilder
ModalSubmitInteraction
A modal submit interaction.
ModalSubmitInteractionData
The data sent in a ModalSubmitInteraction.
MultipartFile
A file to be uploaded as part of a MultipartRequest.
MultipartRequest
An HttpRequest with files & a JSON payload.
NitroType
The types of Discord Nitro subscription a user can have.
NsfwLevel
The NSFW level of a guild.
Nyxx
The base class for clients interacting with the Discord API.
NyxxGateway
A client that can make requests to the HTTP API, connects to the Gateway and is authenticated with a bot token.
NyxxOAuth2
NyxxPlugin<ClientType extends Nyxx>
Provides access to the connection and closing process for implementing plugins.
NyxxPluginState<ClientType extends Nyxx, PluginType extends NyxxPlugin<ClientType>>
Holds the state of a plugin added to a client.
NyxxRest
A client that can make requests to the HTTP API and is authenticated with a bot token.
OAuth2ApiOptions
Options for connecting the the Discord API using credentials from an OAuth2 flow.
Oauth2HttpHandler
An HttpHandler that refreshes the OAuth2 access token if needed.
OAuth2Information
Onboarding
The configuration for a Guild's onboarding process.
OnboardingMode
The mode under which onboarding constraints operate when creating an Onboarding.
OnboardingPrompt
A prompt in an Onboarding flow.
OnboardingPromptBuilder
OnboardingPromptOption
An option in an OnboardingPrompt.
OnboardingPromptOptionBuilder
OnboardingPromptType
The type of an Onboarding prompt.
OnboardingUpdateBuilder
PartialApplication
A partial Application object.
PartialApplicationCommand
A partial ApplicationCommand.
PartialAuditLogEntry
A partial AuditLogEntry.
PartialAutoModerationRule
A partial AutoModerationRule.
PartialChannel
A partial Channel object.
PartialEmoji
A partial Emoji object.
PartialEntitlement
A partial Entitlement.
PartialGlobalSticker
PartialGuild
A partial Guild.
PartialGuildSticker
PartialIntegration
A partial Integration.
PartialMember
A partial Member.
PartialMessage
A partial Message object.
PartialRole
A partial Role.
PartialScheduledEvent
A partial ScheduledEvent.
PartialSku
A partial Sku.
PartialSubscription
A partial Subscription.
PartialTextChannel
A partial TextChannel.
PartialThreadMember
A partial ThreadMember.
PartialUser
A partial User object.
PartialWebhook
A partial Webhook.
PermissionOverwrite
A set of overwrites to apply to permissions within a specific channel.
PermissionOverwriteBuilder
PermissionOverwriteType
The type of a permission overwrite.
Permissions
A set of permissions.
PingInteraction
A ping interaction.
Poll
The poll object has a lot of levels and nested structures. It was also designed to support future extensibility, so some fields may appear to be more complex than necessary.
PollAnswer
The PollAnswer.answerId is a number that labels each answer. As an implementation detail, it currently starts at 1 for the first answer and goes up sequentially. We recommend against depending on this sequence.
PollAnswerBuilder
External references:
PollAnswerCount
PollBuilder
The poll object has a lot of levels and nested structures. It was also designed to support future extensibility, so some fields may appear to be more complex than necessary.
PollLayoutType
A layout type indicating how poll looks.
PollMedia
The poll media object is a common object that backs both the question and answers. The intention is that it allows us to extensibly add new ways to display things in the future. For now, Poll.question only supports PollMedia.text, while answers can have an optional PollMedia.emoji.
PollMediaBuilder
The poll media object is a common object that backs both the question and answers. The intention is that it allows us to extensibly add new ways to display things in the future. For now, Poll.question only supports PollMedia.text, while answers can have an optional PollMedia.emoji.
PollResults
In a nutshell, this contains the number of votes for each answer. Due to the intricacies of counting at scale, while a poll is in progress the results may not be perfectly accurate. They usually are accurate, and shouldn't deviate significantly -- it's just difficult to make guarantees. To compensate for this, after a poll is finished there is a background job which performs a final, accurate tally of votes. This tally has concluded once PollResults.isFinalized is true. If PollResults.answerCounts does not contain an entry for a particular answer, then there are no votes for that answer.
PremiumTier
The premium tier of a guild.
PresenceBuilder
PresenceUpdateEvent
Emitted when a user updates their presence.
PrivacyLevel
The privacy level of a StageInstance.
PrivateThread
A private Thread channel.
PublicThread
A public Thread channel.
RawDispatchEvent
An unparsed dispatch event.
Reaction
A reaction to a message.
ReactionBuilder
ReactionCountDetails
Details about a Reaction's Reaction.count.
ReadOnlyManager<T extends ManagedSnowflakeEntity<T>>
A Manager that provides only read access to the API.
ReadyEvent
Emitted when the client's Gateway session is established.
ReconnectEvent
Emitted when the client receives a request to reconnect.
RecurrenceRule
Indicates how often a ScheduledEvent should recur.
RecurrenceRuleBuilder
RecurrenceRuleFrequency
The frequency with which a ScheduledEvent can recur.
RecurrenceRuleMonth
The month on which a ScheduledEvent recurs.
RecurrenceRuleNWeekday
The week and weekday on which a ScheduledEvent recurs.
RecurrenceRuleWeekday
The weekday on which a ScheduledEvent recurs.
Request
An HTTP request where the entire request body is known in advance.
RequestingIdentify
A shard message sent when the shard is waiting to identify on the Gateway.
ResolvedData
A mapping of IDs to entities.
RestApiOptions
Options for connecting to the Discord API to make HTTP requests with a bot token.
RestClientOptions
Options for controlling the behavior of a NyxxRest client.
ResumedEvent
Emitted when
Role
A role in a Guild.
RoleBuilder
RoleFlags
The flags for a Role.
RoleManager
A manager for Roles.
RoleSubscriptionData
Information about a role subscription.
RoleTags
Additional metadata associated with a role.
RoleUpdateBuilder
RuntimeType<T>
A non-opaque representation of a Type that can be used at runtime.
ScheduledEntityType
The type of the entity associated with a ScheduledEvent.
ScheduledEvent
A scheduled event in a Guild.
ScheduledEventBuilder
ScheduledEventManager
A Manager for ScheduledEvents.
ScheduledEventUpdateBuilder
ScheduledEventUser
A user that has followed a ScheduledEvent.
SelectMenuBuilder
SelectMenuComponent
A dropdown menu in which users can select from on or more choices.
SelectMenuDefaultValue
A default value in a SelectMenuComponent.
SelectMenuDefaultValueType
The type of a SelectMenuDefaultValue.
SelectMenuOption
An option in a SelectMenuComponent.
SelectMenuOptionBuilder
Send
A gateway message sent to instruct the shard to send data on its connection.
Sent
A shard message sent when the shard adds a payload to the connection.
SessionStartLimit
Information about a client's session start limits.
Shard
A single connection to Discord's Gateway.
ShardData
Information a shard needs to run itself.
ShardMessage
The base class for all control messages sent from the shard to the client.
Sku
A premium offering that can be made available to your application's users or guilds.
SkuFlags
Flags applied to an Sku.
SkuManager
SkuType
The type of an Sku.
Snowflake
A unique ID used to identify objects in the API.
SnowflakeEntity<T extends SnowflakeEntity<T>>
The base class for all entities in the API identified by a Snowflake.
StageInstance
Information about a live stage.
StageInstanceBuilder
StageInstanceCreateEvent
Emitted when a stage instance is created.
StageInstanceDeleteEvent
Emitted when a stage instance is deleted.
StageInstanceUpdateBuilder
StageInstanceUpdateEvent
Emitted when a stage instance is updated.
StartShard
A gateway message sent when the Gateway instance is ready for the shard to start.
StickerBuilder
StickerFormatType
StickerItem
A representation of a sticker with minimal information
StickerPack
A Sticker Pack -- group of stickers that are gated behind Nitro.
StickerType
StickerUpdateBuilder
StreamedResponse
An HTTP response where the response body is received asynchronously after the headers have been received.
Subscription
A subscription to an Sku.
SubscriptionManager
SubscriptionStatus
The status of a Subscription.
SystemChannelFlags
The configuration of a guild's system channel.
TargetType
The type of an Invite's target.
Team
A group of developers.
TeamMember
A member of a Team.
TeamMemberRole
The role of a TeamMember.
TeamMembershipState
The status of a member in a Team.
TestEntitlementBuilder
TextChannel
/ A text channel
TextEmoji
A text emoji, such as ❤️.
TextInputBuilder
TextInputComponent
A text field in a modal.
TextInputStyle
The type of a TextInputComponent.
Thread
A thread channel.
ThreadBuilder
ThreadCreateEvent
Emitted when a thread is created.
ThreadDeleteEvent
Emitted when a thread is deleted.
ThreadFromMessageBuilder
ThreadList
A list of threads and thread members.
ThreadListSyncEvent
Emitted when the client's thread list is synced.
ThreadMember
Additional information associated with a Member in a Thread.
ThreadMembersUpdateEvent
Emitted when a members in a thread are updated.
ThreadMemberUpdateEvent
Emitted when the client's thread member is updated.
ThreadsOnlyChannel
ThreadUpdateBuilder
ThreadUpdateEvent
Emitted when a thread is updated.
TriggerMetadata
Additional metadata associated with the trigger for an AutoModerationRule.
TriggerType
The type of a trigger for an AutoModerationRule
TypingStartEvent
Emitted when a user starts typing in a channel.
UnavailableGuildCreateEvent
Emitted when the client is added to an unavailable guild, or when initially receiving guilds over the Gateway.
UnknownDispatchEvent
Emitted when a RawDispatchEvent could not be parsed to a DispatchEvent due to the event being unknown.
UpdateBuilder<T>
User
A single user, outside of a Guild's context.
UserFlags
A set of Flags a user can have.
UserGuild
A collection of channels & users.
UserManager
A manager for Users.
UserStatus
The status of a client.
UserUpdateBuilder
UserUpdateEvent
Emitted when a user is updated.
VerificationLevel
The verification level for a guild.
VideoQualityMode
The quality mode of cameras in a VoiceChannel.
VoiceChannel
A voice channel.
VoiceManager
A manager for VoiceStates.
VoiceRegion
A voice region.
VoiceServerUpdateEvent
Emitted when joining a voice channel to update the voice servers.
VoiceState
A user's voice connection state.
VoiceStateUpdateBuilder
VoiceStateUpdateEvent
Emitted when a user's voice state is updated.
Webhook
A non authenticated way to send messages to a Discord channel.
WebhookAuthor
A partial Webhook sent as part of a Message.
WebhookBuilder
WebhookManager
A manager for Webhooks.
WebhooksUpdateEvent
Emitted when the webhooks in a channel are updated.
WebhookType
The type of a Webhook.
WebhookUpdateBuilder
WelcomeScreen
The configuration for the welcome screen in a guild.
WelcomeScreenChannel
A channel shown in a WelcomeScreen.
WelcomeScreenUpdateBuilder
WidgetSettings
The settings for a Guild's widget.
WidgetSettingsUpdateBuilder
WritableSnowflakeEntity<T extends WritableSnowflakeEntity<T>>
The base class for all SnowflakeEntity's that have a dedicated Manager.

Enums

CdnFormat
Available formats for CDN endpoints.
ConnectionType
The type of a connection.
CurrentUserStatus
GatewayCompression
The compression of a Gateway connection.
GatewayPayloadFormat
The format of Gateway payloads.
InteractionCallbackType
Locale
A language locale available in the Discord client.
Opcode
Opcodes sent or received over the Gateway.
TestEntitlementType
WidgetImageStyle
The style of a guild widget image.

Mixins

MessageResponse<T>
ModalResponse<T>
Sticker
Mixin with shared properties with stickers

Properties

cliIntegration → CliIntegration
A global instance of the CliIntegration plugin.
final
ignoreExceptions → IgnoreExceptions
A global instance of the IgnoreExceptions plugin.
final
logging → Logging
A global instance of the Logging plugin.
final

Typedefs

RateLimitInfo = ({Duration delay, bool isAnticipated, bool isGlobal, HttpRequest request})
Information about a delay applied to request because of a rate limit.

Exceptions / Errors

AlreadyAcknowledgedError
An error thrown when MessageResponse.acknowledge is called on an already acknowledged interaction.
AlreadyRespondedError
An error thrown when MessageResponse.respond is called on an interaction that has already been responded to.
AuditLogEntryNotFoundException
An exception thrown when an audit log entry is not found in a guild.
ClientClosedError
An error thrown when the client is closed while an operation is pending, or when an already closed client is used.
EntitlementNotFoundException
An exception thrown when an entitlement is not found for an application.
HttpResponseError
An HttpResponse which represents an error from the API.
IntegrationNotFoundException
An exception thrown when a integration is not found in a guild.
InvalidEventException
An exception thrown when an unexpected event is received on the Gateway.
MemberAlreadyExistsException
An exception thrown when a member already exists in a guild.
NyxxException
The base class for all exceptions thrown by nyxx.
OutOfRemainingSessionsError
An error thrown when the number of remaining sessions becomes too low.
PluginError
An error thrown when an issue with a client's plugin is encountered.
RoleNotFoundException
An exception thrown when a role is not found in a guild.
ShardDisconnectedError
An error thrown when a shard disconnects unexpectedly.