<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Discorb::Application
— 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::Application";
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 (A)</a> »
<span class='title'><span class='object_link'><a href="../Discorb.html" title="Discorb (module)">Discorb</a></span></span>
»
<span class="title">Application</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::Application
</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::Application</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/discorb/application.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Represents a Discord application.</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="Application/Team.html" title="Discorb::Application::Team (class)">Team</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="#bot_public-instance_method" title="#bot_public (instance method)">#<strong>bot_public</strong> ⇒ Boolean </a>
(also: #bot_public?)
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Whether the application's bot is public.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#bot_require_code_grant-instance_method" title="#bot_require_code_grant (instance method)">#<strong>bot_require_code_grant</strong> ⇒ Boolean </a>
(also: #bot_require_code_grant?)
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Whether the application's bot requires a code grant.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#description-instance_method" title="#description (instance method)">#<strong>description</strong> ⇒ String </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The application's description.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#icon-instance_method" title="#icon (instance method)">#<strong>icon</strong> ⇒ Discorb::Asset </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The application's icon.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong> ⇒ Discorb::Snowflake </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The application's ID.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> ⇒ String </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The application's name.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#owner-instance_method" title="#owner (instance method)">#<strong>owner</strong> ⇒ Discorb::User </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The application's owner.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#summary-instance_method" title="#summary (instance method)">#<strong>summary</strong> ⇒ String </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The application's summary.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#team-instance_method" title="#team (instance method)">#<strong>team</strong> ⇒ Discorb::Application::Team </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The application's team.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#verify_key-instance_method" title="#verify_key (instance method)">#<strong>verify_key</strong> ⇒ String </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The application's public key.</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="bot_public-instance_method">
#<strong>bot_public</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span>
<span class="aliases">Also known as:
<span class="names"><span id='bot_public?-instance_method'>bot_public?</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Whether the application's bot is public.</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 application's bot is public.</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/application.rb', line 25</span>
<span class='kw'>def</span> <span class='id identifier rubyid_bot_public'>bot_public</span>
<span class='ivar'>@bot_public</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="bot_require_code_grant-instance_method">
#<strong>bot_require_code_grant</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span>
<span class="aliases">Also known as:
<span class="names"><span id='bot_require_code_grant?-instance_method'>bot_require_code_grant?</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Whether the application's bot requires a code grant.</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 application's bot requires a code grant.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
28
29
30</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/application.rb', line 28</span>
<span class='kw'>def</span> <span class='id identifier rubyid_bot_require_code_grant'>bot_require_code_grant</span>
<span class='ivar'>@bot_require_code_grant</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="description-instance_method">
#<strong>description</strong> ⇒ <tt>String</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The application's description.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The application's description.</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/application.rb', line 15</span>
<span class='kw'>def</span> <span class='id identifier rubyid_description'>description</span>
<span class='ivar'>@description</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="icon-instance_method">
#<strong>icon</strong> ⇒ <tt><span class='object_link'><a href="Asset.html" title="Discorb::Asset (class)">Discorb::Asset</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The application's icon.</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="Asset.html" title="Discorb::Asset (class)">Discorb::Asset</a></span></tt>)</span>
—
<div class='inline'><p>The application's icon.</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/application.rb', line 13</span>
<span class='kw'>def</span> <span class='id identifier rubyid_icon'>icon</span>
<span class='ivar'>@icon</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="id-instance_method">
#<strong>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 application's ID.</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 application's ID.</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/application.rb', line 9</span>
<span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
<span class='ivar'>@id</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="name-instance_method">
#<strong>name</strong> ⇒ <tt>String</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The application's name.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The application's name.</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/application.rb', line 11</span>
<span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
<span class='ivar'>@name</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="owner-instance_method">
#<strong>owner</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 application's owner.</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 application's owner.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
21
22
23</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/application.rb', line 21</span>
<span class='kw'>def</span> <span class='id identifier rubyid_owner'>owner</span>
<span class='ivar'>@owner</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="summary-instance_method">
#<strong>summary</strong> ⇒ <tt>String</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The application's summary.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The application's summary.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
17
18
19</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/application.rb', line 17</span>
<span class='kw'>def</span> <span class='id identifier rubyid_summary'>summary</span>
<span class='ivar'>@summary</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="team-instance_method">
#<strong>team</strong> ⇒ <tt><span class='object_link'><a href="Application/Team.html" title="Discorb::Application::Team (class)">Discorb::Application::Team</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The application's team.</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="Application/Team.html" title="Discorb::Application::Team (class)">Discorb::Application::Team</a></span></tt>)</span>
—
<div class='inline'><p>The application's team.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
23
24
25</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/application.rb', line 23</span>
<span class='kw'>def</span> <span class='id identifier rubyid_team'>team</span>
<span class='ivar'>@team</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="verify_key-instance_method">
#<strong>verify_key</strong> ⇒ <tt>String</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The application's public key.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The application's public key.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/application.rb', line 19</span>
<span class='kw'>def</span> <span class='id identifier rubyid_verify_key'>verify_key</span>
<span class='ivar'>@verify_key</span>
<span class='kw'>end</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">
47
48
49</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/application.rb', line 47</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'> id=</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</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/4168c1cd86b4804c0e98549928c53b2f117cb5ff"><code>4168c1cd86b4804c0e98549928c53b2f117cb5ff</code></a>, version v0.0.6, with YARD 0.9.26.
</div>
</div>
</body>
</html>