<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Discorb::GatewayHandler::ReactionRemoveEmojiEvent
— 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::GatewayHandler::ReactionRemoveEmojiEvent";
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 (R)</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="../GatewayHandler.html" title="Discorb::GatewayHandler (module)">GatewayHandler</a></span></span>
»
<span class="title">ReactionRemoveEmojiEvent</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::GatewayHandler::ReactionRemoveEmojiEvent
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="GatewayEvent.html" title="Discorb::GatewayHandler::GatewayEvent (class)">GatewayEvent</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="GatewayEvent.html" title="Discorb::GatewayHandler::GatewayEvent (class)">GatewayEvent</a></span></li>
<li class="next">Discorb::GatewayHandler::ReactionRemoveEmojiEvent</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/discorb/gateway.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Represents a <code>MESSAGE_REACTION_REMOVE_EMOJI</code> event.</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="#channel_id-instance_method" title="#channel_id (instance method)">#<strong>channel_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 the message was sent in.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#emoji-instance_method" title="#emoji (instance method)">#<strong>emoji</strong> ⇒ Discorb::UnicodeEmoji, Discorb::PartialEmoji </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The emoji that was reacted with.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#guild-instance_method" title="#guild (instance method)">#<strong>guild</strong> ⇒ nil, Discorb::Guild </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#guild_id-instance_method" title="#guild_id (instance method)">#<strong>guild_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 guild the message was sent in.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#message-instance_method" title="#message (instance method)">#<strong>message</strong> ⇒ nil, Discorb::Message </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="#message_id-instance_method" title="#message_id (instance method)">#<strong>message_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 message.</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="#fetch_message-instance_method" title="#fetch_message (instance method)">#<strong>fetch_message</strong>(force: false) ⇒ Discorb::Message </a>
</span>
<span class="summary_desc"><div class='inline'><p>Fetch the message.</p>
</div></span>
</li>
</ul>
<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 the message was sent in.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
161
162
163</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/gateway.rb', line 161</span>
<span class='kw'>def</span> <span class='id identifier rubyid_channel'>channel</span>
<span class='ivar'>@channel</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="channel_id-instance_method">
#<strong>channel_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">
<p>Returns The ID of the channel the message was sent in.</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 the message was sent in.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
154
155
156</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/gateway.rb', line 154</span>
<span class='kw'>def</span> <span class='id identifier rubyid_channel_id'>channel_id</span>
<span class='ivar'>@channel_id</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="../UnicodeEmoji.html" title="Discorb::UnicodeEmoji (class)">Discorb::UnicodeEmoji</a></span></tt>, <tt><span class='object_link'><a href="../PartialEmoji.html" title="Discorb::PartialEmoji (class)">Discorb::PartialEmoji</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The emoji that was reacted with.</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="../UnicodeEmoji.html" title="Discorb::UnicodeEmoji (class)">Discorb::UnicodeEmoji</a></span></tt>, <tt><span class='object_link'><a href="../PartialEmoji.html" title="Discorb::PartialEmoji (class)">Discorb::PartialEmoji</a></span></tt>)</span>
—
<div class='inline'><p>The emoji that was reacted with.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
169
170
171</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/gateway.rb', line 169</span>
<span class='kw'>def</span> <span class='id identifier rubyid_emoji'>emoji</span>
<span class='ivar'>@emoji</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="guild-instance_method">
#<strong>guild</strong> ⇒ <tt>nil</tt>, <tt><span class='object_link'><a href="../Guild.html" title="Discorb::Guild (class)">Discorb::Guild</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method returns an object from client cache. it will return <code>nil</code> if the object is not in cache.</p>
</div>
</div>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>nil</tt>)</span>
—
<div class='inline'><p>The object wasn't cached.</p>
</div>
</li>
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Guild.html" title="Discorb::Guild (class)">Discorb::Guild</a></span></tt>)</span>
—
<div class='inline'><p>The guild the message was sent in.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
164
165
166</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/gateway.rb', line 164</span>
<span class='kw'>def</span> <span class='id identifier rubyid_guild'>guild</span>
<span class='ivar'>@guild</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="guild_id-instance_method">
#<strong>guild_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">
<p>Returns The ID of the guild the message was sent in.</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 guild the message was sent in.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
158
159
160</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/gateway.rb', line 158</span>
<span class='kw'>def</span> <span class='id identifier rubyid_guild_id'>guild_id</span>
<span class='ivar'>@guild_id</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="message-instance_method">
#<strong>message</strong> ⇒ <tt>nil</tt>, <tt><span class='object_link'><a href="../Message.html" title="Discorb::Message (class)">Discorb::Message</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="../Message.html" title="Discorb::Message (class)">Discorb::Message</a></span></tt>)</span>
—
<div class='inline'><p>The message the reaction was sent in.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
167
168
169</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/gateway.rb', line 167</span>
<span class='kw'>def</span> <span class='id identifier rubyid_message'>message</span>
<span class='ivar'>@message</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="message_id-instance_method">
#<strong>message_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">
<p>Returns The ID of the message.</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 message.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
156
157
158</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/gateway.rb', line 156</span>
<span class='kw'>def</span> <span class='id identifier rubyid_message_id'>message_id</span>
<span class='ivar'>@message_id</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="fetch_message-instance_method">
#<strong>fetch_message</strong>(force: false) ⇒ <tt><span class='object_link'><a href="../Message.html" title="Discorb::Message (class)">Discorb::Message</a></span></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>Fetch the message.
If message is cached, it will be returned.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>force</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
—
<div class='inline'><p>Whether to force fetching the message.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Message.html" title="Discorb::Message (class)">Discorb::Message</a></span></tt>)</span>
—
<div class='inline'><p>The message.</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">
192
193
194
195
196
197
198</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/gateway.rb', line 192</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fetch_message'>fetch_message</span><span class='lparen'>(</span><span class='label'>force:</span> <span class='kw'>false</span><span class='rparen'>)</span>
<span class='const'>Async</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid__task'>_task</span><span class='op'>|</span>
<span class='kw'>next</span> <span class='ivar'>@message</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_force'>force</span> <span class='op'>&&</span> <span class='ivar'>@message</span>
<span class='ivar'>@message</span> <span class='op'>=</span> <span class='ivar'>@channel</span><span class='period'>.</span><span class='id identifier rubyid_fetch_message'>fetch_message</span><span class='lparen'>(</span><span class='ivar'>@message_id</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated from <a href="https://github.com/discorb-lib/discorb/tree/b1dd9cf49ec5d42e3e3ed921f950a18a24c7a2b9"><code>b1dd9cf49ec5d42e3e3ed921f950a18a24c7a2b9</code></a>, version v0.0.7, with YARD 0.9.26.
</div>
</div>
</body>
</html>