<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title> Class: Discorb::Message — 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::Message"; 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 (M)</a> » <span class='title'><span class='object_link'><a href="../Discorb.html" title="Discorb (module)">Discorb</a></span></span> » <span class="title">Message</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::Message </h1> <div class="box_info"> <dl> <dt>Inherits:</dt> <dd> <span class="inheritName"><span class='object_link'><a href="DiscordModel.html" title="Discorb::DiscordModel (class)">DiscordModel</a></span></span> <ul class="fullTree"> <li>Object</li> <li class="next"><span class='object_link'><a href="DiscordModel.html" title="Discorb::DiscordModel (class)">DiscordModel</a></span></li> <li class="next">Discorb::Message</li> </ul> <a href="#" class="inheritanceTree">show all</a> </dd> </dl> <dl> <dt>Defined in:</dt> <dd>lib/discorb/message.rb</dd> </dl> </div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p>Represents a message.</p> </div> </div> <div class="tags"> </div><div id="subclasses"> <h2>Direct Known Subclasses</h2> <p class="children"><span class='object_link'><a href="Webhook/Message.html" title="Discorb::Webhook::Message (class)">Webhook::Message</a></span></p> </div> <h2>Defined Under Namespace</h2> <p class="children"> <strong class="classes">Classes:</strong> <span class='object_link'><a href="Message/Activity.html" title="Discorb::Message::Activity (class)">Activity</a></span>, <span class='object_link'><a href="Message/Flag.html" title="Discorb::Message::Flag (class)">Flag</a></span>, <span class='object_link'><a href="Message/Interaction.html" title="Discorb::Message::Interaction (class)">Interaction</a></span>, <span class='object_link'><a href="Message/Reference.html" title="Discorb::Message::Reference (class)">Reference</a></span>, <span class='object_link'><a href="Message/Sticker.html" title="Discorb::Message::Sticker (class)">Sticker</a></span> </p> <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="#activity-instance_method" title="#activity (instance method)">#<strong>activity</strong> ⇒ Discorb::Message::Activity </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>The activity of the message.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#application_id-instance_method" title="#application_id (instance method)">#<strong>application_id</strong> ⇒ Discorb::Application </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>The application of the message.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#attachments-instance_method" title="#attachments (instance method)">#<strong>attachments</strong> ⇒ Array<Discorb::Attachment> </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>The attachments of the message.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#author-instance_method" title="#author (instance method)">#<strong>author</strong> ⇒ Discorb::User, Discorb::Member </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>The user that sent the message.</p> </div></span> </li> <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="#components-instance_method" title="#components (instance method)">#<strong>components</strong> ⇒ Array<Array<Discorb::Components>> </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>The components of the message.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#content-instance_method" title="#content (instance method)">#<strong>content</strong> ⇒ String </a> (also: #to_s) </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>The content of the message.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#created_at-instance_method" title="#created_at (instance method)">#<strong>created_at</strong> ⇒ Time </a> (also: #timestamp, #sent_at) </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>The time the message was created.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#deleted-instance_method" title="#deleted (instance method)">#<strong>deleted</strong> ⇒ Boolean </a> (also: #deleted?) </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>Whether the message is deleted.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#edited%3F-instance_method" title="#edited? (instance method)">#<strong>edited?</strong> ⇒ Boolean </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>Whether the message was edited.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#embed-instance_method" title="#embed (instance method)">#<strong>embed</strong> ⇒ Discorb::Embed<sup>?</sup> </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="#embeds-instance_method" title="#embeds (instance method)">#<strong>embeds</strong> ⇒ Array<Discorb::Embed> </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>The embeds of the message.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#flag-instance_method" title="#flag (instance method)">#<strong>flag</strong> ⇒ Discorb::Message::Flag </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>The flag of the message.</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="#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 message.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#interaction-instance_method" title="#interaction (instance method)">#<strong>interaction</strong> ⇒ Discorb::Message::Interaction </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>The interaction of the message.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#jump_url-instance_method" title="#jump_url (instance method)">#<strong>jump_url</strong> ⇒ String </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>The URL to jump to the message.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#mention_everyone-instance_method" title="#mention_everyone (instance method)">#<strong>mention_everyone</strong> ⇒ Boolean </a> (also: #mention_everyone?) </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>Whether the message mentions everyone.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#message_reference-instance_method" title="#message_reference (instance method)">#<strong>message_reference</strong> ⇒ Discorb::Message::Reference </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>The reference of the message.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#pinned-instance_method" title="#pinned (instance method)">#<strong>pinned</strong> ⇒ Boolean </a> (also: #pinned?) </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>Whether the message is pinned.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#reactions-instance_method" title="#reactions (instance method)">#<strong>reactions</strong> ⇒ Array<Discorb::Reaction> </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>The reactions of the message.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#stickers-instance_method" title="#stickers (instance method)">#<strong>stickers</strong> ⇒ Discorb::Message::Sticker </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>The sticker of the message.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#thread-instance_method" title="#thread (instance method)">#<strong>thread</strong> ⇒ Discorb::ThreadChannel </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>The thread channel of the message.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#tts-instance_method" title="#tts (instance method)">#<strong>tts</strong> ⇒ Boolean </a> (also: #tts?) </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>Whether the message is tts.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#type-instance_method" title="#type (instance method)">#<strong>type</strong> ⇒ Symbol </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>Currently, this will be one of:.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#updated_at-instance_method" title="#updated_at (instance method)">#<strong>updated_at</strong> ⇒ Time<sup>?</sup> </a> (also: #edited_at, #edited_timestamp) </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="#webhook%3F-instance_method" title="#webhook? (instance method)">#<strong>webhook?</strong> ⇒ Boolean </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>Whether the message was sent by a webhook.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#webhook_id-instance_method" title="#webhook_id (instance method)">#<strong>webhook_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> </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_reaction-instance_method" title="#add_reaction (instance method)">#<strong>add_reaction</strong>(emoji) ⇒ Object </a> (also: #react_with) </span> <span class="summary_desc"><div class='inline'><p>Add a reaction to the message.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#fetch_reacted_users-instance_method" title="#fetch_reacted_users (instance method)">#<strong>fetch_reacted_users</strong>(emoji, limit: nil, after: 0) ⇒ Array<Discorb::User> </a> </span> <span class="summary_desc"><div class='inline'><p>Fetch reacted users of reaction.</p> </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'><p>Meta.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#pin-instance_method" title="#pin (instance method)">#<strong>pin</strong>(reason: nil) ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'><p>Pin the message.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#publish-instance_method" title="#publish (instance method)">#<strong>publish</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'><p>Publish the message.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#remove_reaction-instance_method" title="#remove_reaction (instance method)">#<strong>remove_reaction</strong>(emoji) ⇒ Object </a> (also: #delete_reaction) </span> <span class="summary_desc"><div class='inline'><p>Remove a reaction from the message.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#remove_reaction_of-instance_method" title="#remove_reaction_of (instance method)">#<strong>remove_reaction_of</strong>(emoji, member) ⇒ Object </a> (also: #delete_reaction_of) </span> <span class="summary_desc"><div class='inline'><p>Remove other member's reaction from the message.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#reply-instance_method" title="#reply (instance method)">#<strong>reply</strong>(*args, **kwargs) ⇒ Discorb::Message </a> </span> <span class="summary_desc"><div class='inline'><p>Reply to the message.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#start_thread-instance_method" title="#start_thread (instance method)">#<strong>start_thread</strong>(*args, **kwargs) ⇒ <Type> </a> (also: #create_thread) </span> <span class="summary_desc"><div class='inline'><p>Start thread from the message.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#to_reference-instance_method" title="#to_reference (instance method)">#<strong>to_reference</strong>(fail_if_not_exists: true) ⇒ Hash </a> </span> <span class="summary_desc"><div class='inline'><p>Convert the message to reference object.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#unpin-instance_method" title="#unpin (instance method)">#<strong>unpin</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'><p>Unpin the message.</p> </div></span> </li> </ul> <h3 class="inherited">Methods inherited from <span class='object_link'><a href="DiscordModel.html" title="Discorb::DiscordModel (class)">DiscordModel</a></span></h3> <p class="inherited"><span class='object_link'><a href="DiscordModel.html#==-instance_method" title="Discorb::DiscordModel#== (method)">#==</a></span>, <span class='object_link'><a href="DiscordModel.html#eql%3F-instance_method" title="Discorb::DiscordModel#eql? (method)">#eql?</a></span>, <span class='object_link'><a href="DiscordModel.html#hash-instance_method" title="Discorb::DiscordModel#hash (method)">#hash</a></span></p> <div id="instance_attr_details" class="attr_details"> <h2>Instance Attribute Details</h2> <span id=""></span> <div class="method_details first"> <h3 class="signature first" id="activity-instance_method"> #<strong>activity</strong> ⇒ <tt><span class='object_link'><a href="Message/Activity.html" title="Discorb::Message::Activity (class)">Discorb::Message::Activity</a></span></tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns The activity 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="Message/Activity.html" title="Discorb::Message::Activity (class)">Discorb::Message::Activity</a></span></tt>)</span> — <div class='inline'><p>The activity of the message.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 117 118 119</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 117</span> <span class='kw'>def</span> <span class='id identifier rubyid_activity'>activity</span> <span class='ivar'>@activity</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="application_id-instance_method"> #<strong>application_id</strong> ⇒ <tt><span class='object_link'><a href="Application.html" title="Discorb::Application (class)">Discorb::Application</a></span></tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns The application 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="Application.html" title="Discorb::Application (class)">Discorb::Application</a></span></tt>)</span> — <div class='inline'><p>The application of the message.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 119 120 121</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 119</span> <span class='kw'>def</span> <span class='id identifier rubyid_application_id'>application_id</span> <span class='ivar'>@application_id</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="attachments-instance_method"> #<strong>attachments</strong> ⇒ <tt>Array<<span class='object_link'><a href="Attachment.html" title="Discorb::Attachment (class)">Discorb::Attachment</a></span>></tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns The attachments of the message.</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="Attachment.html" title="Discorb::Attachment (class)">Discorb::Attachment</a></span>></tt>)</span> — <div class='inline'><p>The attachments of the message.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 83 84 85</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 83</span> <span class='kw'>def</span> <span class='id identifier rubyid_attachments'>attachments</span> <span class='ivar'>@attachments</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="author-instance_method"> #<strong>author</strong> ⇒ <tt><span class='object_link'><a href="User.html" title="Discorb::User (class)">Discorb::User</a></span></tt>, <tt><span class='object_link'><a href="Member.html" title="Discorb::Member (class)">Discorb::Member</a></span></tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns The user that sent 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="User.html" title="Discorb::User (class)">Discorb::User</a></span></tt>, <tt><span class='object_link'><a href="Member.html" title="Discorb::Member (class)">Discorb::Member</a></span></tt>)</span> — <div class='inline'><p>The user that sent the message.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 69 70 71</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 69</span> <span class='kw'>def</span> <span class='id identifier rubyid_author'>author</span> <span class='ivar'>@author</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " 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"> </pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 170</span> </pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="components-instance_method"> #<strong>components</strong> ⇒ <tt>Array<Array<Discorb::Components>></tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns The components of the message.</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Array<Array<Discorb::Components>></tt>)</span> — <div class='inline'><p>The components of the message.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 132 133 134</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 132</span> <span class='kw'>def</span> <span class='id identifier rubyid_components'>components</span> <span class='ivar'>@components</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="content-instance_method"> #<strong>content</strong> ⇒ <tt>String</tt> <span class="extras">(readonly)</span> <span class="aliases">Also known as: <span class="names"><span id='to_s-instance_method'>to_s</span></span> </span> </h3><div class="docstring"> <div class="discussion"> <p>Returns The content of the message.</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 content of the message.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 71 72 73</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 71</span> <span class='kw'>def</span> <span class='id identifier rubyid_content'>content</span> <span class='ivar'>@content</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="created_at-instance_method"> #<strong>created_at</strong> ⇒ <tt><span class='object_link'><a href="../Time.html" title="Time (class)">Time</a></span></tt> <span class="extras">(readonly)</span> <span class="aliases">Also known as: <span class="names"><span id='timestamp-instance_method'>timestamp</span>, <span id='sent_at-instance_method'>sent_at</span></span> </span> </h3><div class="docstring"> <div class="discussion"> <p>Returns The time the message was created.</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="../Time.html" title="Time (class)">Time</a></span></tt>)</span> — <div class='inline'><p>The time the message was created.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 74 75 76</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 74</span> <span class='kw'>def</span> <span class='id identifier rubyid_created_at'>created_at</span> <span class='ivar'>@created_at</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="deleted-instance_method"> #<strong>deleted</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span> <span class="aliases">Also known as: <span class="names"><span id='deleted?-instance_method'>deleted?</span></span> </span> </h3><div class="docstring"> <div class="discussion"> <p>Returns Whether the message is deleted.</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 message is deleted.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 134 135 136</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 134</span> <span class='kw'>def</span> <span class='id identifier rubyid_deleted'>deleted</span> <span class='ivar'>@deleted</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="edited?-instance_method"> #<strong>edited?</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns Whether the message was edited.</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 message was edited.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> </pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 170</span> </pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="embed-instance_method"> #<strong>embed</strong> ⇒ <tt><span class='object_link'><a href="Embed.html" title="Discorb::Embed (class)">Discorb::Embed</a></span></tt><sup>?</sup> <span class="extras">(readonly)</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="Embed.html" title="Discorb::Embed (class)">Discorb::Embed</a></span></tt>)</span> — <div class='inline'><p>The embed of the message.</p> </div> </li> <li> <span class='type'>(<tt>nil</tt>)</span> — <div class='inline'><p>If the message has no embed.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> </pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 170</span> </pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="embeds-instance_method"> #<strong>embeds</strong> ⇒ <tt>Array<<span class='object_link'><a href="Embed.html" title="Discorb::Embed (class)">Discorb::Embed</a></span>></tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns The embeds of the message.</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="Embed.html" title="Discorb::Embed (class)">Discorb::Embed</a></span>></tt>)</span> — <div class='inline'><p>The embeds of the message.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 85 86 87</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 85</span> <span class='kw'>def</span> <span class='id identifier rubyid_embeds'>embeds</span> <span class='ivar'>@embeds</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="flag-instance_method"> #<strong>flag</strong> ⇒ <tt><span class='object_link'><a href="Message/Flag.html" title="Discorb::Message::Flag (class)">Discorb::Message::Flag</a></span></tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns The flag 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="Message/Flag.html" title="Discorb::Message::Flag (class)">Discorb::Message::Flag</a></span></tt>)</span> — <div class='inline'><p>The flag of the message.</p> </div> </li> </ul> <p class="tag_title">See Also:</p> <ul class="see"> <li><span class='object_link'><a href="Message/Flag.html" title="Discorb::Message::Flag (class)">Flag</a></span></li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 124 125 126</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 124</span> <span class='kw'>def</span> <span class='id identifier rubyid_flag'>flag</span> <span class='ivar'>@flag</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> <li> <span class='type'>(<tt>nil</tt>)</span> — <div class='inline'><p>If the message was not sent in a guild.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> </pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 170</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"> <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"> 67 68 69</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 67</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="interaction-instance_method"> #<strong>interaction</strong> ⇒ <tt><span class='object_link'><a href="Message/Interaction.html" title="Discorb::Message::Interaction (class)">Discorb::Message::Interaction</a></span></tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns The interaction 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="Message/Interaction.html" title="Discorb::Message::Interaction (class)">Discorb::Message::Interaction</a></span></tt>)</span> — <div class='inline'><p>The interaction of the message.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 128 129 130</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 128</span> <span class='kw'>def</span> <span class='id identifier rubyid_interaction'>interaction</span> <span class='ivar'>@interaction</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="jump_url-instance_method"> #<strong>jump_url</strong> ⇒ <tt>String</tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns The URL to jump to the message.</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 URL to jump to the message.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> </pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 170</span> </pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="mention_everyone-instance_method"> #<strong>mention_everyone</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span> <span class="aliases">Also known as: <span class="names"><span id='mention_everyone?-instance_method'>mention_everyone?</span></span> </span> </h3><div class="docstring"> <div class="discussion"> <p>Returns Whether the message mentions everyone.</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 message mentions everyone.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 140 141 142</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 140</span> <span class='kw'>def</span> <span class='id identifier rubyid_mention_everyone'>mention_everyone</span> <span class='ivar'>@mention_everyone</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="message_reference-instance_method"> #<strong>message_reference</strong> ⇒ <tt><span class='object_link'><a href="Message/Reference.html" title="Discorb::Message::Reference (class)">Discorb::Message::Reference</a></span></tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns The reference 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="Message/Reference.html" title="Discorb::Message::Reference (class)">Discorb::Message::Reference</a></span></tt>)</span> — <div class='inline'><p>The reference of the message.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 121 122 123</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 121</span> <span class='kw'>def</span> <span class='id identifier rubyid_message_reference'>message_reference</span> <span class='ivar'>@message_reference</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="pinned-instance_method"> #<strong>pinned</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span> <span class="aliases">Also known as: <span class="names"><span id='pinned?-instance_method'>pinned?</span></span> </span> </h3><div class="docstring"> <div class="discussion"> <p>Returns Whether the message is pinned.</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 message is pinned.</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/message.rb', line 143</span> <span class='kw'>def</span> <span class='id identifier rubyid_pinned'>pinned</span> <span class='ivar'>@pinned</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="reactions-instance_method"> #<strong>reactions</strong> ⇒ <tt>Array<<span class='object_link'><a href="Reaction.html" title="Discorb::Reaction (class)">Discorb::Reaction</a></span>></tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns The reactions of the message.</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="Reaction.html" title="Discorb::Reaction (class)">Discorb::Reaction</a></span>></tt>)</span> — <div class='inline'><p>The reactions of the message.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 87 88 89</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 87</span> <span class='kw'>def</span> <span class='id identifier rubyid_reactions'>reactions</span> <span class='ivar'>@reactions</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="stickers-instance_method"> #<strong>stickers</strong> ⇒ <tt><span class='object_link'><a href="Message/Sticker.html" title="Discorb::Message::Sticker (class)">Discorb::Message::Sticker</a></span></tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns The sticker 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="Message/Sticker.html" title="Discorb::Message::Sticker (class)">Discorb::Message::Sticker</a></span></tt>)</span> — <div class='inline'><p>The sticker of the message.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 126 127 128</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 126</span> <span class='kw'>def</span> <span class='id identifier rubyid_stickers'>stickers</span> <span class='ivar'>@stickers</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="thread-instance_method"> #<strong>thread</strong> ⇒ <tt><span class='object_link'><a href="ThreadChannel.html" title="Discorb::ThreadChannel (class)">Discorb::ThreadChannel</a></span></tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns The thread channel 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="ThreadChannel.html" title="Discorb::ThreadChannel (class)">Discorb::ThreadChannel</a></span></tt>)</span> — <div class='inline'><p>The thread channel of the message.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 130 131 132</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 130</span> <span class='kw'>def</span> <span class='id identifier rubyid_thread'>thread</span> <span class='ivar'>@thread</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="tts-instance_method"> #<strong>tts</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span> <span class="aliases">Also known as: <span class="names"><span id='tts?-instance_method'>tts?</span></span> </span> </h3><div class="docstring"> <div class="discussion"> <p>Returns Whether the message is tts.</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 message is tts.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 137 138 139</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 137</span> <span class='kw'>def</span> <span class='id identifier rubyid_tts'>tts</span> <span class='ivar'>@tts</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="type-instance_method"> #<strong>type</strong> ⇒ <tt>Symbol</tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Currently, this will be one of:</p> <ul> <li><code>:default</code></li> <li><code>:recipient_add</code></li> <li><code>:recipient_remove</code></li> <li><code>:call</code></li> <li><code>:channel_name_change</code></li> <li><code>:channel_icon_change</code></li> <li><code>:channel_pinned_message</code></li> <li><code>:guild_member_join</code></li> <li><code>:user_premium_guild_subscription</code></li> <li><code>:user_premium_guild_subscription_tier_1</code></li> <li><code>:user_premium_guild_subscription_tier_2</code></li> <li><code>:user_premium_guild_subscription_tier_3</code></li> <li><code>:channel_follow_add</code></li> <li><code>:guild_discovery_disqualified</code></li> <li><code>:guild_discovery_requalified</code></li> <li><code>:guild_discovery_grace_period_initial_warning</code></li> <li><code>:guild_discovery_grace_period_final_warning</code></li> <li><code>:thread_created</code></li> <li><code>:reply</code></li> <li><code>:application_command</code></li> <li><code>:thread_starter_message</code></li> <li><code>:guild_invite_reminder</code></li> </ul> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Symbol</tt>)</span> — <div class='inline'><p>The type of the message.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 115 116 117</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 115</span> <span class='kw'>def</span> <span class='id identifier rubyid_type'>type</span> <span class='ivar'>@type</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="updated_at-instance_method"> #<strong>updated_at</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='edited_at-instance_method'>edited_at</span>, <span id='edited_timestamp-instance_method'>edited_timestamp</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 message was edited.</p> </div> </li> <li> <span class='type'>(<tt>nil</tt>)</span> — <div class='inline'><p>If the message was not edited.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 79 80 81</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 79</span> <span class='kw'>def</span> <span class='id identifier rubyid_updated_at'>updated_at</span> <span class='ivar'>@updated_at</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="webhook?-instance_method"> #<strong>webhook?</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns Whether the message was sent by a webhook.</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 message was sent by a webhook.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> </pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 170</span> </pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="webhook_id-instance_method"> #<strong>webhook_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"> 89 90 91</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 89</span> <span class='kw'>def</span> <span class='id identifier rubyid_webhook_id'>webhook_id</span> <span class='ivar'>@webhook_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="add_reaction-instance_method"> #<strong>add_reaction</strong>(emoji) ⇒ <tt>Object</tt> <span class="aliases">Also known as: <span class="names"><span id='react_with-instance_method'>react_with</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>Add a reaction to the message.</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>emoji</span> <span class='type'>(<tt><span class='object_link'><a href="Emoji.html" title="Discorb::Emoji (class)">Discorb::Emoji</a></span></tt>)</span> — <div class='inline'><p>The emoji to react with.</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"> 265 266 267 268 269</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 265</span> <span class='kw'>def</span> <span class='id identifier rubyid_add_reaction'>add_reaction</span><span class='lparen'>(</span><span class='id identifier rubyid_emoji'>emoji</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='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_put'>put</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'>@channel_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/messages/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/reactions/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_emoji'>emoji</span><span class='period'>.</span><span class='id identifier rubyid_to_uri'>to_uri</span><span class='embexpr_end'>}</span><span class='tstring_content'>/@me</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='kw'>nil</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="fetch_reacted_users-instance_method"> #<strong>fetch_reacted_users</strong>(emoji, limit: nil, after: 0) ⇒ <tt>Array<<span class='object_link'><a href="User.html" title="Discorb::User (class)">Discorb::User</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 reacted users of reaction.</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>emoji</span> <span class='type'>(<tt><span class='object_link'><a href="Emoji.html" title="Discorb::Emoji (class)">Discorb::Emoji</a></span></tt>)</span> — <div class='inline'><p>The emoji to fetch.</p> </div> </li> <li> <span class='name'>limit</span> <span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span> <em class="default">(defaults to: <tt>nil</tt>)</em> — <div class='inline'><p>The maximum number of users to fetch. <code>nil</code> for no limit.</p> </div> </li> <li> <span class='name'>after</span> <span class='type'>(<tt><span class='object_link'><a href="Snowflake.html" title="Discorb::Snowflake (class)">Discorb::Snowflake</a></span></tt>, <tt>nil</tt>)</span> <em class="default">(defaults to: <tt>0</tt>)</em> — <div class='inline'><p>The ID of the user to start fetching from.</p> </div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Array<<span class='object_link'><a href="User.html" title="Discorb::User (class)">Discorb::User</a></span>></tt>)</span> — <div class='inline'><p>The users.</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"> 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 315</span> <span class='kw'>def</span> <span class='id identifier rubyid_fetch_reacted_users'>fetch_reacted_users</span><span class='lparen'>(</span><span class='id identifier rubyid_emoji'>emoji</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>after:</span> <span class='int'>0</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'>if</span> <span class='id identifier rubyid_limit'>limit</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='op'>!</span><span class='id identifier rubyid_limit'>limit</span><span class='period'>.</span><span class='id identifier rubyid_positive?'>positive?</span> <span class='id identifier rubyid_after'>after</span> <span class='op'>=</span> <span class='int'>0</span> <span class='id identifier rubyid_users'>users</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span> <span class='id identifier rubyid_loop'>loop</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_http'>http</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'>@channel_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/messages/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/reactions/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_emoji'>emoji</span><span class='period'>.</span><span class='id identifier rubyid_to_uri'>to_uri</span><span class='embexpr_end'>}</span><span class='tstring_content'>?limit=100&after=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_after'>after</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'>break</span> <span class='kw'>if</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span> <span class='id identifier rubyid_users'>users</span> <span class='op'>+=</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_r'>r</span><span class='op'>|</span> <span class='id identifier rubyid_guild'>guild</span><span class='op'>&.</span><span class='id identifier rubyid_members'>members</span><span class='op'>&.</span><span class='op'>[]</span><span class='lparen'>(</span><span class='id identifier rubyid_r'>r</span><span class='lbracket'>[</span><span class='symbol'>:id</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_users'>users</span><span class='lbracket'>[</span><span class='id identifier rubyid_r'>r</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="User.html" title="Discorb::User (class)">User</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='id identifier rubyid_r'>r</span><span class='rparen'>)</span> <span class='rbrace'>}</span> <span class='kw'>break</span> <span class='kw'>if</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'><</span> <span class='int'>100</span> <span class='id identifier rubyid_after'>after</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='symbol'>:id</span><span class='rbracket'>]</span> <span class='kw'>end</span> <span class='kw'>next</span> <span class='id identifier rubyid_users'>users</span> <span class='kw'>else</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_http'>http</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'>@channel_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/messages/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/reactions/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_emoji'>emoji</span><span class='period'>.</span><span class='id identifier rubyid_to_uri'>to_uri</span><span class='embexpr_end'>}</span><span class='tstring_content'>?limit=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_limit'>limit</span><span class='embexpr_end'>}</span><span class='tstring_content'>&after=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_after'>after</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'>next</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_r'>r</span><span class='op'>|</span> <span class='id identifier rubyid_guild'>guild</span><span class='op'>&.</span><span class='id identifier rubyid_members'>members</span><span class='op'>&.</span><span class='op'>[]</span><span class='lparen'>(</span><span class='id identifier rubyid_r'>r</span><span class='lbracket'>[</span><span class='symbol'>:id</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_users'>users</span><span class='lbracket'>[</span><span class='id identifier rubyid_r'>r</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="User.html" title="Discorb::User (class)">User</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='id identifier rubyid_r'>r</span><span class='rparen'>)</span> <span class='rbrace'>}</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="inspect-instance_method"> #<strong>inspect</strong> ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <p>Meta</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 379 380 381</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 379</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'>@content</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</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="pin-instance_method"> #<strong>pin</strong>(reason: nil) ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <div class="note notetag"> <strong>Note:</strong> <div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p> </div> </div> <div class="note notetag"> <strong>Note:</strong> <div class='inline'><p>This method calls HTTP request.</p> </div> </div> <p>Pin the message.</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>reason</span> <span class='type'>(<tt>String</tt>)</span> <em class="default">(defaults to: <tt>nil</tt>)</em> — <div class='inline'><p>The reason for pinning 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"> 345 346 347 348 349</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 345</span> <span class='kw'>def</span> <span class='id identifier rubyid_pin'>pin</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='id identifier rubyid_channel'>channel</span><span class='period'>.</span><span class='id identifier rubyid_pin_message'>pin_message</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='label'>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="publish-instance_method"> #<strong>publish</strong> ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <div class="note notetag"> <strong>Note:</strong> <div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p> </div> </div> <div class="note notetag"> <strong>Note:</strong> <div class='inline'><p>This method calls HTTP request.</p> </div> </div> <p>Publish the message.</p> </div> </div> <div class="tags"> <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"> 252 253 254 255 256</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 252</span> <span class='kw'>def</span> <span class='id identifier rubyid_publish'>publish</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='id identifier rubyid_channel'>channel</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'>@channel_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/messages/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/crosspost</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='kw'>nil</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="remove_reaction-instance_method"> #<strong>remove_reaction</strong>(emoji) ⇒ <tt>Object</tt> <span class="aliases">Also known as: <span class="names"><span id='delete_reaction-instance_method'>delete_reaction</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>Remove a reaction from the message.</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>emoji</span> <span class='type'>(<tt><span class='object_link'><a href="Emoji.html" title="Discorb::Emoji (class)">Discorb::Emoji</a></span></tt>)</span> — <div class='inline'><p>The emoji to remove.</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"> 280 281 282 283 284</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 280</span> <span class='kw'>def</span> <span class='id identifier rubyid_remove_reaction'>remove_reaction</span><span class='lparen'>(</span><span class='id identifier rubyid_emoji'>emoji</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='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/channels/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@channel_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/messages/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/reactions/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_emoji'>emoji</span><span class='period'>.</span><span class='id identifier rubyid_to_uri'>to_uri</span><span class='embexpr_end'>}</span><span class='tstring_content'>/@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'>end</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="remove_reaction_of-instance_method"> #<strong>remove_reaction_of</strong>(emoji, member) ⇒ <tt>Object</tt> <span class="aliases">Also known as: <span class="names"><span id='delete_reaction_of-instance_method'>delete_reaction_of</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>Remove other member's reaction from the message.</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>emoji</span> <span class='type'>(<tt><span class='object_link'><a href="Emoji.html" title="Discorb::Emoji (class)">Discorb::Emoji</a></span></tt>)</span> — <div class='inline'><p>The emoji to remove.</p> </div> </li> <li> <span class='name'>member</span> <span class='type'>(<tt><span class='object_link'><a href="Member.html" title="Discorb::Member (class)">Discorb::Member</a></span></tt>)</span> — <div class='inline'><p>The member to remove the reaction from.</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"> 296 297 298 299 300</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 296</span> <span class='kw'>def</span> <span class='id identifier rubyid_remove_reaction_of'>remove_reaction_of</span><span class='lparen'>(</span><span class='id identifier rubyid_emoji'>emoji</span><span class='comma'>,</span> <span class='id identifier rubyid_member'>member</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='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/channels/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@channel_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/messages/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/reactions/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_emoji'>emoji</span><span class='period'>.</span><span class='id identifier rubyid_to_uri'>to_uri</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_member'>member</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Member.html" title="Discorb::Member (class)">Member</a></span></span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_member'>member</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span> <span class='op'>:</span> <span class='id identifier rubyid_member'>member</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></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="reply-instance_method"> #<strong>reply</strong>(*args, **kwargs) ⇒ <tt><span class='object_link'><a href="" 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>Reply to 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="" 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"> 241 242 243 244 245</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 241</span> <span class='kw'>def</span> <span class='id identifier rubyid_reply'>reply</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</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='id identifier rubyid_channel'>channel</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='label'>reference:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</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="start_thread-instance_method"> #<strong>start_thread</strong>(*args, **kwargs) ⇒ <tt><Type></tt> <span class="aliases">Also known as: <span class="names"><span id='create_thread-instance_method'>create_thread</span></span> </span> </h3><div class="docstring"> <div class="discussion"> <p>Start thread from the message.</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt><Type></tt>)</span> — <div class='inline'><p><description></p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 369 370 371 372 373</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 369</span> <span class='kw'>def</span> <span class='id identifier rubyid_start_thread'>start_thread</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span><span class='rparen'>)</span> <span class='const'>Async</span> <span class='kw'>do</span> <span class='id identifier rubyid_channel'>channel</span><span class='period'>.</span><span class='id identifier rubyid_start_thread'>start_thread</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='label'>message:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span> <span class='kw'>end</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="to_reference-instance_method"> #<strong>to_reference</strong>(fail_if_not_exists: true) ⇒ <tt>Hash</tt> </h3><div class="docstring"> <div class="discussion"> <p>Convert the message to reference object.</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>fail_if_not_exists</span> <span class='type'>(<tt>Boolean</tt>)</span> <em class="default">(defaults to: <tt>true</tt>)</em> — <div class='inline'><p>Whether to raise an error if the message does not exist.</p> </div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Hash</tt>)</span> — <div class='inline'><p>The reference object.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 223 224 225 226 227 228 229 230</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 223</span> <span class='kw'>def</span> <span class='id identifier rubyid_to_reference'>to_reference</span><span class='lparen'>(</span><span class='label'>fail_if_not_exists:</span> <span class='kw'>true</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='label'>message_id:</span> <span class='ivar'>@id</span><span class='comma'>,</span> <span class='label'>channel_id:</span> <span class='ivar'>@channel_id</span><span class='comma'>,</span> <span class='label'>guild_id:</span> <span class='ivar'>@guild_id</span><span class='comma'>,</span> <span class='label'>fail_if_not_exists:</span> <span class='id identifier rubyid_fail_if_not_exists'>fail_if_not_exists</span><span class='comma'>,</span> <span class='rbrace'>}</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="unpin-instance_method"> #<strong>unpin</strong> ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <div class="note notetag"> <strong>Note:</strong> <div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p> </div> </div> <div class="note notetag"> <strong>Note:</strong> <div class='inline'><p>This method calls HTTP request.</p> </div> </div> <p>Unpin the message.</p> </div> </div> <div class="tags"> <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"> 356 357 358 359 360</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 356</span> <span class='kw'>def</span> <span class='id identifier rubyid_unpin'>unpin</span> <span class='const'>Async</span> <span class='kw'>do</span> <span class='id identifier rubyid_channel'>channel</span><span class='period'>.</span><span class='id identifier rubyid_unpin_message'>unpin_message</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='label'>reason:</span> <span class='id identifier rubyid_reason'>reason</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span> <span class='kw'>end</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated from <a href="https://github.com/discorb-lib/discorb/tree/4168c1cd86b4804c0e98549928c53b2f117cb5ff"><code>4168c1cd86b4804c0e98549928c53b2f117cb5ff</code></a>, version v0.0.6, with YARD 0.9.26. </div> </div> </body> </html>