API Reference Nostrum v0.6.1

Modules

Interface for Discord's rest API.

Ratelimit implementation specific to Discord's API. Only to be used when starting in a rest-only manner.

Supervises caches for nostrum structures.

Cache behaviour & dispatcher for channels.

An ETS-based cache for channels.

Cache behaviour & dispatcher for guilds.

An ETS-based cache for guilds.

A cache module that does nothing.

Mapping of channel -> guild relationships.

Mapping of guild -> shard relationships.

Simple mapping of shard pid to num

Simple cache that stores information for the current user.

Cache behaviour & dispatcher for Discord presences.

ETS-based cache for user presences.

A cache module that does not cache anything.

Cache behaviour & dispatcher for users.

An ETS-based cache for users.

Consumer process for gateway event handling.

Represents a failed response from the API.

Represents an error when interacting with the cache.

Represents an error when playing sound through voice channels.

Functions that work on permissions.

Functions that work on Snowflakes.

Typespecs for creating Application Commands

Struct for command invocation arguments.

Struct and helper functions for working with channels.

Components are a framework for adding interactive elements to the messages your app or bot sends. They're accessible, customizable, and easy to use. There are several different types of components; this documentation will outline the basics of this new framework and each example.

Helpers for dealing with Button Components

Functions that work on Discord embeds.

Struct representing a Discord embed author.

Struct representing a Discord embed field.

Struct representing a Discord embed footer.

Struct representing a Discord embed image.

Struct representing a Discord embed provider.

Struct representing a Discord embed thumbnail.

Struct representing a Discord embed video.

Struct representing a Discord emoji.

Represents an update to channel pins.

Sent when a user is banned from a guild

Sent when a user is unbanned from a guild

Event fired when a guild integration is deleted.

Sent when a guild integration is updated

Struct representing a guild scheduled event user add event.

Struct representing a guild scheduled event user remove event.

Struct representing an Invite Create event

Struct representing an Invite Delete event

Struct representing a Message Delete event

Struct representing a Message Delete Bulk event

Sent when a user adds a reaction to a message

Sent when a user removes a reaction from a message

Sent when a user explicitly removes all reactions from a message

Sent when a bot removes all instances of a given emoji from the reactions of a message

Sent after initial handshake with the gateway

Struct representing a Nostrum-generated Speaking Update event

Struct representing a Thread List Sync event.

Struct representing a thread members update event.

Sent when a user starts typing in a channel

Struct representing a Nostrum-generated Voice Ready event

Sent when a guild's voice server is updated

Represents a user's voice connection status

Struct representing a Discord guild.

Represents a guild's audit log.

Represents a single entry in the guild's audit log.

Represents a guild ban.

Struct representing a Discord guild integration.

Struct representing a Discord guild's integration account.

Struct representing a Discord Guild Integration Application.

Struct representing a Discord guild member.

Struct representing a Discord role.

Struct representing a scheduled event in a guild.

Struct representing any additional metadata associated with a Guild Event.

Struct representing a user in a guild's scheduled event.

Struct representing an unavailable Discord guild.

Application command and Component invocation struct.

Struct representing a Discord invite.

Struct representing a Discord message activity.

Struct representing a Discord message application.

Struct representing a Discord message attachment.

A component attached to a message.

Struct representing a Discord message reaction.

Struct representing a discord message reference.

Struct representing a Discord overwrite.

Struct representing a thread member object

Struct representing a Discord user.

Struct representing a Discord User's connections

Struct representing the flags a user account can have

Struct representing a Discord voice region.

Struct representing the current Voice WS state.

Struct representing the current WS state.

Struct representing a Discord webhook.

A helper module for verifying the Discord bot token.

Utility functions

Interface for playing and listening to audio through Discord's voice channels.

Mix Tasks

Task that pushes docs to gh-pages branch on Discord.