Class: Discordrb::VoiceState
- Inherits:
-
Object
- Object
- Discordrb::VoiceState
- Defined in:
- lib/discordrb/data.rb
Overview
A voice state represents the state of a member's connection to a voice channel. It includes data like the voice channel the member is connected to and mute/deaf flags.
Instance Attribute Summary collapse
-
#deaf ⇒ true, false
readonly
Whether this voice state's member is deafened server-wide.
-
#mute ⇒ true, false
readonly
Whether this voice state's member is muted server-wide.
-
#self_deaf ⇒ true, false
readonly
Whether this voice state's member has deafened themselves.
-
#self_mute ⇒ true, false
readonly
Whether this voice state's member has muted themselves.
-
#user_id ⇒ Integer
readonly
The ID of the user whose voice state is represented by this object.
-
#voice_channel ⇒ Channel
readonly
The voice channel this voice state's member is in.
Instance Attribute Details
#deaf ⇒ true, false (readonly)
Returns whether this voice state's member is deafened server-wide.
428 429 430 |
# File 'lib/discordrb/data.rb', line 428 def deaf @deaf end |
#mute ⇒ true, false (readonly)
Returns whether this voice state's member is muted server-wide.
425 426 427 |
# File 'lib/discordrb/data.rb', line 425 def mute @mute end |
#self_deaf ⇒ true, false (readonly)
Returns whether this voice state's member has deafened themselves.
434 435 436 |
# File 'lib/discordrb/data.rb', line 434 def self_deaf @self_deaf end |
#self_mute ⇒ true, false (readonly)
Returns whether this voice state's member has muted themselves.
431 432 433 |
# File 'lib/discordrb/data.rb', line 431 def self_mute @self_mute end |
#user_id ⇒ Integer (readonly)
Returns the ID of the user whose voice state is represented by this object.
422 423 424 |
# File 'lib/discordrb/data.rb', line 422 def user_id @user_id end |
#voice_channel ⇒ Channel (readonly)
Returns the voice channel this voice state's member is in.
437 438 439 |
# File 'lib/discordrb/data.rb', line 437 def voice_channel @voice_channel end |