<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Discorb::Integration
— 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::Integration";
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 (I)</a> »
<span class='title'><span class='object_link'><a href="../Discorb.html" title="Discorb (module)">Discorb</a></span></span>
»
<span class="title">Integration</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::Integration
</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::Integration</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/discorb/integration.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Represents a integration.</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="Integration/Account.html" title="Discorb::Integration::Account (class)">Account</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="#account-instance_method" title="#account (instance method)">#<strong>account</strong> ⇒ Discorb::Integration::Account </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The account for the integration.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#application-instance_method" title="#application (instance method)">#<strong>application</strong> ⇒ Discorb::Application </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The application for the integration.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#enable_emoticons-instance_method" title="#enable_emoticons (instance method)">#<strong>enable_emoticons</strong> ⇒ Boolean </a>
(also: #enable_emoticons?)
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Whether the integration is enabled emoticons.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#enabled-instance_method" title="#enabled (instance method)">#<strong>enabled</strong> ⇒ Boolean </a>
(also: #enabled?)
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Whether the integration is enabled.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#expire_behavior-instance_method" title="#expire_behavior (instance method)">#<strong>expire_behavior</strong> ⇒ :remove_role, :kick </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The behavior of the integration when it expires.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#expire_grace_period-instance_method" title="#expire_grace_period (instance method)">#<strong>expire_grace_period</strong> ⇒ Integer </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The grace period of the integration.</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 ID of the integration.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#revoked-instance_method" title="#revoked (instance method)">#<strong>revoked</strong> ⇒ Boolean </a>
(also: #revoked?)
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Whether the integration is revoked.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#subscriber_count-instance_method" title="#subscriber_count (instance method)">#<strong>subscriber_count</strong> ⇒ Integer </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The number of subscribers for the integration.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#syncing-instance_method" title="#syncing (instance method)">#<strong>syncing</strong> ⇒ Boolean </a>
(also: #syncing?)
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Whether the integration is syncing.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#type-instance_method" title="#type (instance method)">#<strong>type</strong> ⇒ Symbol </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The type of integration.</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 for the integration.</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="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(reason: nil) ⇒ Object </a>
(also: #destroy!)
</span>
<span class="summary_desc"><div class='inline'><p>Delete the integration.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#guild-instance_method" title="#guild (instance method)">#<strong>guild</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="account-instance_method">
#<strong>account</strong> ⇒ <tt><span class='object_link'><a href="Integration/Account.html" title="Discorb::Integration::Account (class)">Discorb::Integration::Account</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The account for the integration.</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="Integration/Account.html" title="Discorb::Integration::Account (class)">Discorb::Integration::Account</a></span></tt>)</span>
—
<div class='inline'><p>The account for the integration.</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/integration.rb', line 28</span>
<span class='kw'>def</span> <span class='id identifier rubyid_account'>account</span>
<span class='ivar'>@account</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="application-instance_method">
#<strong>application</strong> ⇒ <tt><span class='object_link'><a href="Application.html" title="Discorb::Application (class)">Discorb::Application</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The application for the integration.</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.html" title="Discorb::Application (class)">Discorb::Application</a></span></tt>)</span>
—
<div class='inline'><p>The application for the integration.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
35
36
37</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/integration.rb', line 35</span>
<span class='kw'>def</span> <span class='id identifier rubyid_application'>application</span>
<span class='ivar'>@application</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="enable_emoticons-instance_method">
#<strong>enable_emoticons</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span>
<span class="aliases">Also known as:
<span class="names"><span id='enable_emoticons?-instance_method'>enable_emoticons?</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Whether the integration is enabled emoticons.</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 integration is enabled emoticons.</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/integration.rb', line 19</span>
<span class='kw'>def</span> <span class='id identifier rubyid_enable_emoticons'>enable_emoticons</span>
<span class='ivar'>@enable_emoticons</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="enabled-instance_method">
#<strong>enabled</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span>
<span class="aliases">Also known as:
<span class="names"><span id='enabled?-instance_method'>enabled?</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Whether the integration is 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 integration is enabled.</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/integration.rb', line 13</span>
<span class='kw'>def</span> <span class='id identifier rubyid_enabled'>enabled</span>
<span class='ivar'>@enabled</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="expire_behavior-instance_method">
#<strong>expire_behavior</strong> ⇒ <tt>:remove_role</tt>, <tt>:kick</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The behavior of the integration when it expires.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>:remove_role</tt>, <tt>:kick</tt>)</span>
—
<div class='inline'><p>The behavior of the integration when it expires.</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/integration.rb', line 22</span>
<span class='kw'>def</span> <span class='id identifier rubyid_expire_behavior'>expire_behavior</span>
<span class='ivar'>@expire_behavior</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="expire_grace_period-instance_method">
#<strong>expire_grace_period</strong> ⇒ <tt>Integer</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The grace period of the integration.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
—
<div class='inline'><p>The grace period of the integration.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
24
25
26</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/integration.rb', line 24</span>
<span class='kw'>def</span> <span class='id identifier rubyid_expire_grace_period'>expire_grace_period</span>
<span class='ivar'>@expire_grace_period</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 ID of the integration.</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 integration.</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/integration.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="revoked-instance_method">
#<strong>revoked</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span>
<span class="aliases">Also known as:
<span class="names"><span id='revoked?-instance_method'>revoked?</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Whether the integration is revoked.</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 integration is revoked.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
32
33
34</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/integration.rb', line 32</span>
<span class='kw'>def</span> <span class='id identifier rubyid_revoked'>revoked</span>
<span class='ivar'>@revoked</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="subscriber_count-instance_method">
#<strong>subscriber_count</strong> ⇒ <tt>Integer</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The number of subscribers for the integration.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
—
<div class='inline'><p>The number of subscribers for the integration.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
30
31
32</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/integration.rb', line 30</span>
<span class='kw'>def</span> <span class='id identifier rubyid_subscriber_count'>subscriber_count</span>
<span class='ivar'>@subscriber_count</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="syncing-instance_method">
#<strong>syncing</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span>
<span class="aliases">Also known as:
<span class="names"><span id='syncing?-instance_method'>syncing?</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Whether the integration is syncing.</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 integration is syncing.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
16
17
18</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/integration.rb', line 16</span>
<span class='kw'>def</span> <span class='id identifier rubyid_syncing'>syncing</span>
<span class='ivar'>@syncing</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="type-instance_method">
#<strong>type</strong> ⇒ <tt>Symbol</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The type of integration.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Symbol</tt>)</span>
—
<div class='inline'><p>The type of integration.</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/integration.rb', line 11</span>
<span class='kw'>def</span> <span class='id identifier rubyid_type'>type</span>
<span class='ivar'>@type</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 for the integration.</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 for the integration.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
26
27
28</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/integration.rb', line 26</span>
<span class='kw'>def</span> <span class='id identifier rubyid_user'>user</span>
<span class='ivar'>@user</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="delete!-instance_method">
#<strong>delete!</strong>(reason: nil) ⇒ <tt>Object</tt>
<span class="aliases">Also known as:
<span class="names"><span id='destroy!-instance_method'>destroy!</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Delete the integration.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>reason</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The reason for deleting the integration.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
64
65
66
67
68</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/integration.rb', line 64</span>
<span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span><span class='label'>reason:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@guild</span><span class='embexpr_end'>}</span><span class='tstring_content'>/integrations/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>reason:</span> <span class='id identifier rubyid_reason'>reason</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="guild-instance_method">
#<strong>guild</strong> ⇒ <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
55
56
57</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/integration.rb', line 55</span>
<span class='kw'>def</span> <span class='id identifier rubyid_guild'>guild</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_guilds'>guilds</span><span class='lbracket'>[</span><span class='ivar'>@guild_id</span><span class='rbracket'>]</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/b1dd9cf49ec5d42e3e3ed921f950a18a24c7a2b9"><code>b1dd9cf49ec5d42e3e3ed921f950a18a24c7a2b9</code></a>, version v0.0.7, with YARD 0.9.26.
</div>
</div>
</body>
</html>