<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title> Class: Discorb::Role::Tag — 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::Role::Tag"; 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 (T)</a> » <span class='title'><span class='object_link'><a href="../../Discorb.html" title="Discorb (module)">Discorb</a></span></span> » <span class='title'><span class='object_link'><a href="../Role.html" title="Discorb::Role (class)">Role</a></span></span> » <span class="title">Tag</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::Role::Tag </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::Role::Tag</li> </ul> <a href="#" class="inheritanceTree">show all</a> </dd> </dl> <dl> <dt>Defined in:</dt> <dd>lib/discorb/role.rb</dd> </dl> </div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p>Represents a tag of a role.</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="#bot%3F-instance_method" title="#bot? (instance method)">#<strong>bot?</strong> ⇒ Boolean </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>Whether the role is a bot role.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#bot_id-instance_method" title="#bot_id (instance method)">#<strong>bot_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 bot that owns the role.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#integration%3F-instance_method" title="#integration? (instance method)">#<strong>integration?</strong> ⇒ Boolean </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>Whether the role is an integration role.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#integration_id-instance_method" title="#integration_id (instance method)">#<strong>integration_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 integration.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#premium_subscriber-instance_method" title="#premium_subscriber (instance method)">#<strong>premium_subscriber</strong> ⇒ Boolean </a> (also: #premium_subscriber?) </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>Whether the tag is a premium subscriber role.</p> </div></span> </li> </ul> <h2>Method Summary</h2> <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="bot?-instance_method"> #<strong>bot?</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns Whether the role is a bot role.</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 role is a bot role.</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/role.rb', line 152</span> </pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="bot_id-instance_method"> #<strong>bot_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 bot that owns the role.</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 bot that owns the role.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 146 147 148</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/role.rb', line 146</span> <span class='kw'>def</span> <span class='id identifier rubyid_bot_id'>bot_id</span> <span class='ivar'>@bot_id</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="integration?-instance_method"> #<strong>integration?</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns Whether the role is an integration role.</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 role is an integration role.</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/role.rb', line 152</span> </pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="integration_id-instance_method"> #<strong>integration_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 integration.</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 integration.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 148 149 150</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/role.rb', line 148</span> <span class='kw'>def</span> <span class='id identifier rubyid_integration_id'>integration_id</span> <span class='ivar'>@integration_id</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="premium_subscriber-instance_method"> #<strong>premium_subscriber</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span> <span class="aliases">Also known as: <span class="names"><span id='premium_subscriber?-instance_method'>premium_subscriber?</span></span> </span> </h3><div class="docstring"> <div class="discussion"> <p>Returns Whether the tag is a premium subscriber role.</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 tag is a premium subscriber role.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 150 151 152</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/role.rb', line 150</span> <span class='kw'>def</span> <span class='id identifier rubyid_premium_subscriber'>premium_subscriber</span> <span class='ivar'>@premium_subscriber</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/19ae285d67a4c811bc6a8463bac2a1aca88a8667"><code>19ae285d67a4c811bc6a8463bac2a1aca88a8667</code></a>, version v0.2.0, with YARD 0.9.26. </div> </div> </body> </html>