<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Discorb::Sticker::GuildSticker
— 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::Sticker::GuildSticker";
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'><span class='object_link'><a href="../Sticker.html" title="Discorb::Sticker (class)">Sticker</a></span></span>
»
<span class="title">GuildSticker</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::Sticker::GuildSticker
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="../Sticker.html" title="Discorb::Sticker (class)">Discorb::Sticker</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"><span class='object_link'><a href="../Sticker.html" title="Discorb::Sticker (class)">Discorb::Sticker</a></span></li>
<li class="next">Discorb::Sticker::GuildSticker</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/discorb/sticker.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Represents a sticker of guilds.</p>
</div>
</div>
<div class="tags">
</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="#guild-instance_method" title="#guild (instance method)">#<strong>guild</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Sticker.html" title="Discorb::Sticker (class)">Discorb::Sticker</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Sticker.html#available-instance_method" title="Discorb::Sticker#available (method)">#available</a></span>, <span class='object_link'><a href="../Sticker.html#description-instance_method" title="Discorb::Sticker#description (method)">#description</a></span>, <span class='object_link'><a href="../Sticker.html#format-instance_method" title="Discorb::Sticker#format (method)">#format</a></span>, <span class='object_link'><a href="../Sticker.html#guild_id-instance_method" title="Discorb::Sticker#guild_id (method)">#guild_id</a></span>, <span class='object_link'><a href="../Sticker.html#id-instance_method" title="Discorb::Sticker#id (method)">#id</a></span>, <span class='object_link'><a href="../Sticker.html#name-instance_method" title="Discorb::Sticker#name (method)">#name</a></span>, <span class='object_link'><a href="../Sticker.html#pack_id-instance_method" title="Discorb::Sticker#pack_id (method)">#pack_id</a></span>, <span class='object_link'><a href="../Sticker.html#sort_value-instance_method" title="Discorb::Sticker#sort_value (method)">#sort_value</a></span>, <span class='object_link'><a href="../Sticker.html#tags-instance_method" title="Discorb::Sticker#tags (method)">#tags</a></span>, <span class='object_link'><a href="../Sticker.html#type-instance_method" title="Discorb::Sticker#type (method)">#type</a></span>, <span class='object_link'><a href="../Sticker.html#user-instance_method" title="Discorb::Sticker#user (method)">#user</a></span></p>
<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>Deletes the sticker.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#edit-instance_method" title="#edit (instance method)">#<strong>edit</strong>(name: :unset, description: :unset, tag: :unset, reason: :unset) ⇒ Object </a>
(also: #modify)
</span>
<span class="summary_desc"><div class='inline'><p>Edits the sticker.</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="guild-instance_method">
#<strong>guild</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</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/sticker.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 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">
<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>Deletes the sticker.</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 the deletion.</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">
89
90
91
92
93</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/sticker.rb', line 89</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_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/stickers/</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'>audit_log_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="edit-instance_method">
#<strong>edit</strong>(name: :unset, description: :unset, tag: :unset, reason: :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>Edits the sticker.</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>:unset</tt>)</em>
—
<div class='inline'><p>The new name of the sticker.</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 sticker.</p>
</div>
</li>
<li>
<span class='name'>tag</span>
<span class='type'>(<tt><span class='object_link'><a href="../Emoji.html" title="Discorb::Emoji (class)">Discorb::Emoji</a></span></tt>)</span>
<em class="default">(defaults to: <tt>:unset</tt>)</em>
—
<div class='inline'><p>The new tags of the sticker.</p>
</div>
</li>
<li>
<span class='name'>reason</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>:unset</tt>)</em>
—
<div class='inline'><p>The reason for the edit.</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">
70
71
72
73
74
75
76
77
78</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/sticker.rb', line 70</span>
<span class='kw'>def</span> <span class='id identifier rubyid_edit'>edit</span><span class='lparen'>(</span><span class='label'>name:</span> <span class='symbol'>:unset</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='symbol'>:unset</span><span class='comma'>,</span> <span class='label'>tag:</span> <span class='symbol'>:unset</span><span class='comma'>,</span> <span class='label'>reason:</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'>unless</span> <span class='id identifier rubyid_name'>name</span> <span class='op'>==</span> <span class='symbol'>:unset</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'>unless</span> <span class='id identifier rubyid_description'>description</span> <span class='op'>==</span> <span class='symbol'>:unset</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:tags</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_tag'>tag</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='kw'>unless</span> <span class='id identifier rubyid_tag'>tag</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'>@guild_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/stickers/</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='id identifier rubyid_payload'>payload</span><span class='comma'>,</span> <span class='label'>audit_log_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>
</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>