CommandBot/docs/interfaces/SystemMessageAppearance.html

<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SystemMessageAppearance | 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="SystemMessageAppearance.html">SystemMessageAppearance</a></li></ul><h1>Interface SystemMessageAppearance</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>Configuration of a system message</p>
</div><dl class="tsd-comment-tags"><dt>interface</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">SystemMessageAppearance</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="SystemMessageAppearance.html#accentColor" class="tsd-kind-icon">accent<wbr/>Color</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageAppearance.html#bottomText" class="tsd-kind-icon">bottom<wbr/>Text</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageAppearance.html#deleteTimeout" class="tsd-kind-icon">delete<wbr/>Timeout</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageAppearance.html#displayDetails" class="tsd-kind-icon">display<wbr/>Details</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageAppearance.html#enabled" class="tsd-kind-icon">enabled</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageAppearance.html#footer" class="tsd-kind-icon">footer</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageAppearance.html#showTimestamp" class="tsd-kind-icon">show<wbr/>Timestamp</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageAppearance.html#title" class="tsd-kind-icon">title</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="accentColor" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> accent<wbr/>Color</h3><div class="tsd-signature tsd-kind-icon">accent<wbr/>Color<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ColorResolvable</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/structures/types/SystemMessage.ts#L38">src/structures/types/SystemMessage.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Color of a message</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="bottomText" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> bottom<wbr/>Text</h3><div class="tsd-signature tsd-kind-icon">bottom<wbr/>Text<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/structures/types/SystemMessage.ts#L32">src/structures/types/SystemMessage.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Text below the title</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="deleteTimeout" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> 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/71b0f28/src/structures/types/SystemMessage.ts#L63">src/structures/types/SystemMessage.ts:63</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Time (in ms) after a message of this type gets deleted</p>
</div><dl class="tsd-comment-tags"><dt>remarks</dt><dd><p>Set to <em>Infinity</em> to not delete the message</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="displayDetails" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> display<wbr/>Details</h3><div class="tsd-signature tsd-kind-icon">display<wbr/>Details<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/structures/types/SystemMessage.ts#L44">src/structures/types/SystemMessage.ts:44</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Whether to display detailed informations in the message</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="enabled" class="tsd-anchor"></a><h3>enabled</h3><div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/structures/types/SystemMessage.ts#L20">src/structures/types/SystemMessage.ts:20</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Whether this type of message is enabled</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="footer" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> footer</h3><div class="tsd-signature tsd-kind-icon">footer<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/structures/types/SystemMessage.ts#L56">src/structures/types/SystemMessage.ts:56</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Footer text</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="showTimestamp" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> show<wbr/>Timestamp</h3><div class="tsd-signature tsd-kind-icon">show<wbr/>Timestamp<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/structures/types/SystemMessage.ts#L50">src/structures/types/SystemMessage.ts:50</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Whether to show current time and date in a footer</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="title" class="tsd-anchor"></a><h3>title</h3><div class="tsd-signature tsd-kind-icon">title<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/structures/types/SystemMessage.ts#L26">src/structures/types/SystemMessage.ts:26</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Title field</p>
</div></div></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="SystemMessageAppearance.html" class="tsd-kind-icon">System<wbr/>Message<wbr/>Appearance</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageAppearance.html#accentColor" class="tsd-kind-icon">accent<wbr/>Color</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageAppearance.html#bottomText" class="tsd-kind-icon">bottom<wbr/>Text</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageAppearance.html#deleteTimeout" class="tsd-kind-icon">delete<wbr/>Timeout</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageAppearance.html#displayDetails" class="tsd-kind-icon">display<wbr/>Details</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageAppearance.html#enabled" class="tsd-kind-icon">enabled</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageAppearance.html#footer" class="tsd-kind-icon">footer</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageAppearance.html#showTimestamp" class="tsd-kind-icon">show<wbr/>Timestamp</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageAppearance.html#title" class="tsd-kind-icon">title</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>