cath/interfaces/GiveawaySchema.html
2021-10-27 08:27:12 +08:00

1 line
No EOL
12 KiB
HTML

<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>GiveawaySchema | 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="GiveawaySchema.html">GiveawaySchema</a></li></ul><h1>Interface GiveawaySchema</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">GiveawaySchema</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>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GiveawaySchema.html#Award" class="tsd-kind-icon">Award</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GiveawaySchema.html#Channel" class="tsd-kind-icon">Channel</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GiveawaySchema.html#Clickers" class="tsd-kind-icon">Clickers</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GiveawaySchema.html#End" class="tsd-kind-icon">End</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GiveawaySchema.html#Ended" class="tsd-kind-icon">Ended</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GiveawaySchema.html#Guild" class="tsd-kind-icon">Guild</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GiveawaySchema.html#HostBy" class="tsd-kind-icon">Host<wbr/>By</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GiveawaySchema.html#Message" class="tsd-kind-icon">Message</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GiveawaySchema.html#Requirements" class="tsd-kind-icon">Requirements</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GiveawaySchema.html#Start" class="tsd-kind-icon">Start</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GiveawaySchema.html#Winners" class="tsd-kind-icon">Winners</a></li></ul></section></div></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-interface"><a name="Award" class="tsd-anchor"></a><h3>Award</h3><div class="tsd-signature tsd-kind-icon">Award<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.interface.ts:9</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="Channel" class="tsd-anchor"></a><h3>Channel</h3><div class="tsd-signature tsd-kind-icon">Channel<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.interface.ts:4</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="Clickers" class="tsd-anchor"></a><h3>Clickers</h3><div class="tsd-signature tsd-kind-icon">Clickers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.interface.ts:13</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="End" class="tsd-anchor"></a><h3>End</h3><div class="tsd-signature tsd-kind-icon">End<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.interface.ts:7</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="Ended" class="tsd-anchor"></a><h3>Ended</h3><div class="tsd-signature tsd-kind-icon">Ended<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.interface.ts:11</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="Guild" class="tsd-anchor"></a><h3>Guild</h3><div class="tsd-signature tsd-kind-icon">Guild<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.interface.ts:3</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="HostBy" class="tsd-anchor"></a><h3>Host<wbr/>By</h3><div class="tsd-signature tsd-kind-icon">Host<wbr/>By<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.interface.ts:6</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="Message" class="tsd-anchor"></a><h3>Message</h3><div class="tsd-signature tsd-kind-icon">Message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.interface.ts:5</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="Requirements" class="tsd-anchor"></a><h3>Requirements</h3><div class="tsd-signature tsd-kind-icon">Requirements<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>Enabled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>Roles<span class="tsd-signature-symbol">?: </span><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></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.interface.ts:12</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>Enabled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> Roles<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="Start" class="tsd-anchor"></a><h3>Start</h3><div class="tsd-signature tsd-kind-icon">Start<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.interface.ts:8</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="Winners" class="tsd-anchor"></a><h3>Winners</h3><div class="tsd-signature tsd-kind-icon">Winners<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.interface.ts:10</li></ul></aside></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-interface"><a href="GiveawaySchema.html" class="tsd-kind-icon">Giveaway<wbr/>Schema</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GiveawaySchema.html#Award" class="tsd-kind-icon">Award</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GiveawaySchema.html#Channel" class="tsd-kind-icon">Channel</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GiveawaySchema.html#Clickers" class="tsd-kind-icon">Clickers</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GiveawaySchema.html#End" class="tsd-kind-icon">End</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GiveawaySchema.html#Ended" class="tsd-kind-icon">Ended</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GiveawaySchema.html#Guild" class="tsd-kind-icon">Guild</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GiveawaySchema.html#HostBy" class="tsd-kind-icon">Host<wbr/>By</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GiveawaySchema.html#Message" class="tsd-kind-icon">Message</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GiveawaySchema.html#Requirements" class="tsd-kind-icon">Requirements</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GiveawaySchema.html#Start" class="tsd-kind-icon">Start</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GiveawaySchema.html#Winners" class="tsd-kind-icon">Winners</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>