CommandBot/docs/classes/SystemMessageManager.html

<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SystemMessageManager | commandbot</title><meta name="description" content="Documentation for commandbot"/><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">commandbot</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">commandbot</a></li><li><a href="SystemMessageManager.html">SystemMessageManager</a></li></ul><h1>Class SystemMessageManager</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>Stores configuration and generates system messages</p>
</div><div><p>System messages - predefined messages sent by the bot in special cases (for example after an error, or when a command doesn&#39;t exist)</p>
</div><dl class="tsd-comment-tags"><dt>remarks</dt><dd><p>You can&#39;t customize messages after starting the bot. Changing these properties while the bot is running will have no effect.</p>
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">SystemMessageManager</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="SystemMessageManager.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="SystemMessageManager.html#ERROR" class="tsd-kind-icon">ERROR</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SystemMessageManager.html#NOT_FOUND" class="tsd-kind-icon">NOT_<wbr/>FOUND</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SystemMessageManager.html#PERMISSION" class="tsd-kind-icon">PERMISSION</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SystemMessageManager.html#SUCCESS" class="tsd-kind-icon">SUCCESS</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SystemMessageManager.html#client" class="tsd-kind-icon">client</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SystemMessageManager.html#deleteTimeout" class="tsd-kind-icon">delete<wbr/>Timeout</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="SystemMessageManager.html#send" class="tsd-kind-icon">send</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/>System<wbr/>Message<wbr/>Manager<span class="tsd-signature-symbol">(</span>client<span class="tsd-signature-symbol">: </span><a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SystemMessageManager.html" class="tsd-signature-type" data-tsd-kind="Class">SystemMessageManager</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/SystemMessage.ts#L143">src/structures/SystemMessage.ts:143</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>client: <a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="SystemMessageManager.html" class="tsd-signature-type" data-tsd-kind="Class">SystemMessageManager</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="ERROR" class="tsd-anchor"></a><h3>ERROR</h3><div class="tsd-signature tsd-kind-icon">ERROR<span class="tsd-signature-symbol">:</span> <a href="../interfaces/SystemMessageAppearance.html" class="tsd-signature-type" data-tsd-kind="Interface">SystemMessageAppearance</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/SystemMessage.ts#L121">src/structures/SystemMessage.ts:121</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Sent when an error occurs during the execution of a command</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="NOT_FOUND" class="tsd-anchor"></a><h3>NOT_<wbr/>FOUND</h3><div class="tsd-signature tsd-kind-icon">NOT_<wbr/>FOUND<span class="tsd-signature-symbol">:</span> <a href="../interfaces/SystemMessageAppearance.html" class="tsd-signature-type" data-tsd-kind="Interface">SystemMessageAppearance</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/SystemMessage.ts#L127">src/structures/SystemMessage.ts:127</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Sent when someone tries to run a command that does not exist (mainly by using prefix interactions)</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="PERMISSION" class="tsd-anchor"></a><h3>PERMISSION</h3><div class="tsd-signature tsd-kind-icon">PERMISSION<span class="tsd-signature-symbol">:</span> <a href="../interfaces/SystemMessageAppearance.html" class="tsd-signature-type" data-tsd-kind="Interface">SystemMessageAppearance</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/SystemMessage.ts#L115">src/structures/SystemMessage.ts:115</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Sent whenever caller&#39;s permissions are not sufficient to run a command</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="SUCCESS" class="tsd-anchor"></a><h3>SUCCESS</h3><div class="tsd-signature tsd-kind-icon">SUCCESS<span class="tsd-signature-symbol">:</span> <a href="../interfaces/SystemMessageAppearance.html" class="tsd-signature-type" data-tsd-kind="Interface">SystemMessageAppearance</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/SystemMessage.ts#L134">src/structures/SystemMessage.ts:134</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Sent when a command function returns <em>void</em> without throwing an error</p>
</div><dl class="tsd-comment-tags"><dt>remarks</dt><dd><p>An <em>announceSuccess</em> property must be set to <em>true</em> (default) in order to send this message</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="client" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> client</h3><div class="tsd-signature tsd-kind-icon">client<span class="tsd-signature-symbol">:</span> <a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/SystemMessage.ts#L109">src/structures/SystemMessage.ts:109</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Client parent attached to this manager</p>
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="deleteTimeout" class="tsd-anchor"></a><h3>delete<wbr/>Timeout</h3><div class="tsd-signature tsd-kind-icon">delete<wbr/>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/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/SystemMessage.ts#L141">src/structures/SystemMessage.ts:141</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Global time (in ms) after a message gets deleted</p>
</div><dl class="tsd-comment-tags"><dt>remarks</dt><dd><p>This time applies to all message types but it can be overwritten using local properties with the same name (for example ERROR.deleteTimeout)</p>
</dd></dl></div></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 name="send" class="tsd-anchor"></a><h3>send</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">send<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><a href="../modules.html#MessageType" class="tsd-signature-type" data-tsd-kind="Type alias">MessageType</a>, data<span class="tsd-signature-symbol">?: </span><a href="../interfaces/SystemMessageData.html" class="tsd-signature-type" data-tsd-kind="Interface">SystemMessageData</a>, interaction<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TextChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">DMChannel</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"> | </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </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 <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/SystemMessage.ts#L192">src/structures/SystemMessage.ts:192</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Generates and sends a system message</p>
</div><dl class="tsd-comment-tags"><dt>async</dt><dd></dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <a href="../modules.html#MessageType" class="tsd-signature-type" data-tsd-kind="Type alias">MessageType</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>&quot;ERROR&quot; | &quot;PERMISSION&quot; | &quot;NOT_FOUND&quot; | &quot;SUCCESS&quot;</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <a href="../interfaces/SystemMessageData.html" class="tsd-signature-type" data-tsd-kind="Interface">SystemMessageData</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> interaction: <span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TextChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">DMChannel</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"> | </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MessageEmbed</span><span class="tsd-signature-symbol">&gt;</span></h4><div><p>A message that got sent or <em>void</em></p>
</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="SystemMessageManager.html" class="tsd-kind-icon">System<wbr/>Message<wbr/>Manager</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="SystemMessageManager.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SystemMessageManager.html#ERROR" class="tsd-kind-icon">ERROR</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SystemMessageManager.html#NOT_FOUND" class="tsd-kind-icon">NOT_<wbr/>FOUND</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SystemMessageManager.html#PERMISSION" class="tsd-kind-icon">PERMISSION</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SystemMessageManager.html#SUCCESS" class="tsd-kind-icon">SUCCESS</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SystemMessageManager.html#client" class="tsd-kind-icon">client</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SystemMessageManager.html#deleteTimeout" class="tsd-kind-icon">delete<wbr/>Timeout</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SystemMessageManager.html#send" class="tsd-kind-icon">send</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-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited 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-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static 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>