<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title> Class: Discorb::VoiceState — Documentation by YARD 0.9.26 </title> <link rel="stylesheet" href="../css/style.css" type="text/css" /> <link rel="stylesheet" href="../css/common.css" type="text/css" /> <script type="text/javascript"> pathId = "Discorb::VoiceState"; relpath = '../'; </script> <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> <script type="text/javascript" charset="utf-8" src="../js/app.js"></script> </head> <body> <div class="nav_wrap"> <iframe id="nav" src="../class_list.html?1"></iframe> <div id="resizer"></div> </div> <div id="main" tabindex="-1"> <div id="header"> <div id="menu"> <a href="../a_index.html">Index (V)</a> » <span class='title'><span class='object_link'><a href="../Discorb.html" title="Discorb (module)">Discorb</a></span></span> » <span class="title">VoiceState</span> </div> <div id="search"> <a class="full_list_link" id="class_list_link" href="../class_list.html"> <svg width="24" height="24"> <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect> <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect> <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect> </svg> </a> </div> <div class="clear"></div> </div> <div id="content"><h1>Class: Discorb::VoiceState </h1> <div class="box_info"> <dl> <dt>Inherits:</dt> <dd> <span class="inheritName"><span class='object_link'><a href="DiscordModel.html" title="Discorb::DiscordModel (class)">DiscordModel</a></span></span> <ul class="fullTree"> <li>Object</li> <li class="next"><span class='object_link'><a href="DiscordModel.html" title="Discorb::DiscordModel (class)">DiscordModel</a></span></li> <li class="next">Discorb::VoiceState</li> </ul> <a href="#" class="inheritanceTree">show all</a> </dd> </dl> <dl> <dt>Defined in:</dt> <dd>lib/discorb/voice_state.rb</dd> </dl> </div> <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2> <ul class="summary"> <li class="public "> <span class="summary_signature"> <a href="#channel-instance_method" title="#channel (instance method)">#<strong>channel</strong> ⇒ nil, Discorb::Channel </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#deaf%3F-instance_method" title="#deaf? (instance method)">#<strong>deaf?</strong> ⇒ Boolean </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>Whether the user is deafened.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#guild-instance_method" title="#guild (instance method)">#<strong>guild</strong> ⇒ nil, Discorb::Guild </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#member-instance_method" title="#member (instance method)">#<strong>member</strong> ⇒ Discorb::Member </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>The member associated with this voice state.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#mute%3F-instance_method" title="#mute? (instance method)">#<strong>mute?</strong> ⇒ Boolean </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>Whether the user is muted.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#request_to_speak_timestamp-instance_method" title="#request_to_speak_timestamp (instance method)">#<strong>request_to_speak_timestamp</strong> ⇒ Time </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>The time at which the user requested to speak.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#self_deaf-instance_method" title="#self_deaf (instance method)">#<strong>self_deaf</strong> ⇒ Boolean </a> (also: #self_deaf?) </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>Whether the user is deafened.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#self_mute-instance_method" title="#self_mute (instance method)">#<strong>self_mute</strong> ⇒ Boolean </a> (also: #self_mute?) </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>Whether the user is muted.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#self_stream-instance_method" title="#self_stream (instance method)">#<strong>self_stream</strong> ⇒ Boolean </a> (also: #stream?) </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>Whether the user is streaming.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#self_video-instance_method" title="#self_video (instance method)">#<strong>self_video</strong> ⇒ Boolean </a> (also: #video?) </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>Whether the user is video-enabled.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#server_deaf%3F-instance_method" title="#server_deaf? (instance method)">#<strong>server_deaf?</strong> ⇒ Boolean </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>Whether the user is deafened on the server.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#server_mute%3F-instance_method" title="#server_mute? (instance method)">#<strong>server_mute?</strong> ⇒ Boolean </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>Whether the user is muted on the server.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#session_id-instance_method" title="#session_id (instance method)">#<strong>session_id</strong> ⇒ Discorb::Snowflake </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>The ID of the guild this voice state is for.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#suppress-instance_method" title="#suppress (instance method)">#<strong>suppress</strong> ⇒ Boolean </a> (also: #suppress?) </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>Whether the user is suppressed.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#user-instance_method" title="#user (instance method)">#<strong>user</strong> ⇒ nil, Discorb::User </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'></div></span> </li> </ul> <h2>Method Summary</h2> <h3 class="inherited">Methods inherited from <span class='object_link'><a href="DiscordModel.html" title="Discorb::DiscordModel (class)">DiscordModel</a></span></h3> <p class="inherited"><span class='object_link'><a href="DiscordModel.html#==-instance_method" title="Discorb::DiscordModel#== (method)">#==</a></span>, <span class='object_link'><a href="DiscordModel.html#eql%3F-instance_method" title="Discorb::DiscordModel#eql? (method)">#eql?</a></span>, <span class='object_link'><a href="DiscordModel.html#hash-instance_method" title="Discorb::DiscordModel#hash (method)">#hash</a></span></p> <div id="instance_attr_details" class="attr_details"> <h2>Instance Attribute Details</h2> <span id=""></span> <div class="method_details first"> <h3 class="signature first" id="channel-instance_method"> #<strong>channel</strong> ⇒ <tt>nil</tt>, <tt><span class='object_link'><a href="Channel.html" title="Discorb::Channel (class)">Discorb::Channel</a></span></tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <div class="note notetag"> <strong>Note:</strong> <div class='inline'><p>This method returns an object from client cache. it will return <code>nil</code> if the object is not in cache.</p> </div> </div> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>nil</tt>)</span> — <div class='inline'><p>The object wasn't cached.</p> </div> </li> <li> <span class='type'>(<tt><span class='object_link'><a href="Channel.html" title="Discorb::Channel (class)">Discorb::Channel</a></span></tt>)</span> — <div class='inline'><p>The channel this voice state is for.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> </pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/voice_state.rb', line 28</span> </pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="deaf?-instance_method"> #<strong>deaf?</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns Whether the user is deafened.</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Boolean</tt>)</span> — <div class='inline'><p>Whether the user is deafened.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> </pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/voice_state.rb', line 28</span> </pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="guild-instance_method"> #<strong>guild</strong> ⇒ <tt>nil</tt>, <tt><span class='object_link'><a href="Guild.html" title="Discorb::Guild (class)">Discorb::Guild</a></span></tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <div class="note notetag"> <strong>Note:</strong> <div class='inline'><p>This method returns an object from client cache. it will return <code>nil</code> if the object is not in cache.</p> </div> </div> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>nil</tt>)</span> — <div class='inline'><p>The object wasn't cached.</p> </div> </li> <li> <span class='type'>(<tt><span class='object_link'><a href="Guild.html" title="Discorb::Guild (class)">Discorb::Guild</a></span></tt>)</span> — <div class='inline'><p>The guild this voice state is for.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> </pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/voice_state.rb', line 28</span> </pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="member-instance_method"> #<strong>member</strong> ⇒ <tt><span class='object_link'><a href="Member.html" title="Discorb::Member (class)">Discorb::Member</a></span></tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns The member associated with this voice state.</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt><span class='object_link'><a href="Member.html" title="Discorb::Member (class)">Discorb::Member</a></span></tt>)</span> — <div class='inline'><p>The member associated with this voice state.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 6 7 8</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/voice_state.rb', line 6</span> <span class='kw'>def</span> <span class='id identifier rubyid_member'>member</span> <span class='ivar'>@member</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="mute?-instance_method"> #<strong>mute?</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns Whether the user is muted.</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Boolean</tt>)</span> — <div class='inline'><p>Whether the user is muted.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> </pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/voice_state.rb', line 28</span> </pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="request_to_speak_timestamp-instance_method"> #<strong>request_to_speak_timestamp</strong> ⇒ <tt><span class='object_link'><a href="../Time.html" title="Time (class)">Time</a></span></tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns The time at which the user requested to speak.</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt><span class='object_link'><a href="../Time.html" title="Time (class)">Time</a></span></tt>)</span> — <div class='inline'><p>The time at which the user requested to speak.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 10 11 12</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/voice_state.rb', line 10</span> <span class='kw'>def</span> <span class='id identifier rubyid_request_to_speak_timestamp'>request_to_speak_timestamp</span> <span class='ivar'>@request_to_speak_timestamp</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="self_deaf-instance_method"> #<strong>self_deaf</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span> <span class="aliases">Also known as: <span class="names"><span id='self_deaf?-instance_method'>self_deaf?</span></span> </span> </h3><div class="docstring"> <div class="discussion"> <p>Returns Whether the user is deafened.</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Boolean</tt>)</span> — <div class='inline'><p>Whether the user is deafened.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 12 13 14</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/voice_state.rb', line 12</span> <span class='kw'>def</span> <span class='id identifier rubyid_self_deaf'>self_deaf</span> <span class='ivar'>@self_deaf</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="self_mute-instance_method"> #<strong>self_mute</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span> <span class="aliases">Also known as: <span class="names"><span id='self_mute?-instance_method'>self_mute?</span></span> </span> </h3><div class="docstring"> <div class="discussion"> <p>Returns Whether the user is muted.</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Boolean</tt>)</span> — <div class='inline'><p>Whether the user is muted.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 15 16 17</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/voice_state.rb', line 15</span> <span class='kw'>def</span> <span class='id identifier rubyid_self_mute'>self_mute</span> <span class='ivar'>@self_mute</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="self_stream-instance_method"> #<strong>self_stream</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span> <span class="aliases">Also known as: <span class="names"><span id='stream?-instance_method'>stream?</span></span> </span> </h3><div class="docstring"> <div class="discussion"> <p>Returns Whether the user is streaming.</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Boolean</tt>)</span> — <div class='inline'><p>Whether the user is streaming.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 18 19 20</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/voice_state.rb', line 18</span> <span class='kw'>def</span> <span class='id identifier rubyid_self_stream'>self_stream</span> <span class='ivar'>@self_stream</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="self_video-instance_method"> #<strong>self_video</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span> <span class="aliases">Also known as: <span class="names"><span id='video?-instance_method'>video?</span></span> </span> </h3><div class="docstring"> <div class="discussion"> <p>Returns Whether the user is video-enabled.</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Boolean</tt>)</span> — <div class='inline'><p>Whether the user is video-enabled.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 22 23 24</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/voice_state.rb', line 22</span> <span class='kw'>def</span> <span class='id identifier rubyid_self_video'>self_video</span> <span class='ivar'>@self_video</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="server_deaf?-instance_method"> #<strong>server_deaf?</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns Whether the user is deafened on the server.</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Boolean</tt>)</span> — <div class='inline'><p>Whether the user is deafened on the server.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> </pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/voice_state.rb', line 28</span> </pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="server_mute?-instance_method"> #<strong>server_mute?</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns Whether the user is muted on the server.</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Boolean</tt>)</span> — <div class='inline'><p>Whether the user is muted on the server.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> </pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/voice_state.rb', line 28</span> </pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="session_id-instance_method"> #<strong>session_id</strong> ⇒ <tt><span class='object_link'><a href="Snowflake.html" title="Discorb::Snowflake (class)">Discorb::Snowflake</a></span></tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns The ID of the guild this voice state is for.</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt><span class='object_link'><a href="Snowflake.html" title="Discorb::Snowflake (class)">Discorb::Snowflake</a></span></tt>)</span> — <div class='inline'><p>The ID of the guild this voice state is for.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 8 9 10</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/voice_state.rb', line 8</span> <span class='kw'>def</span> <span class='id identifier rubyid_session_id'>session_id</span> <span class='ivar'>@session_id</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="suppress-instance_method"> #<strong>suppress</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span> <span class="aliases">Also known as: <span class="names"><span id='suppress?-instance_method'>suppress?</span></span> </span> </h3><div class="docstring"> <div class="discussion"> <p>Returns Whether the user is suppressed. (Is at audience).</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Boolean</tt>)</span> — <div class='inline'><p>Whether the user is suppressed. (Is at audience)</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 25 26 27</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/voice_state.rb', line 25</span> <span class='kw'>def</span> <span class='id identifier rubyid_suppress'>suppress</span> <span class='ivar'>@suppress</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="user-instance_method"> #<strong>user</strong> ⇒ <tt>nil</tt>, <tt><span class='object_link'><a href="User.html" title="Discorb::User (class)">Discorb::User</a></span></tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <div class="note notetag"> <strong>Note:</strong> <div class='inline'><p>This method returns an object from client cache. it will return <code>nil</code> if the object is not in cache.</p> </div> </div> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>nil</tt>)</span> — <div class='inline'><p>The object wasn't cached.</p> </div> </li> <li> <span class='type'>(<tt><span class='object_link'><a href="User.html" title="Discorb::User (class)">Discorb::User</a></span></tt>)</span> — <div class='inline'><p>The user this voice state is for.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> </pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/voice_state.rb', line 28</span> </pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated from <a href="https://github.com/discorb-lib/discorb/tree/b7303de88fddee34560510a2749c371c7f17b4da"><code>b7303de88fddee34560510a2749c371c7f17b4da</code></a>, version v0.0.3, with YARD 0.9.26. </div> </div> </body> </html>