Nostrum v0.3.1 API Reference

Modules

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

Functions that work on permissions

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 a Discord guild

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

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 overwrite

Functions that work on Snowflakes

Struct representing a Discord user

Struct representing a Discord User's connections

Struct representing a Discord voice region

Struct representing the current WS state

Struct representing a Discord webhook

Utility functions

Exceptions

Represents a failed response from the API

Represents an error when interacting with the cache

Mix Tasks

Task that pushes docs to gh-pages branch on Discord