4 lines
37 KiB
HTML
4 lines
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-paren
|
||
|
|
</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"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></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"><</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">></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
|