<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Discorb::WelcomeScreen::Channel
— 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::WelcomeScreen::Channel";
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 (C)</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="../WelcomeScreen.html" title="Discorb::WelcomeScreen (class)">WelcomeScreen</a></span></span>
»
<span class="title">Channel</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::WelcomeScreen::Channel
</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::WelcomeScreen::Channel</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/discorb/guild.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Represents a channel to display the welcome screen.</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="#channel-instance_method" title="#channel (instance method)">#<strong>channel</strong> ⇒ nil, Discorb::Channel </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="#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 channel's name.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#emoji-instance_method" title="#emoji (instance method)">#<strong>emoji</strong> ⇒ Discorb::Emoji </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The emoji to display.</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="#edit-instance_method" title="#edit (instance method)">#<strong>edit</strong>(enabled: :unset, channels: :unset, description: :unset, reason: nil) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Edits the welcome screen.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(channel, description, emoji) ⇒ Channel </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>Initialize a new welcome screen channel.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_hash-instance_method" title="#to_hash (instance method)">#<strong>to_hash</strong> ⇒ Hash </a>
</span>
<span class="summary_desc"><div class='inline'><p>Converts the channel to a hash.</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="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(channel, description, emoji) ⇒ <tt><span class='object_link'><a href="" title="Discorb::WelcomeScreen::Channel (class)">Channel</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Initialize a new welcome screen channel.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>channel</span>
<span class='type'>(<tt><span class='object_link'><a href="../TextChannel.html" title="Discorb::TextChannel (class)">Discorb::TextChannel</a></span></tt>)</span>
—
<div class='inline'><p>The channel to display the welcome screen.</p>
</div>
</li>
<li>
<span class='name'>description</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The channel's name.</p>
</div>
</li>
<li>
<span class='name'>emoji</span>
<span class='type'>(<tt><span class='object_link'><a href="../Emoji.html" title="Discorb::Emoji (class)">Discorb::Emoji</a></span></tt>)</span>
—
<div class='inline'><p>The emoji to display.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 1174</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_channel'>channel</span><span class='comma'>,</span> <span class='id identifier rubyid_description'>description</span><span class='comma'>,</span> <span class='id identifier rubyid_emoji'>emoji</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
<span class='ivar'>@screen</span> <span class='op'>=</span> <span class='id identifier rubyid_channel'>channel</span>
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span>
<span class='ivar'>@channel_id</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Snowflake.html" title="Discorb::Snowflake (class)">Snowflake</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:channel_id</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='ivar'>@description</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span>
<span class='ivar'>@emoji_id</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Snowflake.html" title="Discorb::Snowflake (class)">Snowflake</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:emoji_id</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='ivar'>@emoji_name</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:emoji_name</span><span class='rbracket'>]</span>
<span class='kw'>else</span>
<span class='ivar'>@channel_id</span> <span class='op'>=</span> <span class='id identifier rubyid_channel'>channel</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span>
<span class='ivar'>@description</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span>
<span class='kw'>if</span> <span class='id identifier rubyid_emoji'>emoji</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../UnicodeEmoji.html" title="Discorb::UnicodeEmoji (class)">UnicodeEmoji</a></span></span><span class='rparen'>)</span>
<span class='ivar'>@emoji_id</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='ivar'>@emoji_name</span> <span class='op'>=</span> <span class='id identifier rubyid_emoji'>emoji</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span>
<span class='kw'>else</span>
<span class='ivar'>@emoji_id</span> <span class='op'>=</span> <span class='id identifier rubyid_emoji'>emoji</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span>
<span class='ivar'>@emoji_name</span> <span class='op'>=</span> <span class='id identifier rubyid_emoji'>emoji</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<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="channel-instance_method">
#<strong>channel</strong> ⇒ <tt>nil</tt>, <tt><span class='object_link'><a href="../Channel.html" title="Discorb::Channel (class)">Discorb::Channel</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="../Channel.html" title="Discorb::Channel (class)">Discorb::Channel</a></span></tt>)</span>
—
<div class='inline'><p>The channel to display the welcome screen.</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.rb', line 1161</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 channel'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 channel's name.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1159
1160
1161</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 1159</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="emoji-instance_method">
#<strong>emoji</strong> ⇒ <tt><span class='object_link'><a href="../Emoji.html" title="Discorb::Emoji (class)">Discorb::Emoji</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The emoji to display.</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="../Emoji.html" title="Discorb::Emoji (class)">Discorb::Emoji</a></span></tt>)</span>
—
<div class='inline'><p>The emoji to display.</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.rb', line 1161</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="edit-instance_method">
#<strong>edit</strong>(enabled: :unset, channels: :unset, description: :unset, reason: nil) ⇒ <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>
<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 welcome screen.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>enabled</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>:unset</tt>)</em>
—
<div class='inline'><p>Whether the welcome screen is enabled.</p>
</div>
</li>
<li>
<span class='name'>channels</span>
<span class='type'>(<tt>Array<<span class='object_link'><a href="" title="Discorb::WelcomeScreen::Channel (class)">Discorb::WelcomeScreen::Channel</a></span>></tt>)</span>
<em class="default">(defaults to: <tt>:unset</tt>)</em>
—
<div class='inline'><p>The channels to display the welcome screen.</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 description of the welcome screen.</p>
</div>
</li>
<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 editing the welcome screen.</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">
1233
1234
1235
1236
1237
1238
1239
1240
1241</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 1233</span>
<span class='kw'>def</span> <span class='id identifier rubyid_edit'>edit</span><span class='lparen'>(</span><span class='label'>enabled:</span> <span class='symbol'>:unset</span><span class='comma'>,</span> <span class='label'>channels:</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'>reason:</span> <span class='kw'>nil</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'>:enabled</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_enabled'>enabled</span> <span class='kw'>unless</span> <span class='id identifier rubyid_enabled'>enabled</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'>:welcome_channels</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_channels'>channels</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:to_hash</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_channels'>channels</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='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</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/welcome-screen</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 class="method_details ">
<h3 class="signature " id="to_hash-instance_method">
#<strong>to_hash</strong> ⇒ <tt>Hash</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Converts the channel to a hash.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Hash</tt>)</span>
—
<div class='inline'><p>The hash.</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><a href="https://discord.com/developers/docs/resources/guild#welcome-screen-object" target="_parent" title="https://discord.com/developers/docs/resources/guild#welcome-screen-object">https://discord.com/developers/docs/resources/guild#welcome-screen-object</a></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1201
1202
1203
1204
1205
1206
1207
1208</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 1201</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_hash'>to_hash</span>
<span class='lbrace'>{</span>
<span class='label'>channel_id:</span> <span class='ivar'>@channel_id</span><span class='comma'>,</span>
<span class='label'>description:</span> <span class='ivar'>@description</span><span class='comma'>,</span>
<span class='label'>emoji_id:</span> <span class='ivar'>@emoji_id</span><span class='comma'>,</span>
<span class='label'>emoji_name:</span> <span class='ivar'>@emoji_name</span><span class='comma'>,</span>
<span class='rbrace'>}</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/92458538de1b949348a05adf9b6a71df0e532cc8"><code>92458538de1b949348a05adf9b6a71df0e532cc8</code></a>, version v0.2.2, with YARD 0.9.26.
</div>
</div>
</body>
</html>