cath/docs/classes/GiveawaysClient.html
2021-10-27 08:25:48 +08:00

4 lines
No EOL
37 KiB
HTML

<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>GiveawaysClient | cath</title><meta name="description" content="Documentation for cath"/><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><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">cath</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">cath</a></li><li><a href="GiveawaysClient.html">GiveawaysClient</a></li></ul><h1>Class GiveawaysClient</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">GiveawaysClient</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="GiveawaysClient.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="GiveawaysClient.html#GiveawayMessages" class="tsd-kind-icon">Giveaway<wbr/>Messages</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="GiveawaysClient.html#MongooseConnectionURI" class="tsd-kind-icon">Mongoose<wbr/>ConnectionURI</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="GiveawaysClient.html#client" class="tsd-kind-icon">client</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="GiveawaysClient.html#schema" class="tsd-kind-icon">schema</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 tsd-is-private"><a href="GiveawaysClient.html#checkRoles" class="tsd-kind-icon">check<wbr/>Roles</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="GiveawaysClient.html#choose" class="tsd-kind-icon">choose</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="GiveawaysClient.html#create" class="tsd-kind-icon">create</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="GiveawaysClient.html#editButtons" class="tsd-kind-icon">edit<wbr/>Buttons</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="GiveawaysClient.html#end" class="tsd-kind-icon">end</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="GiveawaysClient.html#endByButton" class="tsd-kind-icon">end<wbr/>By<wbr/>Button</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="GiveawaysClient.html#getButtons" class="tsd-kind-icon">get<wbr/>Buttons</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="GiveawaysClient.html#getByMessage" class="tsd-kind-icon">get<wbr/>By<wbr/>Message</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="GiveawaysClient.html#giveawayEmbed" class="tsd-kind-icon">giveaway<wbr/>Embed</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="GiveawaysClient.html#gotoGiveaway" class="tsd-kind-icon">goto<wbr/>Giveaway</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="GiveawaysClient.html#replacePlaceholders" class="tsd-kind-icon">replace<wbr/>Placeholders</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="GiveawaysClient.html#reroll" class="tsd-kind-icon">reroll</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="GiveawaysClient.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="GiveawaysClient.html#startTimer" class="tsd-kind-icon">start<wbr/>Timer</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 name="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/>Giveaways<wbr/>Client<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/GiveawaysClientOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">GiveawaysClientOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="GiveawaysClient.html" class="tsd-signature-type" data-tsd-kind="Class">GiveawaysClient</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.ts:79</li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>name</dt><dd><p>GiveawaysClient</p>
</dd><dt>kind</dt><dd><p>constructor</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/GiveawaysClientOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">GiveawaysClientOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="GiveawaysClient.html" class="tsd-signature-type" data-tsd-kind="Class">GiveawaysClient</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 name="GiveawayMessages" class="tsd-anchor"></a><h3>Giveaway<wbr/>Messages</h3><div class="tsd-signature tsd-kind-icon">Giveaway<wbr/>Messages<span class="tsd-signature-symbol">:</span> <a href="../interfaces/DefaultGiveawayMessages.html" class="tsd-signature-type" data-tsd-kind="Interface">DefaultGiveawayMessages</a></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.ts:71</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="MongooseConnectionURI" class="tsd-anchor"></a><h3>Mongoose<wbr/>ConnectionURI</h3><div class="tsd-signature tsd-kind-icon">Mongoose<wbr/>ConnectionURI<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.ts:72</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="client" class="tsd-anchor"></a><h3>client</h3><div class="tsd-signature tsd-kind-icon">client<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Client</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.ts:70</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="schema" class="tsd-anchor"></a><h3>schema</h3><div class="tsd-signature tsd-kind-icon">schema<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Model</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/GiveawaySchema.html" class="tsd-signature-type" data-tsd-kind="Interface">GiveawaySchema</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.ts:21</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 tsd-is-private"><a name="checkRoles" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> check<wbr/>Roles</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">check<wbr/>Roles<span class="tsd-signature-symbol">(</span>userID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, roleIDs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.ts:260</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>userID: <span class="tsd-signature-type">string</span></h5></li><li><h5>roleIDs: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li><h5>message: <span class="tsd-signature-type">Message</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a name="choose" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> choose</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">choose<span class="tsd-signature-symbol">(</span>winners<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, msgid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.ts:233</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>winners: <span class="tsd-signature-type">number</span></h5></li><li><h5>msgid: <span class="tsd-signature-type">string</span></h5></li><li><h5>message: <span class="tsd-signature-type">Message</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="create" class="tsd-anchor"></a><h3>create</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">create<span class="tsd-signature-symbol">(</span>client<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Client</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span>, __namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.ts:335</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>client: <span class="tsd-signature-type">Client</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h5></li><li><h5>__namedParameters: <span class="tsd-signature-type">Object</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a name="editButtons" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> edit<wbr/>Buttons</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">edit<wbr/>Buttons<span class="tsd-signature-symbol">(</span>client<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Client</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span>, data<span class="tsd-signature-symbol">: </span><a href="../interfaces/GiveawaySchema.html" class="tsd-signature-type" data-tsd-kind="Interface">GiveawaySchema</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.ts:275</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>client: <span class="tsd-signature-type">Client</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h5></li><li><h5>data: <a href="../interfaces/GiveawaySchema.html" class="tsd-signature-type" data-tsd-kind="Interface">GiveawaySchema</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="end" class="tsd-anchor"></a><h3>end</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">end<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Message</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, giveawaymsg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">&quot;ENDED&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;NO_WINNERS&quot;</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.ts:507</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>message: <span class="tsd-signature-type">Message</span></h5></li><li><h5>data: <span class="tsd-signature-type">any</span></h5></li><li><h5>giveawaymsg: <span class="tsd-signature-type">Message</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">&quot;ENDED&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;NO_WINNERS&quot;</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a name="endByButton" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> end<wbr/>By<wbr/>Button</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">end<wbr/>By<wbr/>Button<span class="tsd-signature-symbol">(</span>client<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Client</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span>, Message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, button<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ButtonInteraction</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.ts:481</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>client: <span class="tsd-signature-type">Client</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h5></li><li><h5>Message: <span class="tsd-signature-type">string</span></h5></li><li><h5>button: <span class="tsd-signature-type">ButtonInteraction</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a name="getButtons" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> get<wbr/>Buttons</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">get<wbr/>Buttons<span class="tsd-signature-symbol">(</span>host<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><span class="tsd-signature-type">MessageButton</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.ts:212</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>host: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">MessageButton</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="getByMessage" class="tsd-anchor"></a><h3>get<wbr/>By<wbr/>Message</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>By<wbr/>Message<span class="tsd-signature-symbol">(</span>Message<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><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/GiveawaySchema.html" class="tsd-signature-type" data-tsd-kind="Interface">GiveawaySchema</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">Document</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/GiveawaySchema.html" class="tsd-signature-type" data-tsd-kind="Interface">GiveawaySchema</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.ts:616</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>Message: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/GiveawaySchema.html" class="tsd-signature-type" data-tsd-kind="Interface">GiveawaySchema</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">Document</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/GiveawaySchema.html" class="tsd-signature-type" data-tsd-kind="Interface">GiveawaySchema</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a name="giveawayEmbed" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> giveaway<wbr/>Embed</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">giveaway<wbr/>Embed<span class="tsd-signature-symbol">(</span>client<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Client</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span>, status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, __namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">MessageEmbed</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.ts:300</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>client: <span class="tsd-signature-type">Client</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h5></li><li><h5>status: <span class="tsd-signature-type">string</span></h5></li><li><h5>__namedParameters: <span class="tsd-signature-type">Object</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">MessageEmbed</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a name="gotoGiveaway" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> goto<wbr/>Giveaway</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">goto<wbr/>Giveaway<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MessageButton</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.ts:472</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>data: <span class="tsd-signature-type">any</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">MessageButton</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a name="replacePlaceholders" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> replace<wbr/>Placeholders</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">replace<wbr/>Placeholders<span class="tsd-signature-symbol">(</span>string<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">: </span><a href="../interfaces/GiveawaySchema.html" class="tsd-signature-type" data-tsd-kind="Interface">GiveawaySchema</a>, msg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Message</span>, winners<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.ts:668</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>string: <span class="tsd-signature-type">string</span></h5></li><li><h5>data: <a href="../interfaces/GiveawaySchema.html" class="tsd-signature-type" data-tsd-kind="Interface">GiveawaySchema</a></h5></li><li><h5>msg: <span class="tsd-signature-type">Message</span></h5></li><li><h5>winners: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="reroll" class="tsd-anchor"></a><h3>reroll</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">reroll<span class="tsd-signature-symbol">(</span>client<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Client</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span>, Message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.ts:583</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>client: <span class="tsd-signature-type">Client</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h5></li><li><h5>Message: <span class="tsd-signature-type">string</span></h5></li><li><h5>message: <span class="tsd-signature-type">Message</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="start" class="tsd-anchor"></a><h3>start</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span>client<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Client</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.ts:621</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>client: <span class="tsd-signature-type">Client</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a name="startTimer" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> start<wbr/>Timer</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">start<wbr/>Timer<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Message</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, instant<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.ts:398</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>message: <span class="tsd-signature-type">Message</span></h5></li><li><h5>data: <span class="tsd-signature-type">any</span></h5></li><li><h5>instant: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></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="GiveawaysClient.html" class="tsd-kind-icon">Giveaways<wbr/>Client</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="GiveawaysClient.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="GiveawaysClient.html#GiveawayMessages" class="tsd-kind-icon">Giveaway<wbr/>Messages</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="GiveawaysClient.html#MongooseConnectionURI" class="tsd-kind-icon">Mongoose<wbr/>ConnectionURI</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="GiveawaysClient.html#client" class="tsd-kind-icon">client</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="GiveawaysClient.html#schema" class="tsd-kind-icon">schema</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="GiveawaysClient.html#checkRoles" class="tsd-kind-icon">check<wbr/>Roles</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="GiveawaysClient.html#choose" class="tsd-kind-icon">choose</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="GiveawaysClient.html#create" class="tsd-kind-icon">create</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="GiveawaysClient.html#editButtons" class="tsd-kind-icon">edit<wbr/>Buttons</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="GiveawaysClient.html#end" class="tsd-kind-icon">end</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="GiveawaysClient.html#endByButton" class="tsd-kind-icon">end<wbr/>By<wbr/>Button</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="GiveawaysClient.html#getButtons" class="tsd-kind-icon">get<wbr/>Buttons</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="GiveawaysClient.html#getByMessage" class="tsd-kind-icon">get<wbr/>By<wbr/>Message</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="GiveawaysClient.html#giveawayEmbed" class="tsd-kind-icon">giveaway<wbr/>Embed</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="GiveawaysClient.html#gotoGiveaway" class="tsd-kind-icon">goto<wbr/>Giveaway</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="GiveawaysClient.html#replacePlaceholders" class="tsd-kind-icon">replace<wbr/>Placeholders</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="GiveawaysClient.html#reroll" class="tsd-kind-icon">reroll</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="GiveawaysClient.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="GiveawaysClient.html#startTimer" class="tsd-kind-icon">start<wbr/>Timer</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><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private 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>