View Source Nostrum.Struct.Event.Ready (Nostrum v0.6.1)

Sent after initial handshake with the gateway

Link to this section Summary

Types

Partial application object with id and flags

The guilds that the bot user is in

Used for resuming connections.

A pair of two integers {shard_id, num_shards}.

t()

Event sent after initial handshake with the gateway

Information about the bot user

Link to this section Types

Specs

Partial application object with id and flags

Specs

The guilds that the bot user is in

Specs

session_id() :: String.t()

Used for resuming connections.

If you are wondering whether you need to use this, you probably don't. Nostrum handles reconnections for you.

Specs

shard() :: {integer(), non_neg_integer()} | nil

A pair of two integers {shard_id, num_shards}.

For more information, see https://discord.com/developers/docs/topics/gateway#sharding.

Specs

t() :: %Nostrum.Struct.Event.Ready{
  application: application(),
  guilds: guilds(),
  session_id: session_id(),
  shard: shard(),
  user: user(),
  v: v()
}

Event sent after initial handshake with the gateway

Specs

user() :: Nostrum.Struct.User.t()

Information about the bot user

Specs

v() :: non_neg_integer()

Gateway version. See https://discord.com/developers/docs/topics/gateway#gateways-gateway-versions