<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title> Class: Discorb::GuildChannel — 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::GuildChannel"; 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">GuildChannel</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::GuildChannel <span class="abstract note title">Abstract</span> </h1> <div class="box_info"> <dl> <dt>Inherits:</dt> <dd> <span class="inheritName"><span class='object_link'><a href="Channel.html" title="Discorb::Channel (class)">Channel</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="Channel.html" title="Discorb::Channel (class)">Channel</a></span></li> <li class="next">Discorb::GuildChannel</li> </ul> <a href="#" class="inheritanceTree">show all</a> </dd> </dl> <dl> <dt>Includes:</dt> <dd>Comparable</dd> </dl> <dl> <dt>Defined in:</dt> <dd>lib/discorb/channel.rb</dd> </dl> </div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> <div class="note abstract"> <strong>This class is abstract.</strong> <div class='inline'></div> </div> <p>Represents a channel in guild.</p> </div> </div> <div class="tags"> </div><div id="subclasses"> <h2>Direct Known Subclasses</h2> <p class="children"><span class='object_link'><a href="CategoryChannel.html" title="Discorb::CategoryChannel (class)">CategoryChannel</a></span>, <span class='object_link'><a href="StageChannel.html" title="Discorb::StageChannel (class)">StageChannel</a></span>, <span class='object_link'><a href="TextChannel.html" title="Discorb::TextChannel (class)">TextChannel</a></span>, <span class='object_link'><a href="VoiceChannel.html" title="Discorb::VoiceChannel (class)">VoiceChannel</a></span></p> </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="#permission_overwrites-instance_method" title="#permission_overwrites (instance method)">#<strong>permission_overwrites</strong> ⇒ Hash{Discorb::Role, Discorb::Member => PermissionOverwrite} </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>The permission overwrites of the channel.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#position-instance_method" title="#position (instance method)">#<strong>position</strong> ⇒ Integer </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>The position of the channel as integer.</p> </div></span> </li> </ul> <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Channel.html" title="Discorb::Channel (class)">Channel</a></span></h3> <p class="inherited"><span class='object_link'><a href="Channel.html#id-instance_method" title="Discorb::Channel#id (method)">#id</a></span>, <span class='object_link'><a href="Channel.html#name-instance_method" title="Discorb::Channel#name (method)">#name</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="#<=>-instance_method" title="#<=> (instance method)">#<strong><=></strong>(other) ⇒ -1, 1 </a> </span> <span class="summary_desc"><div class='inline'><p>Compares position of two channels.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#==-instance_method" title="#== (instance method)">#<strong>==</strong>(other) ⇒ Boolean </a> </span> <span class="summary_desc"><div class='inline'><p>Checks if the channel is same as another.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(reason: nil) ⇒ self </a> (also: #close!, #destroy!) </span> <span class="summary_desc"><div class='inline'><p>Deletes the channel.</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> <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> <li class="public "> <span class="summary_signature"> <a href="#mention-instance_method" title="#mention (instance method)">#<strong>mention</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#move-instance_method" title="#move (instance method)">#<strong>move</strong>(position, lock_permissions: false, parent: :unset, reason: nil) ⇒ self </a> </span> <span class="summary_desc"><div class='inline'><p>Moves the channel to another position.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#parent-instance_method" title="#parent (instance method)">#<strong>parent</strong> ⇒ Object </a> (also: #category) </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong> ⇒ String </a> </span> <span class="summary_desc"><div class='inline'><p>Stringifies the channel.</p> </div></span> </li> </ul> <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Channel.html" title="Discorb::Channel (class)">Channel</a></span></h3> <p class="inherited"><span class='object_link'><a href="Channel.html#type-instance_method" title="Discorb::Channel#type (method)">#type</a></span></p> <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#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="permission_overwrites-instance_method"> #<strong>permission_overwrites</strong> ⇒ <tt>Hash{<span class='object_link'><a href="Role.html" title="Discorb::Role (class)">Discorb::Role</a></span>, <span class='object_link'><a href="Member.html" title="Discorb::Member (class)">Discorb::Member</a></span> => <span class='object_link'><a href="PermissionOverwrite.html" title="Discorb::PermissionOverwrite (class)">PermissionOverwrite</a></span>}</tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns The permission overwrites of the channel.</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Hash{<span class='object_link'><a href="Role.html" title="Discorb::Role (class)">Discorb::Role</a></span>, <span class='object_link'><a href="Member.html" title="Discorb::Member (class)">Discorb::Member</a></span> => <span class='object_link'><a href="PermissionOverwrite.html" title="Discorb::PermissionOverwrite (class)">PermissionOverwrite</a></span>}</tt>)</span> — <div class='inline'><p>The permission overwrites of the channel.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 95 96 97</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 95</span> <span class='kw'>def</span> <span class='id identifier rubyid_permission_overwrites'>permission_overwrites</span> <span class='ivar'>@permission_overwrites</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="position-instance_method"> #<strong>position</strong> ⇒ <tt>Integer</tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns The position of the channel as integer.</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 position of the channel as integer.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 93 94 95</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 93</span> <span class='kw'>def</span> <span class='id identifier rubyid_position'>position</span> <span class='ivar'>@position</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="<=>-instance_method"> #<strong><=></strong>(other) ⇒ <tt>-1</tt>, <tt>1</tt> </h3><div class="docstring"> <div class="discussion"> <p>Compares position of two channels.</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>other</span> <span class='type'>(<tt><span class='object_link'><a href="" title="Discorb::GuildChannel (class)">Discorb::GuildChannel</a></span></tt>)</span> — <div class='inline'><p>The channel to compare.</p> </div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>-1</tt>, <tt>1</tt>)</span> — <div class='inline'><p>-1 if the channel is at lower than the other, 1 if the channel is at highter than the other.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 119 120 121 122 123</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 119</span> <span class='kw'>def</span> <span class='op'><=></span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span> <span class='kw'>return</span> <span class='int'>0</span> <span class='kw'>unless</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:position</span><span class='rparen'>)</span> <span class='ivar'>@position</span> <span class='op'><=></span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_position'>position</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="==-instance_method"> #<strong>==</strong>(other) ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> <p>Checks if the channel is same as another.</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>other</span> <span class='type'>(<tt><span class='object_link'><a href="" title="Discorb::GuildChannel (class)">Discorb::GuildChannel</a></span></tt>)</span> — <div class='inline'><p>The channel to check.</p> </div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Boolean</tt>)</span> — <div class='inline'><p><code>true</code> if the channel is same as another.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 132 133 134 135 136</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 132</span> <span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span> <span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>unless</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:id</span><span class='rparen'>)</span> <span class='ivar'>@id</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="delete!-instance_method"> #<strong>delete!</strong>(reason: nil) ⇒ <tt>self</tt> <span class="aliases">Also known as: <span class="names"><span id='close!-instance_method'>close!</span>, <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 channel.</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 of deleting the channel.</p> </div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>self</tt>)</span> — <div class='inline'><p>The deleted channel.</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"> 176 177 178 179 180 181 182</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 176</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='id identifier rubyid_base_url'>base_url</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</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='ivar'>@deleted</span> <span class='op'>=</span> <span class='kw'>true</span> <span class='kw'>self</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"> 159 160 161</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 159</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 class="method_details "> <h3 class="signature " id="inspect-instance_method"> #<strong>inspect</strong> ⇒ <tt>Object</tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 163 164 165</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 163</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'> \"#</span><span class='embexpr_beg'>#{</span><span class='ivar'>@name</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 class="method_details "> <h3 class="signature " id="mention-instance_method"> #<strong>mention</strong> ⇒ <tt>Object</tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 147 148 149</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 147</span> <span class='kw'>def</span> <span class='id identifier rubyid_mention'>mention</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'><#</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 class="method_details "> <h3 class="signature " id="move-instance_method"> #<strong>move</strong>(position, lock_permissions: false, parent: :unset, reason: nil) ⇒ <tt>self</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>Moves the channel to another position.</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>position</span> <span class='type'>(<tt>Integer</tt>)</span> — <div class='inline'><p>The position to move the channel.</p> </div> </li> <li> <span class='name'>lock_permissions</span> <span class='type'>(<tt>Boolean</tt>)</span> <em class="default">(defaults to: <tt>false</tt>)</em> — <div class='inline'><p>Whether to lock the permissions of the channel.</p> </div> </li> <li> <span class='name'>parent</span> <span class='type'>(<tt><span class='object_link'><a href="CategoryChannel.html" title="Discorb::CategoryChannel (class)">Discorb::CategoryChannel</a></span></tt>)</span> <em class="default">(defaults to: <tt>:unset</tt>)</em> — <div class='inline'><p>The parent of channel.</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 of moving the channel.</p> </div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>self</tt>)</span> — <div class='inline'><p>The moved channel.</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"> 199 200 201 202 203 204 205 206 207 208</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 199</span> <span class='kw'>def</span> <span class='id identifier rubyid_move'>move</span><span class='lparen'>(</span><span class='id identifier rubyid_position'>position</span><span class='comma'>,</span> <span class='label'>lock_permissions:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>parent:</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='label'>position:</span> <span class='id identifier rubyid_position'>position</span><span class='comma'>,</span> <span class='rbrace'>}</span> <span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:lock_permissions</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_lock_permissions'>lock_permissions</span> <span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:parent_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_parent'>parent</span><span class='op'>&.</span><span class='id identifier rubyid_id'>id</span> <span class='kw'>if</span> <span class='id identifier rubyid_parent'>parent</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'>/channels</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="parent-instance_method"> #<strong>parent</strong> ⇒ <tt>Object</tt> <span class="aliases">Also known as: <span class="names"><span id='category-instance_method'>category</span></span> </span> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 151 152 153 154 155</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 151</span> <span class='kw'>def</span> <span class='id identifier rubyid_parent'>parent</span> <span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>unless</span> <span class='ivar'>@parent_id</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_channels'>channels</span><span class='lbracket'>[</span><span class='ivar'>@parent_id</span><span class='rbracket'>]</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="to_s-instance_method"> #<strong>to_s</strong> ⇒ <tt>String</tt> </h3><div class="docstring"> <div class="discussion"> <p>Stringifies the channel.</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 channel with <code>#</code>.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 143 144 145</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 143</span> <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>#</span><span class='embexpr_beg'>#{</span><span class='ivar'>@name</span><span class='embexpr_end'>}</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>