<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title> Class: Discorb::Sticker::Pack — 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::Sticker::Pack"; 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 (P)</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="../Sticker.html" title="Discorb::Sticker (class)">Sticker</a></span></span> » <span class="title">Pack</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::Sticker::Pack </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::Sticker::Pack</li> </ul> <a href="#" class="inheritanceTree">show all</a> </dd> </dl> <dl> <dt>Defined in:</dt> <dd>lib/discorb/sticker.rb</dd> </dl> </div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p>Represents a sticker pack.</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="#banner-instance_method" title="#banner (instance method)">#<strong>banner</strong> ⇒ Discorb::Asset </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>The banner of the pack.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#banner_asset_id-instance_method" title="#banner_asset_id (instance method)">#<strong>banner_asset_id</strong> ⇒ Discorb::Store::SKU </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>The banner asset ID of the pack.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#cover_sticker_id-instance_method" title="#cover_sticker_id (instance method)">#<strong>cover_sticker_id</strong> ⇒ Discorb::Snowflake </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>The cover sticker of the pack.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#description-instance_method" title="#description (instance method)">#<strong>description</strong> ⇒ String </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>The description of the pack.</p> </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 sticker pack.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> ⇒ String </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>The name of the sticker pack.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#sku_id-instance_method" title="#sku_id (instance method)">#<strong>sku_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 SKU.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#stickers-instance_method" title="#stickers (instance method)">#<strong>stickers</strong> ⇒ Array<Discorb::Sticker> </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>The stickers in the pack.</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="banner-instance_method"> #<strong>banner</strong> ⇒ <tt><span class='object_link'><a href="../Asset.html" title="Discorb::Asset (class)">Discorb::Asset</a></span></tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns The banner of the pack.</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="../Asset.html" title="Discorb::Asset (class)">Discorb::Asset</a></span></tt>)</span> — <div class='inline'><p>The banner of the pack.</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/sticker.rb', line 117</span> <span class='kw'>def</span> <span class='id identifier rubyid_banner'>banner</span> <span class='ivar'>@banner</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="banner_asset_id-instance_method"> #<strong>banner_asset_id</strong> ⇒ <tt>Discorb::Store::SKU</tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns The banner asset ID of the pack.</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Discorb::Store::SKU</tt>)</span> — <div class='inline'><p>The banner asset ID of the pack.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 113 114 115</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/sticker.rb', line 113</span> <span class='kw'>def</span> <span class='id identifier rubyid_banner_asset_id'>banner_asset_id</span> <span class='ivar'>@banner_asset_id</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="cover_sticker_id-instance_method"> #<strong>cover_sticker_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 cover sticker of the pack.</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 cover sticker of the pack.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 109 110 111</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/sticker.rb', line 109</span> <span class='kw'>def</span> <span class='id identifier rubyid_cover_sticker_id'>cover_sticker_id</span> <span class='ivar'>@cover_sticker_id</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="description-instance_method"> #<strong>description</strong> ⇒ <tt>String</tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns The description of the pack.</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 description of the pack.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 111 112 113</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/sticker.rb', line 111</span> <span class='kw'>def</span> <span class='id identifier rubyid_description'>description</span> <span class='ivar'>@description</span> <span class='kw'>end</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 sticker pack.</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 sticker pack.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 103 104 105</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/sticker.rb', line 103</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="name-instance_method"> #<strong>name</strong> ⇒ <tt>String</tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns The name of the sticker pack.</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 name of the sticker pack.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 105 106 107</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/sticker.rb', line 105</span> <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span> <span class='ivar'>@name</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="sku_id-instance_method"> #<strong>sku_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 SKU.</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 SKU.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 107 108 109</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/sticker.rb', line 107</span> <span class='kw'>def</span> <span class='id identifier rubyid_sku_id'>sku_id</span> <span class='ivar'>@sku_id</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>Array<<span class='object_link'><a href="../Sticker.html" title="Discorb::Sticker (class)">Discorb::Sticker</a></span>></tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns The stickers in the pack.</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="../Sticker.html" title="Discorb::Sticker (class)">Discorb::Sticker</a></span>></tt>)</span> — <div class='inline'><p>The stickers in the pack.</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/sticker.rb', line 115</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> </div> </div> <div id="footer"> Generated from <a href="https://github.com/discorb-lib/discorb/tree/92458538de1b949348a05adf9b6a71df0e532cc8"><code>92458538de1b949348a05adf9b6a71df0e532cc8</code></a>, version v0.2.2, with YARD 0.9.26. </div> </div> </body> </html>