<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Discorb::AllowedMentions
— 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::AllowedMentions";
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 (A)</a> »
<span class='title'><span class='object_link'><a href="../Discorb.html" title="Discorb (module)">Discorb</a></span></span>
»
<span class="title">AllowedMentions</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::AllowedMentions
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Discorb::AllowedMentions</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 allowed mentions in a message.</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="#everyone-instance_method" title="#everyone (instance method)">#<strong>everyone</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Whether to allow @everyone or @here.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#replied_user-instance_method" title="#replied_user (instance method)">#<strong>replied_user</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Whether to ping the user that sent the message to reply.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#roles-instance_method" title="#roles (instance method)">#<strong>roles</strong> ⇒ Boolean, Array<Discorb::Role> </a>
</span>
<span class="summary_desc"><div class='inline'><p>The roles to allow, or false to disable.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#users-instance_method" title="#users (instance method)">#<strong>users</strong> ⇒ Boolean, Array<Discorb::User> </a>
</span>
<span class="summary_desc"><div class='inline'><p>The users to allow, or false to disable.</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="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(everyone: nil, roles: nil, users: nil, replied_user: nil) ⇒ AllowedMentions </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>Initializes a new instance of the AllowedMentions class.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#nil_merge-instance_method" title="#nil_merge (instance method)">#<strong>nil_merge</strong>(*args) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(everyone: nil, roles: nil, users: nil, replied_user: nil) ⇒ <tt><span class='object_link'><a href="" title="Discorb::AllowedMentions (class)">AllowedMentions</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Initializes a new instance of the AllowedMentions class.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>everyone</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>Whether to allow @everyone or @here.</p>
</div>
</li>
<li>
<span class='name'>roles</span>
<span class='type'>(<tt>Boolean</tt>, <tt>Array<<span class='object_link'><a href="Role.html" title="Discorb::Role (class)">Discorb::Role</a></span>></tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The roles to allow, or false to disable.</p>
</div>
</li>
<li>
<span class='name'>users</span>
<span class='type'>(<tt>Boolean</tt>, <tt>Array<<span class='object_link'><a href="User.html" title="Discorb::User (class)">Discorb::User</a></span>></tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The users to allow, or false to disable.</p>
</div>
</li>
<li>
<span class='name'>replied_user</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>Whether to ping the user that sent the message to reply.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
25
26
27
28
29
30</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 25</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>everyone:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>roles:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>users:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>replied_user:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='ivar'>@everyone</span> <span class='op'>=</span> <span class='id identifier rubyid_everyone'>everyone</span>
<span class='ivar'>@roles</span> <span class='op'>=</span> <span class='id identifier rubyid_roles'>roles</span>
<span class='ivar'>@users</span> <span class='op'>=</span> <span class='id identifier rubyid_users'>users</span>
<span class='ivar'>@replied_user</span> <span class='op'>=</span> <span class='id identifier rubyid_replied_user'>replied_user</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="everyone=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="everyone-instance_method">
#<strong>everyone</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Whether to allow @everyone or @here.</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 to allow @everyone or @here.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
9
10
11</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 9</span>
<span class='kw'>def</span> <span class='id identifier rubyid_everyone'>everyone</span>
<span class='ivar'>@everyone</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="replied_user=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="replied_user-instance_method">
#<strong>replied_user</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Whether to ping the user that sent the message to reply.</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 to ping the user that sent the message to reply.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
15
16
17</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 15</span>
<span class='kw'>def</span> <span class='id identifier rubyid_replied_user'>replied_user</span>
<span class='ivar'>@replied_user</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="roles=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="roles-instance_method">
#<strong>roles</strong> ⇒ <tt>Boolean</tt>, <tt>Array<<span class='object_link'><a href="Role.html" title="Discorb::Role (class)">Discorb::Role</a></span>></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The roles to allow, or false to disable.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>, <tt>Array<<span class='object_link'><a href="Role.html" title="Discorb::Role (class)">Discorb::Role</a></span>></tt>)</span>
—
<div class='inline'><p>The roles to allow, or false to disable.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
11
12
13</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 11</span>
<span class='kw'>def</span> <span class='id identifier rubyid_roles'>roles</span>
<span class='ivar'>@roles</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="users=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="users-instance_method">
#<strong>users</strong> ⇒ <tt>Boolean</tt>, <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">
<p>Returns The users to allow, or false to disable.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>, <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 to allow, or false to disable.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
13
14
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 13</span>
<span class='kw'>def</span> <span class='id identifier rubyid_users'>users</span>
<span class='ivar'>@users</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="nil_merge-instance_method">
#<strong>nil_merge</strong>(*args) ⇒ <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
54
55
56
57
58
59</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/message.rb', line 54</span>
<span class='kw'>def</span> <span class='id identifier rubyid_nil_merge'>nil_merge</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
<span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_a'>a</span><span class='op'>|</span>
<span class='kw'>return</span> <span class='id identifier rubyid_a'>a</span> <span class='kw'>unless</span> <span class='id identifier rubyid_a'>a</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='kw'>end</span>
<span class='kw'>nil</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/27a4a46a8d847860751d0c3758742f6c09cec01b"><code>27a4a46a8d847860751d0c3758742f6c09cec01b</code></a>, version v0.0.5, with YARD 0.9.26.
</div>
</div>
</body>
</html>