crux_structs

v0.2.1

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

resolve_id(resolvable)

Resolves the id of a Crux.Structs.VoiceState.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.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

Link to this function

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

Creates a Crux.Structs.VoiceState.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.VoiceState.t/0.

Automatically invoked by Crux.Structs.resolve_id/2.

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