<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Discorb::SelectMenu
— 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::SelectMenu";
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 (S)</a> »
<span class='title'><span class='object_link'><a href="../Discorb.html" title="Discorb (module)">Discorb</a></span></span>
»
<span class="title">SelectMenu</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::SelectMenu
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="Component.html" title="Discorb::Component (class)">Component</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Component.html" title="Discorb::Component (class)">Component</a></span></li>
<li class="next">Discorb::SelectMenu</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/discorb/components.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Represents a select menu component.</p>
</div>
</div>
<div class="tags">
</div><h2>Defined Under Namespace</h2>
<p class="children">
<strong class="classes">Classes:</strong> <span class='object_link'><a href="SelectMenu/Option.html" title="Discorb::SelectMenu::Option (class)">Option</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="#custom_id-instance_method" title="#custom_id (instance method)">#<strong>custom_id</strong> ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>The custom ID of the select menu.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#disabled-instance_method" title="#disabled (instance method)">#<strong>disabled</strong> ⇒ Boolean </a>
(also: #disabled?)
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Whether the select menu is disabled.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#max_values-instance_method" title="#max_values (instance method)">#<strong>max_values</strong> ⇒ Integer </a>
</span>
<span class="summary_desc"><div class='inline'><p>The maximum number of values.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#min_values-instance_method" title="#min_values (instance method)">#<strong>min_values</strong> ⇒ Integer </a>
</span>
<span class="summary_desc"><div class='inline'><p>The minimum number of values.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#options-instance_method" title="#options (instance method)">#<strong>options</strong> ⇒ Array<SelectMenu::Option> </a>
</span>
<span class="summary_desc"><div class='inline'><p>The options of the select menu.</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>(custom_id, options, placeholder: nil, min_values: 1, max_values: 1) ⇒ SelectMenu </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>Initialize a new select menu.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_hash-instance_method" title="#to_hash (instance method)">#<strong>to_hash</strong> ⇒ Hash </a>
</span>
<span class="summary_desc"><div class='inline'><p>Converts the select menu to a hash.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Component.html" title="Discorb::Component (class)">Component</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Component.html#from_hash-class_method" title="Discorb::Component.from_hash (method)">from_hash</a></span></p>
<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>(custom_id, options, placeholder: nil, min_values: 1, max_values: 1) ⇒ <tt><span class='object_link'><a href="" title="Discorb::SelectMenu (class)">SelectMenu</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Initialize a new select menu.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>custom_id</span>
<span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
—
<div class='inline'><p>Custom ID of the select menu.</p>
</div>
</li>
<li>
<span class='name'>options</span>
<span class='type'>(<tt>Array<<span class='object_link'><a href="SelectMenu/Option.html" title="Discorb::SelectMenu::Option (class)">Discorb::SelectMenu::Option</a></span>></tt>)</span>
—
<div class='inline'><p>The options of the select menu.</p>
</div>
</li>
<li>
<span class='name'>placeholder</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The placeholder of the select menu.</p>
</div>
</li>
<li>
<span class='name'>min_values</span>
<span class='type'>(<tt>Integer</tt>)</span>
<em class="default">(defaults to: <tt>1</tt>)</em>
—
<div class='inline'><p>The minimum number of values.</p>
</div>
</li>
<li>
<span class='name'>max_values</span>
<span class='type'>(<tt>Integer</tt>)</span>
<em class="default">(defaults to: <tt>1</tt>)</em>
—
<div class='inline'><p>The maximum number of values.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
167
168
169
170
171
172
173</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/components.rb', line 167</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_custom_id'>custom_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='comma'>,</span> <span class='label'>placeholder:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>min_values:</span> <span class='int'>1</span><span class='comma'>,</span> <span class='label'>max_values:</span> <span class='int'>1</span><span class='rparen'>)</span>
<span class='ivar'>@custom_id</span> <span class='op'>=</span> <span class='id identifier rubyid_custom_id'>custom_id</span>
<span class='ivar'>@options</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span>
<span class='ivar'>@placeholder</span> <span class='op'>=</span> <span class='id identifier rubyid_placeholder'>placeholder</span>
<span class='ivar'>@min_values</span> <span class='op'>=</span> <span class='id identifier rubyid_min_values'>min_values</span>
<span class='ivar'>@max_values</span> <span class='op'>=</span> <span class='id identifier rubyid_max_values'>max_values</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="custom_id=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="custom_id-instance_method">
#<strong>custom_id</strong> ⇒ <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The custom ID of the select menu.</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 custom ID of the select menu.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
147
148
149</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/components.rb', line 147</span>
<span class='kw'>def</span> <span class='id identifier rubyid_custom_id'>custom_id</span>
<span class='ivar'>@custom_id</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="disabled-instance_method">
#<strong>disabled</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span>
<span class="aliases">Also known as:
<span class="names"><span id='disabled?-instance_method'>disabled?</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Whether the select menu is disabled.</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 select menu is disabled.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
155
156
157</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/components.rb', line 155</span>
<span class='kw'>def</span> <span class='id identifier rubyid_disabled'>disabled</span>
<span class='ivar'>@disabled</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="max_values=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="max_values-instance_method">
#<strong>max_values</strong> ⇒ <tt>Integer</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The maximum number of values.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
—
<div class='inline'><p>The maximum number of values.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
153
154
155</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/components.rb', line 153</span>
<span class='kw'>def</span> <span class='id identifier rubyid_max_values'>max_values</span>
<span class='ivar'>@max_values</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="min_values=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="min_values-instance_method">
#<strong>min_values</strong> ⇒ <tt>Integer</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The minimum number of values.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
—
<div class='inline'><p>The minimum number of values.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
151
152
153</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/components.rb', line 151</span>
<span class='kw'>def</span> <span class='id identifier rubyid_min_values'>min_values</span>
<span class='ivar'>@min_values</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="options=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="options-instance_method">
#<strong>options</strong> ⇒ <tt>Array<<span class='object_link'><a href="SelectMenu/Option.html" title="Discorb::SelectMenu::Option (class)">SelectMenu::Option</a></span>></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The options of the select menu.</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="SelectMenu/Option.html" title="Discorb::SelectMenu::Option (class)">SelectMenu::Option</a></span>></tt>)</span>
—
<div class='inline'><p>The options of the select menu.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
149
150
151</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/components.rb', line 149</span>
<span class='kw'>def</span> <span class='id identifier rubyid_options'>options</span>
<span class='ivar'>@options</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="to_hash-instance_method">
#<strong>to_hash</strong> ⇒ <tt>Hash</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Converts the select menu to a hash.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Hash</tt>)</span>
—
<div class='inline'><p>A hash representation of the select menu.</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><a href="https://discord.com/developers/docs/interactions/message-components#select-menu-object-select-menu-structure" target="_parent" title="Official Discord API docs">Official Discord API docs</a></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
181
182
183
184
185
186
187
188
189
190</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/components.rb', line 181</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_hash'>to_hash</span>
<span class='lbrace'>{</span>
<span class='label'>type:</span> <span class='int'>3</span><span class='comma'>,</span>
<span class='label'>custom_id:</span> <span class='ivar'>@custom_id</span><span class='comma'>,</span>
<span class='label'>options:</span> <span class='ivar'>@options</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:to_hash</span><span class='rparen'>)</span><span class='comma'>,</span>
<span class='label'>placeholder:</span> <span class='ivar'>@placeholder</span><span class='comma'>,</span>
<span class='label'>min_values:</span> <span class='ivar'>@min_values</span><span class='comma'>,</span>
<span class='label'>max_values:</span> <span class='ivar'>@max_values</span><span class='comma'>,</span>
<span class='rbrace'>}</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/b7303de88fddee34560510a2749c371c7f17b4da"><code>b7303de88fddee34560510a2749c371c7f17b4da</code></a>, version v0.0.3, with YARD 0.9.26.
</div>
</div>
</body>
</html>