Enum Event

pub enum Event {
    Error(ErrorPayload),
    Ready(ConnectEvent),
    Disconnected {
        reason: Error,
    },
    CurrentUserUpdate(UpdateEvent),
    ActivityJoin(SecretEvent),
    ActivitySpectate(SecretEvent),
    ActivityJoinRequest(JoinRequestEvent),
    ActivityInvite(InviteEvent),
    OverlayUpdate(UpdateEvent),
    RelationshipUpdate(Arc<Relationship>),
}

An event sent from Discord to notify us of some kind of state change or completed action.

{ "evt": "ACTIVITY_JOIN", "data": { "secret": "super_sekret" } }

Variants

Error(ErrorPayload)

Fires when we’ve done something naughty and Discord is telling us to stop.

API docs

Ready(ConnectEvent)

Sent by Discord upon receipt of our Handshake message, the user is the current user logged in to the Discord we connected to.

Disconnected

Fired when the connection has been interrupted between us and Discord, this is a synthesized event as there are can be numerous reasons on the client side for this to happen, in addition to Discord itself being closed, etc.

Fields

reason: Error

CurrentUserUpdate(UpdateEvent)

Fired when any details on the current logged in user are changed.

API docs

ActivityJoin(SecretEvent)

Sent by Discord when the local user has requested to join a game, and the remote user has accepted their request.

API docs

ActivitySpectate(SecretEvent)

Sent by Discord when the local user has chosen to spectate another user’s game session.

API docs

ActivityJoinRequest(JoinRequestEvent)

Fires when a user asks to join the current user’s game.

API docs

ActivityInvite(InviteEvent)

Fires when the current user is invited by another user to their game.

API docs

OverlayUpdate(UpdateEvent)

Event fired when the overlay state changes.

API docs

RelationshipUpdate(Arc<Relationship>)

Event fired when a relationship with another user changes.

API docs

Trait Implementations

impl Debug for Event

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Event

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.