CommandBot/docs/interfaces/ChatCommandInit.html

<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ChatCommandInit | 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="ChatCommandInit.html">ChatCommandInit</a></li></ul><h1>Interface ChatCommandInit</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>Intialization options of chat command</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><a href="PermissionGuildCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">PermissionGuildCommandInit</a><ul class="tsd-hierarchy"><li><span class="target">ChatCommandInit</span></li></ul></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="ChatCommandInit.html#aliases" class="tsd-kind-icon">aliases</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandInit.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandInit.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandInit.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandInit.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandInit.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandInit.html#parameters" class="tsd-kind-icon">parameters</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandInit.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandInit.html#slash" class="tsd-kind-icon">slash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandInit.html#usage" class="tsd-kind-icon">usage</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandInit.html#visible" class="tsd-kind-icon">visible</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="aliases" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> aliases</h3><div class="tsd-signature tsd-kind-icon">aliases<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</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 <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L104">src/commands/types/InitOptions.ts:104</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Different string that can be used with prefix to invoke the command</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> announce<wbr/>Success</h3><div class="tsd-signature tsd-kind-icon">announce<wbr/>Success<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommandInit.html">PermissionGuildCommandInit</a>.<a href="PermissionGuildCommandInit.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L37">src/commands/types/InitOptions.ts:37</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Whether to send a built-in success message when the command has completed (if no other response is defined)</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> default_<wbr/>permission</h3><div class="tsd-signature tsd-kind-icon">default_<wbr/>permission<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommandInit.html">PermissionGuildCommandInit</a>.<a href="PermissionGuildCommandInit.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L19">src/commands/types/InitOptions.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Discord API default permission</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="description" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3><div class="tsd-signature tsd-kind-icon">description<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/aa6cb8b/src/commands/types/InitOptions.ts#L109">src/commands/types/InitOptions.ts:109</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Command description</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="dm" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> dm</h3><div class="tsd-signature tsd-kind-icon">dm<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommandInit.html">PermissionGuildCommandInit</a>.<a href="PermissionGuildCommandInit.html#dm">dm</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L81">src/commands/types/InitOptions.ts:81</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Whether this command should be callable using private messages with bot</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="function" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> function</h3><div class="tsd-signature tsd-kind-icon">function<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#CommandFunction" class="tsd-signature-type" data-tsd-kind="Type alias">CommandFunction</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommandInit.html">PermissionGuildCommandInit</a>.<a href="PermissionGuildCommandInit.html#function">function</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L32">src/commands/types/InitOptions.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Command function (will be executed when calling a command)</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="guilds" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> guilds</h3><div class="tsd-signature tsd-kind-icon">guilds<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommandInit.html">PermissionGuildCommandInit</a>.<a href="PermissionGuildCommandInit.html#guilds">guilds</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L86">src/commands/types/InitOptions.ts:86</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>List of Guild IDs in which the command can be called</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommandInit.html">PermissionGuildCommandInit</a>.<a href="PermissionGuildCommandInit.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L14">src/commands/types/InitOptions.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Command name</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="parameters" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> parameters</h3><div class="tsd-signature tsd-kind-icon">parameters<span class="tsd-signature-symbol">?:</span> <a href="ParameterSchema.html" class="tsd-signature-type" data-tsd-kind="Interface">ParameterSchema</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;simple&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;no_input&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L99">src/commands/types/InitOptions.ts:99</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>List of object defining all parameters of the command</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="permissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> permissions</h3><div class="tsd-signature tsd-kind-icon">permissions<span class="tsd-signature-symbol">?:</span> <a href="CommandPermissionsInit.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandPermissionsInit</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommandInit.html">PermissionGuildCommandInit</a>.<a href="PermissionGuildCommandInit.html#permissions">permissions</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/aa6cb8b/src/commands/types/InitOptions.ts#L68">src/commands/types/InitOptions.ts:68</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Object with permissions&#39; options and resolvables</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="slash" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> slash</h3><div class="tsd-signature tsd-kind-icon">slash<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/aa6cb8b/src/commands/types/InitOptions.ts#L124">src/commands/types/InitOptions.ts:124</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Whether this command should be registered as a slash command</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="usage" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> usage</h3><div class="tsd-signature tsd-kind-icon">usage<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/aa6cb8b/src/commands/types/InitOptions.ts#L114">src/commands/types/InitOptions.ts:114</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Command usage (if <em>undefined</em>, the usage will be automatically generated using parameters)</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="visible" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> visible</h3><div class="tsd-signature tsd-kind-icon">visible<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/aa6cb8b/src/commands/types/InitOptions.ts#L119">src/commands/types/InitOptions.ts:119</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Whether this command is visible in the help message</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="ChatCommandInit.html" class="tsd-kind-icon">Chat<wbr/>Command<wbr/>Init</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandInit.html#aliases" class="tsd-kind-icon">aliases</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandInit.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandInit.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandInit.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandInit.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandInit.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandInit.html#parameters" class="tsd-kind-icon">parameters</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandInit.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandInit.html#slash" class="tsd-kind-icon">slash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandInit.html#usage" class="tsd-kind-icon">usage</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandInit.html#visible" class="tsd-kind-icon">visible</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>