<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Discorb::Presence
— 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::Presence";
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 (P)</a> »
<span class='title'><span class='object_link'><a href="../Discorb.html" title="Discorb (module)">Discorb</a></span></span>
»
<span class="title">Presence</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::Presence
</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::Presence</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/discorb/presence.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Represents a presence of user.</p>
</div>
</div>
<div class="tags">
</div><h2>Defined Under Namespace</h2>
<p class="children">
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Presence/Activity.html" title="Discorb::Presence::Activity (class)">Activity</a></span>, <span class='object_link'><a href="Presence/ClientStatus.html" title="Discorb::Presence::ClientStatus (class)">ClientStatus</a></span>
</p>
<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="#activities-instance_method" title="#activities (instance method)">#<strong>activities</strong> ⇒ Array<Discorb::Presence::Activity> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The activities of the user.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#activity-instance_method" title="#activity (instance method)">#<strong>activity</strong> ⇒ Discorb::Presence::Activity </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The activity of the presence.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#client_status-instance_method" title="#client_status (instance method)">#<strong>client_status</strong> ⇒ Discorb::Presence::ClientStatus </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The client status of the user.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#guild-instance_method" title="#guild (instance method)">#<strong>guild</strong> ⇒ Discorb::Guild </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The guild of the presence.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#status-instance_method" title="#status (instance method)">#<strong>status</strong> ⇒ :online, ... </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The status of the user.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#user-instance_method" title="#user (instance method)">#<strong>user</strong> ⇒ Discorb::User </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The user of the presence.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#inspect-instance_method" title="#inspect (instance method)">#<strong>inspect</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<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="activities-instance_method">
#<strong>activities</strong> ⇒ <tt>Array<<span class='object_link'><a href="Presence/Activity.html" title="Discorb::Presence::Activity (class)">Discorb::Presence::Activity</a></span>></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The activities of the user.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array<<span class='object_link'><a href="Presence/Activity.html" title="Discorb::Presence::Activity (class)">Discorb::Presence::Activity</a></span>></tt>)</span>
—
<div class='inline'><p>The activities of the user.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
11
12
13</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/presence.rb', line 11</span>
<span class='kw'>def</span> <span class='id identifier rubyid_activities'>activities</span>
<span class='ivar'>@activities</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="activity-instance_method">
#<strong>activity</strong> ⇒ <tt><span class='object_link'><a href="Presence/Activity.html" title="Discorb::Presence::Activity (class)">Discorb::Presence::Activity</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The activity of the presence.</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="Presence/Activity.html" title="Discorb::Presence::Activity (class)">Discorb::Presence::Activity</a></span></tt>)</span>
—
<div class='inline'><p>The activity of the presence.</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/presence.rb', line 15</span>
</pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="client_status-instance_method">
#<strong>client_status</strong> ⇒ <tt><span class='object_link'><a href="Presence/ClientStatus.html" title="Discorb::Presence::ClientStatus (class)">Discorb::Presence::ClientStatus</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The client status of the user.</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="Presence/ClientStatus.html" title="Discorb::Presence::ClientStatus (class)">Discorb::Presence::ClientStatus</a></span></tt>)</span>
—
<div class='inline'><p>The client status of the user.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
13
14
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/presence.rb', line 13</span>
<span class='kw'>def</span> <span class='id identifier rubyid_client_status'>client_status</span>
<span class='ivar'>@client_status</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="guild-instance_method">
#<strong>guild</strong> ⇒ <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">
<p>Returns The guild of the presence.</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="Guild.html" title="Discorb::Guild (class)">Discorb::Guild</a></span></tt>)</span>
—
<div class='inline'><p>The guild of the presence.</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/presence.rb', line 15</span>
</pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="status-instance_method">
#<strong>status</strong> ⇒ <tt>:online</tt>, ... <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The status of the user.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>:online</tt>, <tt>:idle</tt>, <tt>:dnd</tt>, <tt>:offline</tt>)</span>
—
<div class='inline'><p>The status of the user.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
9
10
11</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/presence.rb', line 9</span>
<span class='kw'>def</span> <span class='id identifier rubyid_status'>status</span>
<span class='ivar'>@status</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><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">
<p>Returns The user of the presence.</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="User.html" title="Discorb::User (class)">Discorb::User</a></span></tt>)</span>
—
<div class='inline'><p>The user of the presence.</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/presence.rb', line 15</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="inspect-instance_method">
#<strong>inspect</strong> ⇒ <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
41
42
43</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/presence.rb', line 41</span>
<span class='kw'>def</span> <span class='id identifier rubyid_inspect'>inspect</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>#<</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='embexpr_end'>}</span><span class='tstring_content'> @status=</span><span class='embexpr_beg'>#{</span><span class='ivar'>@status</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'> @activity=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_activity'>activity</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'>></span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated from <a href="https://github.com/discorb-lib/discorb/tree/5bbfb4d90cb927c27f3e9c25b29d739224986cd6"><code>5bbfb4d90cb927c27f3e9c25b29d739224986cd6</code></a>, version (main), with YARD 0.9.26.
</div>
</div>
</body>
</html>