<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Discorb::Button
— 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::Button";
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 (B)</a> »
<span class='title'><span class='object_link'><a href="../Discorb.html" title="Discorb (module)">Discorb</a></span></span>
»
<span class="title">Button</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::Button
</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::Button</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 button component.</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="#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 button.</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="summary_desc"><div class='inline'><p>Whether the button is disabled.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#emoji-instance_method" title="#emoji (instance method)">#<strong>emoji</strong> ⇒ Discorb::Emoji </a>
</span>
<span class="summary_desc"><div class='inline'><p>The emoji of the button.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#label-instance_method" title="#label (instance method)">#<strong>label</strong> ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>The label of the button.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#style-instance_method" title="#style (instance method)">#<strong>style</strong> ⇒ :primary, ... </a>
</span>
<span class="summary_desc"><div class='inline'><p>The style of the button.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#url-instance_method" title="#url (instance method)">#<strong>url</strong> ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>The URL of the button.</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>(label, style = :primary, emoji: nil, custom_id: nil, url: nil, disabled: false) ⇒ Button </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>Initialize a new button.</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 button 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>(label, style = :primary, emoji: nil, custom_id: nil, url: nil, disabled: false) ⇒ <tt><span class='object_link'><a href="" title="Discorb::Button (class)">Button</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Initialize a new button.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>label</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The label of the button.</p>
</div>
</li>
<li>
<span class='name'>style</span>
<span class='type'>(<tt>:primary</tt>, <tt>:secondary</tt>, <tt>:success</tt>, <tt>:danger</tt>, <tt>:link</tt>)</span>
<em class="default">(defaults to: <tt>:primary</tt>)</em>
—
<div class='inline'><p>The style of the button.</p>
</div>
</li>
<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>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The emoji of the button.</p>
</div>
</li>
<li>
<span class='name'>custom_id</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The custom ID of the button.</p>
</div>
</li>
<li>
<span class='name'>url</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The URL of the button.</p>
</div>
</li>
<li>
<span class='name'>disabled</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
—
<div class='inline'><p>Whether the button is disabled.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
80
81
82
83
84
85
86
87</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/components.rb', line 80</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_label'>label</span><span class='comma'>,</span> <span class='id identifier rubyid_style'>style</span> <span class='op'>=</span> <span class='symbol'>:primary</span><span class='comma'>,</span> <span class='label'>emoji:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>custom_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>url:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>disabled:</span> <span class='kw'>false</span><span class='rparen'>)</span>
<span class='ivar'>@label</span> <span class='op'>=</span> <span class='id identifier rubyid_label'>label</span>
<span class='ivar'>@style</span> <span class='op'>=</span> <span class='id identifier rubyid_style'>style</span>
<span class='ivar'>@emoji</span> <span class='op'>=</span> <span class='id identifier rubyid_emoji'>emoji</span>
<span class='ivar'>@custom_id</span> <span class='op'>=</span> <span class='id identifier rubyid_custom_id'>custom_id</span>
<span class='ivar'>@url</span> <span class='op'>=</span> <span class='id identifier rubyid_url'>url</span>
<span class='ivar'>@disabled</span> <span class='op'>=</span> <span class='id identifier rubyid_disabled'>disabled</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 button.
Won't be used if the style is <code>:link</code>.</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 button.
Won't be used if the style is <code>:link</code>.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
54
55
56</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/components.rb', line 54</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="disabled=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="disabled-instance_method">
#<strong>disabled</strong> ⇒ <tt>Boolean</tt>
<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 button 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 button is disabled.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
59
60
61</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/components.rb', line 59</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="emoji=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="emoji-instance_method">
#<strong>emoji</strong> ⇒ <tt><span class='object_link'><a href="Emoji.html" title="Discorb::Emoji (class)">Discorb::Emoji</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The emoji of the button.</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="Emoji.html" title="Discorb::Emoji (class)">Discorb::Emoji</a></span></tt>)</span>
—
<div class='inline'><p>The emoji of the button.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
51
52
53</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/components.rb', line 51</span>
<span class='kw'>def</span> <span class='id identifier rubyid_emoji'>emoji</span>
<span class='ivar'>@emoji</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="label=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="label-instance_method">
#<strong>label</strong> ⇒ <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The label of the button.</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 label of the button.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
47
48
49</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/components.rb', line 47</span>
<span class='kw'>def</span> <span class='id identifier rubyid_label'>label</span>
<span class='ivar'>@label</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="style=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="style-instance_method">
#<strong>style</strong> ⇒ <tt>:primary</tt>, ...
</h3><div class="docstring">
<div class="discussion">
<p>Returns The style of the button.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>:primary</tt>, <tt>:secondary</tt>, <tt>:success</tt>, <tt>:danger</tt>, <tt>:link</tt>)</span>
—
<div class='inline'><p>The style of the button.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
49
50
51</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/components.rb', line 49</span>
<span class='kw'>def</span> <span class='id identifier rubyid_style'>style</span>
<span class='ivar'>@style</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="url=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="url-instance_method">
#<strong>url</strong> ⇒ <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The URL of the button.
Only used when the style is <code>:link</code>.</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 of the button.
Only used when the style is <code>:link</code>.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
57
58
59</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/components.rb', line 57</span>
<span class='kw'>def</span> <span class='id identifier rubyid_url'>url</span>
<span class='ivar'>@url</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 button 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 button.</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#button-object-button-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">
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/components.rb', line 95</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_hash'>to_hash</span>
<span class='kw'>if</span> <span class='ivar'>@style</span> <span class='op'>==</span> <span class='symbol'>:link</span>
<span class='lbrace'>{</span>
<span class='label'>type:</span> <span class='int'>2</span><span class='comma'>,</span>
<span class='label'>label:</span> <span class='ivar'>@label</span><span class='comma'>,</span>
<span class='label'>style:</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_styles'>styles</span><span class='lbracket'>[</span><span class='ivar'>@style</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='label'>url:</span> <span class='ivar'>@url</span><span class='comma'>,</span>
<span class='label'>emoji:</span> <span class='id identifier rubyid_hash_emoji'>hash_emoji</span><span class='lparen'>(</span><span class='ivar'>@emoji</span><span class='rparen'>)</span><span class='comma'>,</span>
<span class='label'>disabled:</span> <span class='ivar'>@disabled</span><span class='comma'>,</span>
<span class='rbrace'>}</span>
<span class='kw'>else</span>
<span class='lbrace'>{</span>
<span class='label'>type:</span> <span class='int'>2</span><span class='comma'>,</span>
<span class='label'>label:</span> <span class='ivar'>@label</span><span class='comma'>,</span>
<span class='label'>style:</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_styles'>styles</span><span class='lbracket'>[</span><span class='ivar'>@style</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='label'>custom_id:</span> <span class='ivar'>@custom_id</span><span class='comma'>,</span>
<span class='label'>emoji:</span> <span class='id identifier rubyid_hash_emoji'>hash_emoji</span><span class='lparen'>(</span><span class='ivar'>@emoji</span><span class='rparen'>)</span><span class='comma'>,</span>
<span class='label'>disabled:</span> <span class='ivar'>@disabled</span><span class='comma'>,</span>
<span class='rbrace'>}</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/27a4a46a8d847860751d0c3758742f6c09cec01b"><code>27a4a46a8d847860751d0c3758742f6c09cec01b</code></a>, version v0.0.5, with YARD 0.9.26.
</div>
</div>
</body>
</html>