View Source Nostrum.Struct.Event.VoiceState (Nostrum v0.10.0)

Represents a user's voice connection status

Summary

Types

Channel ID this voice state is for

Whether this user is deafened by the server

Guild ID this voice state is for, if applicable

Guild member this voice state is for, if applicable

Whether this user is muteened by the server

Time at which the user requested to speak, if applicable

Whether this user is locally deafened

Whether this user is locally muted

Whether the user is streaming using "Go Live"

Whether this user's camera is enabled

Session ID for this voice state

Whether this user is muted by the current user

t()

Event sent when a user's voice status is updated

User this voice state is for

Types

Link to this type

channel_id()

View Source (since 0.5.0)
@type channel_id() :: Nostrum.Struct.Channel.id()

Channel ID this voice state is for

@type deaf() :: boolean()

Whether this user is deafened by the server

Link to this type

guild_id()

View Source (since 0.5.0)
@type guild_id() :: Nostrum.Struct.Guild.id() | nil

Guild ID this voice state is for, if applicable

Link to this type

member()

View Source (since 0.5.0)
@type member() :: Nostrum.Struct.Guild.Member.t() | nil

Guild member this voice state is for, if applicable

@type mute() :: boolean()

Whether this user is muteened by the server

Link to this type

request_to_speak_timestamp()

View Source (since 0.5.0)
@type request_to_speak_timestamp() :: DateTime.t() | nil

Time at which the user requested to speak, if applicable

Link to this type

self_deaf()

View Source (since 0.5.0)
@type self_deaf() :: boolean()

Whether this user is locally deafened

Link to this type

self_mute()

View Source (since 0.5.0)
@type self_mute() :: boolean()

Whether this user is locally muted

Link to this type

self_stream()

View Source (since 0.5.0)
@type self_stream() :: boolean()

Whether the user is streaming using "Go Live"

Link to this type

self_video()

View Source (since 0.5.0)
@type self_video() :: boolean()

Whether this user's camera is enabled

Link to this type

session_id()

View Source (since 0.5.0)
@type session_id() :: String.t()

Session ID for this voice state

Link to this type

suppress()

View Source (since 0.5.0)
@type suppress() :: boolean()

Whether this user is muted by the current user

@type t() :: %Nostrum.Struct.Event.VoiceState{
  channel_id: channel_id(),
  deaf: deaf(),
  guild_id: guild_id(),
  member: member(),
  mute: mute(),
  request_to_speak_timestamp: request_to_speak_timestamp(),
  self_deaf: self_deaf(),
  self_mute: self_mute(),
  self_stream: self_stream(),
  self_video: self_video(),
  session_id: session_id(),
  suppress: suppress(),
  user_id: user_id()
}

Event sent when a user's voice status is updated

Link to this type

user_id()

View Source (since 0.5.0)
@type user_id() :: Nostrum.Struct.User.id()

User this voice state is for