Class: RubyCord::Guild::VoiceChannel::VoiceState
- Inherits:
-
DiscordModel
- Object
- DiscordModel
- RubyCord::Guild::VoiceChannel::VoiceState
- Defined in:
- lib/rubycord/guild/channel/voice/voice_state.rb
Instance Attribute Summary collapse
- #channel ⇒ nil, RubyCord::Channel readonly
-
#deaf? ⇒ Boolean
readonly
Whether the user is deafened.
- #guild ⇒ nil, RubyCord::Guild readonly
-
#member ⇒ RubyCord::Guild::Member
readonly
The member associated with this voice state.
-
#mute? ⇒ Boolean
readonly
Whether the user is muted.
-
#request_to_speak_timestamp ⇒ Time
readonly
The time at which the user requested to speak.
-
#self_deaf ⇒ Boolean
(also: #self_deaf?)
readonly
Whether the user is deafened.
-
#self_mute ⇒ Boolean
(also: #self_mute?)
readonly
Whether the user is muted.
-
#self_stream ⇒ Boolean
(also: #stream?)
readonly
Whether the user is streaming.
-
#self_video ⇒ Boolean
(also: #video?)
readonly
Whether the user is video-enabled.
-
#server_deaf? ⇒ Boolean
readonly
Whether the user is deafened on the server.
-
#server_mute? ⇒ Boolean
readonly
Whether the user is muted on the server.
-
#session_id ⇒ RubyCord::Snowflake
readonly
The ID of the guild this voice state is for.
-
#suppress ⇒ Boolean
(also: #suppress?)
readonly
Whether the user is suppressed.
- #user ⇒ nil, RubyCord::User readonly
Method Summary
Methods inherited from DiscordModel
Instance Attribute Details
#channel ⇒ nil, RubyCord::Channel (readonly)
This method returns an object from client cache. it will return nil
if the object is not in cache.
|
# File 'lib/rubycord/guild/channel/voice/voice_state.rb', line 33
|
#deaf? ⇒ Boolean (readonly)
Returns Whether the user is deafened.
|
# File 'lib/rubycord/guild/channel/voice/voice_state.rb', line 33
|
#guild ⇒ nil, RubyCord::Guild (readonly)
This method returns an object from client cache. it will return nil
if the object is not in cache.
|
# File 'lib/rubycord/guild/channel/voice/voice_state.rb', line 33
|
#member ⇒ RubyCord::Guild::Member (readonly)
Returns The member associated with this voice state.
11 12 13 |
# File 'lib/rubycord/guild/channel/voice/voice_state.rb', line 11 def member @member end |
#mute? ⇒ Boolean (readonly)
Returns Whether the user is muted.
|
# File 'lib/rubycord/guild/channel/voice/voice_state.rb', line 33
|
#request_to_speak_timestamp ⇒ Time (readonly)
Returns The time at which the user requested to speak.
15 16 17 |
# File 'lib/rubycord/guild/channel/voice/voice_state.rb', line 15 def end |
#self_deaf ⇒ Boolean (readonly) Also known as: self_deaf?
Returns Whether the user is deafened.
17 18 19 |
# File 'lib/rubycord/guild/channel/voice/voice_state.rb', line 17 def self_deaf @self_deaf end |
#self_mute ⇒ Boolean (readonly) Also known as: self_mute?
Returns Whether the user is muted.
20 21 22 |
# File 'lib/rubycord/guild/channel/voice/voice_state.rb', line 20 def self_mute @self_mute end |
#self_stream ⇒ Boolean (readonly) Also known as: stream?
Returns Whether the user is streaming.
23 24 25 |
# File 'lib/rubycord/guild/channel/voice/voice_state.rb', line 23 def self_stream @self_stream end |
#self_video ⇒ Boolean (readonly) Also known as: video?
Returns Whether the user is video-enabled.
27 28 29 |
# File 'lib/rubycord/guild/channel/voice/voice_state.rb', line 27 def self_video @self_video end |
#server_deaf? ⇒ Boolean (readonly)
Returns Whether the user is deafened on the server.
|
# File 'lib/rubycord/guild/channel/voice/voice_state.rb', line 33
|
#server_mute? ⇒ Boolean (readonly)
Returns Whether the user is muted on the server.
|
# File 'lib/rubycord/guild/channel/voice/voice_state.rb', line 33
|
#session_id ⇒ RubyCord::Snowflake (readonly)
Returns The ID of the guild this voice state is for.
13 14 15 |
# File 'lib/rubycord/guild/channel/voice/voice_state.rb', line 13 def session_id @session_id end |
#suppress ⇒ Boolean (readonly) Also known as: suppress?
Returns Whether the user is suppressed. (Is at audience).
30 31 32 |
# File 'lib/rubycord/guild/channel/voice/voice_state.rb', line 30 def suppress @suppress end |
#user ⇒ nil, RubyCord::User (readonly)
This method returns an object from client cache. it will return nil
if the object is not in cache.
|
# File 'lib/rubycord/guild/channel/voice/voice_state.rb', line 33
|