cath/interfaces/DefaultGiveawayMessages.html
2021-10-09 08:51:53 +08:00

1 line
No EOL
18 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>DefaultGiveawayMessages | 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="DefaultGiveawayMessages.html">DefaultGiveawayMessages</a></li></ul><h1>Interface DefaultGiveawayMessages</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">DefaultGiveawayMessages</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="DefaultGiveawayMessages.html#alreadyEnded" class="tsd-kind-icon">already<wbr/>Ended</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#alreadyParticipated" class="tsd-kind-icon">already<wbr/>Participated</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#dmMessage" class="tsd-kind-icon">dm<wbr/>Message</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#dmWinner" class="tsd-kind-icon">dm<wbr/>Winner</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#editParticipants" class="tsd-kind-icon">edit<wbr/>Participants</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#giveaway" class="tsd-kind-icon">giveaway</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#giveawayDescription" class="tsd-kind-icon">giveaway<wbr/>Description</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#giveawayFooterImage" class="tsd-kind-icon">giveaway<wbr/>Footer<wbr/>Image</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#newParticipant" class="tsd-kind-icon">new<wbr/>Participant</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#noLevel" class="tsd-kind-icon">no<wbr/>Level</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#noParticipants" class="tsd-kind-icon">no<wbr/>Participants</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#noWeeklyExp" class="tsd-kind-icon">no<wbr/>Weekly<wbr/>Exp</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#noWinner" class="tsd-kind-icon">no<wbr/>Winner</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#nonoRole" class="tsd-kind-icon">nono<wbr/>Role</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#rerolledMessage" class="tsd-kind-icon">rerolled<wbr/>Message</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#toParticipate" class="tsd-kind-icon">to<wbr/>Participate</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#winMessage" class="tsd-kind-icon">win<wbr/>Message</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="alreadyEnded" class="tsd-anchor"></a><h3>already<wbr/>Ended</h3><div class="tsd-signature tsd-kind-icon">already<wbr/>Ended<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;The giveaway had already ended!&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.interface.ts:42</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="alreadyParticipated" class="tsd-anchor"></a><h3>already<wbr/>Participated</h3><div class="tsd-signature tsd-kind-icon">already<wbr/>Participated<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;**You have already participated in this giveaway!**&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.interface.ts:38</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="dmMessage" class="tsd-anchor"></a><h3>dm<wbr/>Message</h3><div class="tsd-signature tsd-kind-icon">dm<wbr/>Message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;You have won a giveaway in **{guildName}**!\nPrize: [{prize}]({giveawayURL})&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.interface.ts:40</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="dmWinner" class="tsd-anchor"></a><h3>dm<wbr/>Winner</h3><div class="tsd-signature tsd-kind-icon">dm<wbr/>Winner<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">true</span></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.interface.ts:30</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="editParticipants" class="tsd-anchor"></a><h3>edit<wbr/>Participants</h3><div class="tsd-signature tsd-kind-icon">edit<wbr/>Participants<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">true</span></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.interface.ts:46</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="giveaway" class="tsd-anchor"></a><h3>giveaway</h3><div class="tsd-signature tsd-kind-icon">giveaway<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;🎉🎉 **GIVEAWAY!** 🎉🎉&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.interface.ts:31</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="giveawayDescription" class="tsd-anchor"></a><h3>giveaway<wbr/>Description</h3><div class="tsd-signature tsd-kind-icon">giveaway<wbr/>Description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;🎁 Award: **{award}**\n🎊 Hosted by: {hostedBy}\n⏲ Winner(s): `{winners}` \n🙏 Entrants: {totalParticipants} \n\n**Requirements:** {requirements}&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.interface.ts:32</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="giveawayFooterImage" class="tsd-anchor"></a><h3>giveaway<wbr/>Footer<wbr/>Image</h3><div class="tsd-signature tsd-kind-icon">giveaway<wbr/>Footer<wbr/>Image<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;https://emoji.gg/assets/emoji/3461-giveaway.gif&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.interface.ts:33</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="newParticipant" class="tsd-anchor"></a><h3>new<wbr/>Participant</h3><div class="tsd-signature tsd-kind-icon">new<wbr/>Participant<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;You have successfully entered for this giveaway! There are total `{totalParticipants}` entrants&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.interface.ts:37</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="noLevel" class="tsd-anchor"></a><h3>no<wbr/>Level</h3><div class="tsd-signature tsd-kind-icon">no<wbr/>Level<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;You dont have the minimum required level to join this giveaway&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.interface.ts:44</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="noParticipants" class="tsd-anchor"></a><h3>no<wbr/>Participants</h3><div class="tsd-signature tsd-kind-icon">no<wbr/>Participants<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;There isn&#39;t enough entrant in this giveaway!&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.interface.ts:39</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="noWeeklyExp" class="tsd-anchor"></a><h3>no<wbr/>Weekly<wbr/>Exp</h3><div class="tsd-signature tsd-kind-icon">no<wbr/>Weekly<wbr/>Exp<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;you dont have the required minimum weekly xp to join this giveaway&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.interface.ts:43</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="noWinner" class="tsd-anchor"></a><h3>no<wbr/>Winner</h3><div class="tsd-signature tsd-kind-icon">no<wbr/>Winner<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;There isn&#39;t any winner in this giveaway due to not enough entrants&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.interface.ts:41</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="nonoRole" class="tsd-anchor"></a><h3>nono<wbr/>Role</h3><div class="tsd-signature tsd-kind-icon">nono<wbr/>Role<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;You don&#39;t the required role(s)\n{requiredRoles} role(s) to join the giveaway&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.interface.ts:45</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="rerolledMessage" class="tsd-anchor"></a><h3>rerolled<wbr/>Message</h3><div class="tsd-signature tsd-kind-icon">rerolled<wbr/>Message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Rerolled! {winner} is the new winner of the giveaway!&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.interface.ts:35</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="toParticipate" class="tsd-anchor"></a><h3>to<wbr/>Participate</h3><div class="tsd-signature tsd-kind-icon">to<wbr/>Participate<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;**Click the `Enter` button to enter the giveaway!**&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.interface.ts:36</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="winMessage" class="tsd-anchor"></a><h3>win<wbr/>Message</h3><div class="tsd-signature tsd-kind-icon">win<wbr/>Message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;congratulations {winners}! You have won **{prize}** from total `{totalParticipants}` entrants!&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in GiveawaysClient/giveaway.interface.ts:34</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="DefaultGiveawayMessages.html" class="tsd-kind-icon">Default<wbr/>Giveaway<wbr/>Messages</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#alreadyEnded" class="tsd-kind-icon">already<wbr/>Ended</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#alreadyParticipated" class="tsd-kind-icon">already<wbr/>Participated</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#dmMessage" class="tsd-kind-icon">dm<wbr/>Message</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#dmWinner" class="tsd-kind-icon">dm<wbr/>Winner</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#editParticipants" class="tsd-kind-icon">edit<wbr/>Participants</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#giveaway" class="tsd-kind-icon">giveaway</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#giveawayDescription" class="tsd-kind-icon">giveaway<wbr/>Description</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#giveawayFooterImage" class="tsd-kind-icon">giveaway<wbr/>Footer<wbr/>Image</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#newParticipant" class="tsd-kind-icon">new<wbr/>Participant</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#noLevel" class="tsd-kind-icon">no<wbr/>Level</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#noParticipants" class="tsd-kind-icon">no<wbr/>Participants</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#noWeeklyExp" class="tsd-kind-icon">no<wbr/>Weekly<wbr/>Exp</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#noWinner" class="tsd-kind-icon">no<wbr/>Winner</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#nonoRole" class="tsd-kind-icon">nono<wbr/>Role</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#rerolledMessage" class="tsd-kind-icon">rerolled<wbr/>Message</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#toParticipate" class="tsd-kind-icon">to<wbr/>Participate</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DefaultGiveawayMessages.html#winMessage" class="tsd-kind-icon">win<wbr/>Message</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-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private 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></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>