Crux

v2020-03-17 17:55:51Z

Crux v2020-03-17 17:55:51Z Crux.Structs.Presence View Source

Represents a Discord Presence Object.

Differences opposed to the Discord API Object:

  • :user is just the user id

Link to this section Summary

Types

id_resolvable()

All available types that can be resolved into a user id.

t()

Functions

create(data)

Creates a Crux.Structs.Presence.t/0 struct from raw data.

resolve_id(resolvable)

Resolves the id of a Crux.Structs.Presence.t/0

Link to this section Types

Link to this type

id_resolvable() View Source (since 0.2.1) 
id_resolvable() :: Crux.Structs.User.id_resolvable()

All available types that can be resolved into a user id.

Link to this type

t() View Source (since 0.1.0) 
t() :: %Crux.Structs.Presence{
  activities: [map()],
  client_status: %{required(atom()) => atom()},
  game: map() | nil,
  status: String.t(),
  user: Crux.Structs.Snowflake.t()
}

Link to this section Functions

Link to this function

create(data) View Source (since 0.1.0) 
create(data :: map()) :: t()

Creates a Crux.Structs.Presence.t/0 struct from raw data.

Automatically invoked by Crux.Structs.create/2.

Link to this function

resolve_id(resolvable) View Source (since 0.2.1) 
resolve_id(id_resolvable()) :: Crux.Structs.Snowflake.t() | nil

Resolves the id of a Crux.Structs.Presence.t/0

Automatically invoked by Crux.Structs.resolve_id/2

For examples see Crux.Structs.User.resolve_id/1