View Source Nostrum.Struct.Event.VoiceState (Nostrum v0.6.1)
Represents a user's voice connection status
Link to this section 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
Event sent when a user's voice status is updated
User this voice state is for
Link to this section Types
Specs
channel_id() :: Nostrum.Struct.Channel.id()
Channel ID this voice state is for
Specs
deaf() :: boolean()
Whether this user is deafened by the server
Specs
guild_id() :: Nostrum.Struct.Guild.id() | nil
Guild ID this voice state is for, if applicable
Specs
member() :: Nostrum.Struct.Guild.Member.t() | nil
Guild member this voice state is for, if applicable
Specs
mute() :: boolean()
Whether this user is muteened by the server
Specs
request_to_speak_timestamp() :: DateTime.t() | nil
Time at which the user requested to speak, if applicable
Specs
self_deaf() :: boolean()
Whether this user is locally deafened
Specs
self_mute() :: boolean()
Whether this user is locally muted
Specs
self_stream() :: boolean()
Whether the user is streaming using "Go Live"
Specs
self_video() :: boolean()
Whether this user's camera is enabled
Specs
session_id() :: String.t()
Session ID for this voice state
Specs
suppress() :: boolean()
Whether this user is muted by the current user
Specs
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
Specs
user_id() :: Nostrum.Struct.User.id()
User this voice state is for