<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Discorb::GuildTemplate
— 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::GuildTemplate";
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 (G)</a> »
<span class='title'><span class='object_link'><a href="../Discorb.html" title="Discorb (module)">Discorb</a></span></span>
»
<span class="title">GuildTemplate</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::GuildTemplate
</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::GuildTemplate</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/discorb/guild_template.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Represents a guild template.</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="GuildTemplate/TemplateGuild.html" title="Discorb::GuildTemplate::TemplateGuild (class)">TemplateGuild</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="#code-instance_method" title="#code (instance method)">#<strong>code</strong> ⇒ String </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The code of the template.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#created_at-instance_method" title="#created_at (instance method)">#<strong>created_at</strong> ⇒ Time </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The time this template was created.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#creator-instance_method" title="#creator (instance method)">#<strong>creator</strong> ⇒ Discorb::User </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The user who created this template.</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 description of the template.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#is_dirty-instance_method" title="#is_dirty (instance method)">#<strong>is_dirty</strong> ⇒ Boolean </a>
(also: #dirty?)
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Whether this template is dirty.</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 name of the template.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#serialized_source_guild-instance_method" title="#serialized_source_guild (instance method)">#<strong>serialized_source_guild</strong> ⇒ Discorb::GuildTemplate::TemplateGuild </a>
(also: #content)
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The guild where the template was created.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#source_guild-instance_method" title="#source_guild (instance method)">#<strong>source_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="#source_guild_id-instance_method" title="#source_guild_id (instance method)">#<strong>source_guild_id</strong> ⇒ Discorb::Guild </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The guild where the template was created.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#updated_at-instance_method" title="#updated_at (instance method)">#<strong>updated_at</strong> ⇒ Time </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The time this template was last updated.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#usage_count-instance_method" title="#usage_count (instance method)">#<strong>usage_count</strong> ⇒ Integer </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The number of times this template has been used.</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> ⇒ Object </a>
(also: #destroy!)
</span>
<span class="summary_desc"><div class='inline'><p>Delete the template.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#edit-instance_method" title="#edit (instance method)">#<strong>edit</strong>(name = nil, description = :unset) ⇒ Object </a>
(also: #modify)
</span>
<span class="summary_desc"><div class='inline'><p>Edit the template.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Update the template.</p>
</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="code-instance_method">
#<strong>code</strong> ⇒ <tt>String</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The code of the template.</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 code of the template.</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/guild_template.rb', line 9</span>
<span class='kw'>def</span> <span class='id identifier rubyid_code'>code</span>
<span class='ivar'>@code</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="created_at-instance_method">
#<strong>created_at</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 this template was created.</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 this template was created.</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/guild_template.rb', line 19</span>
<span class='kw'>def</span> <span class='id identifier rubyid_created_at'>created_at</span>
<span class='ivar'>@created_at</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="creator-instance_method">
#<strong>creator</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 who created this template.</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 who created this template.</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/guild_template.rb', line 17</span>
<span class='kw'>def</span> <span class='id identifier rubyid_creator'>creator</span>
<span class='ivar'>@creator</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 description of the template.</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 description of the template.</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/guild_template.rb', line 13</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="is_dirty-instance_method">
#<strong>is_dirty</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span>
<span class="aliases">Also known as:
<span class="names"><span id='dirty?-instance_method'>dirty?</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Whether this template is dirty.</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 this template is dirty.</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/guild_template.rb', line 28</span>
<span class='kw'>def</span> <span class='id identifier rubyid_is_dirty'>is_dirty</span>
<span class='ivar'>@is_dirty</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 name of the template.</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 name of the template.</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/guild_template.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="serialized_source_guild-instance_method">
#<strong>serialized_source_guild</strong> ⇒ <tt><span class='object_link'><a href="GuildTemplate/TemplateGuild.html" title="Discorb::GuildTemplate::TemplateGuild (class)">Discorb::GuildTemplate::TemplateGuild</a></span></tt> <span class="extras">(readonly)</span>
<span class="aliases">Also known as:
<span class="names"><span id='content-instance_method'>content</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The guild where the template was created.</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="GuildTemplate/TemplateGuild.html" title="Discorb::GuildTemplate::TemplateGuild (class)">Discorb::GuildTemplate::TemplateGuild</a></span></tt>)</span>
—
<div class='inline'><p>The guild where the template was created.</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/guild_template.rb', line 25</span>
<span class='kw'>def</span> <span class='id identifier rubyid_serialized_source_guild'>serialized_source_guild</span>
<span class='ivar'>@serialized_source_guild</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="source_guild-instance_method">
#<strong>source_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 template is based on.</p>
</div>
</li>
<li>
<span class='type'>(<tt>nil</tt>)</span>
—
<div class='inline'><p>Client wasn't able to find the guild this template is based on.</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/guild_template.rb', line 31</span>
</pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="source_guild_id-instance_method">
#<strong>source_guild_id</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 where the template was created.</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 where the template was created.</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/guild_template.rb', line 23</span>
<span class='kw'>def</span> <span class='id identifier rubyid_source_guild_id'>source_guild_id</span>
<span class='ivar'>@source_guild_id</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="updated_at-instance_method">
#<strong>updated_at</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 this template was last updated.</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 this template was last updated.</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/guild_template.rb', line 21</span>
<span class='kw'>def</span> <span class='id identifier rubyid_updated_at'>updated_at</span>
<span class='ivar'>@updated_at</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="usage_count-instance_method">
#<strong>usage_count</strong> ⇒ <tt>Integer</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The number of times this template has been used.</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 times this template has been used.</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/guild_template.rb', line 15</span>
<span class='kw'>def</span> <span class='id identifier rubyid_usage_count'>usage_count</span>
<span class='ivar'>@usage_count</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> ⇒ <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">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Delete the template.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
83
84
85
86
87</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild_template.rb', line 83</span>
<span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</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'>@source_guild_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/templates/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@code</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></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="edit-instance_method">
#<strong>edit</strong>(name = nil, description = :unset) ⇒ <tt>Object</tt>
<span class="aliases">Also known as:
<span class="names"><span id='modify-instance_method'>modify</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>The arguments of this method are defaultly set to <code>:unset</code>. Specify value to set the value, if not don't specify or specify <code>:unset</code>.</p>
</div>
</div>
<p>Edit the template.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>name</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The new name of the template.</p>
</div>
</li>
<li>
<span class='name'>description</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>:unset</tt>)</em>
—
<div class='inline'><p>The new description of the template.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
55
56
57
58
59
60
61
62</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild_template.rb', line 55</span>
<span class='kw'>def</span> <span class='id identifier rubyid_edit'>edit</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_description'>description</span> <span class='op'>=</span> <span class='symbol'>:unset</span><span class='rparen'>)</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid_payload'>payload</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span> <span class='kw'>if</span> <span class='id identifier rubyid_name'>name</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span> <span class='op'>!=</span> <span class='symbol'>:unset</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_patch'>patch</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'>@source_guild_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/templates/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@code</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_payload'>payload</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="update-instance_method">
#<strong>update</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Update the template.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
71
72
73
74
75
76</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild_template.rb', line 71</span>
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</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_put'>put</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'>@source_guild_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/templates/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@code</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='id identifier rubyid__set_data'>_set_data</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
<span class='kw'>end</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/19ae285d67a4c811bc6a8463bac2a1aca88a8667"><code>19ae285d67a4c811bc6a8463bac2a1aca88a8667</code></a>, version v0.2.0, with YARD 0.9.26.
</div>
</div>
</body>
</html>