djs-menu-v13
Version:
A module for create simple and complex menu for your Discord Bot
19 lines • 20 kB
HTML
<html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MenuPage | djs-menu-v13</title><meta name="description" content="Documentation for djs-menu-v13"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">djs-menu-v13</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">djs-menu-v13</a></li><li><a href="MenuPage.html">MenuPage</a></li></ul><h1>Class MenuPage</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
<p>This class that represent a page in a menu.</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">MenuPage</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="MenuPage.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="MenuPage.html#buttons" class="tsd-kind-icon">buttons</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MenuPage.html#content" class="tsd-kind-icon">content</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MenuPage.html#embeds" class="tsd-kind-icon">embeds</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MenuPage.html#files" class="tsd-kind-icon">files</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MenuPage.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MenuPage.html#timeout" class="tsd-kind-icon">timeout</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MenuPage.html#type" class="tsd-kind-icon">type</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="MenuPage.html#addButton" class="tsd-kind-icon">add<wbr/>Button</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MenuPage.html#addEmbed" class="tsd-kind-icon">add<wbr/>Embed</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MenuPage.html#addFile" class="tsd-kind-icon">add<wbr/>File</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MenuPage.html#setContent" class="tsd-kind-icon">set<wbr/>Content</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MenuPage.html#setId" class="tsd-kind-icon">set<wbr/>Id</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MenuPage.html#setTimeout" class="tsd-kind-icon">set<wbr/>Timeout</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Menu<wbr/>Page<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MenuPage.html" class="tsd-signature-type" data-tsd-kind="Class">MenuPage</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Shizey/djs-menu-v13/blob/e7e4bb2/src/Classes/Page.ts#L23">src/Classes/Page.ts:23</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="MenuPage.html" class="tsd-signature-type" data-tsd-kind="Class">MenuPage</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="buttons" class="tsd-anchor"></a><h3>buttons</h3><div class="tsd-signature tsd-kind-icon">buttons<span class="tsd-signature-symbol">:</span> <a href="../modules.html#MenuButton" class="tsd-signature-type" data-tsd-kind="Type alias">MenuButton</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Shizey/djs-menu-v13/blob/e7e4bb2/src/Classes/Page.ts#L16">src/Classes/Page.ts:16</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="content" class="tsd-anchor"></a><h3>content</h3><div class="tsd-signature tsd-kind-icon">content<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Shizey/djs-menu-v13/blob/e7e4bb2/src/Classes/Page.ts#L15">src/Classes/Page.ts:15</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="embeds" class="tsd-anchor"></a><h3>embeds</h3><div class="tsd-signature tsd-kind-icon">embeds<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MessageEmbed</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Shizey/djs-menu-v13/blob/e7e4bb2/src/Classes/Page.ts#L14">src/Classes/Page.ts:14</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="files" class="tsd-anchor"></a><h3>files</h3><div class="tsd-signature tsd-kind-icon">files<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MessageAttachment</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Shizey/djs-menu-v13/blob/e7e4bb2/src/Classes/Page.ts#L17">src/Classes/Page.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="id" class="tsd-anchor"></a><h3>id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Shizey/djs-menu-v13/blob/e7e4bb2/src/Classes/Page.ts#L13">src/Classes/Page.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="timeout" class="tsd-anchor"></a><h3>timeout</h3><div class="tsd-signature tsd-kind-icon">timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Shizey/djs-menu-v13/blob/e7e4bb2/src/Classes/Page.ts#L18">src/Classes/Page.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Shizey/djs-menu-v13/blob/e7e4bb2/src/Classes/Page.ts#L19">src/Classes/Page.ts:19</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="addButton" class="tsd-anchor"></a><h3>add<wbr/>Button</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">add<wbr/>Button<span class="tsd-signature-symbol">(</span>button<span class="tsd-signature-symbol">: </span><a href="../modules.html#SingleButton" class="tsd-signature-type" data-tsd-kind="Type alias">SingleButton</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MenuPage.html" class="tsd-signature-type" data-tsd-kind="Class">MenuPage</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Shizey/djs-menu-v13/blob/e7e4bb2/src/Classes/Page.ts#L70">src/Classes/Page.ts:70</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A function for add a button to the page.
The target is the ID of the page that will be displayed
when the button is clicked.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>button: <a href="../modules.html#SingleButton" class="tsd-signature-type" data-tsd-kind="Type alias">SingleButton</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="MenuPage.html" class="tsd-signature-type" data-tsd-kind="Class">MenuPage</a></h4><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="addEmbed" class="tsd-anchor"></a><h3>add<wbr/>Embed</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">add<wbr/>Embed<span class="tsd-signature-symbol">(</span>embed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MessageEmbed</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MenuPage.html" class="tsd-signature-type" data-tsd-kind="Class">MenuPage</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Shizey/djs-menu-v13/blob/e7e4bb2/src/Classes/Page.ts#L48">src/Classes/Page.ts:48</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A function for add embed that will display in the message page</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>embed: <span class="tsd-signature-type">MessageEmbed</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="MenuPage.html" class="tsd-signature-type" data-tsd-kind="Class">MenuPage</a></h4><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="addFile" class="tsd-anchor"></a><h3>add<wbr/>File</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">add<wbr/>File<span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MessageAttachment</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MenuPage.html" class="tsd-signature-type" data-tsd-kind="Class">MenuPage</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Shizey/djs-menu-v13/blob/e7e4bb2/src/Classes/Page.ts#L99">src/Classes/Page.ts:99</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A function for add a file that will displayed in the page.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>file: <span class="tsd-signature-type">MessageAttachment</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="MenuPage.html" class="tsd-signature-type" data-tsd-kind="Class">MenuPage</a></h4><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setContent" class="tsd-anchor"></a><h3>set<wbr/>Content</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Content<span class="tsd-signature-symbol">(</span>content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MenuPage.html" class="tsd-signature-type" data-tsd-kind="Class">MenuPage</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Shizey/djs-menu-v13/blob/e7e4bb2/src/Classes/Page.ts#L58">src/Classes/Page.ts:58</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A function for set the content of the Discord message.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>content: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="MenuPage.html" class="tsd-signature-type" data-tsd-kind="Class">MenuPage</a></h4><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setId" class="tsd-anchor"></a><h3>set<wbr/>Id</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Id<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MenuPage.html" class="tsd-signature-type" data-tsd-kind="Class">MenuPage</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Shizey/djs-menu-v13/blob/e7e4bb2/src/Classes/Page.ts#L38">src/Classes/Page.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The ID of the page.
This ID will be used to identify the page in the button with target.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="MenuPage.html" class="tsd-signature-type" data-tsd-kind="Class">MenuPage</a></h4><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setTimeout" class="tsd-anchor"></a><h3>set<wbr/>Timeout</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Timeout<span class="tsd-signature-symbol">(</span>timeout<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MenuPage.html" class="tsd-signature-type" data-tsd-kind="Class">MenuPage</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Shizey/djs-menu-v13/blob/e7e4bb2/src/Classes/Page.ts#L89">src/Classes/Page.ts:89</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A function for set the timeout
before that you are unable to interact with the page.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>timeout: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="MenuPage.html" class="tsd-signature-type" data-tsd-kind="Class">MenuPage</a></h4><div></div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="MenuPage.html" class="tsd-kind-icon">Menu<wbr/>Page</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="MenuPage.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MenuPage.html#buttons" class="tsd-kind-icon">buttons</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MenuPage.html#content" class="tsd-kind-icon">content</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MenuPage.html#embeds" class="tsd-kind-icon">embeds</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MenuPage.html#files" class="tsd-kind-icon">files</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MenuPage.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MenuPage.html#timeout" class="tsd-kind-icon">timeout</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MenuPage.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MenuPage.html#addButton" class="tsd-kind-icon">add<wbr/>Button</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MenuPage.html#addEmbed" class="tsd-kind-icon">add<wbr/>Embed</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MenuPage.html#addFile" class="tsd-kind-icon">add<wbr/>File</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MenuPage.html#setContent" class="tsd-kind-icon">set<wbr/>Content</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MenuPage.html#setId" class="tsd-kind-icon">set<wbr/>Id</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MenuPage.html#setTimeout" class="tsd-kind-icon">set<wbr/>Timeout</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>