<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Discorb::ThreadChannel
— 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::ThreadChannel";
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 (T)</a> »
<span class='title'><span class='object_link'><a href="../Discorb.html" title="Discorb (module)">Discorb</a></span></span>
»
<span class="title">ThreadChannel</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::ThreadChannel
<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::ThreadChannel</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd><span class='object_link'><a href="Messageable.html" title="Discorb::Messageable (module)">Messageable</a></span></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 thread.</p>
</div>
</div>
<div class="tags">
</div><div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="ThreadChannel/Private.html" title="Discorb::ThreadChannel::Private (class)">Private</a></span>, <span class='object_link'><a href="ThreadChannel/Public.html" title="Discorb::ThreadChannel::Public (class)">Public</a></span></p>
</div>
<h2>Defined Under Namespace</h2>
<p class="children">
<strong class="classes">Classes:</strong> <span class='object_link'><a href="ThreadChannel/Member.html" title="Discorb::ThreadChannel::Member (class)">Member</a></span>, <span class='object_link'><a href="ThreadChannel/Private.html" title="Discorb::ThreadChannel::Private (class)">Private</a></span>, <span class='object_link'><a href="ThreadChannel/Public.html" title="Discorb::ThreadChannel::Public (class)">Public</a></span>
</p>
<h2>Class 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_type-class_method" title="channel_type (class method)">.<strong>channel_type</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute channel_type.</p>
</div></span>
</li>
</ul>
<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="#archived-instance_method" title="#archived (instance method)">#<strong>archived</strong> ⇒ Boolean </a>
(also: #archived?)
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Whether the thread is archived or not.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#archived_timestamp-instance_method" title="#archived_timestamp (instance method)">#<strong>archived_timestamp</strong> ⇒ Time<sup>?</sup> </a>
(also: #archived_at)
</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="#auto_archive_duration-instance_method" title="#auto_archive_duration (instance method)">#<strong>auto_archive_duration</strong> ⇒ Integer </a>
(also: #archive_in)
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Auto archive duration in seconds.</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 channel.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#member_count-instance_method" title="#member_count (instance method)">#<strong>member_count</strong> ⇒ Integer </a>
(also: #recipient_count)
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The number of recipients in the thread.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#members-instance_method" title="#members (instance method)">#<strong>members</strong> ⇒ Array<Discorb::ThreadChannel::Member> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The members of the thread.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#message_count-instance_method" title="#message_count (instance method)">#<strong>message_count</strong> ⇒ Integer </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The number of messages in the thread.</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 thread.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#rate_limit_per_user-instance_method" title="#rate_limit_per_user (instance method)">#<strong>rate_limit_per_user</strong> ⇒ Integer </a>
(also: #slowmode)
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The rate limit per user (slowmode) in the thread.</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="#add_member-instance_method" title="#add_member (instance method)">#<strong>add_member</strong>(member = :me) ⇒ Object </a>
(also: #join)
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#archive-instance_method" title="#archive (instance method)">#<strong>archive</strong>(reason: nil) ⇒ self </a>
</span>
<span class="summary_desc"><div class='inline'><p>Helper method to archive the thread.</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, archived: :unset, auto_archive_duration: :unset, archive_in: :unset, locked: :unset, reason: nil) ⇒ self </a>
</span>
<span class="summary_desc"><div class='inline'><p>Edit the thread.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fetch_members-instance_method" title="#fetch_members (instance method)">#<strong>fetch_members</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></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="#joined%3F-instance_method" title="#joined? (instance method)">#<strong>joined?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#lock-instance_method" title="#lock (instance method)">#<strong>lock</strong>(reason: nil) ⇒ self </a>
</span>
<span class="summary_desc"><div class='inline'><p>Helper method to lock the thread.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#me-instance_method" title="#me (instance method)">#<strong>me</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#owner-instance_method" title="#owner (instance method)">#<strong>owner</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></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: #channel)
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#remove_member-instance_method" title="#remove_member (instance method)">#<strong>remove_member</strong>(member = :me) ⇒ Object </a>
(also: #leave)
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#unarchive-instance_method" title="#unarchive (instance method)">#<strong>unarchive</strong>(reason: nil) ⇒ self </a>
</span>
<span class="summary_desc"><div class='inline'><p>Helper method to unarchive the thread.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#unlock-instance_method" title="#unlock (instance method)">#<strong>unlock</strong>(reason: nil) ⇒ self </a>
</span>
<span class="summary_desc"><div class='inline'><p>Helper method to unlock the thread.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="Messageable.html" title="Discorb::Messageable (module)">Messageable</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Messageable.html#fetch_message-instance_method" title="Discorb::Messageable#fetch_message (method)">#fetch_message</a></span>, <span class='object_link'><a href="Messageable.html#fetch_messages-instance_method" title="Discorb::Messageable#fetch_messages (method)">#fetch_messages</a></span>, <span class='object_link'><a href="Messageable.html#post-instance_method" title="Discorb::Messageable#post (method)">#post</a></span>, <span class='object_link'><a href="Messageable.html#typing-instance_method" title="Discorb::Messageable#typing (method)">#typing</a></span></p>
<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#==-instance_method" title="Discorb::Channel#== (method)">#==</a></span>, <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#==-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="class_attr_details" class="attr_details">
<h2>Class Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="channel_type-class_method">
.<strong>channel_type</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute channel_type.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
987
988
989</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 987</span>
<span class='kw'>def</span> <span class='id identifier rubyid_channel_type'>channel_type</span>
<span class='ivar'>@channel_type</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="archived-instance_method">
#<strong>archived</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span>
<span class="aliases">Also known as:
<span class="names"><span id='archived?-instance_method'>archived?</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Whether the thread is archived or not.</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 thread is archived or not.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
821
822
823</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 821</span>
<span class='kw'>def</span> <span class='id identifier rubyid_archived'>archived</span>
<span class='ivar'>@archived</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="archived_timestamp-instance_method">
#<strong>archived_timestamp</strong> ⇒ <tt><span class='object_link'><a href="../Time.html" title="Time (class)">Time</a></span></tt><sup>?</sup> <span class="extras">(readonly)</span>
<span class="aliases">Also known as:
<span class="names"><span id='archived_at-instance_method'>archived_at</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
</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 the thread was archived.</p>
</div>
</li>
<li>
<span class='type'>(<tt>nil</tt>)</span>
—
<div class='inline'><p>If the thread is not archived.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
815
816
817</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 815</span>
<span class='kw'>def</span> <span class='id identifier rubyid_archived_timestamp'>archived_timestamp</span>
<span class='ivar'>@archived_timestamp</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="auto_archive_duration-instance_method">
#<strong>auto_archive_duration</strong> ⇒ <tt>Integer</tt> <span class="extras">(readonly)</span>
<span class="aliases">Also known as:
<span class="names"><span id='archive_in-instance_method'>archive_in</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Auto archive duration in seconds.</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>Auto archive duration in seconds.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
818
819
820</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 818</span>
<span class='kw'>def</span> <span class='id identifier rubyid_auto_archive_duration'>auto_archive_duration</span>
<span class='ivar'>@auto_archive_duration</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">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This ID is same as the starter message's ID</p>
</div>
</div>
<p>Returns The ID of the channel.</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 channel.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
798
799
800</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 798</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="member_count-instance_method">
#<strong>member_count</strong> ⇒ <tt>Integer</tt> <span class="extras">(readonly)</span>
<span class="aliases">Also known as:
<span class="names"><span id='recipient_count-instance_method'>recipient_count</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This will stop counting at 50.</p>
</div>
</div>
<p>Returns The number of recipients in the thread.</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 recipients in the thread.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
806
807
808</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 806</span>
<span class='kw'>def</span> <span class='id identifier rubyid_member_count'>member_count</span>
<span class='ivar'>@member_count</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="members-instance_method">
#<strong>members</strong> ⇒ <tt>Array<<span class='object_link'><a href="ThreadChannel/Member.html" title="Discorb::ThreadChannel::Member (class)">Discorb::ThreadChannel::Member</a></span>></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The members of the thread.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array<<span class='object_link'><a href="ThreadChannel/Member.html" title="Discorb::ThreadChannel::Member (class)">Discorb::ThreadChannel::Member</a></span>></tt>)</span>
—
<div class='inline'><p>The members of the thread.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
812
813
814</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 812</span>
<span class='kw'>def</span> <span class='id identifier rubyid_members'>members</span>
<span class='ivar'>@members</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="message_count-instance_method">
#<strong>message_count</strong> ⇒ <tt>Integer</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 will stop counting at 50.</p>
</div>
</div>
<p>Returns The number of messages in the thread.</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 messages in the thread.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
803
804
805</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 803</span>
<span class='kw'>def</span> <span class='id identifier rubyid_message_count'>message_count</span>
<span class='ivar'>@message_count</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 thread.</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 thread.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
800
801
802</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 800</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="rate_limit_per_user-instance_method">
#<strong>rate_limit_per_user</strong> ⇒ <tt>Integer</tt> <span class="extras">(readonly)</span>
<span class="aliases">Also known as:
<span class="names"><span id='slowmode-instance_method'>slowmode</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The rate limit per user (slowmode) in the thread.</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 rate limit per user (slowmode) in the thread.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
809
810
811</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 809</span>
<span class='kw'>def</span> <span class='id identifier rubyid_rate_limit_per_user'>rate_limit_per_user</span>
<span class='ivar'>@rate_limit_per_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="add_member-instance_method">
#<strong>add_member</strong>(member = :me) ⇒ <tt>Object</tt>
<span class="aliases">Also known as:
<span class="names"><span id='join-instance_method'>join</span></span>
</span>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
947
948
949
950
951
952
953
954
955</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 947</span>
<span class='kw'>def</span> <span class='id identifier rubyid_add_member'>add_member</span><span class='lparen'>(</span><span class='id identifier rubyid_member'>member</span> <span class='op'>=</span> <span class='symbol'>:me</span><span class='rparen'>)</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='kw'>if</span> <span class='id identifier rubyid_member'>member</span> <span class='op'>==</span> <span class='symbol'>:me</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_internet'>internet</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/channels/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/thread-members/@me</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'>else</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_internet'>internet</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/channels/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/thread-members/</span><span class='embexpr_beg'>#{</span><span class='const'>Utils</span><span class='period'>.</span><span class='id identifier rubyid_try'>try</span><span class='lparen'>(</span><span class='id identifier rubyid_member'>member</span><span class='comma'>,</span> <span class='symbol'>:id</span><span class='rparen'>)</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>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="archive-instance_method">
#<strong>archive</strong>(reason: nil) ⇒ <tt>self</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Helper method to archive the thread.</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 archiving the thread.</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 archived thread.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
880
881
882</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 880</span>
<span class='kw'>def</span> <span class='id identifier rubyid_archive'>archive</span><span class='lparen'>(</span><span class='label'>reason:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_edit'>edit</span><span class='lparen'>(</span><span class='label'>archived:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>reason:</span> <span class='id identifier rubyid_reason'>reason</span><span class='rparen'>)</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, archived: :unset, auto_archive_duration: :unset, archive_in: :unset, locked: :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>
<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 thread.</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 name of the thread.</p>
</div>
</li>
<li>
<span class='name'>archived</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>:unset</tt>)</em>
—
<div class='inline'><p>Whether the thread is archived or not.</p>
</div>
</li>
<li>
<span class='name'>auto_archive_duration</span>
<span class='type'>(<tt>Integer</tt>)</span>
<em class="default">(defaults to: <tt>:unset</tt>)</em>
—
<div class='inline'><p>The auto archive duration in seconds.</p>
</div>
</li>
<li>
<span class='name'>archive_in</span>
<span class='type'>(<tt>Integer</tt>)</span>
<em class="default">(defaults to: <tt>:unset</tt>)</em>
—
<div class='inline'><p>Alias of <code>auto_archive_duration</code>.</p>
</div>
</li>
<li>
<span class='name'>locked</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>:unset</tt>)</em>
—
<div class='inline'><p>Whether the thread is locked or not.</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 editing the thread.</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 edited thread.</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>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#archive-instance_method" title="Discorb::ThreadChannel#archive (method)">#archive</a></span></li>
<li><span class='object_link'><a href="#lock-instance_method" title="Discorb::ThreadChannel#lock (method)">#lock</a></span></li>
<li><span class='object_link'><a href="#unarchive-instance_method" title="Discorb::ThreadChannel#unarchive (method)">#unarchive</a></span></li>
<li><span class='object_link'><a href="#unlock-instance_method" title="Discorb::ThreadChannel#unlock (method)">#unlock</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
860
861
862
863
864
865
866
867
868
869
870
871</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 860</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'>archived:</span> <span class='symbol'>:unset</span><span class='comma'>,</span> <span class='label'>auto_archive_duration:</span> <span class='symbol'>:unset</span><span class='comma'>,</span> <span class='label'>archive_in:</span> <span class='symbol'>:unset</span><span class='comma'>,</span> <span class='label'>locked:</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'>: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='op'>!=</span> <span class='symbol'>:unset</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:archived</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_archived'>archived</span> <span class='kw'>if</span> <span class='id identifier rubyid_archived'>archived</span> <span class='op'>!=</span> <span class='symbol'>:unset</span>
<span class='id identifier rubyid_auto_archive_duration'>auto_archive_duration</span> <span class='op'>||=</span> <span class='id identifier rubyid_archive_in'>archive_in</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:auto_archive_duration</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_auto_archive_duration'>auto_archive_duration</span> <span class='kw'>if</span> <span class='id identifier rubyid_auto_archive_duration'>auto_archive_duration</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'>:locked</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_locked'>locked</span> <span class='kw'>if</span> <span class='id identifier rubyid_locked'>locked</span> <span class='op'>!=</span> <span class='symbol'>:unset</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_internet'>internet</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'>/channels/</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'>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="fetch_members-instance_method">
#<strong>fetch_members</strong> ⇒ <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
971
972
973
974
975
976</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 971</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fetch_members'>fetch_members</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_internet'>internet</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/channels/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/thread-members</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_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_d'>d</span><span class='op'>|</span> <span class='ivar'>@members</span><span class='lbracket'>[</span><span class='id identifier rubyid_d'>d</span><span class='lbracket'>[</span><span class='symbol'>:id</span><span class='rbracket'>]</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="ThreadChannel/Member.html" title="Discorb::ThreadChannel::Member (class)">Member</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="ThreadChannel/Member.html#initialize-instance_method" title="Discorb::ThreadChannel::Member#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='id identifier rubyid_d'>d</span><span class='rparen'>)</span> <span class='rbrace'>}</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">
935
936
937</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 935</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</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">
943
944
945</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 943</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="joined?-instance_method">
#<strong>joined?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
931
932
933</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 931</span>
<span class='kw'>def</span> <span class='id identifier rubyid_joined?'>joined?</span>
<span class='ivar'>@members</span><span class='lbracket'>[</span><span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="lock-instance_method">
#<strong>lock</strong>(reason: nil) ⇒ <tt>self</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Helper method to lock the thread.</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 locking the thread.</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 locked thread.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
891
892
893</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 891</span>
<span class='kw'>def</span> <span class='id identifier rubyid_lock'>lock</span><span class='lparen'>(</span><span class='label'>reason:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_edit'>edit</span><span class='lparen'>(</span><span class='label'>archived:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>locked:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>reason:</span> <span class='id identifier rubyid_reason'>reason</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="me-instance_method">
#<strong>me</strong> ⇒ <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
927
928
929</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 927</span>
<span class='kw'>def</span> <span class='id identifier rubyid_me'>me</span>
<span class='ivar'>@members</span><span class='lbracket'>[</span><span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="owner-instance_method">
#<strong>owner</strong> ⇒ <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
939
940
941</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 939</span>
<span class='kw'>def</span> <span class='id identifier rubyid_owner'>owner</span>
<span class='id identifier rubyid_guild'>guild</span><span class='period'>.</span><span class='id identifier rubyid_members'>members</span><span class='lbracket'>[</span><span class='ivar'>@owner_id</span><span class='rbracket'>]</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='channel-instance_method'>channel</span></span>
</span>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
919
920
921
922
923</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 919</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="remove_member-instance_method">
#<strong>remove_member</strong>(member = :me) ⇒ <tt>Object</tt>
<span class="aliases">Also known as:
<span class="names"><span id='leave-instance_method'>leave</span></span>
</span>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
959
960
961
962
963
964
965
966
967</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 959</span>
<span class='kw'>def</span> <span class='id identifier rubyid_remove_member'>remove_member</span><span class='lparen'>(</span><span class='id identifier rubyid_member'>member</span> <span class='op'>=</span> <span class='symbol'>:me</span><span class='rparen'>)</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='kw'>if</span> <span class='id identifier rubyid_member'>member</span> <span class='op'>==</span> <span class='symbol'>:me</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_internet'>internet</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'>/channels/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/thread-members/@me</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'>else</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_internet'>internet</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'>/channels/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/thread-members/</span><span class='embexpr_beg'>#{</span><span class='const'>Utils</span><span class='period'>.</span><span class='id identifier rubyid_try'>try</span><span class='lparen'>(</span><span class='id identifier rubyid_member'>member</span><span class='comma'>,</span> <span class='symbol'>:id</span><span class='rparen'>)</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>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="unarchive-instance_method">
#<strong>unarchive</strong>(reason: nil) ⇒ <tt>self</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Helper method to unarchive the thread.</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 unarchiving the thread.</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 unarchived thread.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
902
903
904</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 902</span>
<span class='kw'>def</span> <span class='id identifier rubyid_unarchive'>unarchive</span><span class='lparen'>(</span><span class='label'>reason:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_edit'>edit</span><span class='lparen'>(</span><span class='label'>archived:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>reason:</span> <span class='id identifier rubyid_reason'>reason</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="unlock-instance_method">
#<strong>unlock</strong>(reason: nil) ⇒ <tt>self</tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method won't unarchive the thread. Use <span class='object_link'><a href="#unarchive-instance_method" title="Discorb::ThreadChannel#unarchive (method)">#unarchive</a></span> instead.</p>
</div>
</div>
<p>Helper method to unlock the thread.</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 unlocking the thread.</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 unlocked thread.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
915
916
917</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/channel.rb', line 915</span>
<span class='kw'>def</span> <span class='id identifier rubyid_unlock'>unlock</span><span class='lparen'>(</span><span class='label'>reason:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_edit'>edit</span><span class='lparen'>(</span><span class='label'>archived:</span> <span class='op'>!</span><span class='id identifier rubyid_unarchive'>unarchive</span><span class='comma'>,</span> <span class='label'>locked:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>reason:</span> <span class='id identifier rubyid_reason'>reason</span><span class='rparen'>)</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/5bbfb4d90cb927c27f3e9c25b29d739224986cd6"><code>5bbfb4d90cb927c27f3e9c25b29d739224986cd6</code></a>, version (main), with YARD 0.9.26.
</div>
</div>
</body>
</html>