crux_structs v0.2.3 Crux.Structs.VoiceState View Source

Represents a Discord Voice State Object

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 t:Crux.Structs.VoiceState.t/0 struct from raw data.

resolve_id(resolvable)

Resolves the id of a t:Crux.Structs.VoiceState.t/0.

Link to this section Types

id_resolvable()

(since 0.2.1)

Specs

id_resolvable() :: Crux.Structs.User.id_resolvable()

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

t()

(since 0.1.0)

Specs

t() :: %Crux.Structs.VoiceState{
  channel_id: Crux.Structs.Snowflake.t() | nil,
  deaf: boolean(),
  guild_id: Crux.Structs.Snowflake.t(),
  mute: boolean(),
  self_deaf: boolean(),
  self_mute: boolean(),
  self_stream: boolean(),
  session_id: String.t(),
  suppress: boolean(),
  user_id: Crux.Structs.Snowflake.t()
}

Link to this section Functions

create(data)

(since 0.1.0)

Specs

create(data :: map()) :: t()

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

Automatically invoked by Crux.Structs.create/2.

resolve_id(resolvable)

(since 0.2.1)

Specs

resolve_id(id_resolvable()) :: Crux.Structs.Snowflake.t() | nil

Resolves the id of a t:Crux.Structs.VoiceState.t/0.

Automatically invoked by Crux.Structs.resolve_id/2.

iex> %Crux.Structs.VoiceState{user_id: 218348062828003328}
...> |> Crux.Structs.VoiceState.resolve_id()
218348062828003328

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