API Reference Nostrum v0.4.6

Interface for Discord's rest API.

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

Cache for channels.

Functions for retrieving guild states.

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 for presences.

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.

Struct for interaction data.

Struct for command invocation arguments.

Struct representing a Discord guild channel.

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.

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

Struct representing a Nostrum-generated Speaking Update event

Struct representing a Discord guild.

Represents a guild's audit log.

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

Struct representing a Discord guild integration.

Struct representing a Discord guild's integration account.

Struct representing a Discord guild member.

Struct representing a Discord role.

Struct representing an unavailable Discord guild.

Slash command invocation struct.

Struct representing a Discord invite.

Struct representing a Discord message.

Struct representing a Discord message activity.

Struct representing a Discord message application.

Struct representing a Discord message attachment.

Struct representing a Discord message reaction.

Struct representing a discord message reference.

Struct representing a Discord overwrite.

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 WS state.

Struct representing a Discord webhook.

Utility functions

Interface for playing audio through Discord's voice channels.

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