Archived
Version 4.2.0
This commit is contained in:
mmacierzanka committed
1 parent
5a805517a8
commit
f804f652ff
52 files changed
+435
-429
No files matched your search
@@ -229,6 +229,7 @@ const cmd = bot.commands.add("CHAT", {
|
||||
cmd.append("COMMAND", {
|
||||
name: "child",
|
||||
description: "This is a subcommand",
|
||||
aliases: ["ch"],
|
||||
});
|
||||
|
||||
// Create and append a subcommand group
|
||||
@@ -241,6 +242,7 @@ const group = cmd.append("GROUP", {
|
||||
group.append({
|
||||
name: "group_command",
|
||||
description: "This is a subcommand that is a child of the command_group",
|
||||
aliases: ["subch"],
|
||||
});
|
||||
```
|
||||
|
||||
|
||||
@@ -1 +1 @@
|
||||
window.searchData = {"kinds":{"128":"Class","256":"Interface","512":"Constructor","1024":"Property","2048":"Method","65536":"Type literal","262144":"Accessor","4194304":"Type alias","8388608":"Event"},"rows":[{"id":0,"kind":128,"name":"Bot","url":"classes/Bot.html","classes":"tsd-kind-class"},{"id":1,"kind":512,"name":"constructor","url":"classes/Bot.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"Bot"},{"id":2,"kind":8388608,"name":"on","url":"classes/Bot.html#on","classes":"tsd-kind-event tsd-parent-kind-class","parent":"Bot"},{"id":3,"kind":1024,"name":"name","url":"classes/Bot.html#name","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Bot"},{"id":4,"kind":1024,"name":"client","url":"classes/Bot.html#client","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Bot"},{"id":5,"kind":1024,"name":"commands","url":"classes/Bot.html#commands","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Bot"},{"id":6,"kind":1024,"name":"token","url":"classes/Bot.html#token","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Bot"},{"id":7,"kind":1024,"name":"applicationId","url":"classes/Bot.html#applicationId","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Bot"},{"id":8,"kind":1024,"name":"messages","url":"classes/Bot.html#messages","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Bot"},{"id":9,"kind":2048,"name":"start","url":"classes/Bot.html#start","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Bot"},{"id":10,"kind":256,"name":"InitOptions","url":"interfaces/InitOptions.html","classes":"tsd-kind-interface"},{"id":11,"kind":1024,"name":"name","url":"interfaces/InitOptions.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"InitOptions"},{"id":12,"kind":1024,"name":"globalPrefix","url":"interfaces/InitOptions.html#globalPrefix","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"InitOptions"},{"id":13,"kind":1024,"name":"argumentSeparator","url":"interfaces/InitOptions.html#argumentSeparator","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"InitOptions"},{"id":14,"kind":1024,"name":"commandSeparator","url":"interfaces/InitOptions.html#commandSeparator","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"InitOptions"},{"id":15,"kind":1024,"name":"clientOptions","url":"interfaces/InitOptions.html#clientOptions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"InitOptions"},{"id":16,"kind":1024,"name":"help","url":"interfaces/InitOptions.html#help","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"InitOptions"},{"id":17,"kind":1024,"name":"token","url":"interfaces/InitOptions.html#token","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"InitOptions"},{"id":18,"kind":1024,"name":"applicationId","url":"interfaces/InitOptions.html#applicationId","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"InitOptions"},{"id":19,"kind":256,"name":"ChatCommandInit","url":"interfaces/ChatCommandInit.html","classes":"tsd-kind-interface"},{"id":20,"kind":1024,"name":"parameters","url":"interfaces/ChatCommandInit.html#parameters","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ChatCommandInit"},{"id":21,"kind":1024,"name":"aliases","url":"interfaces/ChatCommandInit.html#aliases","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ChatCommandInit"},{"id":22,"kind":1024,"name":"description","url":"interfaces/ChatCommandInit.html#description","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ChatCommandInit"},{"id":23,"kind":1024,"name":"usage","url":"interfaces/ChatCommandInit.html#usage","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ChatCommandInit"},{"id":24,"kind":1024,"name":"visible","url":"interfaces/ChatCommandInit.html#visible","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ChatCommandInit"},{"id":25,"kind":1024,"name":"slash","url":"interfaces/ChatCommandInit.html#slash","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ChatCommandInit"},{"id":26,"kind":1024,"name":"dm","url":"interfaces/ChatCommandInit.html#dm","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ChatCommandInit"},{"id":27,"kind":1024,"name":"guilds","url":"interfaces/ChatCommandInit.html#guilds","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ChatCommandInit"},{"id":28,"kind":1024,"name":"permissions","url":"interfaces/ChatCommandInit.html#permissions","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ChatCommandInit"},{"id":29,"kind":1024,"name":"function","url":"interfaces/ChatCommandInit.html#function","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ChatCommandInit"},{"id":30,"kind":1024,"name":"announceSuccess","url":"interfaces/ChatCommandInit.html#announceSuccess","classes":"tsLine truncated
|
||||
window.searchData = {"kinds":{"128":"Class","256":"Interface","512":"Constructor","1024":"Property","2048":"Method","65536":"Type literal","262144":"Accessor","4194304":"Type alias","8388608":"Event"},"rows":[{"id":0,"kind":128,"name":"Bot","url":"classes/Bot.html","classes":"tsd-kind-class"},{"id":1,"kind":512,"name":"constructor","url":"classes/Bot.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"Bot"},{"id":2,"kind":8388608,"name":"on","url":"classes/Bot.html#on","classes":"tsd-kind-event tsd-parent-kind-class","parent":"Bot"},{"id":3,"kind":1024,"name":"name","url":"classes/Bot.html#name","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Bot"},{"id":4,"kind":1024,"name":"client","url":"classes/Bot.html#client","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Bot"},{"id":5,"kind":1024,"name":"commands","url":"classes/Bot.html#commands","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Bot"},{"id":6,"kind":1024,"name":"token","url":"classes/Bot.html#token","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Bot"},{"id":7,"kind":1024,"name":"applicationId","url":"classes/Bot.html#applicationId","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Bot"},{"id":8,"kind":1024,"name":"messages","url":"classes/Bot.html#messages","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Bot"},{"id":9,"kind":2048,"name":"start","url":"classes/Bot.html#start","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Bot"},{"id":10,"kind":256,"name":"InitOptions","url":"interfaces/InitOptions.html","classes":"tsd-kind-interface"},{"id":11,"kind":1024,"name":"name","url":"interfaces/InitOptions.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"InitOptions"},{"id":12,"kind":1024,"name":"globalPrefix","url":"interfaces/InitOptions.html#globalPrefix","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"InitOptions"},{"id":13,"kind":1024,"name":"argumentSeparator","url":"interfaces/InitOptions.html#argumentSeparator","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"InitOptions"},{"id":14,"kind":1024,"name":"commandSeparator","url":"interfaces/InitOptions.html#commandSeparator","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"InitOptions"},{"id":15,"kind":1024,"name":"clientOptions","url":"interfaces/InitOptions.html#clientOptions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"InitOptions"},{"id":16,"kind":1024,"name":"help","url":"interfaces/InitOptions.html#help","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"InitOptions"},{"id":17,"kind":1024,"name":"token","url":"interfaces/InitOptions.html#token","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"InitOptions"},{"id":18,"kind":1024,"name":"applicationId","url":"interfaces/InitOptions.html#applicationId","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"InitOptions"},{"id":19,"kind":256,"name":"ChatCommandInit","url":"interfaces/ChatCommandInit.html","classes":"tsd-kind-interface"},{"id":20,"kind":1024,"name":"parameters","url":"interfaces/ChatCommandInit.html#parameters","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ChatCommandInit"},{"id":21,"kind":1024,"name":"aliases","url":"interfaces/ChatCommandInit.html#aliases","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ChatCommandInit"},{"id":22,"kind":1024,"name":"description","url":"interfaces/ChatCommandInit.html#description","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ChatCommandInit"},{"id":23,"kind":1024,"name":"usage","url":"interfaces/ChatCommandInit.html#usage","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ChatCommandInit"},{"id":24,"kind":1024,"name":"visible","url":"interfaces/ChatCommandInit.html#visible","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ChatCommandInit"},{"id":25,"kind":1024,"name":"slash","url":"interfaces/ChatCommandInit.html#slash","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ChatCommandInit"},{"id":26,"kind":1024,"name":"dm","url":"interfaces/ChatCommandInit.html#dm","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ChatCommandInit"},{"id":27,"kind":1024,"name":"guilds","url":"interfaces/ChatCommandInit.html#guilds","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ChatCommandInit"},{"id":28,"kind":1024,"name":"permissions","url":"interfaces/ChatCommandInit.html#permissions","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ChatCommandInit"},{"id":29,"kind":1024,"name":"function","url":"interfaces/ChatCommandInit.html#function","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ChatCommandInit"},{"id":30,"kind":1024,"name":"announceSuccess","url":"interfaces/ChatCommandInit.html#announceSuccess","classes":"tsLine truncated
|
||||
+12
-12
@@ -1,26 +1,26 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Bot | 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="Bot.html">Bot</a></li></ul><h1>Class Bot</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>Application instance</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">EventEmitter</span><ul class="tsd-hierarchy"><li><span class="target">Bot</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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="Bot.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Events</h3><ul class="tsd-index-list"><li class="tsd-kind-event tsd-parent-kind-class"><a href="Bot.html#on" class="tsd-kind-icon">on</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="Bot.html#applicationId" class="tsd-kind-icon">application<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Bot.html#client" class="tsd-kind-icon">client</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Bot.html#commands" class="tsd-kind-icon">commands</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Bot.html#messages" class="tsd-kind-icon">messages</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Bot.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Bot.html#token" class="tsd-kind-icon">token</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="Bot.html#captureRejectionSymbol" class="tsd-kind-icon">capture<wbr/>Rejection<wbr/>Symbol</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="Bot.html#captureRejections" class="tsd-kind-icon">capture<wbr/>Rejections</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="Bot.html#defaultMaxListeners" class="tsd-kind-icon">default<wbr/>Max<wbr/>Listeners</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="Bot.html#errorMonitor" class="tsd-kind-icon">error<wbr/>Monitor</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 tsd-is-external"><a href="Bot.html#addListener" class="tsd-kind-icon">add<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#emit" class="tsd-kind-icon">emit</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#eventNames" class="tsd-kind-icon">event<wbr/>Names</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#getMaxListeners" class="tsd-kind-icon">get<wbr/>Max<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#listenerCount" class="tsd-kind-icon">listener<wbr/>Count</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#listeners" class="tsd-kind-icon">listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#off" class="tsd-kind-icon">off</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#once" class="tsd-kind-icon">once</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#prependListener" class="tsd-kind-icon">prepend<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#prependOnceListener" class="tsd-kind-icon">prepend<wbr/>Once<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#rawListeners" class="tsd-kind-icon">raw<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#removeAllListeners" class="tsd-kind-icon">remove<wbr/>All<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#removeListener" class="tsd-kind-icon">remove<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#setMaxListeners" class="tsd-kind-icon">set<wbr/>Max<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Bot.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="Bot.html#getEventListener" class="tsd-kind-icon">get<wbr/>Event<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="Bot.html#listenerCount-1" class="tsd-kind-icon">listener<wbr/>Count</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="BoLine truncated
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">EventEmitter</span><ul class="tsd-hierarchy"><li><span class="target">Bot</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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="Bot.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Events</h3><ul class="tsd-index-list"><li class="tsd-kind-event tsd-parent-kind-class"><a href="Bot.html#on" class="tsd-kind-icon">on</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="Bot.html#applicationId" class="tsd-kind-icon">application<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Bot.html#client" class="tsd-kind-icon">client</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Bot.html#commands" class="tsd-kind-icon">commands</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Bot.html#messages" class="tsd-kind-icon">messages</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Bot.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Bot.html#token" class="tsd-kind-icon">token</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="Bot.html#captureRejectionSymbol" class="tsd-kind-icon">capture<wbr/>Rejection<wbr/>Symbol</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="Bot.html#captureRejections" class="tsd-kind-icon">capture<wbr/>Rejections</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="Bot.html#defaultMaxListeners" class="tsd-kind-icon">default<wbr/>Max<wbr/>Listeners</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="Bot.html#errorMonitor" class="tsd-kind-icon">error<wbr/>Monitor</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 tsd-is-external"><a href="Bot.html#addListener" class="tsd-kind-icon">add<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#emit" class="tsd-kind-icon">emit</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#eventNames" class="tsd-kind-icon">event<wbr/>Names</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#getMaxListeners" class="tsd-kind-icon">get<wbr/>Max<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#listenerCount" class="tsd-kind-icon">listener<wbr/>Count</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#listeners" class="tsd-kind-icon">listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#off" class="tsd-kind-icon">off</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#once" class="tsd-kind-icon">once</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#prependListener" class="tsd-kind-icon">prepend<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#prependOnceListener" class="tsd-kind-icon">prepend<wbr/>Once<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#rawListeners" class="tsd-kind-icon">raw<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#removeAllListeners" class="tsd-kind-icon">remove<wbr/>All<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#removeListener" class="tsd-kind-icon">remove<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="Bot.html#setMaxListeners" class="tsd-kind-icon">set<wbr/>Max<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Bot.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="Bot.html#getEventListener" class="tsd-kind-icon">get<wbr/>Event<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="Bot.html#listenerCount-1" class="tsd-kind-icon">listener<wbr/>Count</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="BoLine truncated
|
||||
<p>Main bot constructor</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>__namedParameters: <a href="../interfaces/InitOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">InitOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Events</h2><section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class"><a name="on" class="tsd-anchor"></a><h3>on</h3><ul class="tsd-signatures tsd-kind-event tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"READY"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"MESSAGE"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>m<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"COMMAND"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>m<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CommandInteraction</span>, cmdMsg<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"ERROR"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</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/2867da1/src/structures/Bot.ts#L73">src/structures/Bot.ts:73</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>__namedParameters: <a href="../interfaces/InitOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">InitOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Events</h2><section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class"><a name="on" class="tsd-anchor"></a><h3>on</h3><ul class="tsd-signatures tsd-kind-event tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"READY"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"MESSAGE"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>m<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"COMMAND"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>m<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CommandInteraction</span>, cmdMsg<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"ERROR"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</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/Bot.ts#L66">src/structures/Bot.ts:66</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Emitted after connecting to Discord API</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"READY"</span></h5></li><li><h5>listener: <span class="tsd-signature-type">Function</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Bot.ts#L78">src/structures/Bot.ts:78</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"READY"</span></h5></li><li><h5>listener: <span class="tsd-signature-type">Function</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Bot.ts#L71">src/structures/Bot.ts:71</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Emitted whenever bot receives a Discord message</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"MESSAGE"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>m<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>m<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>m: <span class="tsd-signature-type">Message</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Bot.ts#L83">src/structures/Bot.ts:83</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"MESSAGE"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>m<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>m<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>m: <span class="tsd-signature-type">Message</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Bot.ts#L76">src/structures/Bot.ts:76</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Emitted whenever bots receives a Discord message or interaction that gets recognized as a CommandBot command</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"COMMAND"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>m<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CommandInteraction</span>, cmdMsg<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>m<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CommandInteraction</span>, cmdMsg<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>m: <span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CommandInteraction</span></h5></li><li><h5>cmdMsg: <a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Bot.ts#L88">src/structures/Bot.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"COMMAND"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>m<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CommandInteraction</span>, cmdMsg<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>m<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CommandInteraction</span>, cmdMsg<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>m: <span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CommandInteraction</span></h5></li><li><h5>cmdMsg: <a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Bot.ts#L81">src/structures/Bot.ts:81</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Emitted on every bot error</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"ERROR"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>e: <span class="tsd-signature-type">any</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</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="applicationId" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> application<wbr/>Id</h3><div class="tsd-signature tsd-kind-icon">application<wbr/>Id<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/2867da1/src/structures/Bot.ts#L135">src/structures/Bot.ts:135</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"ERROR"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>e: <span class="tsd-signature-type">any</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</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="applicationId" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> application<wbr/>Id</h3><div class="tsd-signature tsd-kind-icon">application<wbr/>Id<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/5a80551/src/structures/Bot.ts#L124">src/structures/Bot.ts:124</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API application ID</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="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> <span class="tsd-signature-type">Client</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Bot.ts#L111">src/structures/Bot.ts:111</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="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> <span class="tsd-signature-type">Client</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Bot.ts#L103">src/structures/Bot.ts:103</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord.js {@link Client} instance</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="commands" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> commands</h3><div class="tsd-signature tsd-kind-icon">commands<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Bot.ts#L119">src/structures/Bot.ts:119</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="commands" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> commands</h3><div class="tsd-signature tsd-kind-icon">commands<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Bot.ts#L110">src/structures/Bot.ts:110</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Instance command 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="messages" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> messages</h3><div class="tsd-signature tsd-kind-icon">messages<span class="tsd-signature-symbol">:</span> <a href="SystemMessageManager.html" class="tsd-signature-type" data-tsd-kind="Class">SystemMessageManager</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Bot.ts#L143">src/structures/Bot.ts:143</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="messages" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> messages</h3><div class="tsd-signature tsd-kind-icon">messages<span class="tsd-signature-symbol">:</span> <a href="SystemMessageManager.html" class="tsd-signature-type" data-tsd-kind="Class">SystemMessageManager</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Bot.ts#L131">src/structures/Bot.ts:131</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p><a href="SystemMessageManager.html">SystemMessageManager</a> storing messages' configuration</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="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> 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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Bot.ts#L103">src/structures/Bot.ts:103</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> 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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Bot.ts#L96">src/structures/Bot.ts:96</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Bot name</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="token" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> token</h3><div class="tsd-signature tsd-kind-icon">token<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/2867da1/src/structures/Bot.ts#L127">src/structures/Bot.ts:127</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="token" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> token</h3><div class="tsd-signature tsd-kind-icon">token<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/5a80551/src/structures/Bot.ts#L117">src/structures/Bot.ts:117</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord Bot token</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 tsd-is-static tsd-is-external"><a name="captureRejectionSymbol" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> capture<wbr/>Rejection<wbr/>Symbol</h3><div class="tsd-signature tsd-kind-icon">capture<wbr/>Rejection<wbr/>Symbol<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="Bot.html#captureRejectionSymbol" class="tsd-signature-type" data-tsd-kind="Property">captureRejectionSymbol</a></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/events.d.ts:46</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a name="captureRejections" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr/>Rejections</h3><div class="tsd-signature tsd-kind-icon">capture<wbr/>Rejections<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/events.d.ts:52</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Sets or gets the default captureRejection value for all emitters.</p>
|
||||
@@ -31,7 +31,7 @@ events. Listeners installed using this symbol are called before the regular
|
||||
</div><div><p>Installing a listener using this symbol does not change the behavior once an
|
||||
<code>'error'</code> event is emitted, therefore the process will still crash if no
|
||||
regular <code>'error'</code> listener is installed.</p>
|
||||
</div></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 tsd-is-external"><a name="addListener" class="tsd-anchor"></a><h3>add<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"><li class="tsd-signature tsd-kind-icon">add<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/events.d.ts:72</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external"><a name="emit" class="tsd-anchor"></a><h3>emit</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"><li class="tsd-signature tsd-kind-icon">emit<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, <span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/events.d.ts:82</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external"><a name="eventNames" class="tsd-anchor"></a><h3>event<wbr/>Names</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"><li class="tsd-signature tsd-kind-icon">event<wbr/>Names<span class="tsd-signature-symbol">(</span>Line truncated
|
||||
</div></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 tsd-is-external"><a name="addListener" class="tsd-anchor"></a><h3>add<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"><li class="tsd-signature tsd-kind-icon">add<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/events.d.ts:72</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="Bot.html" class="tsd-signature-type" data-tsd-kind="Class">Bot</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external"><a name="emit" class="tsd-anchor"></a><h3>emit</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"><li class="tsd-signature tsd-kind-icon">emit<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, <span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/events.d.ts:82</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external"><a name="eventNames" class="tsd-anchor"></a><h3>event<wbr/>Names</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"><li class="tsd-signature tsd-kind-icon">event<wbr/>Names<span class="tsd-signature-symbol">(</span>Line truncated
|
||||
<p>Starts your Discord bot</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><span class="tsd-flag ts-flagOptional">Optional</span> port: <span class="tsd-signature-type">number</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> register: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><div><p>whether this operation has been completed successfully</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a name="getEventListener" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr/>Event<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">get<wbr/>Event<wbr/>Listener<span class="tsd-signature-symbol">(</span>emitter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DOMEventTarget</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">EventEmitter</span>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/events.d.ts:34</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
|
||||
@@ -1,24 +1,24 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ChatCommand | 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="ChatCommand.html">ChatCommand</a></li></ul><h1>Class ChatCommand</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>A representation of CHAT_INPUT command (also known as a slash command)</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="PermissionGuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionGuildCommand</a><ul class="tsd-hierarchy"><li><span class="target">ChatCommand</span><ul class="tsd-hierarchy"><li><a href="HelpMessage.html" class="tsd-signature-type" data-tsd-kind="Class">HelpMessage</a></li></ul></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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="ChatCommand.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 tsd-is-private"><a href="ChatCommand.html#_children" class="tsd-kind-icon">_children</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ChatCommand.html#aliases" class="tsd-kind-icon">aliases</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ChatCommand.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ChatCommand.html#parameters" class="tsd-kind-icon">parameters</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ChatCommand.html#slash" class="tsd-kind-icon">slash</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ChatCommand.html#usage" class="tsd-kind-icon">usage</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ChatCommand.html#visible" class="tsd-kind-icon">visible</a></li></ul></section><section class="tsd-index-section "><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="ChatCommand.html#children" class="tsd-kind-icon">children</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="ChatCommand.html#hasSubCommands" class="tsd-kind-icon">has<wbr/>Sub<wbr/>Commands</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 tsd-has-type-parameter"><a href="ChatCommand.html#append" class="tsd-kind-icon">append</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="ChatCommand.html#fetchSubcommand" class="tsd-kind-icon">fetch<wbr/>Subcommand</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="ChatCommand.html#getSubcommand" class="tsd-kind-icon">get<wbr/>Subcommand</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="ChatCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="ChatCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="ChatCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="ChatCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="ChatCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</a></li></ul></section></div></section></section><section class="tsd-panel-group tsLine truncated
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="PermissionGuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionGuildCommand</a><ul class="tsd-hierarchy"><li><span class="target">ChatCommand</span><ul class="tsd-hierarchy"><li><a href="HelpMessage.html" class="tsd-signature-type" data-tsd-kind="Class">HelpMessage</a></li></ul></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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="ChatCommand.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 tsd-is-private"><a href="ChatCommand.html#_children" class="tsd-kind-icon">_children</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ChatCommand.html#aliases" class="tsd-kind-icon">aliases</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ChatCommand.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ChatCommand.html#parameters" class="tsd-kind-icon">parameters</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ChatCommand.html#slash" class="tsd-kind-icon">slash</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ChatCommand.html#usage" class="tsd-kind-icon">usage</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ChatCommand.html#visible" class="tsd-kind-icon">visible</a></li></ul></section><section class="tsd-index-section "><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="ChatCommand.html#children" class="tsd-kind-icon">children</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="ChatCommand.html#hasSubCommands" class="tsd-kind-icon">has<wbr/>Sub<wbr/>Commands</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 tsd-has-type-parameter"><a href="ChatCommand.html#append" class="tsd-kind-icon">append</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="ChatCommand.html#fetchSubcommand" class="tsd-kind-icon">fetch<wbr/>Subcommand</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="ChatCommand.html#getSubcommand" class="tsd-kind-icon">get<wbr/>Subcommand</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="ChatCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="ChatCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="ChatCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="ChatCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="ChatCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</a></li></ul></section></div></section></section><section class="tsd-panel-group tsLine truncated
|
||||
<p>ChatCommand constructor</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>manager: <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>a manager that this command belongs to</p>
|
||||
</div></div></li><li><h5>options: <a href="../interfaces/ChatCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandInit</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p><a href="../interfaces/ChatCommandInit.html">ChatCommandInit</a> object containing all options needed to create a <a href="ChatCommand.html">ChatCommand</a></p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</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 tsd-is-private"><a name="_children" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> _children</h3><div class="tsd-signature tsd-kind-icon">_children<span class="tsd-signature-symbol">:</span> <a href="../modules.html#ChildCommandResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandResolvable</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/ChatCommand.ts#L26">src/commands/ChatCommand.ts:26</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</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 tsd-is-private"><a name="_children" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> _children</h3><div class="tsd-signature tsd-kind-icon">_children<span class="tsd-signature-symbol">:</span> <a href="../modules.html#ChildCommandResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandResolvable</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/ChatCommand.ts#L64">src/commands/ChatCommand.ts:64</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Subcommands and groups of this command</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="aliases" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/ChatCommand.ts#L41">src/commands/ChatCommand.ts:41</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="aliases" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/ChatCommand.ts#L78">src/commands/ChatCommand.ts:78</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of different names that can be used to invoke a command (when using prefix interactions)</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 tsd-is-inherited"><a name="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/FunctionCommand.ts#L28">src/commands/base/FunctionCommand.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L56">src/commands/base/FunctionCommand.ts:56</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether a SUCCESS message should be sent after executing the command function (when there is no other reply)</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 tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L47">src/commands/base/Command.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L60">src/commands/base/Command.ts:60</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default_permission</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="description" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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/2867da1/src/commands/ChatCommand.ts#L49">src/commands/ChatCommand.ts:49</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="description" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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/5a80551/src/commands/ChatCommand.ts#L85">src/commands/ChatCommand.ts:85</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command description displayed in the help message or in slash commands menu (Default description: "No description")</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 tsd-is-inherited"><a name="dm" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#dm">dm</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/PermissionGuildCommand.ts#L29">src/commands/base/PermissionGuildCommand.ts:29</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="dm" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#dm">dm</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/PermissionGuildCommand.ts#L45">src/commands/base/PermissionGuildCommand.ts:45</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>If set to <em>false</em>, all interactions that get invoked from private/direct conversations (outside a guild) will result a PermissionError</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 tsd-is-inherited"><a name="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#ephemeral">ephemeral</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/FunctionCommand.ts#L42">src/commands/base/FunctionCommand.ts:42</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#ephemeral">ephemeral</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L70">src/commands/base/FunctionCommand.ts:70</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether a reply should be visible only to the caller</p>
|
||||
</div><div><ul>
|
||||
<li>NONE - bot replies are public and visible to everyone in a text channel</li>
|
||||
@@ -27,29 +27,29 @@
|
||||
</ul>
|
||||
<p><a href="https://support.discord.com/hc/pl/articles/1500000580222-Ephemeral-Messages-FAQ">Read more</a></p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd><dt>remarks</dt><dd><p>Since ephemeral interactions cannot be deleted, a placeholding embed will be sent when there will be no response from the command function and <em>announceSuccess</em> will be set to false (placeholding message uses <em>color</em> and <em>title</em> parameters from SUCCESS system message configuration)</p>
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="guilds" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#guilds">guilds</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/PermissionGuildCommand.ts#L21">src/commands/base/PermissionGuildCommand.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="guilds" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#guilds">guilds</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/PermissionGuildCommand.ts#L38">src/commands/base/PermissionGuildCommand.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of Discord guild (server) IDs in which this command can be used</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 tsd-is-inherited"><a name="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#manager">manager</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L23">src/commands/base/Command.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#manager">manager</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L39">src/commands/base/Command.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Manager in which this command is registered</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 tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> 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="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L31">src/commands/base/Command.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> 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="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L46">src/commands/base/Command.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</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="parameters" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> parameters</h3><div class="tsd-signature tsd-kind-icon">parameters<span class="tsd-signature-symbol">:</span> <a href="Parameter.html" class="tsd-signature-type" data-tsd-kind="Class">Parameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/ChatCommand.ts#L33">src/commands/ChatCommand.ts:33</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="parameters" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> parameters</h3><div class="tsd-signature tsd-kind-icon">parameters<span class="tsd-signature-symbol">:</span> <a href="Parameter.html" class="tsd-signature-type" data-tsd-kind="Class">Parameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/ChatCommand.ts#L71">src/commands/ChatCommand.ts:71</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of parameters that can passed to this command</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 tsd-is-inherited"><a name="permissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> permissions</h3><div class="tsd-signature tsd-kind-icon">permissions<span class="tsd-signature-symbol">:</span> <a href="CommandPermissions.html" class="tsd-signature-type" data-tsd-kind="Class">CommandPermissions</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#permissions">permissions</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/PermissionCommand.ts#L21">src/commands/base/PermissionCommand.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="permissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> permissions</h3><div class="tsd-signature tsd-kind-icon">permissions<span class="tsd-signature-symbol">:</span> <a href="CommandPermissions.html" class="tsd-signature-type" data-tsd-kind="Class">CommandPermissions</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#permissions">permissions</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/PermissionCommand.ts#L34">src/commands/base/PermissionCommand.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object containing check functions and permission bitfields</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="slash" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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/2867da1/src/commands/ChatCommand.ts#L73">src/commands/ChatCommand.ts:73</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="slash" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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/5a80551/src/commands/ChatCommand.ts#L106">src/commands/ChatCommand.ts:106</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether this command should be registered as a slash command (default: true)</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 tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L39">src/commands/base/Command.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L53">src/commands/base/Command.ts:53</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>CommandBot's internal command type</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="usage" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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/2867da1/src/commands/ChatCommand.ts#L57">src/commands/ChatCommand.ts:57</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="usage" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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/5a80551/src/commands/ChatCommand.ts#L92">src/commands/ChatCommand.ts:92</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command usage displayed in the help message</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="visible" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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/2867da1/src/commands/ChatCommand.ts#L65">src/commands/ChatCommand.ts:65</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="visible" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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/5a80551/src/commands/ChatCommand.ts#L99">src/commands/ChatCommand.ts:99</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether this command is visible in the help message (default: true)</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a name="children" class="tsd-anchor"></a><h3>children</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> children<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">readonly </span><a href="../modules.html#ChildCommandResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandResolvable</a><span class="tsd-signature-symbol">[]</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/2867da1/src/commands/ChatCommand.ts#L142">src/commands/ChatCommand.ts:142</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a name="children" class="tsd-anchor"></a><h3>children</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> children<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">readonly </span><a href="../modules.html#ChildCommandResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandResolvable</a><span class="tsd-signature-symbol">[]</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/commands/ChatCommand.ts#L174">src/commands/ChatCommand.ts:174</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Returns list of attached subcommands</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">readonly </span><a href="../modules.html#ChildCommandResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandResolvable</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a name="hasSubCommands" class="tsd-anchor"></a><h3>has<wbr/>Sub<wbr/>Commands</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> hasSubCommands<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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/2867da1/src/commands/ChatCommand.ts#L133">src/commands/ChatCommand.ts:133</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">readonly </span><a href="../modules.html#ChildCommandResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandResolvable</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a name="hasSubCommands" class="tsd-anchor"></a><h3>has<wbr/>Sub<wbr/>Commands</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> hasSubCommands<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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/commands/ChatCommand.ts#L166">src/commands/ChatCommand.ts:166</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Returns <em>true</em> if the command has subcommands attached</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></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 tsd-has-type-parameter"><a name="append" class="tsd-anchor"></a><h3>append</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">append<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span>, options<span class="tsd-signature-symbol">: </span><a href="../modules.html#ChildCommandInit" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandInit</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></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/2867da1/src/commands/ChatCommand.ts#L168">src/commands/ChatCommand.ts:168</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></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 tsd-has-type-parameter"><a name="append" class="tsd-anchor"></a><h3>append</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">append<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span>, options<span class="tsd-signature-symbol">: </span><a href="../modules.html#ChildCommandInit" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandInit</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></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/commands/ChatCommand.ts#L199">src/commands/ChatCommand.ts:199</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Attaches subcommand or subcommand group to this ChatCommand</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>remarks</dt><dd><p>After appending a subcommand or a subcommand group the main command can only be invoked using prefix interactions</p>
|
||||
</dd></dl></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#ChildCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
@@ -57,34 +57,34 @@
|
||||
</div></div></li><li><h5>options: <a href="../modules.html#ChildCommandInit" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandInit</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>initialization options</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>A computed subcommand object</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="fetchSubcommand" class="tsd-anchor"></a><h3>fetch<wbr/>Subcommand</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">fetch<wbr/>Subcommand<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CommandInteractionOption</span><span class="tsd-signature-symbol">[]</span>, 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-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</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/2867da1/src/commands/ChatCommand.ts#L193">src/commands/ChatCommand.ts:193</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <span class="tsd-signature-type">CommandInteractionOption</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="fetchSubcommand" class="tsd-anchor"></a><h3>fetch<wbr/>Subcommand</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">fetch<wbr/>Subcommand<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CommandInteractionOption</span><span class="tsd-signature-symbol">[]</span>, 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-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</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/commands/ChatCommand.ts#L223">src/commands/ChatCommand.ts:223</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <span class="tsd-signature-type">CommandInteractionOption</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>parameter options</p>
|
||||
</div></div></li><li><h5>interaction: <span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord interaction</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></h4><div><p>an <a href="InputManager.html">InputManager</a> containing all interaction-related data or <em>null</em></p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="getSubcommand" class="tsd-anchor"></a><h3>get<wbr/>Subcommand</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Subcommand<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, group<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><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</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/2867da1/src/commands/ChatCommand.ts#L252">src/commands/ChatCommand.ts:252</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="getSubcommand" class="tsd-anchor"></a><h3>get<wbr/>Subcommand</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Subcommand<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, group<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><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</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/commands/ChatCommand.ts#L281">src/commands/ChatCommand.ts:281</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>subcommand name</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> group: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a></h4><div><p>a <a href="SubCommand.html">SubCommand</a> object or <em>null</em></p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isBaseCommandType" class="tsd-anchor"></a><h3>is<wbr/>Base<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#isBaseCommandType">isBaseCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L88">src/commands/base/Command.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isBaseCommandType" class="tsd-anchor"></a><h3>is<wbr/>Base<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#isBaseCommandType">isBaseCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L100">src/commands/base/Command.ts:100</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check base command type</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#BaseCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>base command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isChildCommandType" class="tsd-anchor"></a><h3>is<wbr/>Child<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#isChildCommandType">isChildCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L155">src/commands/base/Command.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isChildCommandType" class="tsd-anchor"></a><h3>is<wbr/>Child<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#isChildCommandType">isChildCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L165">src/commands/base/Command.ts:165</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check child command type</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#ChildCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>child command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as a child command of the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isCommandType" class="tsd-anchor"></a><h3>is<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#isCommandType">isCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L128">src/commands/base/Command.ts:128</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isCommandType" class="tsd-anchor"></a><h3>is<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#isCommandType">isCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L139">src/commands/base/Command.ts:139</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Checks command type</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a name="start" class="tsd-anchor"></a><h3>start</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#start">start</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/ChatCommand.ts#L153">src/commands/ChatCommand.ts:153</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a name="start" class="tsd-anchor"></a><h3>start</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#start">start</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/ChatCommand.ts#L185">src/commands/ChatCommand.ts:185</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Invoke the command</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>input: <a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>input data manager</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ChatCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#toObject">toObject</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/ChatCommand.ts#L271">src/commands/ChatCommand.ts:271</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ChatCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#toObject">toObject</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/ChatCommand.ts#L299">src/commands/ChatCommand.ts:299</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Converts <a href="ChatCommand.html">ChatCommand</a> instance to object that is recognized by the Discord API</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/ChatCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandObject</a></h4><div><p>Discord API object</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="ChatCommand.html" class="tsd-kind-icon">Chat<wbr/>Command</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="ChatCommand.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="ChatCommand.html#_children" class="tsd-kind-icon">_children</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ChatCommand.html#aliases" class="tsd-kind-icon">aliases</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ChatCommand.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ChatCommand.html#parameters" class="tsd-kind-icon">parameters</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ChatCommand.html#slash" class="tsd-kind-icon">slash</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ChatCommand.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ChatCommand.html#usage" class="tsd-kind-icon">usage</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ChatCommand.html#visible" class="tsd-kind-icon">visible</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="ChatCommand.html#children" class="tsd-kind-icon">children</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="ChatCommand.html#hasSubCommands" class="tsd-kind-icon">has<wbr/>Sub<wbr/>Commands</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="ChatCommand.html#append" class="tsd-kind-icon">append</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="ChatCommand.html#fetchSubcommand" class="tsd-kind-icon">fetch<wbr/>Subcommand</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="ChatCommand.html#getSubcommand" class="tsd-kind-icon">get<wbr/>Subcommand</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="ChatCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="ChatCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="ChatCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="ChatCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="ChatCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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-cLine truncated
|
||||
@@ -1,6 +1,6 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Command | 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="Command.html">Command</a></li></ul><h1>Class Command</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>Bot core command object</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Command</span><ul class="tsd-hierarchy"><li><a href="SubCommandGroup.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommandGroup</a></li><li><a href="FunctionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCommand</a></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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="Command.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="Command.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Command.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Command.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Command.html#type" class="tsd-kind-icon">type</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 tsd-has-type-parameter"><a href="Command.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="Command.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="Command.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Command.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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/>Command<span class="tsd-signature-symbol">(</span>manager<span class="tsd-signature-symbol">: </span><a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a>, type<span class="tsd-signature-symbol">: </span><a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/APICommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandInit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</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/2867da1/src/commands/base/Command.ts#L56">src/commands/base/Command.ts:56</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Command</span><ul class="tsd-hierarchy"><li><a href="SubCommandGroup.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommandGroup</a></li><li><a href="FunctionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCommand</a></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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="Command.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="Command.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Command.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Command.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Command.html#type" class="tsd-kind-icon">type</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 tsd-has-type-parameter"><a href="Command.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="Command.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="Command.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Command.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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/>Command<span class="tsd-signature-symbol">(</span>manager<span class="tsd-signature-symbol">: </span><a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a>, type<span class="tsd-signature-symbol">: </span><a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/APICommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandInit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</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/commands/base/Command.ts#L69">src/commands/base/Command.ts:69</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command core constructor</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>manager: <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>manager bound to this command</p>
|
||||
@@ -8,30 +8,30 @@
|
||||
<p>command internal type</p>
|
||||
</div></div></li><li><h5>options: <a href="../interfaces/APICommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandInit</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>initialization options</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</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="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L47">src/commands/base/Command.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</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="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L60">src/commands/base/Command.ts:60</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default_permission</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="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L23">src/commands/base/Command.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L39">src/commands/base/Command.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Manager in which this command is registered</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="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> 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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L31">src/commands/base/Command.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> 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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L46">src/commands/base/Command.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</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="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L39">src/commands/base/Command.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L53">src/commands/base/Command.ts:53</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>CommandBot's internal command type</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></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 tsd-has-type-parameter"><a name="isBaseCommandType" class="tsd-anchor"></a><h3>is<wbr/>Base<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></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/2867da1/src/commands/base/Command.ts#L88">src/commands/base/Command.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></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 tsd-has-type-parameter"><a name="isBaseCommandType" class="tsd-anchor"></a><h3>is<wbr/>Base<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></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/commands/base/Command.ts#L100">src/commands/base/Command.ts:100</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check base command type</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#BaseCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>base command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a name="isChildCommandType" class="tsd-anchor"></a><h3>is<wbr/>Child<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></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/2867da1/src/commands/base/Command.ts#L155">src/commands/base/Command.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a name="isChildCommandType" class="tsd-anchor"></a><h3>is<wbr/>Child<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></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/commands/base/Command.ts#L165">src/commands/base/Command.ts:165</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check child command type</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#ChildCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>child command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as a child command of the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a name="isCommandType" class="tsd-anchor"></a><h3>is<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></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/2867da1/src/commands/base/Command.ts#L128">src/commands/base/Command.ts:128</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a name="isCommandType" class="tsd-anchor"></a><h3>is<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></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/commands/base/Command.ts#L139">src/commands/base/Command.ts:139</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Checks command type</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</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/2867da1/src/commands/base/Command.ts#L75">src/commands/base/Command.ts:75</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</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/commands/base/Command.ts#L88">src/commands/base/Command.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Converts a command instance to an <a href="../interfaces/APICommandObject.html">APICommandObject</a></p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a></h4><div><p>An object that is accepted by the Discord API</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="Command.html" class="tsd-kind-icon">Command</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="Command.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Command.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Command.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Command.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Command.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="Command.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="Command.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="Command.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Command.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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>
|
||||
@@ -1,30 +1,30 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>CommandManager | 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="CommandManager.html">CommandManager</a></li></ul><h1>Class CommandManager</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>Object that stores the registered commands and is responsible for data exchanging with the Discord API</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">CommandManager</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="CommandManager.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 tsd-is-private"><a href="CommandManager.html#_commands" class="tsd-kind-icon">_commands</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="CommandManager.html#_globalEntryName" class="tsd-kind-icon">_global<wbr/>Entry<wbr/>Name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="CommandManager.html#_registerCache" class="tsd-kind-icon">_register<wbr/>Cache</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandManager.html#argumentSeparator" class="tsd-kind-icon">argument<wbr/>Separator</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandManager.html#client" class="tsd-kind-icon">client</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandManager.html#commandSeparator" class="tsd-kind-icon">command<wbr/>Separator</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandManager.html#help" class="tsd-kind-icon">help</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandManager.html#prefix" class="tsd-kind-icon">prefix</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="CommandManager.html#baseApiUrl" class="tsd-kind-icon">base<wbr/>Api<wbr/>Url</a></li></ul></section><section class="tsd-index-section "><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="CommandManager.html#cache" class="tsd-kind-icon">cache</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="CommandManager.html#commandsCount" class="tsd-kind-icon">commands<wbr/>Count</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 tsd-has-type-parameter"><a href="CommandManager.html#add" class="tsd-kind-icon">add</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="CommandManager.html#arrayToMap" class="tsd-kind-icon">array<wbr/>To<wbr/>Map</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#fetch" class="tsd-kind-icon">fetch</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="CommandManager.html#get" class="tsd-kind-icon">get</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#getApi" class="tsd-kind-icon">get<wbr/>Api</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="CommandManager.html#getCache" class="tsd-kind-icon">get<wbr/>Cache</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#getIdApi" class="tsd-kind-icon">get<wbr/>Id<wbr/>Api</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#getPermissionsApi" class="tsd-kind-icon">get<wbr/>Permissions<wbr/>Api</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#list" class="tsd-kind-icon">list</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#listApi" class="tsd-kind-icon">list<wbr/>Api</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#register" class="tsd-kind-icon">register</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#setPermissionsApi" class="tsd-kind-icon">set<wbr/>Permissions<wbr/>Api</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="CommandManager.html#updateCache" class="tsd-kind-icon">update<wbr/>Cache</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="CommandManager.html#isCommand" class="tsd-kind-icon">is<wbr/>Command</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/>Command<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>, helpMsg<span class="tsd-Line truncated
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">CommandManager</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="CommandManager.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 tsd-is-private"><a href="CommandManager.html#_commands" class="tsd-kind-icon">_commands</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="CommandManager.html#_globalEntryName" class="tsd-kind-icon">_global<wbr/>Entry<wbr/>Name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="CommandManager.html#_registerCache" class="tsd-kind-icon">_register<wbr/>Cache</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandManager.html#argumentSeparator" class="tsd-kind-icon">argument<wbr/>Separator</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandManager.html#client" class="tsd-kind-icon">client</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandManager.html#commandSeparator" class="tsd-kind-icon">command<wbr/>Separator</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandManager.html#help" class="tsd-kind-icon">help</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandManager.html#prefix" class="tsd-kind-icon">prefix</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="CommandManager.html#baseApiUrl" class="tsd-kind-icon">base<wbr/>Api<wbr/>Url</a></li></ul></section><section class="tsd-index-section "><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="CommandManager.html#cache" class="tsd-kind-icon">cache</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="CommandManager.html#commandsCount" class="tsd-kind-icon">commands<wbr/>Count</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 tsd-has-type-parameter"><a href="CommandManager.html#add" class="tsd-kind-icon">add</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="CommandManager.html#arrayToMap" class="tsd-kind-icon">array<wbr/>To<wbr/>Map</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#fetch" class="tsd-kind-icon">fetch</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="CommandManager.html#get" class="tsd-kind-icon">get</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#getApi" class="tsd-kind-icon">get<wbr/>Api</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="CommandManager.html#getCache" class="tsd-kind-icon">get<wbr/>Cache</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#getIdApi" class="tsd-kind-icon">get<wbr/>Id<wbr/>Api</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#getPermissionsApi" class="tsd-kind-icon">get<wbr/>Permissions<wbr/>Api</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#list" class="tsd-kind-icon">list</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#listApi" class="tsd-kind-icon">list<wbr/>Api</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#register" class="tsd-kind-icon">register</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#setPermissionsApi" class="tsd-kind-icon">set<wbr/>Permissions<wbr/>Api</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="CommandManager.html#updateCache" class="tsd-kind-icon">update<wbr/>Cache</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="CommandManager.html#isCommand" class="tsd-kind-icon">is<wbr/>Command</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/>Command<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>, helpMsg<span class="tsd-Line truncated
|
||||
<p>client that this manager belongs to</p>
|
||||
</div></div></li><li><h5>helpMsg: <a href="../interfaces/HelpMessageParams.html" class="tsd-signature-type" data-tsd-kind="Interface">HelpMessageParams</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>parameters defining appearance of the help message</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> prefix: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> argSep: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> cmdSep: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</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 tsd-is-private"><a name="_commands" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> _commands</h3><div class="tsd-signature tsd-kind-icon">_commands<span class="tsd-signature-symbol">:</span> <a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/CommandManager.ts#L31">src/structures/CommandManager.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> prefix: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> argSep: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> cmdSep: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</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 tsd-is-private"><a name="_commands" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> _commands</h3><div class="tsd-signature tsd-kind-icon">_commands<span class="tsd-signature-symbol">:</span> <a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/CommandManager.ts#L30">src/structures/CommandManager.ts:30</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of commands registered in the 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 tsd-is-private"><a name="_globalEntryName" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> _global<wbr/>Entry<wbr/>Name</h3><div class="tsd-signature tsd-kind-icon">_global<wbr/>Entry<wbr/>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "global"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/CommandManager.ts#L39">src/structures/CommandManager.ts:39</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a name="_registerCache" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> _register<wbr/>Cache</h3><div class="tsd-signature tsd-kind-icon">_register<wbr/>Cache<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/CommandManager.ts#L38">src/structures/CommandManager.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-private"><a name="_globalEntryName" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> _global<wbr/>Entry<wbr/>Name</h3><div class="tsd-signature tsd-kind-icon">_global<wbr/>Entry<wbr/>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "global"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/CommandManager.ts#L38">src/structures/CommandManager.ts:38</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a name="_registerCache" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> _register<wbr/>Cache</h3><div class="tsd-signature tsd-kind-icon">_register<wbr/>Cache<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/CommandManager.ts#L37">src/structures/CommandManager.ts:37</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Cache of Discord API commands data</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="argumentSeparator" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> argument<wbr/>Separator</h3><div class="tsd-signature tsd-kind-icon">argument<wbr/>Separator<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/2867da1/src/structures/CommandManager.ts#L71">src/structures/CommandManager.ts:71</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="argumentSeparator" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> argument<wbr/>Separator</h3><div class="tsd-signature tsd-kind-icon">argument<wbr/>Separator<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/5a80551/src/structures/CommandManager.ts#L66">src/structures/CommandManager.ts:66</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>A string used to split all incoming input data from Discord messages</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="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/2867da1/src/structures/CommandManager.ts#L47">src/structures/CommandManager.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="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/CommandManager.ts#L45">src/structures/CommandManager.ts:45</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Client connected 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="commandSeparator" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> command<wbr/>Separator</h3><div class="tsd-signature tsd-kind-icon">command<wbr/>Separator<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/2867da1/src/structures/CommandManager.ts#L79">src/structures/CommandManager.ts:79</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="commandSeparator" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> command<wbr/>Separator</h3><div class="tsd-signature tsd-kind-icon">command<wbr/>Separator<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/5a80551/src/structures/CommandManager.ts#L73">src/structures/CommandManager.ts:73</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>A string used to separate subcommand groups and subcommands</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="help" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> help</h3><div class="tsd-signature tsd-kind-icon">help<span class="tsd-signature-symbol">?:</span> <a href="HelpMessage.html" class="tsd-signature-type" data-tsd-kind="Class">HelpMessage</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/CommandManager.ts#L55">src/structures/CommandManager.ts:55</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="help" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> help</h3><div class="tsd-signature tsd-kind-icon">help<span class="tsd-signature-symbol">?:</span> <a href="HelpMessage.html" class="tsd-signature-type" data-tsd-kind="Class">HelpMessage</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/CommandManager.ts#L52">src/structures/CommandManager.ts:52</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Help command associated with 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="prefix" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> prefix</h3><div class="tsd-signature tsd-kind-icon">prefix<span class="tsd-signature-symbol">:</span> <a href="PrefixManager.html" class="tsd-signature-type" data-tsd-kind="Class">PrefixManager</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/CommandManager.ts#L63">src/structures/CommandManager.ts:63</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="prefix" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> prefix</h3><div class="tsd-signature tsd-kind-icon">prefix<span class="tsd-signature-symbol">:</span> <a href="PrefixManager.html" class="tsd-signature-type" data-tsd-kind="Class">PrefixManager</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/CommandManager.ts#L59">src/structures/CommandManager.ts:59</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>A manager holding all guild-specific prefixes and a global prefix</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 tsd-is-static"><a name="baseApiUrl" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> base<wbr/>Api<wbr/>Url</h3><div class="tsd-signature tsd-kind-icon">base<wbr/>Api<wbr/>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "https://discord.com/api/v8"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/CommandManager.ts#L88">src/structures/CommandManager.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-static"><a name="baseApiUrl" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> base<wbr/>Api<wbr/>Url</h3><div class="tsd-signature tsd-kind-icon">base<wbr/>Api<wbr/>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "https://discord.com/api/v8"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/CommandManager.ts#L81">src/structures/CommandManager.ts:81</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API URL</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>static</dt><dd></dd><dt>readonly</dt><dd></dd></dl></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a name="cache" class="tsd-anchor"></a><h3>cache</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> cache<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></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/2867da1/src/structures/CommandManager.ts#L120">src/structures/CommandManager.ts:120</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div><dl class="tsd-comment-tags"><dt>static</dt><dd></dd><dt>readonly</dt><dd></dd></dl></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a name="cache" class="tsd-anchor"></a><h3>cache</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> cache<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></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/CommandManager.ts#L113">src/structures/CommandManager.ts:113</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API commands cache</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a name="commandsCount" class="tsd-anchor"></a><h3>commands<wbr/>Count</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> commandsCount<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/2867da1/src/structures/CommandManager.ts#L128">src/structures/CommandManager.ts:128</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a name="commandsCount" class="tsd-anchor"></a><h3>commands<wbr/>Count</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> commandsCount<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/CommandManager.ts#L120">src/structures/CommandManager.ts:120</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Number of commands registered in this manager</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></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 tsd-has-type-parameter"><a name="add" class="tsd-anchor"></a><h3>add</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">add<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span>, options<span class="tsd-signature-symbol">: </span><a href="../modules.html#CommandInit" class="tsd-signature-type" data-tsd-kind="Type alias">CommandInit</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></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/2867da1/src/structures/CommandManager.ts#L145">src/structures/CommandManager.ts:145</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></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 tsd-has-type-parameter"><a name="add" class="tsd-anchor"></a><h3>add</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">add<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span>, options<span class="tsd-signature-symbol">: </span><a href="../modules.html#CommandInit" class="tsd-signature-type" data-tsd-kind="Type alias">CommandInit</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></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/CommandManager.ts#L137">src/structures/CommandManager.ts:137</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Creates and registers command in the manager based on the given options</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>remarks</dt><dd><p>All commands have to be added to the instance <strong>before starting the bot</strong>. Adding commands while the bot is running is not possible and can cause issues.</p>
|
||||
<p>Command types</p>
|
||||
@@ -38,57 +38,57 @@
|
||||
</div></div></li><li><h5>options: <a href="../modules.html#CommandInit" class="tsd-signature-type" data-tsd-kind="Type alias">CommandInit</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>an object containing all properties required to create this type of command</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>A computed command object that inherits from <a href="Command.html">Command</a></p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a name="arrayToMap" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> array<wbr/>To<wbr/>Map</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">array<wbr/>To<wbr/>Map<span class="tsd-signature-symbol">(</span>a<span class="tsd-signature-symbol">: </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">></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/2867da1/src/structures/CommandManager.ts#L556">src/structures/CommandManager.ts:556</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a name="arrayToMap" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> array<wbr/>To<wbr/>Map</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">array<wbr/>To<wbr/>Map<span class="tsd-signature-symbol">(</span>a<span class="tsd-signature-symbol">: </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">></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/CommandManager.ts#L555">src/structures/CommandManager.ts:555</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Performs internal data type conversions</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>a: <a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">></span></h4><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="fetch" class="tsd-anchor"></a><h3>fetch</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">fetch<span class="tsd-signature-symbol">(</span>i<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-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</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/2867da1/src/structures/CommandManager.ts#L314">src/structures/CommandManager.ts:314</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>a: <a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">></span></h4><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="fetch" class="tsd-anchor"></a><h3>fetch</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">fetch<span class="tsd-signature-symbol">(</span>i<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-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</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/CommandManager.ts#L297">src/structures/CommandManager.ts:297</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Process an interaction</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>i: <span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>interaction object to fetch a command from</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></h4><div><p>An InputManager containing all input data (command, arguments, target etc.)</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a name="get" class="tsd-anchor"></a><h3>get</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">get<T><span class="tsd-signature-symbol">(</span>q<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, t<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></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/2867da1/src/structures/CommandManager.ts#L175">src/structures/CommandManager.ts:175</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a name="get" class="tsd-anchor"></a><h3>get</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">get<T><span class="tsd-signature-symbol">(</span>q<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, t<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"CHAT"</span><span class="tsd-signature-symbol"> ? </span><a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> : </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</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/CommandManager.ts#L166">src/structures/CommandManager.ts:166</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Get command registered in this manager</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>q: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command name or alias</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> t: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>A command object</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="getApi" class="tsd-anchor"></a><h3>get<wbr/>Api</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Api<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, guild<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Guild</span>, noCache<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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"><</span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">></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/2867da1/src/structures/CommandManager.ts#L214">src/structures/CommandManager.ts:214</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> t: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"CHAT"</span><span class="tsd-signature-symbol"> ? </span><a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> : </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></h4><div><p>A command object</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="getApi" class="tsd-anchor"></a><h3>get<wbr/>Api</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Api<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, guild<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Guild</span>, noCache<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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"><</span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">></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/CommandManager.ts#L203">src/structures/CommandManager.ts:203</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Fetches command object from the Discord API</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>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord command ID</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> guild: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Guild</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> noCache: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">></span></h4><div><p>Discord command object</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a name="getCache" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> get<wbr/>Cache</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">get<wbr/>Cache<span class="tsd-signature-symbol">(</span>q<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, guildId<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><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</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/2867da1/src/structures/CommandManager.ts#L547">src/structures/CommandManager.ts:547</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a name="getCache" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> get<wbr/>Cache</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">get<wbr/>Cache<span class="tsd-signature-symbol">(</span>q<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, guildId<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><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</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/CommandManager.ts#L547">src/structures/CommandManager.ts:547</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Retrieves cache from the manager</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>q: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> guildId: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a></h4><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="getIdApi" class="tsd-anchor"></a><h3>get<wbr/>Id<wbr/>Api</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Id<wbr/>Api<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, type<span class="tsd-signature-symbol">: </span><a href="../modules.html#APICommandType" class="tsd-signature-type" data-tsd-kind="Type alias">APICommandType</a>, guild<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Guild</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"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></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/2867da1/src/structures/CommandManager.ts#L249">src/structures/CommandManager.ts:249</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>q: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> guildId: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a></h4><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="getIdApi" class="tsd-anchor"></a><h3>get<wbr/>Id<wbr/>Api</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Id<wbr/>Api<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, type<span class="tsd-signature-symbol">: </span><a href="../modules.html#APICommandType" class="tsd-signature-type" data-tsd-kind="Type alias">APICommandType</a>, guild<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Guild</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"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></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/CommandManager.ts#L235">src/structures/CommandManager.ts:235</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Fetches command ID by name from the Discord APi</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>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>name of the command</p>
|
||||
</div></div></li><li><h5>type: <a href="../modules.html#APICommandType" class="tsd-signature-type" data-tsd-kind="Type alias">APICommandType</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command type you want to get ID for</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> guild: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Guild</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><div><p>Command ID from the Discord API</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="getPermissionsApi" class="tsd-anchor"></a><h3>get<wbr/>Permissions<wbr/>Api</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Permissions<wbr/>Api<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, g<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Guild</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"><</span><a href="../interfaces/CommandPermission.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandPermission</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></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/2867da1/src/structures/CommandManager.ts#L509">src/structures/CommandManager.ts:509</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="getPermissionsApi" class="tsd-anchor"></a><h3>get<wbr/>Permissions<wbr/>Api</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Permissions<wbr/>Api<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, g<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Guild</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"><</span><a href="../interfaces/CommandPermission.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandPermission</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></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/CommandManager.ts#L511">src/structures/CommandManager.ts:511</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Get permissions from Discord Permissions API for a specified command</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>async</dt><dd></dd><dt>experimental</dt><dd><p>This functionality hasn't been polished and fully tested yet. Using it might lead to errors and application crashes.</p>
|
||||
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command ID</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> g: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Guild</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/CommandPermission.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandPermission</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="list" class="tsd-anchor"></a><h3>list</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">list<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">readonly </span><a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a><span class="tsd-signature-symbol">[]</span></li><li class="tsd-signature tsd-kind-icon">list<span class="tsd-signature-symbol">(</span>f<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"CHAT"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">readonly </span><a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a><span class="tsd-signature-symbol">[]</span></li><li class="tsd-signature tsd-kind-icon">list<span class="tsd-signature-symbol">(</span>f<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"CONTEXT"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">readonly </span><a href="ContextMenuCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ContextMenuCommand</a><span class="tsd-signature-symbol">[]</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/2867da1/src/structures/CommandManager.ts#L267">src/structures/CommandManager.ts:267</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> g: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Guild</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/CommandPermission.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandPermission</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="list" class="tsd-anchor"></a><h3>list</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">list<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">readonly </span><a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a><span class="tsd-signature-symbol">[]</span></li><li class="tsd-signature tsd-kind-icon">list<span class="tsd-signature-symbol">(</span>f<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"CHAT"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">readonly </span><a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a><span class="tsd-signature-symbol">[]</span></li><li class="tsd-signature tsd-kind-icon">list<span class="tsd-signature-symbol">(</span>f<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"CONTEXT"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">readonly </span><a href="ContextMenuCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ContextMenuCommand</a><span class="tsd-signature-symbol">[]</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/CommandManager.ts#L252">src/structures/CommandManager.ts:252</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Lists all commands in the manager</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">readonly </span><a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a><span class="tsd-signature-symbol">[]</span></h4><div><p>An array of commands registered in this manager</p>
|
||||
</div></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/CommandManager.ts#L268">src/structures/CommandManager.ts:268</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>f: <span class="tsd-signature-type">"CHAT"</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">readonly </span><a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a><span class="tsd-signature-symbol">[]</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/CommandManager.ts#L269">src/structures/CommandManager.ts:269</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>f: <span class="tsd-signature-type">"CONTEXT"</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">readonly </span><a href="ContextMenuCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ContextMenuCommand</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="listApi" class="tsd-anchor"></a><h3>list<wbr/>Api</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">list<wbr/>Api<span class="tsd-signature-symbol">(</span>g<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Guild</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"><</span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></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/2867da1/src/structures/CommandManager.ts#L288">src/structures/CommandManager.ts:288</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/CommandManager.ts#L253">src/structures/CommandManager.ts:253</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>f: <span class="tsd-signature-type">"CHAT"</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">readonly </span><a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a><span class="tsd-signature-symbol">[]</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/CommandManager.ts#L254">src/structures/CommandManager.ts:254</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>f: <span class="tsd-signature-type">"CONTEXT"</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">readonly </span><a href="ContextMenuCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ContextMenuCommand</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="listApi" class="tsd-anchor"></a><h3>list<wbr/>Api</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">list<wbr/>Api<span class="tsd-signature-symbol">(</span>g<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Guild</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"><</span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></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/CommandManager.ts#L272">src/structures/CommandManager.ts:272</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Lists commands registered in the Discord API</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><span class="tsd-flag ts-flagOptional">Optional</span> g: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Guild</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>List of commands from Discord API</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="register" class="tsd-anchor"></a><h3>register</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">register<span class="tsd-signature-symbol">(</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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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/2867da1/src/structures/CommandManager.ts#L420">src/structures/CommandManager.ts:420</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="register" class="tsd-anchor"></a><h3>register</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">register<span class="tsd-signature-symbol">(</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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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/CommandManager.ts#L424">src/structures/CommandManager.ts:424</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Register all commands in this manager in the Discord API</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>async</dt><dd></dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="setPermissionsApi" class="tsd-anchor"></a><h3>set<wbr/>Permissions<wbr/>Api</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Permissions<wbr/>Api<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, permissions<span class="tsd-signature-symbol">: </span><a href="../interfaces/CommandPermission.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandPermission</a><span class="tsd-signature-symbol">[]</span>, g<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Guild</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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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/2867da1/src/structures/CommandManager.ts#L483">src/structures/CommandManager.ts:483</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div><dl class="tsd-comment-tags"><dt>async</dt><dd></dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="setPermissionsApi" class="tsd-anchor"></a><h3>set<wbr/>Permissions<wbr/>Api</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Permissions<wbr/>Api<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, permissions<span class="tsd-signature-symbol">: </span><a href="../interfaces/CommandPermission.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandPermission</a><span class="tsd-signature-symbol">[]</span>, g<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Guild</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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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/CommandManager.ts#L486">src/structures/CommandManager.ts:486</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Set permissions using Discord Permissions API</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>async</dt><dd></dd><dt>experimental</dt><dd><p>This functionality hasn't been polished and fully tested yet. Using it might lead to errors and application crashes.</p>
|
||||
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command ID</p>
|
||||
</div></div></li><li><h5>permissions: <a href="../interfaces/CommandPermission.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandPermission</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>permissions to set</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> g: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Guild</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a name="updateCache" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> update<wbr/>Cache</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">update<wbr/>Cache<span class="tsd-signature-symbol">(</span>commands<span class="tsd-signature-symbol">: </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">[]</span>, guildId<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><span class="tsd-signature-type">void</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/2867da1/src/structures/CommandManager.ts#L532">src/structures/CommandManager.ts:532</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>commands: <a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> g: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Guild</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a name="updateCache" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> update<wbr/>Cache</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">update<wbr/>Cache<span class="tsd-signature-symbol">(</span>commands<span class="tsd-signature-symbol">: </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">[]</span>, guildId<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><span class="tsd-signature-type">void</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/CommandManager.ts#L533">src/structures/CommandManager.ts:533</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>commands: <a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/RegisteredCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisteredCommandObject</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>list of commands to cache</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> guildId: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>guild ID</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a name="isCommand" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr/>Command</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<span class="tsd-signature-symbol">(</span>c<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">c</span><span class="tsd-signature-symbol"> is </span><a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</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/2867da1/src/structures/CommandManager.ts#L570">src/structures/CommandManager.ts:570</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>static</dt><dd></dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>c: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a name="isCommand" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr/>Command</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<span class="tsd-signature-symbol">(</span>c<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">c</span><span class="tsd-signature-symbol"> is </span><a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</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/CommandManager.ts#L568">src/structures/CommandManager.ts:568</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>static</dt><dd></dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>c: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>object to check</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">c</span><span class="tsd-signature-symbol"> is </span><a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a></h4><div><p>Whether this object is a <a href="Command.html">Command</a> object</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="CommandManager.html" class="tsd-kind-icon">Command<wbr/>Manager</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="CommandManager.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="CommandManager.html#_commands" class="tsd-kind-icon">_commands</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="CommandManager.html#_globalEntryName" class="tsd-kind-icon">_global<wbr/>Entry<wbr/>Name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="CommandManager.html#_registerCache" class="tsd-kind-icon">_register<wbr/>Cache</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandManager.html#argumentSeparator" class="tsd-kind-icon">argument<wbr/>Separator</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandManager.html#client" class="tsd-kind-icon">client</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandManager.html#commandSeparator" class="tsd-kind-icon">command<wbr/>Separator</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandManager.html#help" class="tsd-kind-icon">help</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandManager.html#prefix" class="tsd-kind-icon">prefix</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="CommandManager.html#baseApiUrl" class="tsd-kind-icon">base<wbr/>Api<wbr/>Url</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="CommandManager.html#cache" class="tsd-kind-icon">cache</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="CommandManager.html#commandsCount" class="tsd-kind-icon">commands<wbr/>Count</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="CommandManager.html#add" class="tsd-kind-icon">add</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="CommandManager.html#arrayToMap" class="tsd-kind-icon">array<wbr/>To<wbr/>Map</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#fetch" class="tsd-kind-icon">fetch</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="CommandManager.html#get" class="tsd-kind-icon">get</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#getApi" class="tsd-kind-icon">get<wbr/>Api</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="CommandManager.html#getCache" class="tsd-kind-icon">get<wbr/>Cache</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#getIdApi" class="tsd-kind-icon">get<wbr/>Id<wbr/>Api</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#getPermissionsApi" class="tsd-kind-icon">get<wbr/>Permissions<wbr/>Api</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#list" class="tsd-kind-icon">list</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#listApi" class="tsd-kind-icon">list<wbr/>Api</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#register" class="tsd-kind-icon">register</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CommandManager.html#setPermissionsApi" class="tsd-kind-icon">set<wbr/>Permissions<wbr/>Api</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="CommandManager.html#updateCache" class="tsd-kind-icon">update<wbr/>Cache</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="CommandManager.html#isCommand" class="tsd-kind-icon">is<wbr/>Command</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><Line truncated
|
||||
@@ -1,18 +1,18 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>CommandPermissions | 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="CommandPermissions.html">CommandPermissions</a></li></ul><h1>Class CommandPermissions</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>Object that stores permission resolvables and properties (bouund to a <a href="PermissionCommand.html">PermissionCommand</a>)</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">CommandPermissions</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="CommandPermissions.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="CommandPermissions.html#checkType" class="tsd-kind-icon">check<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandPermissions.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandPermissions.html#permissions" class="tsd-kind-icon">permissions</a></li></ul></section><section class="tsd-index-section "><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="CommandPermissions.html#bitfield" class="tsd-kind-icon">bitfield</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="CommandPermissions.html#isCustom" class="tsd-kind-icon">is<wbr/>Custom</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="CommandPermissions.html#check" class="tsd-kind-icon">check</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/>Command<wbr/>Permissions<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><a href="PermissionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionCommand</a>, o<span class="tsd-signature-symbol">?: </span><a href="../interfaces/CommandPermissionsInit.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandPermissionsInit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CommandPermissions.html" class="tsd-signature-type" data-tsd-kind="Class">CommandPermissions</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/2867da1/src/structures/CommandPermissions.ts#L39">src/structures/CommandPermissions.ts:39</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>command: <a href="PermissionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionCommand</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">CommandPermissions</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="CommandPermissions.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="CommandPermissions.html#checkType" class="tsd-kind-icon">check<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandPermissions.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CommandPermissions.html#permissions" class="tsd-kind-icon">permissions</a></li></ul></section><section class="tsd-index-section "><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="CommandPermissions.html#bitfield" class="tsd-kind-icon">bitfield</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="CommandPermissions.html#isCustom" class="tsd-kind-icon">is<wbr/>Custom</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="CommandPermissions.html#check" class="tsd-kind-icon">check</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/>Command<wbr/>Permissions<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><a href="PermissionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionCommand</a>, o<span class="tsd-signature-symbol">?: </span><a href="../interfaces/CommandPermissionsInit.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandPermissionsInit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CommandPermissions.html" class="tsd-signature-type" data-tsd-kind="Class">CommandPermissions</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/CommandPermissions.ts#L67">src/structures/CommandPermissions.ts:67</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>command: <a href="PermissionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionCommand</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command attached to this permissions object</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> o: <a href="../interfaces/CommandPermissionsInit.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandPermissionsInit</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="CommandPermissions.html" class="tsd-signature-type" data-tsd-kind="Class">CommandPermissions</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="checkType" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> check<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">check<wbr/>Type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#PermissionCheckTypes" class="tsd-signature-type" data-tsd-kind="Type alias">PermissionCheckTypes</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/CommandPermissions.ts#L32">src/structures/CommandPermissions.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> o: <a href="../interfaces/CommandPermissionsInit.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandPermissionsInit</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="CommandPermissions.html" class="tsd-signature-type" data-tsd-kind="Class">CommandPermissions</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="checkType" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> check<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">check<wbr/>Type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#PermissionCheckTypes" class="tsd-signature-type" data-tsd-kind="Type alias">PermissionCheckTypes</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/CommandPermissions.ts#L60">src/structures/CommandPermissions.ts:60</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command permissions</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="command" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <a href="PermissionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionCommand</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/CommandPermissions.ts#L16">src/structures/CommandPermissions.ts:16</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="command" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <a href="PermissionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionCommand</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/CommandPermissions.ts#L46">src/structures/CommandPermissions.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command bound to this object</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="permissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> permissions</h3><div class="tsd-signature tsd-kind-icon">permissions<span class="tsd-signature-symbol">:</span> <a href="../modules.html#PermissionFunction" class="tsd-signature-type" data-tsd-kind="Type alias">PermissionFunction</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Permissions</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/CommandPermissions.ts#L24">src/structures/CommandPermissions.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="permissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> permissions</h3><div class="tsd-signature tsd-kind-icon">permissions<span class="tsd-signature-symbol">:</span> <a href="../modules.html#PermissionFunction" class="tsd-signature-type" data-tsd-kind="Type alias">PermissionFunction</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Permissions</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/CommandPermissions.ts#L53">src/structures/CommandPermissions.ts:53</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>If set to "ALL", the command can only be used when all specified conditions are met. (works only for Discord.js permissions object)</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a name="bitfield" class="tsd-anchor"></a><h3>bitfield</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> bitfield<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInt</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/2867da1/src/structures/CommandPermissions.ts#L57">src/structures/CommandPermissions.ts:57</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a name="bitfield" class="tsd-anchor"></a><h3>bitfield</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> bitfield<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInt</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/CommandPermissions.ts#L84">src/structures/CommandPermissions.ts:84</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Permission bitfield</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BigInt</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a name="isCustom" class="tsd-anchor"></a><h3>is<wbr/>Custom</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isCustom<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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/2867da1/src/structures/CommandPermissions.ts#L49">src/structures/CommandPermissions.ts:49</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BigInt</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a name="isCustom" class="tsd-anchor"></a><h3>is<wbr/>Custom</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isCustom<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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/CommandPermissions.ts#L77">src/structures/CommandPermissions.ts:77</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether this object uses custom function to check permissions</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></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="check" class="tsd-anchor"></a><h3>check</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">check<span class="tsd-signature-symbol">(</span>i<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-symbol">: </span><span class="tsd-signature-type">boolean</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/2867da1/src/structures/CommandPermissions.ts#L67">src/structures/CommandPermissions.ts:67</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></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="check" class="tsd-anchor"></a><h3>check</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">check<span class="tsd-signature-symbol">(</span>i<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-symbol">: </span><span class="tsd-signature-type">boolean</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/CommandPermissions.ts#L94">src/structures/CommandPermissions.ts:94</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Checks if the interaction sender is permitted to use the command attached to this object</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>i: <span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command interaction or Discord message</p>
|
||||
|
||||
@@ -1,20 +1,20 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ContextMenuCommand | 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="ContextMenuCommand.html">ContextMenuCommand</a></li></ul><h1>Class ContextMenuCommand</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>Representation of all context menu Discord interactions</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="PermissionGuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionGuildCommand</a><ul class="tsd-hierarchy"><li><span class="target">ContextMenuCommand</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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="ContextMenuCommand.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 tsd-is-inherited"><a href="ContextMenuCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ContextMenuCommand.html#contextType" class="tsd-kind-icon">context<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#type" class="tsd-kind-icon">type</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 tsd-has-type-parameter tsd-is-inherited"><a href="ContextMenuCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="ContextMenuCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="ContextMenuCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="ContextMenuCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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 tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Context<wbr/>Menu<wbr/>Command<span class="tsd-signature-symbol">(</span>manager<span class="tsd-signature-symbol">: </span><a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/ContextMenuCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">ContextMenuCommandInit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ContextMenuCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ContextMenuCommand</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/ContextMenuCommand.ts#L26">src/commands/ContextMenuCommand.ts:26</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="PermissionGuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionGuildCommand</a><ul class="tsd-hierarchy"><li><span class="target">ContextMenuCommand</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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="ContextMenuCommand.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 tsd-is-inherited"><a href="ContextMenuCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ContextMenuCommand.html#contextType" class="tsd-kind-icon">context<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#type" class="tsd-kind-icon">type</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 tsd-has-type-parameter tsd-is-inherited"><a href="ContextMenuCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="ContextMenuCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="ContextMenuCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="ContextMenuCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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 tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Context<wbr/>Menu<wbr/>Command<span class="tsd-signature-symbol">(</span>manager<span class="tsd-signature-symbol">: </span><a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/ContextMenuCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">ContextMenuCommandInit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ContextMenuCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ContextMenuCommand</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/ContextMenuCommand.ts#L38">src/commands/ContextMenuCommand.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Context menu command constructor</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>manager: <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>manager that this command belongs to</p>
|
||||
</div></div></li><li><h5>options: <a href="../interfaces/ContextMenuCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">ContextMenuCommandInit</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>initialization options</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="ContextMenuCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ContextMenuCommand</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 tsd-is-inherited"><a name="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/FunctionCommand.ts#L28">src/commands/base/FunctionCommand.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="ContextMenuCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ContextMenuCommand</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 tsd-is-inherited"><a name="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L56">src/commands/base/FunctionCommand.ts:56</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether a SUCCESS message should be sent after executing the command function (when there is no other reply)</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="contextType" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> context<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">context<wbr/>Type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#ContextType" class="tsd-signature-type" data-tsd-kind="Type alias">ContextType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/ContextMenuCommand.ts#L18">src/commands/ContextMenuCommand.ts:18</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="contextType" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> context<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">context<wbr/>Type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#ContextType" class="tsd-signature-type" data-tsd-kind="Type alias">ContextType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/ContextMenuCommand.ts#L30">src/commands/ContextMenuCommand.ts:30</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Type of context menu interaction</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 tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L47">src/commands/base/Command.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L60">src/commands/base/Command.ts:60</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default_permission</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 tsd-is-inherited"><a name="dm" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#dm">dm</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/PermissionGuildCommand.ts#L29">src/commands/base/PermissionGuildCommand.ts:29</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="dm" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#dm">dm</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/PermissionGuildCommand.ts#L45">src/commands/base/PermissionGuildCommand.ts:45</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>If set to <em>false</em>, all interactions that get invoked from private/direct conversations (outside a guild) will result a PermissionError</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 tsd-is-inherited"><a name="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#ephemeral">ephemeral</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/FunctionCommand.ts#L42">src/commands/base/FunctionCommand.ts:42</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#ephemeral">ephemeral</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L70">src/commands/base/FunctionCommand.ts:70</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether a reply should be visible only to the caller</p>
|
||||
</div><div><ul>
|
||||
<li>NONE - bot replies are public and visible to everyone in a text channel</li>
|
||||
@@ -23,34 +23,34 @@
|
||||
</ul>
|
||||
<p><a href="https://support.discord.com/hc/pl/articles/1500000580222-Ephemeral-Messages-FAQ">Read more</a></p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd><dt>remarks</dt><dd><p>Since ephemeral interactions cannot be deleted, a placeholding embed will be sent when there will be no response from the command function and <em>announceSuccess</em> will be set to false (placeholding message uses <em>color</em> and <em>title</em> parameters from SUCCESS system message configuration)</p>
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="guilds" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#guilds">guilds</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/PermissionGuildCommand.ts#L21">src/commands/base/PermissionGuildCommand.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="guilds" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#guilds">guilds</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/PermissionGuildCommand.ts#L38">src/commands/base/PermissionGuildCommand.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of Discord guild (server) IDs in which this command can be used</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 tsd-is-inherited"><a name="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#manager">manager</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L23">src/commands/base/Command.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#manager">manager</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L39">src/commands/base/Command.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Manager in which this command is registered</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 tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> 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="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L31">src/commands/base/Command.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> 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="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L46">src/commands/base/Command.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</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 tsd-is-inherited"><a name="permissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> permissions</h3><div class="tsd-signature tsd-kind-icon">permissions<span class="tsd-signature-symbol">:</span> <a href="CommandPermissions.html" class="tsd-signature-type" data-tsd-kind="Class">CommandPermissions</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#permissions">permissions</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/PermissionCommand.ts#L21">src/commands/base/PermissionCommand.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="permissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> permissions</h3><div class="tsd-signature tsd-kind-icon">permissions<span class="tsd-signature-symbol">:</span> <a href="CommandPermissions.html" class="tsd-signature-type" data-tsd-kind="Class">CommandPermissions</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#permissions">permissions</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/PermissionCommand.ts#L34">src/commands/base/PermissionCommand.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object containing check functions and permission bitfields</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 tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L39">src/commands/base/Command.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L53">src/commands/base/Command.ts:53</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>CommandBot's internal command type</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></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 tsd-has-type-parameter tsd-is-inherited"><a name="isBaseCommandType" class="tsd-anchor"></a><h3>is<wbr/>Base<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#isBaseCommandType">isBaseCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L88">src/commands/base/Command.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></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 tsd-has-type-parameter tsd-is-inherited"><a name="isBaseCommandType" class="tsd-anchor"></a><h3>is<wbr/>Base<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#isBaseCommandType">isBaseCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L100">src/commands/base/Command.ts:100</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check base command type</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#BaseCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>base command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isChildCommandType" class="tsd-anchor"></a><h3>is<wbr/>Child<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#isChildCommandType">isChildCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L155">src/commands/base/Command.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isChildCommandType" class="tsd-anchor"></a><h3>is<wbr/>Child<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#isChildCommandType">isChildCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L165">src/commands/base/Command.ts:165</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check child command type</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#ChildCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>child command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as a child command of the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isCommandType" class="tsd-anchor"></a><h3>is<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#isCommandType">isCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L128">src/commands/base/Command.ts:128</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isCommandType" class="tsd-anchor"></a><h3>is<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#isCommandType">isCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L139">src/commands/base/Command.ts:139</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Checks command type</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a name="start" class="tsd-anchor"></a><h3>start</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#start">start</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/PermissionGuildCommand.ts#L59">src/commands/base/PermissionGuildCommand.ts:59</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a name="start" class="tsd-anchor"></a><h3>start</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#start">start</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/PermissionGuildCommand.ts#L75">src/commands/base/PermissionGuildCommand.ts:75</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Invoke the command</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>input: <a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>input data</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ContextMenuCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ContextMenuCommandObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#toObject">toObject</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/ContextMenuCommand.ts#L44">src/commands/ContextMenuCommand.ts:44</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="../interfaces/ContextMenuCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ContextMenuCommandObject</a></h4><div><p>Discord API object</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ContextMenuCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ContextMenuCommandObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="PermissionGuildCommand.html">PermissionGuildCommand</a>.<a href="PermissionGuildCommand.html#toObject">toObject</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/ContextMenuCommand.ts#L55">src/commands/ContextMenuCommand.ts:55</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="../interfaces/ContextMenuCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ContextMenuCommandObject</a></h4><div><p>Discord API object</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="ContextMenuCommand.html" class="tsd-kind-icon">Context<wbr/>Menu<wbr/>Command</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="ContextMenuCommand.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ContextMenuCommand.html#contextType" class="tsd-kind-icon">context<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="ContextMenuCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="ContextMenuCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="ContextMenuCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ContextMenuCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="ContextMenuCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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>
|
||||
@@ -1,6 +1,6 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>FunctionCommand | 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="FunctionCommand.html">FunctionCommand</a></li></ul><h1>Class FunctionCommand</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>Function (executable) command</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a><ul class="tsd-hierarchy"><li><span class="target">FunctionCommand</span><ul class="tsd-hierarchy"><li><a href="GuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">GuildCommand</a></li><li><a href="PermissionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionCommand</a></li></ul></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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="FunctionCommand.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 tsd-is-private"><a href="FunctionCommand.html#_function" class="tsd-kind-icon">_function</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="FunctionCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="FunctionCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="FunctionCommand.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="FunctionCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="FunctionCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="FunctionCommand.html#type" class="tsd-kind-icon">type</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 tsd-is-private"><a href="FunctionCommand.html#handleReply" class="tsd-kind-icon">handle<wbr/>Reply</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="FunctionCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="FunctionCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="FunctionCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="FunctionCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="FunctionCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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 tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Function<wbr/>Command<span class="tsd-signature-symbol">(</span>manager<span class="tsd-signature-symbol">: </span><a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a>, type<span class="tsd-signature-symbol">: </span><a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/FunctionCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">FunctionCommandInit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="FunctionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCommand</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="Command.html">Command</a>.<a href="Command.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/FunctionCommand.ts#L51">src/commands/base/FunctionCommand.ts:51</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a><ul class="tsd-hierarchy"><li><span class="target">FunctionCommand</span><ul class="tsd-hierarchy"><li><a href="GuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">GuildCommand</a></li><li><a href="PermissionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionCommand</a></li></ul></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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="FunctionCommand.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 tsd-is-private"><a href="FunctionCommand.html#_function" class="tsd-kind-icon">_function</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="FunctionCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="FunctionCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="FunctionCommand.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="FunctionCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="FunctionCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="FunctionCommand.html#type" class="tsd-kind-icon">type</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 tsd-is-private"><a href="FunctionCommand.html#handleReply" class="tsd-kind-icon">handle<wbr/>Reply</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="FunctionCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="FunctionCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="FunctionCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="FunctionCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="FunctionCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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 tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Function<wbr/>Command<span class="tsd-signature-symbol">(</span>manager<span class="tsd-signature-symbol">: </span><a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a>, type<span class="tsd-signature-symbol">: </span><a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/FunctionCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">FunctionCommandInit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="FunctionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCommand</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="Command.html">Command</a>.<a href="Command.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L79">src/commands/base/FunctionCommand.ts:79</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Executable command constructor</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>manager: <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command manager attached to this command</p>
|
||||
@@ -8,13 +8,13 @@
|
||||
<p>command type</p>
|
||||
</div></div></li><li><h5>options: <a href="../interfaces/FunctionCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">FunctionCommandInit</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command initailization options</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="FunctionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCommand</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 tsd-is-private"><a name="_function" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/FunctionCommand.ts#L21">src/commands/base/FunctionCommand.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="FunctionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCommand</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 tsd-is-private"><a name="_function" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L49">src/commands/base/FunctionCommand.ts:49</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command function (called on command execution)</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="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/FunctionCommand.ts#L28">src/commands/base/FunctionCommand.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L56">src/commands/base/FunctionCommand.ts:56</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether a SUCCESS message should be sent after executing the command function (when there is no other reply)</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 tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="Command.html">Command</a>.<a href="Command.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L47">src/commands/base/Command.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="Command.html">Command</a>.<a href="Command.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L60">src/commands/base/Command.ts:60</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default_permission</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="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/FunctionCommand.ts#L42">src/commands/base/FunctionCommand.ts:42</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L70">src/commands/base/FunctionCommand.ts:70</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether a reply should be visible only to the caller</p>
|
||||
</div><div><ul>
|
||||
<li>NONE - bot replies are public and visible to everyone in a text channel</li>
|
||||
@@ -23,39 +23,39 @@
|
||||
</ul>
|
||||
<p><a href="https://support.discord.com/hc/pl/articles/1500000580222-Ephemeral-Messages-FAQ">Read more</a></p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd><dt>remarks</dt><dd><p>Since ephemeral interactions cannot be deleted, a placeholding embed will be sent when there will be no response from the command function and <em>announceSuccess</em> will be set to false (placeholding message uses <em>color</em> and <em>title</em> parameters from SUCCESS system message configuration)</p>
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#manager">manager</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L23">src/commands/base/Command.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#manager">manager</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L39">src/commands/base/Command.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Manager in which this command is registered</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 tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> 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="Command.html">Command</a>.<a href="Command.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L31">src/commands/base/Command.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> 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="Command.html">Command</a>.<a href="Command.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L46">src/commands/base/Command.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</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 tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></div><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L39">src/commands/base/Command.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></div><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L53">src/commands/base/Command.ts:53</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>CommandBot's internal command type</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></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 tsd-is-private"><a name="handleReply" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> handle<wbr/>Reply</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">handle<wbr/>Reply<span class="tsd-signature-symbol">(</span>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>, result<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MessageEmbed</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ReplyMessageOptions</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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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/2867da1/src/commands/base/FunctionCommand.ts#L88">src/commands/base/FunctionCommand.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></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 tsd-is-private"><a name="handleReply" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> handle<wbr/>Reply</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">handle<wbr/>Reply<span class="tsd-signature-symbol">(</span>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>, result<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MessageEmbed</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ReplyMessageOptions</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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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/commands/base/FunctionCommand.ts#L115">src/commands/base/FunctionCommand.ts:115</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Reply handler</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>interaction: <span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord interaction object</p>
|
||||
</div></div></li><li><h5>result: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MessageEmbed</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ReplyMessageOptions</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>result of command function execution</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isBaseCommandType" class="tsd-anchor"></a><h3>is<wbr/>Base<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#isBaseCommandType">isBaseCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L88">src/commands/base/Command.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isBaseCommandType" class="tsd-anchor"></a><h3>is<wbr/>Base<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#isBaseCommandType">isBaseCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L100">src/commands/base/Command.ts:100</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check base command type</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#BaseCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>base command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isChildCommandType" class="tsd-anchor"></a><h3>is<wbr/>Child<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#isChildCommandType">isChildCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L155">src/commands/base/Command.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isChildCommandType" class="tsd-anchor"></a><h3>is<wbr/>Child<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#isChildCommandType">isChildCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L165">src/commands/base/Command.ts:165</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check child command type</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#ChildCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>child command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as a child command of the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isCommandType" class="tsd-anchor"></a><h3>is<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#isCommandType">isCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L128">src/commands/base/Command.ts:128</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isCommandType" class="tsd-anchor"></a><h3>is<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#isCommandType">isCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L139">src/commands/base/Command.ts:139</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Checks command type</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="start" class="tsd-anchor"></a><h3>start</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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/2867da1/src/commands/base/FunctionCommand.ts#L74">src/commands/base/FunctionCommand.ts:74</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="start" class="tsd-anchor"></a><h3>start</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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/commands/base/FunctionCommand.ts#L102">src/commands/base/FunctionCommand.ts:102</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Invoke the command</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>input: <a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>input data manager</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div><p>A <em>Promise</em> that resolves after the function command is completed</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#toObject">toObject</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L75">src/commands/base/Command.ts:75</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#toObject">toObject</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L88">src/commands/base/Command.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Converts a command instance to an <a href="../interfaces/APICommandObject.html">APICommandObject</a></p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a></h4><div><p>An object that is accepted by the Discord API</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="FunctionCommand.html" class="tsd-kind-icon">Function<wbr/>Command</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="FunctionCommand.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="FunctionCommand.html#_function" class="tsd-kind-icon">_function</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="FunctionCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="FunctionCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="FunctionCommand.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="FunctionCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="FunctionCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="FunctionCommand.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="FunctionCommand.html#handleReply" class="tsd-kind-icon">handle<wbr/>Reply</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="FunctionCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="FunctionCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="FunctionCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="FunctionCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="FunctionCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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>
|
||||
@@ -1,6 +1,6 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>GuildCommand | 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="GuildCommand.html">GuildCommand</a></li></ul><h1>Class GuildCommand</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>Guild-scoped executable command</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="FunctionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCommand</a><ul class="tsd-hierarchy"><li><span class="target">GuildCommand</span></li></ul></li></ul></section><section class="tsd-panel"><h3>Implemented by</h3><ul class="tsd-hierarchy"><li><a href="PermissionGuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionGuildCommand</a></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 tsd-is-overwrite"><a href="GuildCommand.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 tsd-is-inherited"><a href="GuildCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="GuildCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="GuildCommand.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="GuildCommand.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="GuildCommand.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="GuildCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="GuildCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="GuildCommand.html#type" class="tsd-kind-icon">type</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 tsd-has-type-parameter tsd-is-inherited"><a href="GuildCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="GuildCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="GuildCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="GuildCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="GuildCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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 tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Guild<wbr/>Command<span class="tsd-signature-symbol">(</span>manager<span class="tsd-signature-symbol">: </span><a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a>, type<span class="tsd-signature-symbol">: </span><a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/GuildCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">GuildCommandInit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="GuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">GuildCommand</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/GuildCommand.ts#L36">src/commands/base/GuildCommand.ts:36</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="FunctionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCommand</a><ul class="tsd-hierarchy"><li><span class="target">GuildCommand</span></li></ul></li></ul></section><section class="tsd-panel"><h3>Implemented by</h3><ul class="tsd-hierarchy"><li><a href="PermissionGuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionGuildCommand</a></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 tsd-is-overwrite"><a href="GuildCommand.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 tsd-is-inherited"><a href="GuildCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="GuildCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="GuildCommand.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="GuildCommand.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="GuildCommand.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="GuildCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="GuildCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="GuildCommand.html#type" class="tsd-kind-icon">type</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 tsd-has-type-parameter tsd-is-inherited"><a href="GuildCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="GuildCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="GuildCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="GuildCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="GuildCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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 tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Guild<wbr/>Command<span class="tsd-signature-symbol">(</span>manager<span class="tsd-signature-symbol">: </span><a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a>, type<span class="tsd-signature-symbol">: </span><a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/GuildCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">GuildCommandInit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="GuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">GuildCommand</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/GuildCommand.ts#L52">src/commands/base/GuildCommand.ts:52</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Guild-scoped command constructor</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>manager: <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command manager attached to this command</p>
|
||||
@@ -8,13 +8,13 @@
|
||||
<p>command type</p>
|
||||
</div></div></li><li><h5>options: <a href="../interfaces/GuildCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">GuildCommandInit</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command initialization options</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="GuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">GuildCommand</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 tsd-is-inherited"><a name="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/FunctionCommand.ts#L28">src/commands/base/FunctionCommand.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="GuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">GuildCommand</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 tsd-is-inherited"><a name="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L56">src/commands/base/FunctionCommand.ts:56</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether a SUCCESS message should be sent after executing the command function (when there is no other reply)</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 tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L47">src/commands/base/Command.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L60">src/commands/base/Command.ts:60</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default_permission</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="dm" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/GuildCommand.ts#L27">src/commands/base/GuildCommand.ts:27</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="dm" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/GuildCommand.ts#L43">src/commands/base/GuildCommand.ts:43</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>If set to <em>false</em>, all interactions that get invoked from private/direct conversations (outside a guild) will result a PermissionError</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 tsd-is-inherited"><a name="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#ephemeral">ephemeral</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/FunctionCommand.ts#L42">src/commands/base/FunctionCommand.ts:42</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#ephemeral">ephemeral</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L70">src/commands/base/FunctionCommand.ts:70</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether a reply should be visible only to the caller</p>
|
||||
</div><div><ul>
|
||||
<li>NONE - bot replies are public and visible to everyone in a text channel</li>
|
||||
@@ -23,34 +23,34 @@
|
||||
</ul>
|
||||
<p><a href="https://support.discord.com/hc/pl/articles/1500000580222-Ephemeral-Messages-FAQ">Read more</a></p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd><dt>remarks</dt><dd><p>Since ephemeral interactions cannot be deleted, a placeholding embed will be sent when there will be no response from the command function and <em>announceSuccess</em> will be set to false (placeholding message uses <em>color</em> and <em>title</em> parameters from SUCCESS system message configuration)</p>
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="guilds" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/GuildCommand.ts#L19">src/commands/base/GuildCommand.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="guilds" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/GuildCommand.ts#L36">src/commands/base/GuildCommand.ts:36</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of Discord guild (server) IDs in which this command can be used</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 tsd-is-inherited"><a name="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#manager">manager</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L23">src/commands/base/Command.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#manager">manager</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L39">src/commands/base/Command.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Manager in which this command is registered</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 tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> 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="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L31">src/commands/base/Command.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> 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="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L46">src/commands/base/Command.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</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 tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L39">src/commands/base/Command.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L53">src/commands/base/Command.ts:53</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>CommandBot's internal command type</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></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 tsd-has-type-parameter tsd-is-inherited"><a name="isBaseCommandType" class="tsd-anchor"></a><h3>is<wbr/>Base<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#isBaseCommandType">isBaseCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L88">src/commands/base/Command.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></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 tsd-has-type-parameter tsd-is-inherited"><a name="isBaseCommandType" class="tsd-anchor"></a><h3>is<wbr/>Base<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#isBaseCommandType">isBaseCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L100">src/commands/base/Command.ts:100</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check base command type</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#BaseCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>base command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isChildCommandType" class="tsd-anchor"></a><h3>is<wbr/>Child<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#isChildCommandType">isChildCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L155">src/commands/base/Command.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isChildCommandType" class="tsd-anchor"></a><h3>is<wbr/>Child<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#isChildCommandType">isChildCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L165">src/commands/base/Command.ts:165</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check child command type</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#ChildCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>child command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as a child command of the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isCommandType" class="tsd-anchor"></a><h3>is<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#isCommandType">isCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L128">src/commands/base/Command.ts:128</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isCommandType" class="tsd-anchor"></a><h3>is<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#isCommandType">isCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L139">src/commands/base/Command.ts:139</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Checks command type</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a name="start" class="tsd-anchor"></a><h3>start</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#start">start</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/GuildCommand.ts#L56">src/commands/base/GuildCommand.ts:56</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a name="start" class="tsd-anchor"></a><h3>start</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#start">start</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/GuildCommand.ts#L72">src/commands/base/GuildCommand.ts:72</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Invoke the command</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>input: <a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>input data</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#toObject">toObject</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L75">src/commands/base/Command.ts:75</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#toObject">toObject</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L88">src/commands/base/Command.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Converts a command instance to an <a href="../interfaces/APICommandObject.html">APICommandObject</a></p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a></h4><div><p>An object that is accepted by the Discord API</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="GuildCommand.html" class="tsd-kind-icon">Guild<wbr/>Command</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="GuildCommand.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="GuildCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="GuildCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="GuildCommand.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="GuildCommand.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="GuildCommand.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="GuildCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="GuildCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="GuildCommand.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="GuildCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="GuildCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="GuildCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="GuildCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="GuildCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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>
|
||||
@@ -1,22 +1,22 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>HelpMessage | 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="HelpMessage.html">HelpMessage</a></li></ul><h1>Class HelpMessage</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><a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a><ul class="tsd-hierarchy"><li><span class="target">HelpMessage</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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="HelpMessage.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 tsd-is-private"><a href="HelpMessage.html#_appearance" class="tsd-kind-icon">_appearance</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#aliases" class="tsd-kind-icon">aliases</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#parameters" class="tsd-kind-icon">parameters</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#slash" class="tsd-kind-icon">slash</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#usage" class=Line truncated
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>HelpMessage | 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="HelpMessage.html">HelpMessage</a></li></ul><h1>Class HelpMessage</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><a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a><ul class="tsd-hierarchy"><li><span class="target">HelpMessage</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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="HelpMessage.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 tsd-is-private"><a href="HelpMessage.html#_appearance" class="tsd-kind-icon">_appearance</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#aliases" class="tsd-kind-icon">aliases</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#parameters" class="tsd-kind-icon">parameters</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#slash" class="tsd-kind-icon">slash</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#usage" class=Line truncated
|
||||
<p>Help message constructor</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cmdManager: <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command manager related to this command</p>
|
||||
</div></div></li><li><h5>options: <a href="../interfaces/HelpMessageParams.html" class="tsd-signature-type" data-tsd-kind="Interface">HelpMessageParams</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>appearance properties</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="HelpMessage.html" class="tsd-signature-type" data-tsd-kind="Class">HelpMessage</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 tsd-is-private"><a name="_appearance" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> _appearance</h3><div class="tsd-signature tsd-kind-icon">_appearance<span class="tsd-signature-symbol">:</span> <a href="../interfaces/HelpMessageParams.html" class="tsd-signature-type" data-tsd-kind="Interface">HelpMessageParams</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/Help.ts#L72">src/commands/Help.ts:72</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="HelpMessage.html" class="tsd-signature-type" data-tsd-kind="Class">HelpMessage</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 tsd-is-private"><a name="_appearance" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> _appearance</h3><div class="tsd-signature tsd-kind-icon">_appearance<span class="tsd-signature-symbol">:</span> <a href="../interfaces/HelpMessageParams.html" class="tsd-signature-type" data-tsd-kind="Interface">HelpMessageParams</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/Help.ts#L65">src/commands/Help.ts:65</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Help message appearance options</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 tsd-is-inherited"><a name="aliases" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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></div><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#aliases">aliases</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/ChatCommand.ts#L41">src/commands/ChatCommand.ts:41</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="aliases" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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></div><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#aliases">aliases</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/ChatCommand.ts#L78">src/commands/ChatCommand.ts:78</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of different names that can be used to invoke a command (when using prefix interactions)</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 tsd-is-inherited"><a name="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/FunctionCommand.ts#L28">src/commands/base/FunctionCommand.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L56">src/commands/base/FunctionCommand.ts:56</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether a SUCCESS message should be sent after executing the command function (when there is no other reply)</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 tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L47">src/commands/base/Command.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L60">src/commands/base/Command.ts:60</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default_permission</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 tsd-is-inherited"><a name="description" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#description">description</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/ChatCommand.ts#L49">src/commands/ChatCommand.ts:49</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="description" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#description">description</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/ChatCommand.ts#L85">src/commands/ChatCommand.ts:85</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command description displayed in the help message or in slash commands menu (Default description: "No description")</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 tsd-is-inherited"><a name="dm" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#dm">dm</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/PermissionGuildCommand.ts#L29">src/commands/base/PermissionGuildCommand.ts:29</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="dm" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#dm">dm</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/PermissionGuildCommand.ts#L45">src/commands/base/PermissionGuildCommand.ts:45</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>If set to <em>false</em>, all interactions that get invoked from private/direct conversations (outside a guild) will result a PermissionError</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 tsd-is-inherited"><a name="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#ephemeral">ephemeral</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/FunctionCommand.ts#L42">src/commands/base/FunctionCommand.ts:42</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#ephemeral">ephemeral</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L70">src/commands/base/FunctionCommand.ts:70</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether a reply should be visible only to the caller</p>
|
||||
</div><div><ul>
|
||||
<li>NONE - bot replies are public and visible to everyone in a text channel</li>
|
||||
@@ -25,29 +25,29 @@
|
||||
</ul>
|
||||
<p><a href="https://support.discord.com/hc/pl/articles/1500000580222-Ephemeral-Messages-FAQ">Read more</a></p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd><dt>remarks</dt><dd><p>Since ephemeral interactions cannot be deleted, a placeholding embed will be sent when there will be no response from the command function and <em>announceSuccess</em> will be set to false (placeholding message uses <em>color</em> and <em>title</em> parameters from SUCCESS system message configuration)</p>
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="guilds" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#guilds">guilds</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/PermissionGuildCommand.ts#L21">src/commands/base/PermissionGuildCommand.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="guilds" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#guilds">guilds</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/PermissionGuildCommand.ts#L38">src/commands/base/PermissionGuildCommand.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of Discord guild (server) IDs in which this command can be used</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 tsd-is-inherited"><a name="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#manager">manager</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L23">src/commands/base/Command.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#manager">manager</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L39">src/commands/base/Command.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Manager in which this command is registered</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 tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> 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="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L31">src/commands/base/Command.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> 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="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L46">src/commands/base/Command.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</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 tsd-is-inherited"><a name="parameters" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> parameters</h3><div class="tsd-signature tsd-kind-icon">parameters<span class="tsd-signature-symbol">:</span> <a href="Parameter.html" class="tsd-signature-type" data-tsd-kind="Class">Parameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#parameters">parameters</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/ChatCommand.ts#L33">src/commands/ChatCommand.ts:33</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="parameters" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> parameters</h3><div class="tsd-signature tsd-kind-icon">parameters<span class="tsd-signature-symbol">:</span> <a href="Parameter.html" class="tsd-signature-type" data-tsd-kind="Class">Parameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#parameters">parameters</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/ChatCommand.ts#L71">src/commands/ChatCommand.ts:71</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of parameters that can passed to this command</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 tsd-is-inherited"><a name="permissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> permissions</h3><div class="tsd-signature tsd-kind-icon">permissions<span class="tsd-signature-symbol">:</span> <a href="CommandPermissions.html" class="tsd-signature-type" data-tsd-kind="Class">CommandPermissions</a></div><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#permissions">permissions</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/PermissionCommand.ts#L21">src/commands/base/PermissionCommand.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="permissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> permissions</h3><div class="tsd-signature tsd-kind-icon">permissions<span class="tsd-signature-symbol">:</span> <a href="CommandPermissions.html" class="tsd-signature-type" data-tsd-kind="Class">CommandPermissions</a></div><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#permissions">permissions</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/PermissionCommand.ts#L34">src/commands/base/PermissionCommand.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object containing check functions and permission bitfields</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 tsd-is-inherited"><a name="slash" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#slash">slash</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/ChatCommand.ts#L73">src/commands/ChatCommand.ts:73</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="slash" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#slash">slash</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/ChatCommand.ts#L106">src/commands/ChatCommand.ts:106</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether this command should be registered as a slash command (default: true)</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 tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></div><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L39">src/commands/base/Command.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></div><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L53">src/commands/base/Command.ts:53</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>CommandBot's internal command type</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 tsd-is-inherited"><a name="usage" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#usage">usage</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/ChatCommand.ts#L57">src/commands/ChatCommand.ts:57</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="usage" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#usage">usage</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/ChatCommand.ts#L92">src/commands/ChatCommand.ts:92</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command usage displayed in the help message</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 tsd-is-inherited"><a name="visible" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#visible">visible</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/ChatCommand.ts#L65">src/commands/ChatCommand.ts:65</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="visible" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#visible">visible</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/ChatCommand.ts#L99">src/commands/ChatCommand.ts:99</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether this command is visible in the help message (default: true)</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a name="children" class="tsd-anchor"></a><h3>children</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> children<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">readonly </span><a href="../modules.html#ChildCommandResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandResolvable</a><span class="tsd-signature-symbol">[]</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/2867da1/src/commands/ChatCommand.ts#L142">src/commands/ChatCommand.ts:142</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a name="children" class="tsd-anchor"></a><h3>children</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> children<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">readonly </span><a href="../modules.html#ChildCommandResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandResolvable</a><span class="tsd-signature-symbol">[]</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/commands/ChatCommand.ts#L174">src/commands/ChatCommand.ts:174</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Returns list of attached subcommands</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">readonly </span><a href="../modules.html#ChildCommandResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandResolvable</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a name="hasSubCommands" class="tsd-anchor"></a><h3>has<wbr/>Sub<wbr/>Commands</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> hasSubCommands<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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/2867da1/src/commands/ChatCommand.ts#L133">src/commands/ChatCommand.ts:133</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">readonly </span><a href="../modules.html#ChildCommandResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandResolvable</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a name="hasSubCommands" class="tsd-anchor"></a><h3>has<wbr/>Sub<wbr/>Commands</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> hasSubCommands<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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/commands/ChatCommand.ts#L166">src/commands/ChatCommand.ts:166</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Returns <em>true</em> if the command has subcommands attached</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></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 tsd-has-type-parameter tsd-is-inherited"><a name="append" class="tsd-anchor"></a><h3>append</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">append<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span>, options<span class="tsd-signature-symbol">: </span><a href="../modules.html#ChildCommandInit" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandInit</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#append">append</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/ChatCommand.ts#L168">src/commands/ChatCommand.ts:168</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></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 tsd-has-type-parameter tsd-is-inherited"><a name="append" class="tsd-anchor"></a><h3>append</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">append<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span>, options<span class="tsd-signature-symbol">: </span><a href="../modules.html#ChildCommandInit" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandInit</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#append">append</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/ChatCommand.ts#L199">src/commands/ChatCommand.ts:199</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Attaches subcommand or subcommand group to this ChatCommand</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>remarks</dt><dd><p>After appending a subcommand or a subcommand group the main command can only be invoked using prefix interactions</p>
|
||||
</dd></dl></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#ChildCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
@@ -55,37 +55,37 @@
|
||||
</div></div></li><li><h5>options: <a href="../modules.html#ChildCommandInit" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandInit</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>initialization options</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>A computed subcommand object</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a name="fetchSubcommand" class="tsd-anchor"></a><h3>fetch<wbr/>Subcommand</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">fetch<wbr/>Subcommand<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CommandInteractionOption</span><span class="tsd-signature-symbol">[]</span>, 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-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#fetchSubcommand">fetchSubcommand</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/ChatCommand.ts#L193">src/commands/ChatCommand.ts:193</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <span class="tsd-signature-type">CommandInteractionOption</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a name="fetchSubcommand" class="tsd-anchor"></a><h3>fetch<wbr/>Subcommand</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">fetch<wbr/>Subcommand<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CommandInteractionOption</span><span class="tsd-signature-symbol">[]</span>, 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-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#fetchSubcommand">fetchSubcommand</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/ChatCommand.ts#L223">src/commands/ChatCommand.ts:223</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <span class="tsd-signature-type">CommandInteractionOption</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>parameter options</p>
|
||||
</div></div></li><li><h5>interaction: <span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord interaction</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></h4><div><p>an <a href="InputManager.html">InputManager</a> containing all interaction-related data or <em>null</em></p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="generateMessage" class="tsd-anchor"></a><h3>generate<wbr/>Message</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">generate<wbr/>Message<span class="tsd-signature-symbol">(</span>i<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>, cmdName<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><span class="tsd-signature-type">MessageEmbed</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/2867da1/src/commands/Help.ts#L108">src/commands/Help.ts:108</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>i: <span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="generateMessage" class="tsd-anchor"></a><h3>generate<wbr/>Message</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">generate<wbr/>Message<span class="tsd-signature-symbol">(</span>i<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>, cmdName<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><span class="tsd-signature-type">MessageEmbed</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/commands/Help.ts#L101">src/commands/Help.ts:101</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>i: <span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord interaction</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> cmdName: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">MessageEmbed</span></h4><div><p>A computed help message in form of {@link MessageEmbed}</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a name="getSubcommand" class="tsd-anchor"></a><h3>get<wbr/>Subcommand</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">get<wbr/>Subcommand<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, group<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><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#getSubcommand">getSubcommand</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/ChatCommand.ts#L252">src/commands/ChatCommand.ts:252</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a name="getSubcommand" class="tsd-anchor"></a><h3>get<wbr/>Subcommand</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">get<wbr/>Subcommand<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, group<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><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#getSubcommand">getSubcommand</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/ChatCommand.ts#L281">src/commands/ChatCommand.ts:281</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>subcommand name</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> group: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a></h4><div><p>a <a href="SubCommand.html">SubCommand</a> object or <em>null</em></p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isBaseCommandType" class="tsd-anchor"></a><h3>is<wbr/>Base<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#isBaseCommandType">isBaseCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L88">src/commands/base/Command.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isBaseCommandType" class="tsd-anchor"></a><h3>is<wbr/>Base<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#isBaseCommandType">isBaseCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L100">src/commands/base/Command.ts:100</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check base command type</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#BaseCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>base command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isChildCommandType" class="tsd-anchor"></a><h3>is<wbr/>Child<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#isChildCommandType">isChildCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L155">src/commands/base/Command.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isChildCommandType" class="tsd-anchor"></a><h3>is<wbr/>Child<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#isChildCommandType">isChildCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L165">src/commands/base/Command.ts:165</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check child command type</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#ChildCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>child command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as a child command of the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isCommandType" class="tsd-anchor"></a><h3>is<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#isCommandType">isCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L128">src/commands/base/Command.ts:128</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isCommandType" class="tsd-anchor"></a><h3>is<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#isCommandType">isCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L139">src/commands/base/Command.ts:139</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Checks command type</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a name="start" class="tsd-anchor"></a><h3>start</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#start">start</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/ChatCommand.ts#L153">src/commands/ChatCommand.ts:153</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a name="start" class="tsd-anchor"></a><h3>start</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#start">start</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/ChatCommand.ts#L185">src/commands/ChatCommand.ts:185</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Invoke the command</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>input: <a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>input data manager</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ChatCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#toObject">toObject</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/ChatCommand.ts#L271">src/commands/ChatCommand.ts:271</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ChatCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ChatCommand.html">ChatCommand</a>.<a href="ChatCommand.html#toObject">toObject</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/ChatCommand.ts#L299">src/commands/ChatCommand.ts:299</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Converts <a href="ChatCommand.html">ChatCommand</a> instance to object that is recognized by the Discord API</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/ChatCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandObject</a></h4><div><p>Discord API object</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="HelpMessage.html" class="tsd-kind-icon">Help<wbr/>Message</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="HelpMessage.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="HelpMessage.html#_appearance" class="tsd-kind-icon">_appearance</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#aliases" class="tsd-kind-icon">aliases</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#parameters" class="tsd-kind-icon">parameters</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#slash" class="tsd-kind-icon">slash</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#usage" class="tsd-kind-icon">usage</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#visible" class="tsd-kind-icon">visible</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#children" class="tsd-kind-icon">children</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#hasSubCommands" class="tsd-kind-icon">has<wbr/>Sub<wbr/>Commands</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="HelpMessage.html#append" class="tsd-kind-icon">append</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#fetchSubcommand" class="tsd-kind-icon">fetch<wbr/>Subcommand</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="HelpMessage.html#generateMessage" class="tsd-kind-icon">generate<wbr/>Message</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#getSubcommand" class="tsd-kind-icon">get<wbr/>Subcommand</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="HelpMessage.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="HelpMessage.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="HelpMessage.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="HelpMessage.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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 cLine truncated
|
||||
@@ -1,20 +1,20 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>InputManager | 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="InputManager.html">InputManager</a></li></ul><h1>Class InputManager</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>Object that stores all interaction input data (target, arguments, content and the interaction itself)</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">InputManager</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="InputManager.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 tsd-is-private"><a href="InputManager.html#arguments" class="tsd-kind-icon">arguments</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="InputManager.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="InputManager.html#interaction" class="tsd-kind-icon">interaction</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="InputManager.html#target" class="tsd-kind-icon">target</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 tsd-has-type-parameter"><a href="InputManager.html#get" class="tsd-kind-icon">get</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/>Input<wbr/>Manager<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><a href="FunctionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCommand</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>, args<span class="tsd-signature-symbol">: </span><a href="InputParameter.html" class="tsd-signature-type" data-tsd-kind="Class">InputParameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span>, target<span class="tsd-signature-symbol">?: </span><a href="TargetID.html" class="tsd-signature-type" data-tsd-kind="Class">TargetID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</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/2867da1/src/structures/InputManager.ts#L50">src/structures/InputManager.ts:50</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>command: <a href="FunctionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCommand</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">InputManager</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="InputManager.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 tsd-is-private"><a href="InputManager.html#arguments" class="tsd-kind-icon">arguments</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="InputManager.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="InputManager.html#interaction" class="tsd-kind-icon">interaction</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="InputManager.html#target" class="tsd-kind-icon">target</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 tsd-has-type-parameter"><a href="InputManager.html#get" class="tsd-kind-icon">get</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/>Input<wbr/>Manager<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><a href="FunctionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCommand</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>, args<span class="tsd-signature-symbol">: </span><a href="InputParameter.html" class="tsd-signature-type" data-tsd-kind="Class">InputParameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span>, target<span class="tsd-signature-symbol">?: </span><a href="TargetID.html" class="tsd-signature-type" data-tsd-kind="Class">TargetID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</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/InputManager.ts#L46">src/structures/InputManager.ts:46</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>command: <a href="FunctionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCommand</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command related to this manager</p>
|
||||
</div></div></li><li><h5>interaction: <span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>interaction or message</p>
|
||||
</div></div></li><li><h5>args: <a href="InputParameter.html" class="tsd-signature-type" data-tsd-kind="Class">InputParameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>list of input arguments</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> target: <a href="TargetID.html" class="tsd-signature-type" data-tsd-kind="Class">TargetID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</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 tsd-is-private"><a name="arguments" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> arguments</h3><div class="tsd-signature tsd-kind-icon">arguments<span class="tsd-signature-symbol">:</span> <a href="InputParameter.html" class="tsd-signature-type" data-tsd-kind="Class">InputParameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/InputManager.ts#L41">src/structures/InputManager.ts:41</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> target: <a href="TargetID.html" class="tsd-signature-type" data-tsd-kind="Class">TargetID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</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 tsd-is-private"><a name="arguments" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> arguments</h3><div class="tsd-signature tsd-kind-icon">arguments<span class="tsd-signature-symbol">:</span> <a href="InputParameter.html" class="tsd-signature-type" data-tsd-kind="Class">InputParameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/InputManager.ts#L37">src/structures/InputManager.ts:37</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>All input arguments</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="command" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <a href="FunctionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCommand</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/InputManager.ts#L17">src/structures/InputManager.ts:17</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="command" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <a href="FunctionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCommand</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/InputManager.ts#L16">src/structures/InputManager.ts:16</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command related 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="interaction" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> interaction</h3><div class="tsd-signature tsd-kind-icon">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></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/InputManager.ts#L25">src/structures/InputManager.ts:25</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="interaction" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> interaction</h3><div class="tsd-signature tsd-kind-icon">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></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/InputManager.ts#L23">src/structures/InputManager.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command interaction or message</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="target" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> target</h3><div class="tsd-signature tsd-kind-icon">target<span class="tsd-signature-symbol">?:</span> <a href="TargetID.html" class="tsd-signature-type" data-tsd-kind="Class">TargetID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/InputManager.ts#L33">src/structures/InputManager.ts:33</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="target" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> target</h3><div class="tsd-signature tsd-kind-icon">target<span class="tsd-signature-symbol">?:</span> <a href="TargetID.html" class="tsd-signature-type" data-tsd-kind="Class">TargetID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/InputManager.ts#L30">src/structures/InputManager.ts:30</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command target (when using context menu interactions)</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></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 tsd-has-type-parameter"><a name="get" class="tsd-anchor"></a><h3>get</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">get<T><span class="tsd-signature-symbol">(</span>query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#InputParameterValue" class="tsd-signature-type" data-tsd-kind="Type alias">InputParameterValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></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/2867da1/src/structures/InputManager.ts#L64">src/structures/InputManager.ts:64</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></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 tsd-has-type-parameter"><a name="get" class="tsd-anchor"></a><h3>get</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">get<T><span class="tsd-signature-symbol">(</span>query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#InputParameterValue" class="tsd-signature-type" data-tsd-kind="Type alias">InputParameterValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></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/InputManager.ts#L60">src/structures/InputManager.ts:60</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Get input values</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#ParameterType" class="tsd-signature-type" data-tsd-kind="Type alias">ParameterType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>query: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>parameter name</p>
|
||||
|
||||
@@ -1,25 +1,25 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>InputParameter | 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="InputParameter.html">InputParameter</a></li></ul><h1>Class InputParameter<T></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>Parameter with input value from interaction (reffered to as argument)</p>
|
||||
</div></div></section><section class="tsd-panel tsd-type-parameters"><h3>Type parameters</h3><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#ParameterType" class="tsd-signature-type" data-tsd-kind="Type alias">ParameterType</a></h4></li></ul></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="Parameter.html" class="tsd-signature-type" data-tsd-kind="Class">Parameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">InputParameter</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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite"><a href="InputParameter.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 tsd-is-inherited"><a href="InputParameter.html#choices" class="tsd-kind-icon">choices</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="InputParameter.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="InputParameter.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="InputParameter.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="InputParameter.html#optional" class="tsd-kind-icon">optional</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="InputParameter.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="InputParameter.html#value" class="tsd-kind-icon">value</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="InputParameter.html#descriptionRegExp" class="tsd-kind-icon">description<wbr/>Reg<wbr/>Exp</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="InputParameter.html#nameRegExp" class="tsd-kind-icon">name<wbr/>Reg<wbr/>Exp</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 tsd-has-type-parameter tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Input<wbr/>Parameter<T><span class="tsd-signature-symbol">(</span>param<span class="tsd-signature-symbol">: </span><a href="Parameter.html" class="tsd-signature-type" data-tsd-kind="Class">Parameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#InputParameterValue" class="tsd-signature-type" data-tsd-kind="Type alias">InputParameterValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="InputParameter.html" class="tsd-signature-type" data-tsd-kind="Class">InputParameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="Parameter.html">Parameter</a>.<a href="Parameter.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Parameter.ts#L232">src/structures/Parameter.ts:232</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#ParameterType" class="tsd-signature-type" data-tsd-kind="Type alias">ParameterType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>param: <a href="Parameter.html" class="tsd-signature-typLine truncated
|
||||
</div></div></section><section class="tsd-panel tsd-type-parameters"><h3>Type parameters</h3><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#ParameterType" class="tsd-signature-type" data-tsd-kind="Type alias">ParameterType</a></h4></li></ul></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="Parameter.html" class="tsd-signature-type" data-tsd-kind="Class">Parameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">InputParameter</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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite"><a href="InputParameter.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 tsd-is-inherited"><a href="InputParameter.html#choices" class="tsd-kind-icon">choices</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="InputParameter.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="InputParameter.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="InputParameter.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="InputParameter.html#optional" class="tsd-kind-icon">optional</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="InputParameter.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="InputParameter.html#value" class="tsd-kind-icon">value</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="InputParameter.html#descriptionRegExp" class="tsd-kind-icon">description<wbr/>Reg<wbr/>Exp</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="InputParameter.html#nameRegExp" class="tsd-kind-icon">name<wbr/>Reg<wbr/>Exp</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 tsd-has-type-parameter tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Input<wbr/>Parameter<T><span class="tsd-signature-symbol">(</span>param<span class="tsd-signature-symbol">: </span><a href="Parameter.html" class="tsd-signature-type" data-tsd-kind="Class">Parameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#InputParameterValue" class="tsd-signature-type" data-tsd-kind="Type alias">InputParameterValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="InputParameter.html" class="tsd-signature-type" data-tsd-kind="Class">InputParameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="Parameter.html">Parameter</a>.<a href="Parameter.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Parameter.ts#L213">src/structures/Parameter.ts:213</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#ParameterType" class="tsd-signature-type" data-tsd-kind="Type alias">ParameterType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>param: <a href="Parameter.html" class="tsd-signature-typLine truncated
|
||||
<p>parent parameter</p>
|
||||
</div></div></li><li><h5>value: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#InputParameterValue" class="tsd-signature-type" data-tsd-kind="Type alias">InputParameterValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>input value</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="InputParameter.html" class="tsd-signature-type" data-tsd-kind="Class">InputParameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></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 tsd-is-inherited"><a name="choices" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> choices</h3><div class="tsd-signature tsd-kind-icon">choices<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="Parameter.html">Parameter</a>.<a href="Parameter.html#choices">choices</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Parameter.ts#L163">src/structures/Parameter.ts:163</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="InputParameter.html" class="tsd-signature-type" data-tsd-kind="Class">InputParameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></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 tsd-is-inherited"><a name="choices" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> choices</h3><div class="tsd-signature tsd-kind-icon">choices<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="Parameter.html">Parameter</a>.<a href="Parameter.html#choices">choices</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Parameter.ts#L148">src/structures/Parameter.ts:148</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of value choices (available only when type is set to "STRING")</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 tsd-is-inherited"><a name="command" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a></div><aside class="tsd-sources"><p>Inherited from <a href="Parameter.html">Parameter</a>.<a href="Parameter.html#command">command</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Parameter.ts#L124">src/structures/Parameter.ts:124</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="command" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a></div><aside class="tsd-sources"><p>Inherited from <a href="Parameter.html">Parameter</a>.<a href="Parameter.html#command">command</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Parameter.ts#L113">src/structures/Parameter.ts:113</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command associated with this parameter</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 tsd-is-inherited"><a name="description" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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"><p>Inherited from <a href="Parameter.html">Parameter</a>.<a href="Parameter.html#description">description</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Parameter.ts#L139">src/structures/Parameter.ts:139</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="description" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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"><p>Inherited from <a href="Parameter.html">Parameter</a>.<a href="Parameter.html#description">description</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Parameter.ts#L127">src/structures/Parameter.ts:127</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter description</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 tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> 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="Parameter.html">Parameter</a>.<a href="Parameter.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Parameter.ts#L131">src/structures/Parameter.ts:131</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> 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="Parameter.html">Parameter</a>.<a href="Parameter.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Parameter.ts#L120">src/structures/Parameter.ts:120</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter name</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 tsd-is-inherited"><a name="optional" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> optional</h3><div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="Parameter.html">Parameter</a>.<a href="Parameter.html#optional">optional</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Parameter.ts#L147">src/structures/Parameter.ts:147</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="optional" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> optional</h3><div class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="Parameter.html">Parameter</a>.<a href="Parameter.html#optional">optional</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Parameter.ts#L134">src/structures/Parameter.ts:134</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether this parameter is optional</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 tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></div><aside class="tsd-sources"><p>Inherited from <a href="Parameter.html">Parameter</a>.<a href="Parameter.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Parameter.ts#L155">src/structures/Parameter.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></div><aside class="tsd-sources"><p>Inherited from <a href="Parameter.html">Parameter</a>.<a href="Parameter.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Parameter.ts#L141">src/structures/Parameter.ts:141</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter input type</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="value" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> value</h3><div class="tsd-signature tsd-kind-icon">value<span class="tsd-signature-symbol">:</span> <a href="../modules.html#InputParameterValue" class="tsd-signature-type" data-tsd-kind="Type alias">InputParameterValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Parameter.ts#L225">src/structures/Parameter.ts:225</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="value" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> value</h3><div class="tsd-signature tsd-kind-icon">value<span class="tsd-signature-symbol">:</span> <a href="../modules.html#InputParameterValue" class="tsd-signature-type" data-tsd-kind="Type alias">InputParameterValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Parameter.ts#L206">src/structures/Parameter.ts:206</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Value of an argument</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 tsd-is-inherited tsd-is-static"><a name="descriptionRegExp" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> description<wbr/>Reg<wbr/>Exp</h3><div class="tsd-signature tsd-kind-icon">description<wbr/>Reg<wbr/>Exp<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><p>Inherited from <a href="Parameter.html">Parameter</a>.<a href="Parameter.html#descriptionRegExp">descriptionRegExp</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Parameter.ts#L179">src/structures/Parameter.ts:179</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited tsd-is-static"><a name="descriptionRegExp" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> description<wbr/>Reg<wbr/>Exp</h3><div class="tsd-signature tsd-kind-icon">description<wbr/>Reg<wbr/>Exp<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><p>Inherited from <a href="Parameter.html">Parameter</a>.<a href="Parameter.html#descriptionRegExp">descriptionRegExp</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Parameter.ts#L162">src/structures/Parameter.ts:162</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter description check regular expression</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>static</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a name="nameRegExp" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> name<wbr/>Reg<wbr/>Exp</h3><div class="tsd-signature tsd-kind-icon">name<wbr/>Reg<wbr/>Exp<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><p>Inherited from <a href="Parameter.html">Parameter</a>.<a href="Parameter.html#nameRegExp">nameRegExp</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Parameter.ts#L171">src/structures/Parameter.ts:171</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div><dl class="tsd-comment-tags"><dt>static</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a name="nameRegExp" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> name<wbr/>Reg<wbr/>Exp</h3><div class="tsd-signature tsd-kind-icon">name<wbr/>Reg<wbr/>Exp<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><p>Inherited from <a href="Parameter.html">Parameter</a>.<a href="Parameter.html#nameRegExp">nameRegExp</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Parameter.ts#L155">src/structures/Parameter.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter name check regular expression</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>static</dt><dd></dd></dl></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-class tsd-has-type-parameter"><a href="InputParameter.html" class="tsd-kind-icon">Input<wbr/>Parameter</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite"><a href="InputParameter.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="InputParameter.html#choices" class="tsd-kind-icon">choices</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="InputParameter.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="InputParameter.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="InputParameter.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="InputParameter.html#optional" class="tsd-kind-icon">optional</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="InputParameter.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="InputParameter.html#value" class="tsd-kind-icon">value</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="InputParameter.html#descriptionRegExp" class="tsd-kind-icon">description<wbr/>Reg<wbr/>Exp</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="InputParameter.html#nameRegExp" class="tsd-kind-icon">name<wbr/>Reg<wbr/>Exp</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>
|
||||
@@ -1,10 +1,10 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>MissingParameterError | 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="MissingParameterError.html">MissingParameterError</a></li></ul><h1>Class MissingParameterError</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>Error indicating that a required parameter is missing in the request</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">ReferenceError</span><ul class="tsd-hierarchy"><li><span class="target">MissingParameterError</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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="MissingParameterError.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 tsd-is-private"><a href="MissingParameterError.html#argument" class="tsd-kind-icon">argument</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="MissingParameterError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="MissingParameterError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="MissingParameterError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="MissingParameterError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</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="MissingParameterError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="MissingParameterError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="MissingParameterError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</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 tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Missing<wbr/>Parameter<wbr/>Error<span class="tsd-signature-symbol">(</span>a<span class="tsd-signature-symbol">: </span><a href="Parameter.html" class="tsd-signature-type" data-tsd-kind="Class">Parameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MissingParameterError.html" class="tsd-signature-type" data-tsd-kind="Class">MissingParameterError</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides ReferenceError.constructor</p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/errors.ts#L108">src/errors.ts:108</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>a: <a href="Parameter.html" class="tsd-signature-type" data-tsd-kind="Class">Parameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">ReferenceError</span><ul class="tsd-hierarchy"><li><span class="target">MissingParameterError</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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="MissingParameterError.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 tsd-is-private"><a href="MissingParameterError.html#argument" class="tsd-kind-icon">argument</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="MissingParameterError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="MissingParameterError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="MissingParameterError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="MissingParameterError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</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="MissingParameterError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="MissingParameterError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="MissingParameterError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</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 tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Missing<wbr/>Parameter<wbr/>Error<span class="tsd-signature-symbol">(</span>a<span class="tsd-signature-symbol">: </span><a href="Parameter.html" class="tsd-signature-type" data-tsd-kind="Class">Parameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MissingParameterError.html" class="tsd-signature-type" data-tsd-kind="Class">MissingParameterError</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides ReferenceError.constructor</p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/errors.ts#L106">src/errors.ts:106</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>a: <a href="Parameter.html" class="tsd-signature-type" data-tsd-kind="Class">Parameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>missing parameter object</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="MissingParameterError.html" class="tsd-signature-type" data-tsd-kind="Class">MissingParameterError</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 tsd-is-private"><a name="argument" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> argument</h3><div class="tsd-signature tsd-kind-icon">argument<span class="tsd-signature-symbol">:</span> <a href="Parameter.html" class="tsd-signature-type" data-tsd-kind="Class">Parameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/errors.ts#L102">src/errors.ts:102</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="MissingParameterError.html" class="tsd-signature-type" data-tsd-kind="Class">MissingParameterError</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 tsd-is-private"><a name="argument" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> argument</h3><div class="tsd-signature tsd-kind-icon">argument<span class="tsd-signature-symbol">:</span> <a href="Parameter.html" class="tsd-signature-type" data-tsd-kind="Class">Parameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/errors.ts#L100">src/errors.ts:100</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Missing parameter object</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 tsd-is-inherited tsd-is-external"><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"><p>Inherited from ReferenceError.message</p><ul><li>Defined in C:/Users/grzan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es5.d.ts:974</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><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 ReferenceError.name</p><ul><li>Defined in C:/Users/grzan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es5.d.ts:973</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="stack" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3><div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from ReferenceError.stack</p><ul><li>Defined in C:/Users/grzan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es5.d.ts:975</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a name="stackTraceLimit" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr/>Trace<wbr/>Limit</h3><div class="tsd-signature tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from ReferenceError.stackTraceLimit</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:13</li></ul></aside></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="toString" class="tsd-anchor"></a><h3>to<wbr/>String</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/2867da1/src/errors.ts#L118">src/errors.ts:118</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited tsd-is-external"><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"><p>Inherited from ReferenceError.message</p><ul><li>Defined in C:/Users/grzan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es5.d.ts:974</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><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 ReferenceError.name</p><ul><li>Defined in C:/Users/grzan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es5.d.ts:973</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="stack" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3><div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from ReferenceError.stack</p><ul><li>Defined in C:/Users/grzan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es5.d.ts:975</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a name="stackTraceLimit" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr/>Trace<wbr/>Limit</h3><div class="tsd-signature tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from ReferenceError.stackTraceLimit</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:13</li></ul></aside></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="toString" class="tsd-anchor"></a><h3>to<wbr/>String</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/errors.ts#L116">src/errors.ts:116</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Converts error object to user-readable message</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>Formatted error message</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a name="captureStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr/>Stack<wbr/>Trace</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from ReferenceError.captureStackTrace</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:4</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
|
||||
@@ -1,16 +1,16 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ObjectID | 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="ObjectID.html">ObjectID</a></li></ul><h1>Class ObjectID<T></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>Wrapped representation of Discord user, role, channel or other mentionable Discord arugment object</p>
|
||||
</div></div></section><section class="tsd-panel tsd-type-parameters"><h3>Type parameters</h3><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#ObjectIdType" class="tsd-signature-type" data-tsd-kind="Type alias">ObjectIdType</a></h4></li></ul></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ObjectID</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 tsd-has-type-parameter"><a href="ObjectID.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="ObjectID.html#guild" class="tsd-kind-icon">guild</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ObjectID.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ObjectID.html#type" class="tsd-kind-icon">type</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="ObjectID.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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 tsd-has-type-parameter"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">new <wbr/>ObjectID<T><span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span>, guild<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Guild</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ObjectID.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></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/2867da1/src/structures/Parameter.ts#L325">src/structures/Parameter.ts:325</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#ObjectIdType" class="tsd-signature-type" data-tsd-kind="Type alias">ObjectIdType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-type-parameters"><h3>Type parameters</h3><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#ObjectIdType" class="tsd-signature-type" data-tsd-kind="Type alias">ObjectIdType</a></h4></li></ul></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ObjectID</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 tsd-has-type-parameter"><a href="ObjectID.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="ObjectID.html#guild" class="tsd-kind-icon">guild</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ObjectID.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ObjectID.html#type" class="tsd-kind-icon">type</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="ObjectID.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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 tsd-has-type-parameter"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">new <wbr/>ObjectID<T><span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span>, guild<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Guild</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ObjectID.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></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/Parameter.ts#L305">src/structures/Parameter.ts:305</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#ObjectIdType" class="tsd-signature-type" data-tsd-kind="Type alias">ObjectIdType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>object Discord ID</p>
|
||||
</div></div></li><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>object type</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> guild: <span class="tsd-signature-type">Guild</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="ObjectID.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></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="guild" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> guild</h3><div class="tsd-signature tsd-kind-icon">guild<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Guild</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Parameter.ts#L310">src/structures/Parameter.ts:310</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> guild: <span class="tsd-signature-type">Guild</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="ObjectID.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></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="guild" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> guild</h3><div class="tsd-signature tsd-kind-icon">guild<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Guild</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Parameter.ts#L290">src/structures/Parameter.ts:290</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Guild needed to convert the object</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="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> id</h3><div class="tsd-signature tsd-kind-icon">id<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/2867da1/src/structures/Parameter.ts#L303">src/structures/Parameter.ts:303</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> id</h3><div class="tsd-signature tsd-kind-icon">id<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/5a80551/src/structures/Parameter.ts#L283">src/structures/Parameter.ts:283</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object ID</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="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Parameter.ts#L317">src/structures/Parameter.ts:317</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Parameter.ts#L297">src/structures/Parameter.ts:297</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object type</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></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="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</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"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ObjectIdReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ObjectIdReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></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/2867da1/src/structures/Parameter.ts#L337">src/structures/Parameter.ts:337</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></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="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</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"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ObjectIdReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ObjectIdReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></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/Parameter.ts#L317">src/structures/Parameter.ts:317</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Uses informations associated with the object to generate a Discord.js representation</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>async</dt><dd></dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ObjectIdReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ObjectIdReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>A fetched object (or null)</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 tsd-has-type-parameter"><a href="ObjectID.html" class="tsd-kind-icon">ObjectID</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a href="ObjectID.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ObjectID.html#guild" class="tsd-kind-icon">guild</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ObjectID.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ObjectID.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="ObjectID.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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>
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>OperationSuccess | 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="OperationSuccess.html">OperationSuccess</a></li></ul><h1>Class OperationSuccess</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>Object indicating command execution success</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">OperationSuccess</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="OperationSuccess.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="OperationSuccess.html#command" class="tsd-kind-icon">command</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/>Operation<wbr/>Success<span class="tsd-signature-symbol">(</span>c<span class="tsd-signature-symbol">: </span><a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="OperationSuccess.html" class="tsd-signature-type" data-tsd-kind="Class">OperationSuccess</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/2867da1/src/errors.ts#L140">src/errors.ts:140</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>c: <a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">OperationSuccess</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="OperationSuccess.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="OperationSuccess.html#command" class="tsd-kind-icon">command</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/>Operation<wbr/>Success<span class="tsd-signature-symbol">(</span>c<span class="tsd-signature-symbol">: </span><a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="OperationSuccess.html" class="tsd-signature-type" data-tsd-kind="Class">OperationSuccess</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/errors.ts#L137">src/errors.ts:137</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>c: <a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command that succeeded</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="OperationSuccess.html" class="tsd-signature-type" data-tsd-kind="Class">OperationSuccess</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="command" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/errors.ts#L134">src/errors.ts:134</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="OperationSuccess.html" class="tsd-signature-type" data-tsd-kind="Class">OperationSuccess</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="command" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/errors.ts#L131">src/errors.ts:131</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command that succeeded</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></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-class"><a href="OperationSuccess.html" class="tsd-kind-icon">Operation<wbr/>Success</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="OperationSuccess.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="OperationSuccess.html#command" class="tsd-kind-icon">command</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>
|
||||
@@ -1,23 +1,23 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Parameter | 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="Parameter.html">Parameter</a></li></ul><h1>Class Parameter<T></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>Representation of command parameter</p>
|
||||
</div></div></section><section class="tsd-panel tsd-type-parameters"><h3>Type parameters</h3><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#ParameterType" class="tsd-signature-type" data-tsd-kind="Type alias">ParameterType</a></h4></li></ul></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Parameter</span><ul class="tsd-hierarchy"><li><a href="InputParameter.html" class="tsd-signature-type" data-tsd-kind="Class">InputParameter</a></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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a href="Parameter.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="Parameter.html#choices" class="tsd-kind-icon">choices</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Parameter.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Parameter.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Parameter.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Parameter.html#optional" class="tsd-kind-icon">optional</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Parameter.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="Parameter.html#descriptionRegExp" class="tsd-kind-icon">description<wbr/>Reg<wbr/>Exp</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="Parameter.html#nameRegExp" class="tsd-kind-icon">name<wbr/>Reg<wbr/>Exp</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 tsd-has-type-parameter"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">new <wbr/>Parameter<T><span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/ParameterSchema.html" class="tsd-signature-type" data-tsd-kind="Interface">ParameterSchema</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Parameter.html" class="tsd-signature-type" data-tsd-kind="Class">Parameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></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/2867da1/src/structures/Parameter.ts#L186">src/structures/Parameter.ts:186</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#ParameterType" class="tsd-signature-type" data-tsd-kind="Type alias">ParameterType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>command: <a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-type-parameters"><h3>Type parameters</h3><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#ParameterType" class="tsd-signature-type" data-tsd-kind="Type alias">ParameterType</a></h4></li></ul></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Parameter</span><ul class="tsd-hierarchy"><li><a href="InputParameter.html" class="tsd-signature-type" data-tsd-kind="Class">InputParameter</a></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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a href="Parameter.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="Parameter.html#choices" class="tsd-kind-icon">choices</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Parameter.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Parameter.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Parameter.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Parameter.html#optional" class="tsd-kind-icon">optional</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Parameter.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="Parameter.html#descriptionRegExp" class="tsd-kind-icon">description<wbr/>Reg<wbr/>Exp</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="Parameter.html#nameRegExp" class="tsd-kind-icon">name<wbr/>Reg<wbr/>Exp</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 tsd-has-type-parameter"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">new <wbr/>Parameter<T><span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/ParameterSchema.html" class="tsd-signature-type" data-tsd-kind="Interface">ParameterSchema</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Parameter.html" class="tsd-signature-type" data-tsd-kind="Class">Parameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></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/Parameter.ts#L169">src/structures/Parameter.ts:169</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#ParameterType" class="tsd-signature-type" data-tsd-kind="Type alias">ParameterType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>command: <a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>parameter parent command</p>
|
||||
</div></div></li><li><h5>options: <a href="../interfaces/ParameterSchema.html" class="tsd-signature-type" data-tsd-kind="Interface">ParameterSchema</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>options used to compute a Parameter object</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="Parameter.html" class="tsd-signature-type" data-tsd-kind="Class">Parameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></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="choices" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> choices</h3><div class="tsd-signature tsd-kind-icon">choices<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/2867da1/src/structures/Parameter.ts#L163">src/structures/Parameter.ts:163</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="Parameter.html" class="tsd-signature-type" data-tsd-kind="Class">Parameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></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="choices" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> choices</h3><div class="tsd-signature tsd-kind-icon">choices<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/5a80551/src/structures/Parameter.ts#L148">src/structures/Parameter.ts:148</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of value choices (available only when type is set to "STRING")</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="command" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Parameter.ts#L124">src/structures/Parameter.ts:124</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="command" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Parameter.ts#L113">src/structures/Parameter.ts:113</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command associated with this parameter</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="description" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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/2867da1/src/structures/Parameter.ts#L139">src/structures/Parameter.ts:139</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="description" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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/5a80551/src/structures/Parameter.ts#L127">src/structures/Parameter.ts:127</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter description</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="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> 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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Parameter.ts#L131">src/structures/Parameter.ts:131</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> 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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Parameter.ts#L120">src/structures/Parameter.ts:120</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter name</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="optional" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> optional</h3><div class="tsd-signature tsd-kind-icon">optional<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/2867da1/src/structures/Parameter.ts#L147">src/structures/Parameter.ts:147</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="optional" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> optional</h3><div class="tsd-signature tsd-kind-icon">optional<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/5a80551/src/structures/Parameter.ts#L134">src/structures/Parameter.ts:134</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether this parameter is optional</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="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Parameter.ts#L155">src/structures/Parameter.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Parameter.ts#L141">src/structures/Parameter.ts:141</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter input type</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 tsd-is-static"><a name="descriptionRegExp" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> description<wbr/>Reg<wbr/>Exp</h3><div class="tsd-signature tsd-kind-icon">description<wbr/>Reg<wbr/>Exp<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Parameter.ts#L179">src/structures/Parameter.ts:179</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-static"><a name="descriptionRegExp" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> description<wbr/>Reg<wbr/>Exp</h3><div class="tsd-signature tsd-kind-icon">description<wbr/>Reg<wbr/>Exp<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Parameter.ts#L162">src/structures/Parameter.ts:162</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter description check regular expression</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>static</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"><a name="nameRegExp" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> name<wbr/>Reg<wbr/>Exp</h3><div class="tsd-signature tsd-kind-icon">name<wbr/>Reg<wbr/>Exp<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Parameter.ts#L171">src/structures/Parameter.ts:171</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div><dl class="tsd-comment-tags"><dt>static</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"><a name="nameRegExp" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> name<wbr/>Reg<wbr/>Exp</h3><div class="tsd-signature tsd-kind-icon">name<wbr/>Reg<wbr/>Exp<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Parameter.ts#L155">src/structures/Parameter.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter name check regular expression</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>static</dt><dd></dd></dl></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-class tsd-has-type-parameter"><a href="Parameter.html" class="tsd-kind-icon">Parameter</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a href="Parameter.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Parameter.html#choices" class="tsd-kind-icon">choices</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Parameter.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Parameter.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Parameter.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Parameter.html#optional" class="tsd-kind-icon">optional</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Parameter.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="Parameter.html#descriptionRegExp" class="tsd-kind-icon">description<wbr/>Reg<wbr/>Exp</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="Parameter.html#nameRegExp" class="tsd-kind-icon">name<wbr/>Reg<wbr/>Exp</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>
|
||||
@@ -1,14 +1,14 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ParameterTypeError | 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="ParameterTypeError.html">ParameterTypeError</a></li></ul><h1>Class ParameterTypeError</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>Error indicating that an input value cannot be converted to a expected type</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">TypeError</span><ul class="tsd-hierarchy"><li><span class="target">ParameterTypeError</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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="ParameterTypeError.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 tsd-is-inherited tsd-is-external"><a href="ParameterTypeError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ParameterTypeError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ParameterTypeError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="ParameterTypeError.html#stringContent" class="tsd-kind-icon">string<wbr/>Content</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="ParameterTypeError.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ParameterTypeError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</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="ParameterTypeError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ParameterTypeError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ParameterTypeError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</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 tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Parameter<wbr/>Type<wbr/>Error<span class="tsd-signature-symbol">(</span>s<span class="tsd-signature-symbol">: </span><a href="../modules.html#ParameterResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ParameterResolvable</a>, type<span class="tsd-signature-symbol">: </span><a href="../modules.html#ParameterType" class="tsd-signature-type" data-tsd-kind="Type alias">ParameterType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ParameterTypeError.html" class="tsd-signature-type" data-tsd-kind="Class">ParameterTypeError</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides TypeError.constructor</p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/errors.ts#L74">src/errors.ts:74</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>s: <a href="../modules.html#ParameterResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ParameterResolvable</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">TypeError</span><ul class="tsd-hierarchy"><li><span class="target">ParameterTypeError</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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="ParameterTypeError.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 tsd-is-inherited tsd-is-external"><a href="ParameterTypeError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ParameterTypeError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ParameterTypeError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="ParameterTypeError.html#stringContent" class="tsd-kind-icon">string<wbr/>Content</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="ParameterTypeError.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ParameterTypeError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</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="ParameterTypeError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ParameterTypeError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ParameterTypeError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</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 tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Parameter<wbr/>Type<wbr/>Error<span class="tsd-signature-symbol">(</span>s<span class="tsd-signature-symbol">: </span><a href="../modules.html#ParameterResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ParameterResolvable</a>, type<span class="tsd-signature-symbol">: </span><a href="../modules.html#ParameterType" class="tsd-signature-type" data-tsd-kind="Type alias">ParameterType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ParameterTypeError.html" class="tsd-signature-type" data-tsd-kind="Class">ParameterTypeError</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides TypeError.constructor</p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/errors.ts#L73">src/errors.ts:73</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>s: <a href="../modules.html#ParameterResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ParameterResolvable</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>value with an invalid type</p>
|
||||
</div></div></li><li><h5>type: <a href="../modules.html#ParameterType" class="tsd-signature-type" data-tsd-kind="Type alias">ParameterType</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>expected type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="ParameterTypeError.html" class="tsd-signature-type" data-tsd-kind="Class">ParameterTypeError</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 tsd-is-inherited tsd-is-external"><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"><p>Inherited from TypeError.message</p><ul><li>Defined in C:/Users/grzan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es5.d.ts:974</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><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 TypeError.name</p><ul><li>Defined in C:/Users/grzan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es5.d.ts:973</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="stack" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3><div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from TypeError.stack</p><ul><li>Defined in C:/Users/grzan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es5.d.ts:975</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a name="stringContent" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> string<wbr/>Content</h3><div class="tsd-signature tsd-kind-icon">string<wbr/>Content<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/2867da1/src/errors.ts#L60">src/errors.ts:60</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="ParameterTypeError.html" class="tsd-signature-type" data-tsd-kind="Class">ParameterTypeError</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 tsd-is-inherited tsd-is-external"><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"><p>Inherited from TypeError.message</p><ul><li>Defined in C:/Users/grzan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es5.d.ts:974</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><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 TypeError.name</p><ul><li>Defined in C:/Users/grzan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es5.d.ts:973</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="stack" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3><div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from TypeError.stack</p><ul><li>Defined in C:/Users/grzan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es5.d.ts:975</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a name="stringContent" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> string<wbr/>Content</h3><div class="tsd-signature tsd-kind-icon">string<wbr/>Content<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/5a80551/src/errors.ts#L59">src/errors.ts:59</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Value converted to a string</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 tsd-is-private"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#ParameterType" class="tsd-signature-type" data-tsd-kind="Type alias">ParameterType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/errors.ts#L67">src/errors.ts:67</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-private"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#ParameterType" class="tsd-signature-type" data-tsd-kind="Type alias">ParameterType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/errors.ts#L66">src/errors.ts:66</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Expected type</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 tsd-is-inherited tsd-is-static tsd-is-external"><a name="stackTraceLimit" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr/>Trace<wbr/>Limit</h3><div class="tsd-signature tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from TypeError.stackTraceLimit</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:13</li></ul></aside></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="toString" class="tsd-anchor"></a><h3>to<wbr/>String</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/2867da1/src/errors.ts#L85">src/errors.ts:85</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited tsd-is-static tsd-is-external"><a name="stackTraceLimit" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr/>Trace<wbr/>Limit</h3><div class="tsd-signature tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from TypeError.stackTraceLimit</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:13</li></ul></aside></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="toString" class="tsd-anchor"></a><h3>to<wbr/>String</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/errors.ts#L84">src/errors.ts:84</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Converts error object to user-readable message</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>Formatted error message</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a name="captureStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr/>Stack<wbr/>Trace</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from TypeError.captureStackTrace</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:4</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>PermissionCommand | 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="PermissionCommand.html">PermissionCommand</a></li></ul><h1>Class PermissionCommand</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>Executable command with attached permission system</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="FunctionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCommand</a><ul class="tsd-hierarchy"><li><span class="target">PermissionCommand</span><ul class="tsd-hierarchy"><li><a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a></li><li><a href="PermissionGuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionGuildCommand</a></li></ul></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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="PermissionCommand.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 tsd-is-inherited"><a href="PermissionCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionCommand.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PermissionCommand.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionCommand.html#type" class="tsd-kind-icon">type</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 tsd-has-type-parameter tsd-is-inherited"><a href="PermissionCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="PermissionCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="PermissionCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="PermissionCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="PermissionCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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 tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Permission<wbr/>Command<span class="tsd-signature-symbol">(</span>manager<span class="tsd-signature-symbol">: </span><a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a>, type<span class="tsd-signature-symbol">: </span><a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/PermissionCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">PermissionCommandInit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="PermissionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionCommand</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/PermissionCommand.ts#L30">src/commands/base/PermissionCommand.ts:30</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="FunctionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCommand</a><ul class="tsd-hierarchy"><li><span class="target">PermissionCommand</span><ul class="tsd-hierarchy"><li><a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a></li><li><a href="PermissionGuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionGuildCommand</a></li></ul></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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="PermissionCommand.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 tsd-is-inherited"><a href="PermissionCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionCommand.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PermissionCommand.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionCommand.html#type" class="tsd-kind-icon">type</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 tsd-has-type-parameter tsd-is-inherited"><a href="PermissionCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="PermissionCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="PermissionCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="PermissionCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="PermissionCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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 tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Permission<wbr/>Command<span class="tsd-signature-symbol">(</span>manager<span class="tsd-signature-symbol">: </span><a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a>, type<span class="tsd-signature-symbol">: </span><a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/PermissionCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">PermissionCommandInit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="PermissionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionCommand</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/PermissionCommand.ts#L43">src/commands/base/PermissionCommand.ts:43</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Constructor of command with attached permissions</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>manager: <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command manager attached to this command</p>
|
||||
@@ -8,11 +8,11 @@
|
||||
<p>command type</p>
|
||||
</div></div></li><li><h5>options: <a href="../interfaces/PermissionCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">PermissionCommandInit</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command initalization options</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="PermissionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionCommand</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 tsd-is-inherited"><a name="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/FunctionCommand.ts#L28">src/commands/base/FunctionCommand.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="PermissionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionCommand</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 tsd-is-inherited"><a name="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L56">src/commands/base/FunctionCommand.ts:56</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether a SUCCESS message should be sent after executing the command function (when there is no other reply)</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 tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L47">src/commands/base/Command.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L60">src/commands/base/Command.ts:60</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default_permission</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 tsd-is-inherited"><a name="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#ephemeral">ephemeral</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/FunctionCommand.ts#L42">src/commands/base/FunctionCommand.ts:42</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#ephemeral">ephemeral</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L70">src/commands/base/FunctionCommand.ts:70</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether a reply should be visible only to the caller</p>
|
||||
</div><div><ul>
|
||||
<li>NONE - bot replies are public and visible to everyone in a text channel</li>
|
||||
@@ -21,34 +21,34 @@
|
||||
</ul>
|
||||
<p><a href="https://support.discord.com/hc/pl/articles/1500000580222-Ephemeral-Messages-FAQ">Read more</a></p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd><dt>remarks</dt><dd><p>Since ephemeral interactions cannot be deleted, a placeholding embed will be sent when there will be no response from the command function and <em>announceSuccess</em> will be set to false (placeholding message uses <em>color</em> and <em>title</em> parameters from SUCCESS system message configuration)</p>
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#manager">manager</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L23">src/commands/base/Command.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#manager">manager</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L39">src/commands/base/Command.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Manager in which this command is registered</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 tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> 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="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L31">src/commands/base/Command.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> 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="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L46">src/commands/base/Command.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</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="permissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> permissions</h3><div class="tsd-signature tsd-kind-icon">permissions<span class="tsd-signature-symbol">:</span> <a href="CommandPermissions.html" class="tsd-signature-type" data-tsd-kind="Class">CommandPermissions</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/PermissionCommand.ts#L21">src/commands/base/PermissionCommand.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="permissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> permissions</h3><div class="tsd-signature tsd-kind-icon">permissions<span class="tsd-signature-symbol">:</span> <a href="CommandPermissions.html" class="tsd-signature-type" data-tsd-kind="Class">CommandPermissions</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/PermissionCommand.ts#L34">src/commands/base/PermissionCommand.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object containing check functions and permission bitfields</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 tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L39">src/commands/base/Command.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L53">src/commands/base/Command.ts:53</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>CommandBot's internal command type</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></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 tsd-has-type-parameter tsd-is-inherited"><a name="isBaseCommandType" class="tsd-anchor"></a><h3>is<wbr/>Base<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#isBaseCommandType">isBaseCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L88">src/commands/base/Command.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></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 tsd-has-type-parameter tsd-is-inherited"><a name="isBaseCommandType" class="tsd-anchor"></a><h3>is<wbr/>Base<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#isBaseCommandType">isBaseCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L100">src/commands/base/Command.ts:100</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check base command type</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#BaseCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>base command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isChildCommandType" class="tsd-anchor"></a><h3>is<wbr/>Child<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#isChildCommandType">isChildCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L155">src/commands/base/Command.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isChildCommandType" class="tsd-anchor"></a><h3>is<wbr/>Child<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#isChildCommandType">isChildCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L165">src/commands/base/Command.ts:165</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check child command type</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#ChildCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>child command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as a child command of the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isCommandType" class="tsd-anchor"></a><h3>is<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#isCommandType">isCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L128">src/commands/base/Command.ts:128</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isCommandType" class="tsd-anchor"></a><h3>is<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#isCommandType">isCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L139">src/commands/base/Command.ts:139</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Checks command type</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a name="start" class="tsd-anchor"></a><h3>start</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#start">start</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/PermissionCommand.ts#L49">src/commands/base/PermissionCommand.ts:49</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a name="start" class="tsd-anchor"></a><h3>start</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#start">start</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/PermissionCommand.ts#L62">src/commands/base/PermissionCommand.ts:62</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Invoke the command</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>input: <a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>input data</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#toObject">toObject</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L75">src/commands/base/Command.ts:75</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommand.html">FunctionCommand</a>.<a href="FunctionCommand.html#toObject">toObject</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L88">src/commands/base/Command.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Converts a command instance to an <a href="../interfaces/APICommandObject.html">APICommandObject</a></p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a></h4><div><p>An object that is accepted by the Discord API</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="PermissionCommand.html" class="tsd-kind-icon">Permission<wbr/>Command</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="PermissionCommand.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionCommand.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PermissionCommand.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionCommand.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="PermissionCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="PermissionCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="PermissionCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="PermissionCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="PermissionCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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>
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>PermissionGuildCommand | 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="PermissionGuildCommand.html">PermissionGuildCommand</a></li></ul><h1>Class PermissionGuildCommand</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>Guild-scoped executable command with permissions attached</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>implements</dt><dd><p>{GuildCommand}</p>
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="PermissionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionCommand</a><ul class="tsd-hierarchy"><li><span class="target">PermissionGuildCommand</span><ul class="tsd-hierarchy"><li><a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a></li><li><a href="ContextMenuCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ContextMenuCommand</a></li></ul></li></ul></li></ul></section><section class="tsd-panel"><h3>Implements</h3><ul class="tsd-hierarchy"><li><a href="GuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">GuildCommand</a></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 tsd-is-overwrite"><a href="PermissionGuildCommand.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 tsd-is-inherited"><a href="PermissionGuildCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PermissionGuildCommand.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PermissionGuildCommand.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#type" class="tsd-kind-icon">type</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 tsd-has-type-parameter tsd-is-inherited"><a href="PermissionGuildCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="PermissionGuildCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="PermissionGuildCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="PermissionGuildCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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 tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Permission<wbr/>Guild<wbr/>Command<span class="tsd-signature-symbol">(</span>manager<span class="tsd-signature-symbol">: </span><a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a>, type<span class="tsd-signature-symbol">: </span><a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/PermissionGuildCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">PermissionGuildCommandInit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="PermissionGuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionGuildCommand</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="PermissionCommand.html">PermissionCommand</a>.<Line truncated
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="PermissionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionCommand</a><ul class="tsd-hierarchy"><li><span class="target">PermissionGuildCommand</span><ul class="tsd-hierarchy"><li><a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a></li><li><a href="ContextMenuCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ContextMenuCommand</a></li></ul></li></ul></li></ul></section><section class="tsd-panel"><h3>Implements</h3><ul class="tsd-hierarchy"><li><a href="GuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">GuildCommand</a></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 tsd-is-overwrite"><a href="PermissionGuildCommand.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 tsd-is-inherited"><a href="PermissionGuildCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PermissionGuildCommand.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PermissionGuildCommand.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#type" class="tsd-kind-icon">type</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 tsd-has-type-parameter tsd-is-inherited"><a href="PermissionGuildCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="PermissionGuildCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="PermissionGuildCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="PermissionGuildCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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 tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Permission<wbr/>Guild<wbr/>Command<span class="tsd-signature-symbol">(</span>manager<span class="tsd-signature-symbol">: </span><a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a>, type<span class="tsd-signature-symbol">: </span><a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/PermissionGuildCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">PermissionGuildCommandInit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="PermissionGuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionGuildCommand</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="PermissionCommand.html">PermissionCommand</a>.<Line truncated
|
||||
<p>Guild-scoped, executable, permissions command constructor</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>manager: <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command manager attached to this command</p>
|
||||
@@ -9,13 +9,13 @@
|
||||
<p>command type</p>
|
||||
</div></div></li><li><h5>options: <a href="../interfaces/PermissionGuildCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">PermissionGuildCommandInit</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command initialization options</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="PermissionGuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionGuildCommand</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 tsd-is-inherited"><a name="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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>Implementation of GuildCommand.announceSuccess</p><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/FunctionCommand.ts#L28">src/commands/base/FunctionCommand.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="PermissionGuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionGuildCommand</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 tsd-is-inherited"><a name="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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>Implementation of GuildCommand.announceSuccess</p><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L56">src/commands/base/FunctionCommand.ts:56</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether a SUCCESS message should be sent after executing the command function (when there is no other reply)</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 tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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>Implementation of GuildCommand.default_permission</p><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L47">src/commands/base/Command.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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>Implementation of GuildCommand.default_permission</p><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L60">src/commands/base/Command.ts:60</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default_permission</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="dm" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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>Implementation of GuildCommand.dm</p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/PermissionGuildCommand.ts#L29">src/commands/base/PermissionGuildCommand.ts:29</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="dm" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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>Implementation of GuildCommand.dm</p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/PermissionGuildCommand.ts#L45">src/commands/base/PermissionGuildCommand.ts:45</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>If set to <em>false</em>, all interactions that get invoked from private/direct conversations (outside a guild) will result a PermissionError</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 tsd-is-inherited"><a name="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><p>Implementation of GuildCommand.ephemeral</p><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#ephemeral">ephemeral</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/FunctionCommand.ts#L42">src/commands/base/FunctionCommand.ts:42</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><p>Implementation of GuildCommand.ephemeral</p><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#ephemeral">ephemeral</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L70">src/commands/base/FunctionCommand.ts:70</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether a reply should be visible only to the caller</p>
|
||||
</div><div><ul>
|
||||
<li>NONE - bot replies are public and visible to everyone in a text channel</li>
|
||||
@@ -24,36 +24,36 @@
|
||||
</ul>
|
||||
<p><a href="https://support.discord.com/hc/pl/articles/1500000580222-Ephemeral-Messages-FAQ">Read more</a></p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd><dt>remarks</dt><dd><p>Since ephemeral interactions cannot be deleted, a placeholding embed will be sent when there will be no response from the command function and <em>announceSuccess</em> will be set to false (placeholding message uses <em>color</em> and <em>title</em> parameters from SUCCESS system message configuration)</p>
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="guilds" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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>Implementation of GuildCommand.guilds</p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/PermissionGuildCommand.ts#L21">src/commands/base/PermissionGuildCommand.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="guilds" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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>Implementation of GuildCommand.guilds</p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/PermissionGuildCommand.ts#L38">src/commands/base/PermissionGuildCommand.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of Discord guild (server) IDs in which this command can be used</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 tsd-is-inherited"><a name="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><p>Implementation of GuildCommand.manager</p><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#manager">manager</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L23">src/commands/base/Command.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><p>Implementation of GuildCommand.manager</p><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#manager">manager</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L39">src/commands/base/Command.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Manager in which this command is registered</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 tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> 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>Implementation of GuildCommand.name</p><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L31">src/commands/base/Command.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> 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>Implementation of GuildCommand.name</p><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L46">src/commands/base/Command.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</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 tsd-is-inherited"><a name="permissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> permissions</h3><div class="tsd-signature tsd-kind-icon">permissions<span class="tsd-signature-symbol">:</span> <a href="CommandPermissions.html" class="tsd-signature-type" data-tsd-kind="Class">CommandPermissions</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#permissions">permissions</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/PermissionCommand.ts#L21">src/commands/base/PermissionCommand.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="permissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> permissions</h3><div class="tsd-signature tsd-kind-icon">permissions<span class="tsd-signature-symbol">:</span> <a href="CommandPermissions.html" class="tsd-signature-type" data-tsd-kind="Class">CommandPermissions</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#permissions">permissions</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/PermissionCommand.ts#L34">src/commands/base/PermissionCommand.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object containing check functions and permission bitfields</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 tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></div><aside class="tsd-sources"><p>Implementation of GuildCommand.type</p><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L39">src/commands/base/Command.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></div><aside class="tsd-sources"><p>Implementation of GuildCommand.type</p><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L53">src/commands/base/Command.ts:53</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>CommandBot's internal command type</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></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 tsd-has-type-parameter tsd-is-inherited"><a name="isBaseCommandType" class="tsd-anchor"></a><h3>is<wbr/>Base<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of GuildCommand.isBaseCommandType</p><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#isBaseCommandType">isBaseCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L88">src/commands/base/Command.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></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 tsd-has-type-parameter tsd-is-inherited"><a name="isBaseCommandType" class="tsd-anchor"></a><h3>is<wbr/>Base<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of GuildCommand.isBaseCommandType</p><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#isBaseCommandType">isBaseCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L100">src/commands/base/Command.ts:100</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check base command type</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#BaseCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>base command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isChildCommandType" class="tsd-anchor"></a><h3>is<wbr/>Child<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of GuildCommand.isChildCommandType</p><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#isChildCommandType">isChildCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L155">src/commands/base/Command.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isChildCommandType" class="tsd-anchor"></a><h3>is<wbr/>Child<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of GuildCommand.isChildCommandType</p><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#isChildCommandType">isChildCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L165">src/commands/base/Command.ts:165</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check child command type</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#ChildCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>child command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as a child command of the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isCommandType" class="tsd-anchor"></a><h3>is<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of GuildCommand.isCommandType</p><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#isCommandType">isCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L128">src/commands/base/Command.ts:128</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isCommandType" class="tsd-anchor"></a><h3>is<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of GuildCommand.isCommandType</p><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#isCommandType">isCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L139">src/commands/base/Command.ts:139</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Checks command type</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a name="start" class="tsd-anchor"></a><h3>start</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of GuildCommand.start</p><p>Overrides <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#start">start</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/PermissionGuildCommand.ts#L59">src/commands/base/PermissionGuildCommand.ts:59</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a name="start" class="tsd-anchor"></a><h3>start</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of GuildCommand.start</p><p>Overrides <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#start">start</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/PermissionGuildCommand.ts#L75">src/commands/base/PermissionGuildCommand.ts:75</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Invoke the command</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>input: <a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>input data</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of GuildCommand.toObject</p><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#toObject">toObject</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L75">src/commands/base/Command.ts:75</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of GuildCommand.toObject</p><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#toObject">toObject</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L88">src/commands/base/Command.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Converts a command instance to an <a href="../interfaces/APICommandObject.html">APICommandObject</a></p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a></h4><div><p>An object that is accepted by the Discord API</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="PermissionGuildCommand.html" class="tsd-kind-icon">Permission<wbr/>Guild<wbr/>Command</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="PermissionGuildCommand.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PermissionGuildCommand.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PermissionGuildCommand.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="PermissionGuildCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="PermissionGuildCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="PermissionGuildCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="PermissionGuildCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="PermissionGuildCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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>
|
||||
@@ -1,12 +1,12 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>PermissionsError | 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="PermissionsError.html">PermissionsError</a></li></ul><h1>Class PermissionsError</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>Error indicating that a caller doesn't have enough permissions to execute a command</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Error</span><ul class="tsd-hierarchy"><li><span class="target">PermissionsError</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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="PermissionsError.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 tsd-is-private"><a href="PermissionsError.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="PermissionsError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="PermissionsError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="PermissionsError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="PermissionsError.html#user" class="tsd-kind-icon">user</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="PermissionsError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</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="PermissionsError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="PermissionsError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="PermissionsError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</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 tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Permissions<wbr/>Error<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a>, user<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GuildMember</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="PermissionsError.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionsError</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides Error.constructor</p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/errors.ts#L32">src/errors.ts:32</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>command: <a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Error</span><ul class="tsd-hierarchy"><li><span class="target">PermissionsError</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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="PermissionsError.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 tsd-is-private"><a href="PermissionsError.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="PermissionsError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="PermissionsError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="PermissionsError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="PermissionsError.html#user" class="tsd-kind-icon">user</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="PermissionsError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</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="PermissionsError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="PermissionsError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="PermissionsError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</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 tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Permissions<wbr/>Error<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a>, user<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GuildMember</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="PermissionsError.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionsError</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides Error.constructor</p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/errors.ts#L32">src/errors.ts:32</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>command: <a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command that user wanted and failed to invoke</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> user: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GuildMember</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="PermissionsError.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionsError</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 tsd-is-private"><a name="command" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/errors.ts#L18">src/errors.ts:18</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> user: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GuildMember</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="PermissionsError.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionsError</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 tsd-is-private"><a name="command" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/errors.ts#L18">src/errors.ts:18</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command that user wanted and failed to invoke</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 tsd-is-inherited tsd-is-external"><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"><p>Inherited from Error.message</p><ul><li>Defined in C:/Users/grzan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es5.d.ts:974</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><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 Error.name</p><ul><li>Defined in C:/Users/grzan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es5.d.ts:973</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="stack" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3><div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.stack</p><ul><li>Defined in C:/Users/grzan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es5.d.ts:975</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a name="user" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> user</h3><div class="tsd-signature tsd-kind-icon">user<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GuildMember</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/errors.ts#L25">src/errors.ts:25</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited tsd-is-external"><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"><p>Inherited from Error.message</p><ul><li>Defined in C:/Users/grzan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es5.d.ts:974</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><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 Error.name</p><ul><li>Defined in C:/Users/grzan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es5.d.ts:973</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="stack" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3><div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.stack</p><ul><li>Defined in C:/Users/grzan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es5.d.ts:975</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a name="user" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> user</h3><div class="tsd-signature tsd-kind-icon">user<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GuildMember</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/errors.ts#L25">src/errors.ts:25</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>User that doesn't have the permissions</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 tsd-is-inherited tsd-is-static tsd-is-external"><a name="stackTraceLimit" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr/>Trace<wbr/>Limit</h3><div class="tsd-signature tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from Error.stackTraceLimit</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:13</li></ul></aside></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="toString" class="tsd-anchor"></a><h3>to<wbr/>String</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/2867da1/src/errors.ts#L43">src/errors.ts:43</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited tsd-is-static tsd-is-external"><a name="stackTraceLimit" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr/>Trace<wbr/>Limit</h3><div class="tsd-signature tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from Error.stackTraceLimit</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:13</li></ul></aside></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="toString" class="tsd-anchor"></a><h3>to<wbr/>String</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/errors.ts#L43">src/errors.ts:43</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Converts error object to user-readable message</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>Formatted error message</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a name="captureStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr/>Stack<wbr/>Trace</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Error.captureStackTrace</p><ul><li>Defined in node_modules/@types/node/globals.d.ts:4</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
|
||||
@@ -1,26 +1,26 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>PrefixManager | 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="PrefixManager.html">PrefixManager</a></li></ul><h1>Class PrefixManager</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>Maps server IDs with command prefixes and allows to manage them</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>experimental</dt><dd><p>This feature should be fully functional but it doesn't store its data in any kind of local storage or cache. All informations get lost after restarting the application. It is possible to create a store for that data (exporting to a file or in some kind of database) and then load it every time the application starts.</p>
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">PrefixManager</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="PrefixManager.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 tsd-is-private"><a href="PrefixManager.html#_global" class="tsd-kind-icon">_global</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="PrefixManager.html#_prefixes" class="tsd-kind-icon">_prefixes</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PrefixManager.html#manager" class="tsd-kind-icon">manager</a></li></ul></section><section class="tsd-index-section "><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="PrefixManager.html#globalPrefix" class="tsd-kind-icon">global<wbr/>Prefix</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="PrefixManager.html#prefixes" class="tsd-kind-icon">prefixes</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="PrefixManager.html#get" class="tsd-kind-icon">get</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PrefixManager.html#remove" class="tsd-kind-icon">remove</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PrefixManager.html#set" class="tsd-kind-icon">set</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/>Prefix<wbr/>Manager<span class="tsd-signature-symbol">(</span>manager<span class="tsd-signature-symbol">: </span><a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a>, defaultPrefix<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><a href="PrefixManager.html" class="tsd-signature-type" data-tsd-kind="Class">PrefixManager</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/2867da1/src/structures/PrefixManager.ts#L44">src/structures/PrefixManager.ts:44</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>manager: <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">PrefixManager</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="PrefixManager.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 tsd-is-private"><a href="PrefixManager.html#_global" class="tsd-kind-icon">_global</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="PrefixManager.html#_prefixes" class="tsd-kind-icon">_prefixes</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PrefixManager.html#manager" class="tsd-kind-icon">manager</a></li></ul></section><section class="tsd-index-section "><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="PrefixManager.html#globalPrefix" class="tsd-kind-icon">global<wbr/>Prefix</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="PrefixManager.html#prefixes" class="tsd-kind-icon">prefixes</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="PrefixManager.html#get" class="tsd-kind-icon">get</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PrefixManager.html#remove" class="tsd-kind-icon">remove</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PrefixManager.html#set" class="tsd-kind-icon">set</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/>Prefix<wbr/>Manager<span class="tsd-signature-symbol">(</span>manager<span class="tsd-signature-symbol">: </span><a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a>, defaultPrefix<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><a href="PrefixManager.html" class="tsd-signature-type" data-tsd-kind="Class">PrefixManager</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/PrefixManager.ts#L44">src/structures/PrefixManager.ts:44</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>manager: <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>manager attached to this object</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> defaultPrefix: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="PrefixManager.html" class="tsd-signature-type" data-tsd-kind="Class">PrefixManager</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 tsd-is-private"><a name="_global" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> _global</h3><div class="tsd-signature tsd-kind-icon">_global<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "GLOBAL"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/PrefixManager.ts#L30">src/structures/PrefixManager.ts:30</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> defaultPrefix: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="PrefixManager.html" class="tsd-signature-type" data-tsd-kind="Class">PrefixManager</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 tsd-is-private"><a name="_global" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> _global</h3><div class="tsd-signature tsd-kind-icon">_global<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "GLOBAL"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/PrefixManager.ts#L30">src/structures/PrefixManager.ts:30</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Global scope identifier</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 tsd-is-private"><a name="_prefixes" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> _prefixes</h3><div class="tsd-signature tsd-kind-icon">_prefixes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><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><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/PrefixManager.ts#L23">src/structures/PrefixManager.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-private"><a name="_prefixes" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> _prefixes</h3><div class="tsd-signature tsd-kind-icon">_prefixes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><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><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/PrefixManager.ts#L23">src/structures/PrefixManager.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Prefixes data</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="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/PrefixManager.ts#L37">src/structures/PrefixManager.ts:37</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/PrefixManager.ts#L37">src/structures/PrefixManager.ts:37</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command manager associated with the object</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a name="globalPrefix" class="tsd-anchor"></a><h3>global<wbr/>Prefix</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> globalPrefix<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</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/2867da1/src/structures/PrefixManager.ts#L58">src/structures/PrefixManager.ts:58</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a name="globalPrefix" class="tsd-anchor"></a><h3>global<wbr/>Prefix</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> globalPrefix<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</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/PrefixManager.ts#L58">src/structures/PrefixManager.ts:58</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Manager global prefix</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a name="prefixes" class="tsd-anchor"></a><h3>prefixes</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> prefixes<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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/2867da1/src/structures/PrefixManager.ts#L66">src/structures/PrefixManager.ts:66</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a name="prefixes" class="tsd-anchor"></a><h3>prefixes</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> prefixes<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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/PrefixManager.ts#L65">src/structures/PrefixManager.ts:65</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Manager data</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></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="get" class="tsd-anchor"></a><h3>get</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>scope<span class="tsd-signature-symbol">?: </span><a href="../modules.html#ScopeResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ScopeResolvable</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</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/2867da1/src/structures/PrefixManager.ts#L76">src/structures/PrefixManager.ts:76</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></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="get" class="tsd-anchor"></a><h3>get</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>scope<span class="tsd-signature-symbol">?: </span><a href="../modules.html#ScopeResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ScopeResolvable</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</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/PrefixManager.ts#L75">src/structures/PrefixManager.ts:75</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Get prefix for a specified scope</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> scope: <a href="../modules.html#ScopeResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ScopeResolvable</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>guild object or ID</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4><div><p>a prefix used in given scope</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="remove" class="tsd-anchor"></a><h3>remove</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">remove<span class="tsd-signature-symbol">(</span>scope<span class="tsd-signature-symbol">?: </span><a href="../modules.html#ScopeResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ScopeResolvable</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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/2867da1/src/structures/PrefixManager.ts#L108">src/structures/PrefixManager.ts:108</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="remove" class="tsd-anchor"></a><h3>remove</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">remove<span class="tsd-signature-symbol">(</span>scope<span class="tsd-signature-symbol">?: </span><a href="../modules.html#ScopeResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ScopeResolvable</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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/PrefixManager.ts#L105">src/structures/PrefixManager.ts:105</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Remove prefix for the specified scope</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> scope: <a href="../modules.html#ScopeResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ScopeResolvable</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="set" class="tsd-anchor"></a><h3>set</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<span class="tsd-signature-symbol">(</span>prefix<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, scope<span class="tsd-signature-symbol">?: </span><a href="../modules.html#ScopeResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ScopeResolvable</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</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/2867da1/src/structures/PrefixManager.ts#L91">src/structures/PrefixManager.ts:91</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> scope: <a href="../modules.html#ScopeResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ScopeResolvable</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="set" class="tsd-anchor"></a><h3>set</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<span class="tsd-signature-symbol">(</span>prefix<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, scope<span class="tsd-signature-symbol">?: </span><a href="../modules.html#ScopeResolvable" class="tsd-signature-type" data-tsd-kind="Type alias">ScopeResolvable</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</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/PrefixManager.ts#L89">src/structures/PrefixManager.ts:89</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Set prefix for a specific scope</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>prefix: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>new prefix</p>
|
||||
|
||||
@@ -1,18 +1,20 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SubCommand | 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="SubCommand.html">SubCommand</a></li></ul><h1>Class SubCommand</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>Representation of SUB_COMMAND Discord interaction</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="PermissionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionCommand</a><ul class="tsd-hierarchy"><li><span class="target">SubCommand</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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="SubCommand.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 tsd-is-inherited"><a href="SubCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommand.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommand.html#parameters" class="tsd-kind-icon">parameters</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommand.html#parent" class="tsd-kind-icon">parent</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommand.html#usage" class="tsd-kind-icon">usage</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 tsd-has-type-parameter tsd-is-inherited"><a href="SubCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="SubCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="SubCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="SubCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="SubCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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 tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Sub<wbr/>Command<span class="tsd-signature-symbol">(</span>parent<span class="tsd-signature-symbol">: </span><a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a><span class="tsd-signature-symbol"> | </span><a href="SubCommandGroup.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommandGroup</a>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/SubCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandInit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/SubCommand.ts#L54">src/commands/SubCommand.ts:54</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="PermissionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionCommand</a><ul class="tsd-hierarchy"><li><span class="target">SubCommand</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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="SubCommand.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="SubCommand.html#aliases" class="tsd-kind-icon">aliases</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommand.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommand.html#parameters" class="tsd-kind-icon">parameters</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommand.html#parent" class="tsd-kind-icon">parent</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommand.html#usage" class="tsd-kind-icon">usage</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 tsd-has-type-parameter tsd-is-inherited"><a href="SubCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="SubCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="SubCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="SubCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="SubCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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 tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Sub<wbr/>Command<span class="tsd-signature-symbol">(</span>parent<span class="tsd-signature-symbol">: </span><a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a><span class="tsd-signature-symbol"> | </span><a href="SubCommandGroup.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommandGroup</a>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/SubCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandInit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/SubCommand.ts#L85">src/commands/SubCommand.ts:85</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Subcommand constructor (SUB_COMMAND parameter in Discord API)</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>parent: <a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a><span class="tsd-signature-symbol"> | </span><a href="SubCommandGroup.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommandGroup</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command parent</p>
|
||||
</div></div></li><li><h5>options: <a href="../interfaces/SubCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandInit</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>initialization options</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</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 tsd-is-inherited"><a name="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/FunctionCommand.ts#L28">src/commands/base/FunctionCommand.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</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="aliases" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/SubCommand.ts#L70">src/commands/SubCommand.ts:70</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of different names that can be used to invoke a command (when using prefix interactions)</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 tsd-is-inherited"><a name="announceSuccess" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L56">src/commands/base/FunctionCommand.ts:56</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether a SUCCESS message should be sent after executing the command function (when there is no other reply)</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 tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L47">src/commands/base/Command.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L60">src/commands/base/Command.ts:60</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default_permission</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="description" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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/2867da1/src/commands/SubCommand.ts#L30">src/commands/SubCommand.ts:30</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="description" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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/5a80551/src/commands/SubCommand.ts#L56">src/commands/SubCommand.ts:56</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command description displayed in the help message or in slash commands menu (Default description: "No description")</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 tsd-is-inherited"><a name="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#ephemeral">ephemeral</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/FunctionCommand.ts#L42">src/commands/base/FunctionCommand.ts:42</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#ephemeral">ephemeral</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L70">src/commands/base/FunctionCommand.ts:70</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether a reply should be visible only to the caller</p>
|
||||
</div><div><ul>
|
||||
<li>NONE - bot replies are public and visible to everyone in a text channel</li>
|
||||
@@ -21,38 +23,38 @@
|
||||
</ul>
|
||||
<p><a href="https://support.discord.com/hc/pl/articles/1500000580222-Ephemeral-Messages-FAQ">Read more</a></p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd><dt>remarks</dt><dd><p>Since ephemeral interactions cannot be deleted, a placeholding embed will be sent when there will be no response from the command function and <em>announceSuccess</em> will be set to false (placeholding message uses <em>color</em> and <em>title</em> parameters from SUCCESS system message configuration)</p>
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#manager">manager</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L23">src/commands/base/Command.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a name="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#manager">manager</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L39">src/commands/base/Command.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Manager in which this command is registered</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 tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> 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="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L31">src/commands/base/Command.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> 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="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L46">src/commands/base/Command.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</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="parameters" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> parameters</h3><div class="tsd-signature tsd-kind-icon">parameters<span class="tsd-signature-symbol">:</span> <a href="Parameter.html" class="tsd-signature-type" data-tsd-kind="Class">Parameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/SubCommand.ts#L38">src/commands/SubCommand.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="parameters" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> parameters</h3><div class="tsd-signature tsd-kind-icon">parameters<span class="tsd-signature-symbol">:</span> <a href="Parameter.html" class="tsd-signature-type" data-tsd-kind="Class">Parameter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/SubCommand.ts#L63">src/commands/SubCommand.ts:63</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of parameters that can passed to this command</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="parent" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> parent</h3><div class="tsd-signature tsd-kind-icon">parent<span class="tsd-signature-symbol">:</span> <a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a><span class="tsd-signature-symbol"> | </span><a href="SubCommandGroup.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommandGroup</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/SubCommand.ts#L22">src/commands/SubCommand.ts:22</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="parent" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> parent</h3><div class="tsd-signature tsd-kind-icon">parent<span class="tsd-signature-symbol">:</span> <a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a><span class="tsd-signature-symbol"> | </span><a href="SubCommandGroup.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommandGroup</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/SubCommand.ts#L49">src/commands/SubCommand.ts:49</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command parent</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 tsd-is-inherited"><a name="permissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> permissions</h3><div class="tsd-signature tsd-kind-icon">permissions<span class="tsd-signature-symbol">:</span> <a href="CommandPermissions.html" class="tsd-signature-type" data-tsd-kind="Class">CommandPermissions</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#permissions">permissions</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/PermissionCommand.ts#L21">src/commands/base/PermissionCommand.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="permissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> permissions</h3><div class="tsd-signature tsd-kind-icon">permissions<span class="tsd-signature-symbol">:</span> <a href="CommandPermissions.html" class="tsd-signature-type" data-tsd-kind="Class">CommandPermissions</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#permissions">permissions</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/PermissionCommand.ts#L34">src/commands/base/PermissionCommand.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object containing check functions and permission bitfields</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 tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L39">src/commands/base/Command.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L53">src/commands/base/Command.ts:53</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>CommandBot's internal command type</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="usage" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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/2867da1/src/commands/SubCommand.ts#L46">src/commands/SubCommand.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="usage" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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/5a80551/src/commands/SubCommand.ts#L77">src/commands/SubCommand.ts:77</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command usage displayed in the help message</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></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 tsd-has-type-parameter tsd-is-inherited"><a name="isBaseCommandType" class="tsd-anchor"></a><h3>is<wbr/>Base<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#isBaseCommandType">isBaseCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L88">src/commands/base/Command.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></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 tsd-has-type-parameter tsd-is-inherited"><a name="isBaseCommandType" class="tsd-anchor"></a><h3>is<wbr/>Base<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#isBaseCommandType">isBaseCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L100">src/commands/base/Command.ts:100</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check base command type</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#BaseCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>base command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isChildCommandType" class="tsd-anchor"></a><h3>is<wbr/>Child<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#isChildCommandType">isChildCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L155">src/commands/base/Command.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isChildCommandType" class="tsd-anchor"></a><h3>is<wbr/>Child<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#isChildCommandType">isChildCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L165">src/commands/base/Command.ts:165</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check child command type</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#ChildCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>child command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as a child command of the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isCommandType" class="tsd-anchor"></a><h3>is<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#isCommandType">isCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L128">src/commands/base/Command.ts:128</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isCommandType" class="tsd-anchor"></a><h3>is<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#isCommandType">isCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L139">src/commands/base/Command.ts:139</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Checks command type</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a name="start" class="tsd-anchor"></a><h3>start</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#start">start</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/SubCommand.ts#L91">src/commands/SubCommand.ts:91</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a name="start" class="tsd-anchor"></a><h3>start</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#start">start</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/SubCommand.ts#L139">src/commands/SubCommand.ts:139</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Invoke the command</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>input: <a href="InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>input data</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ChatCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#toObject">toObject</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/SubCommand.ts#L107">src/commands/SubCommand.ts:107</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="../interfaces/ChatCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandObject</a></h4><div><p>Discord API object</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="SubCommand.html" class="tsd-kind-icon">Sub<wbr/>Command</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="SubCommand.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommand.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommand.html#parameters" class="tsd-kind-icon">parameters</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommand.html#parent" class="tsd-kind-icon">parent</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommand.html#usage" class="tsd-kind-icon">usage</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="SubCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="SubCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="SubCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="SubCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="SubCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ChatCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="PermissionCommand.html">PermissionCommand</a>.<a href="PermissionCommand.html#toObject">toObject</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/SubCommand.ts#L154">src/commands/SubCommand.ts:154</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="../interfaces/ChatCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandObject</a></h4><div><p>Discord API object</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="SubCommand.html" class="tsd-kind-icon">Sub<wbr/>Command</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="SubCommand.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommand.html#aliases" class="tsd-kind-icon">aliases</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommand.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommand.html#parameters" class="tsd-kind-icon">parameters</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommand.html#parent" class="tsd-kind-icon">parent</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommand.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommand.html#usage" class="tsd-kind-icon">usage</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="SubCommand.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="SubCommand.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="SubCommand.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="SubCommand.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="SubCommand.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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>
|
||||
@@ -1,44 +1,44 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SubCommandGroup | 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="SubCommandGroup.html">SubCommandGroup</a></li></ul><h1>Class SubCommandGroup</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>Group of subcommands</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a><ul class="tsd-hierarchy"><li><span class="target">SubCommandGroup</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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="SubCommandGroup.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 tsd-is-private"><a href="SubCommandGroup.html#_children" class="tsd-kind-icon">_children</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommandGroup.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommandGroup.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommandGroup.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommandGroup.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommandGroup.html#parent" class="tsd-kind-icon">parent</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommandGroup.html#type" class="tsd-kind-icon">type</a></li></ul></section><section class="tsd-index-section "><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="SubCommandGroup.html#children" class="tsd-kind-icon">children</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="SubCommandGroup.html#append" class="tsd-kind-icon">append</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="SubCommandGroup.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="SubCommandGroup.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="SubCommandGroup.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="SubCommandGroup.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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 tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Sub<wbr/>Command<wbr/>Group<span class="tsd-signature-symbol">(</span>parent<span class="tsd-signature-symbol">: </span><a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/SubCommandGroupInit.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandGroupInit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SubCommandGroup.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommandGroup</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="Command.html">Command</a>.<a href="Command.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/SubCommandGroup.ts#L42">src/commands/SubCommandGroup.ts:42</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>parent: <a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a><ul class="tsd-hierarchy"><li><span class="target">SubCommandGroup</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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="SubCommandGroup.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 tsd-is-private"><a href="SubCommandGroup.html#_children" class="tsd-kind-icon">_children</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommandGroup.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommandGroup.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommandGroup.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommandGroup.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommandGroup.html#parent" class="tsd-kind-icon">parent</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommandGroup.html#type" class="tsd-kind-icon">type</a></li></ul></section><section class="tsd-index-section "><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="SubCommandGroup.html#children" class="tsd-kind-icon">children</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="SubCommandGroup.html#append" class="tsd-kind-icon">append</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="SubCommandGroup.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="SubCommandGroup.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="SubCommandGroup.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="SubCommandGroup.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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 tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Sub<wbr/>Command<wbr/>Group<span class="tsd-signature-symbol">(</span>parent<span class="tsd-signature-symbol">: </span><a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/SubCommandGroupInit.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandGroupInit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SubCommandGroup.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommandGroup</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="Command.html">Command</a>.<a href="Command.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/SubCommandGroup.ts#L52">src/commands/SubCommandGroup.ts:52</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>parent: <a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>group parent command</p>
|
||||
</div></div></li><li><h5>options: <a href="../interfaces/SubCommandGroupInit.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandGroupInit</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>initialization options</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="SubCommandGroup.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommandGroup</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 tsd-is-private"><a name="_children" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> _children</h3><div class="tsd-signature tsd-kind-icon">_children<span class="tsd-signature-symbol">:</span> <a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/SubCommandGroup.ts#L19">src/commands/SubCommandGroup.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="SubCommandGroup.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommandGroup</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 tsd-is-private"><a name="_children" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> _children</h3><div class="tsd-signature tsd-kind-icon">_children<span class="tsd-signature-symbol">:</span> <a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/SubCommandGroup.ts#L31">src/commands/SubCommandGroup.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Group members (children)</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 tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="Command.html">Command</a>.<a href="Command.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L47">src/commands/base/Command.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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="Command.html">Command</a>.<a href="Command.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L60">src/commands/base/Command.ts:60</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API default_permission</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="description" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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/2867da1/src/commands/SubCommandGroup.ts#L35">src/commands/SubCommandGroup.ts:35</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="description" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</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/5a80551/src/commands/SubCommandGroup.ts#L45">src/commands/SubCommandGroup.ts:45</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Group description (default: "No description")</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 tsd-is-inherited"><a name="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#manager">manager</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L23">src/commands/base/Command.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="manager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> manager</h3><div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="CommandManager.html" class="tsd-signature-type" data-tsd-kind="Class">CommandManager</a></div><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#manager">manager</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L39">src/commands/base/Command.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Manager in which this command is registered</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 tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> 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="Command.html">Command</a>.<a href="Command.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L31">src/commands/base/Command.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> 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="Command.html">Command</a>.<a href="Command.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L46">src/commands/base/Command.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</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="parent" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> parent</h3><div class="tsd-signature tsd-kind-icon">parent<span class="tsd-signature-symbol">:</span> <a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/SubCommandGroup.ts#L27">src/commands/SubCommandGroup.ts:27</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="parent" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> parent</h3><div class="tsd-signature tsd-kind-icon">parent<span class="tsd-signature-symbol">:</span> <a href="ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/SubCommandGroup.ts#L38">src/commands/SubCommandGroup.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Group parent command</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 tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></div><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L39">src/commands/base/Command.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></div><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L53">src/commands/base/Command.ts:53</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>CommandBot's internal command type</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a name="children" class="tsd-anchor"></a><h3>children</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> children<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">readonly </span><a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a><span class="tsd-signature-symbol">[]</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/2867da1/src/commands/SubCommandGroup.ts#L64">src/commands/SubCommandGroup.ts:64</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a name="children" class="tsd-anchor"></a><h3>children</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> children<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">readonly </span><a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a><span class="tsd-signature-symbol">[]</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/commands/SubCommandGroup.ts#L74">src/commands/SubCommandGroup.ts:74</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of subcommands attached to this group</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">readonly </span><a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></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="append" class="tsd-anchor"></a><h3>append</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">append<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/SubCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandInit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</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/2867da1/src/commands/SubCommandGroup.ts#L74">src/commands/SubCommandGroup.ts:74</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">readonly </span><a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></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="append" class="tsd-anchor"></a><h3>append</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">append<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/SubCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandInit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</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/commands/SubCommandGroup.ts#L84">src/commands/SubCommandGroup.ts:84</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Attach a subcommand to this group</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/SubCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandInit</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>subcommand initialization options</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a></h4><div><p>A computed <a href="SubCommand.html">SubCommand</a> object</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isBaseCommandType" class="tsd-anchor"></a><h3>is<wbr/>Base<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#isBaseCommandType">isBaseCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L88">src/commands/base/Command.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isBaseCommandType" class="tsd-anchor"></a><h3>is<wbr/>Base<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#isBaseCommandType">isBaseCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L100">src/commands/base/Command.ts:100</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check base command type</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#BaseCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>base command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#BaseCommands" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isChildCommandType" class="tsd-anchor"></a><h3>is<wbr/>Child<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#isChildCommandType">isChildCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L155">src/commands/base/Command.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isChildCommandType" class="tsd-anchor"></a><h3>is<wbr/>Child<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#isChildCommandType">isChildCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L165">src/commands/base/Command.ts:165</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Check child command type</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#ChildCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>child command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#ChildCommands" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as a child command of the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isCommandType" class="tsd-anchor"></a><h3>is<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#isCommandType">isCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/base/Command.ts#L128">src/commands/base/Command.ts:128</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a name="isCommandType" class="tsd-anchor"></a><h3>is<wbr/>Command<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Command<wbr/>Type<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Command.html">Command</a>.<a href="Command.html#isCommandType">isCommandType</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L139">src/commands/base/Command.ts:139</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Checks command type</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>command type</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol"> is </span><a href="../modules.html#Commands" class="tsd-signature-type" data-tsd-kind="Type alias">Commands</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>Whether this command can be used as the given type</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/SubCommandGroupObject.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandGroupObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="Command.html">Command</a>.<a href="Command.html#toObject">toObject</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/SubCommandGroup.ts#L88">src/commands/SubCommandGroup.ts:88</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="../interfaces/SubCommandGroupObject.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandGroupObject</a></h4><div><p>Discord API object</p>
|
||||
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a name="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/SubCommandGroupObject.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandGroupObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="Command.html">Command</a>.<a href="Command.html#toObject">toObject</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/SubCommandGroup.ts#L97">src/commands/SubCommandGroup.ts:97</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="../interfaces/SubCommandGroupObject.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandGroupObject</a></h4><div><p>Discord API object</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="SubCommandGroup.html" class="tsd-kind-icon">Sub<wbr/>Command<wbr/>Group</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="SubCommandGroup.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="SubCommandGroup.html#_children" class="tsd-kind-icon">_children</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommandGroup.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommandGroup.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommandGroup.html#manager" class="tsd-kind-icon">manager</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommandGroup.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="SubCommandGroup.html#parent" class="tsd-kind-icon">parent</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="SubCommandGroup.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="SubCommandGroup.html#children" class="tsd-kind-icon">children</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SubCommandGroup.html#append" class="tsd-kind-icon">append</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="SubCommandGroup.html#isBaseCommandType" class="tsd-kind-icon">is<wbr/>Base<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="SubCommandGroup.html#isChildCommandType" class="tsd-kind-icon">is<wbr/>Child<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="SubCommandGroup.html#isCommandType" class="tsd-kind-icon">is<wbr/>Command<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="SubCommandGroup.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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>
|
||||
@@ -2,21 +2,21 @@
|
||||
<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't exist)</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>remarks</dt><dd><p>You can'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/2867da1/src/structures/SystemMessage.ts#L159">src/structures/SystemMessage.ts:159</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/2867da1/src/structures/SystemMessage.ts#L134">src/structures/SystemMessage.ts:134</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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/2867da1/src/structures/SystemMessage.ts#L141">src/structures/SystemMessage.ts:141</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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/2867da1/src/structures/SystemMessage.ts#L127">src/structures/SystemMessage.ts:127</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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'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/2867da1/src/structures/SystemMessage.ts#L149">src/structures/SystemMessage.ts:149</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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/2867da1/src/structures/SystemMessage.ts#L121">src/structures/SystemMessage.ts:121</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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/2867da1/src/structures/SystemMessage.ts#L157">src/structures/SystemMessage.ts:157</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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"><</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">></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/2867da1/src/structures/SystemMessage.ts#L208">src/structures/SystemMessage.ts:208</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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"><</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">></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>"ERROR" | "PERMISSION" | "NOT_FOUND" | "SUCCESS"</p>
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>TargetID | 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="TargetID.html">TargetID</a></li></ul><h1>Class TargetID<T></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>Wrapped representation of Discord target object (target of context menu interactions)</p>
|
||||
</div></div></section><section class="tsd-panel tsd-type-parameters"><h3>Type parameters</h3><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#TargetType" class="tsd-signature-type" data-tsd-kind="Type alias">TargetType</a></h4></li></ul></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">TargetID</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 tsd-has-type-parameter"><a href="TargetID.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="TargetID.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TargetID.html#interaction" class="tsd-kind-icon">interaction</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="TargetID.html#type" class="tsd-kind-icon">type</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="TargetID.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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 tsd-has-type-parameter"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">new <wbr/>TargetID<T><span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span>, 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-symbol">: </span><a href="TargetID.html" class="tsd-signature-type" data-tsd-kind="Class">TargetID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></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/2867da1/src/structures/Parameter.ts#L383">src/structures/Parameter.ts:383</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#TargetType" class="tsd-signature-type" data-tsd-kind="Type alias">TargetType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-type-parameters"><h3>Type parameters</h3><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#TargetType" class="tsd-signature-type" data-tsd-kind="Type alias">TargetType</a></h4></li></ul></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">TargetID</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 tsd-has-type-parameter"><a href="TargetID.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="TargetID.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TargetID.html#interaction" class="tsd-kind-icon">interaction</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="TargetID.html#type" class="tsd-kind-icon">type</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="TargetID.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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 tsd-has-type-parameter"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">new <wbr/>TargetID<T><span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span>, 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-symbol">: </span><a href="TargetID.html" class="tsd-signature-type" data-tsd-kind="Class">TargetID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></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/Parameter.ts#L364">src/structures/Parameter.ts:364</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#TargetType" class="tsd-signature-type" data-tsd-kind="Type alias">TargetType</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>object Discord ID</p>
|
||||
</div></div></li><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li><li><h5>interaction: <span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="TargetID.html" class="tsd-signature-type" data-tsd-kind="Class">TargetID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></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="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> id</h3><div class="tsd-signature tsd-kind-icon">id<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/2867da1/src/structures/Parameter.ts#L361">src/structures/Parameter.ts:361</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li><li><h5>interaction: <span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Interaction</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="TargetID.html" class="tsd-signature-type" data-tsd-kind="Class">TargetID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></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="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> id</h3><div class="tsd-signature tsd-kind-icon">id<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/5a80551/src/structures/Parameter.ts#L342">src/structures/Parameter.ts:342</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object ID</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="interaction" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> interaction</h3><div class="tsd-signature tsd-kind-icon">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></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Parameter.ts#L368">src/structures/Parameter.ts:368</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="interaction" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> interaction</h3><div class="tsd-signature tsd-kind-icon">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></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Parameter.ts#L349">src/structures/Parameter.ts:349</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Interaction associated with the target</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 tsd-is-private"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Parameter.ts#L375">src/structures/Parameter.ts:375</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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 tsd-is-private"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Parameter.ts#L356">src/structures/Parameter.ts:356</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Target type</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></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="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#TargetIdReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">TargetIdReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></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/2867da1/src/structures/Parameter.ts#L395">src/structures/Parameter.ts:395</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></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="toObject" class="tsd-anchor"></a><h3>to<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#TargetIdReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">TargetIdReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></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/Parameter.ts#L376">src/structures/Parameter.ts:376</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Uses informations associated with the object to generate a Discord.js representation</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>async</dt><dd></dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#TargetIdReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">TargetIdReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><div><p>A fetched object (or null)</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 tsd-has-type-parameter"><a href="TargetID.html" class="tsd-kind-icon">TargetID</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a href="TargetID.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TargetID.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TargetID.html#interaction" class="tsd-kind-icon">interaction</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="TargetID.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="TargetID.html#toObject" class="tsd-kind-icon">to<wbr/>Object</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>
|
||||
+1
-1
@@ -174,7 +174,7 @@
|
||||
<h2>Subcommands</h2>
|
||||
</a>
|
||||
<p>To create a subcommand create a standard chat command and use <em><a href="https://grz4na.github.io/CommandBot/classes/ChatCommand.html#append">ChatCommand.prototype.append</a></em> method to create and attach subcommands or subcommand groups. To add subcommands to groups use <em><a href="https://grz4na.github.io/CommandBot/classes/SubCommandGroup.html#append">SubCommandGroup.prototype.append</a></em>.</p>
|
||||
<pre><code class="language-typescript"><span class="hl-0">// Create a chat command</span><br/><span class="hl-3">const</span><span class="hl-2"> </span><span class="hl-4">cmd</span><span class="hl-2"> = </span><span class="hl-1">bot</span><span class="hl-2">.</span><span class="hl-1">commands</span><span class="hl-2">.</span><span class="hl-5">add</span><span class="hl-2">(</span><span class="hl-6">"CHAT"</span><span class="hl-2">, {</span><br/><span class="hl-2"> </span><span class="hl-1">name:</span><span class="hl-2"> </span><span class="hl-6">"parent"</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-1">slash:</span><span class="hl-2"> </span><span class="hl-3">true</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-1">description:</span><span class="hl-2"> </span><span class="hl-6">"This is a parent"</span><span class="hl-2">,</span><br/><span class="hl-2">});</span><br/><br/><span class="hl-0">// Create and append a subcommand</span><br/><span class="hl-1">cmd</span><span class="hl-2">.</span><span class="hl-5">append</span><span class="hl-2">(</span><span class="hl-6">"COMMAND"</span><span class="hl-2">, {</span><br/><span class="hl-2"> </span><span class="hl-1">name:</span><span class="hl-2"> </span><span class="hl-6">"child"</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-1">description:</span><span class="hl-2"> </span><span class="hl-6">"This is a subcommand"</span><span class="hl-2">,</span><br/><span class="hl-2">});</span><br/><br/><span class="hl-0">// Create and append a subcommand group</span><br/><span class="hl-3">const</span><span class="hl-2"> </span><span class="hl-4">group</span><span class="hl-2"> = </span><span class="hl-1">cmd</span><span class="hl-2">.</span><span class="hl-5">append</span><span class="hl-2">(</span><span class="hl-6">"GROUP"</span><span class="hl-2">, {</span><br/><span class="hl-2"> </span><span class="hl-1">name:</span><span class="hl-2"> </span><span class="hl-6">"command_group"</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-1">description:</span><span class="hl-2"> </span><span class="hl-6">"This is a subcommand group"</span><span class="hl-2">,</span><br/><span class="hl-2">});</span><br/><br/><span class="hl-0">// Add a subcommand to the group</span><br/><span class="hl-1">group</span><span class="hl-2">.</span><span class="hl-5">append</span><span class="hl-2">({</span><br/><span class="hl-2"> </span><span class="hl-1">name:</span><span class="hl-2"> </span><span class="hl-6">"group_command"</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-1">description:</span><span class="hl-2"> </span><span class="hl-6">"This is a subcommand that is a child of the command_group"</span><span class="hl-2">,</span><br/><span class="hl-2">});</span>
|
||||
<pre><code class="language-typescript"><span class="hl-0">// Create a chat command</span><br/><span class="hl-3">const</span><span class="hl-2"> </span><span class="hl-4">cmd</span><span class="hl-2"> = </span><span class="hl-1">bot</span><span class="hl-2">.</span><span class="hl-1">commands</span><span class="hl-2">.</span><span class="hl-5">add</span><span class="hl-2">(</span><span class="hl-6">"CHAT"</span><span class="hl-2">, {</span><br/><span class="hl-2"> </span><span class="hl-1">name:</span><span class="hl-2"> </span><span class="hl-6">"parent"</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-1">slash:</span><span class="hl-2"> </span><span class="hl-3">true</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-1">description:</span><span class="hl-2"> </span><span class="hl-6">"This is a parent"</span><span class="hl-2">,</span><br/><span class="hl-2">});</span><br/><br/><span class="hl-0">// Create and append a subcommand</span><br/><span class="hl-1">cmd</span><span class="hl-2">.</span><span class="hl-5">append</span><span class="hl-2">(</span><span class="hl-6">"COMMAND"</span><span class="hl-2">, {</span><br/><span class="hl-2"> </span><span class="hl-1">name:</span><span class="hl-2"> </span><span class="hl-6">"child"</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-1">description:</span><span class="hl-2"> </span><span class="hl-6">"This is a subcommand"</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-1">aliases:</span><span class="hl-2"> [</span><span class="hl-6">"ch"</span><span class="hl-2">],</span><br/><span class="hl-2">});</span><br/><br/><span class="hl-0">// Create and append a subcommand group</span><br/><span class="hl-3">const</span><span class="hl-2"> </span><span class="hl-4">group</span><span class="hl-2"> = </span><span class="hl-1">cmd</span><span class="hl-2">.</span><span class="hl-5">append</span><span class="hl-2">(</span><span class="hl-6">"GROUP"</span><span class="hl-2">, {</span><br/><span class="hl-2"> </span><span class="hl-1">name:</span><span class="hl-2"> </span><span class="hl-6">"command_group"</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-1">description:</span><span class="hl-2"> </span><span class="hl-6">"This is a subcommand group"</span><span class="hl-2">,</span><br/><span class="hl-2">});</span><br/><br/><span class="hl-0">// Add a subcommand to the group</span><br/><span class="hl-1">group</span><span class="hl-2">.</span><span class="hl-5">append</span><span class="hl-2">({</span><br/><span class="hl-2"> </span><span class="hl-1">name:</span><span class="hl-2"> </span><span class="hl-6">"group_command"</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-1">description:</span><span class="hl-2"> </span><span class="hl-6">"This is a subcommand that is a child of the command_group"</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-1">aliases:</span><span class="hl-2"> [</span><span class="hl-6">"subch"</span><span class="hl-2">],</span><br/><span class="hl-2">});</span>
|
||||
</code></pre>
|
||||
<p>To invoke subcommands using Discord messages use an <em><a href="https://grz4na.github.io/CommandBot/classes/CommandManager.html#argumentSeparator">argumentSeparator</a></em> (default: "/").</p>
|
||||
<pre><code><span class="hl-2">!</span><span class="hl-1">parent</span><span class="hl-2"> - </span><span class="hl-6">"parent"</span><span class="hl-2"> </span><span class="hl-1">command</span><br/><span class="hl-2">!</span><span class="hl-1">parent</span><span class="hl-2">/</span><span class="hl-1">child</span><span class="hl-2"> - </span><span class="hl-6">"child"</span><span class="hl-2"> </span><span class="hl-1">command</span><br/><span class="hl-2">!</span><span class="hl-1">parent</span><span class="hl-2">/</span><span class="hl-1">command_group</span><span class="hl-2"> - </span><span class="hl-3">this</span><span class="hl-2"> </span><span class="hl-1">will</span><span class="hl-2"> </span><span class="hl-1">invoke</span><span class="hl-2"> </span><span class="hl-1">the</span><span class="hl-2"> </span><span class="hl-6">"parent"</span><span class="hl-2"> </span><span class="hl-1">command</span><br/><span class="hl-2">!</span><span class="hl-1">parent</span><span class="hl-2">/</span><span class="hl-1">command_group</span><span class="hl-2">/</span><span class="hl-1">group_command</span><span class="hl-2"> - </span><span class="hl-6">"group_command"</span><span class="hl-2"> </span><span class="hl-1">command</span><span class="hl-2"> </span><span class="hl-1">which</span><span class="hl-2"> </span><span class="hl-1">is</span><span class="hl-2"> </span><span class="hl-1">a</span><span class="hl-2"> </span><span class="hl-1">parent</span><span class="hl-2"> </span><span class="hl-3">of</span><span class="hl-2"> </span><span class="hl-6">"command_group"</span><span class="hl-2"> </span><span class="hl-1">group</span>
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>APICommandInit | 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="APICommandInit.html">APICommandInit</a></li></ul><h1>Interface APICommandInit</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>Initialization options of core <a href="../classes/Command.html">Command</a> object</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">APICommandInit</span><ul class="tsd-hierarchy"><li><a href="SubCommandGroupInit.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandGroupInit</a></li><li><a href="FunctionCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">FunctionCommandInit</a></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="APICommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="APICommandInit.html#name" class="tsd-kind-icon">name</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="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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/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">
|
||||
</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">APICommandInit</span><ul class="tsd-hierarchy"><li><a href="SubCommandGroupInit.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandGroupInit</a></li><li><a href="FunctionCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">FunctionCommandInit</a></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="APICommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="APICommandInit.html#name" class="tsd-kind-icon">name</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="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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L25">src/commands/base/Command.ts:25</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="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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/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">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L20">src/commands/base/Command.ts:20</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</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="APICommandInit.html" class="tsd-kind-icon">APICommand<wbr/>Init</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="APICommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="APICommandInit.html#name" class="tsd-kind-icon">name</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>
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>APICommandObject | 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="APICommandObject.html">APICommandObject</a></li></ul><h1>Interface APICommandObject</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>Discord base API command object</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">APICommandObject</span><ul class="tsd-hierarchy"><li><a href="ChatCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandObject</a></li><li><a href="ContextMenuCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ContextMenuCommandObject</a></li><li><a href="SubCommandGroupObject.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandGroupObject</a></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="APICommandObject.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="APICommandObject.html#name" class="tsd-kind-icon">name</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="default_permission" class="tsd-anchor"></a><h3>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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/types/api.ts#L24">src/structures/types/api.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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">APICommandObject</span><ul class="tsd-hierarchy"><li><a href="ChatCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandObject</a></li><li><a href="ContextMenuCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ContextMenuCommandObject</a></li><li><a href="SubCommandGroupObject.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandGroupObject</a></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="APICommandObject.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="APICommandObject.html#name" class="tsd-kind-icon">name</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="default_permission" class="tsd-anchor"></a><h3>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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/apiTypes.ts#L23">src/structures/apiTypes.ts:23</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="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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/types/api.ts#L19">src/structures/types/api.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/apiTypes.ts#L18">src/structures/apiTypes.ts:18</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</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="APICommandObject.html" class="tsd-kind-icon">APICommand<wbr/>Object</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="APICommandObject.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="APICommandObject.html#name" class="tsd-kind-icon">name</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>
|
||||
@@ -1,16 +1,16 @@
|
||||
<!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#ephemeral" class="tsd-kind-icon">ephemeral</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/2867da1/src/commands/types/InitOptions.ts#L115">src/commands/types/InitOptions.ts:115</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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#ephemeral" class="tsd-kind-icon">ephemeral</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/5a80551/src/commands/ChatCommand.ts#L29">src/commands/ChatCommand.ts:29</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/2867da1/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">
|
||||
</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/5a80551/src/commands/base/FunctionCommand.ts#L23">src/commands/base/FunctionCommand.ts:23</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/2867da1/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">
|
||||
</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/5a80551/src/commands/base/Command.ts#L25">src/commands/base/Command.ts:25</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/2867da1/src/commands/types/InitOptions.ts#L120">src/commands/types/InitOptions.ts:120</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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/5a80551/src/commands/ChatCommand.ts#L34">src/commands/ChatCommand.ts:34</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/2867da1/src/commands/types/InitOptions.ts#L92">src/commands/types/InitOptions.ts:92</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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/5a80551/src/commands/base/PermissionGuildCommand.ts#L17">src/commands/base/PermissionGuildCommand.ts:17</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="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommandInit.html">PermissionGuildCommandInit</a>.<a href="PermissionGuildCommandInit.html#ephemeral">ephemeral</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/InitOptions.ts#L48">src/commands/types/InitOptions.ts:48</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommandInit.html">PermissionGuildCommandInit</a>.<a href="PermissionGuildCommandInit.html#ephemeral">ephemeral</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L34">src/commands/base/FunctionCommand.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether a reply should be visible only to the caller</p>
|
||||
</div><div><ul>
|
||||
<li>NONE - bot replies are public and visible to everyone in a text channel</li>
|
||||
@@ -18,20 +18,20 @@
|
||||
<li>FULL - INTERACTIONS + responses to prefix interactions will be sent as direct messages to the command caller</li>
|
||||
</ul>
|
||||
<p><a href="https://support.discord.com/hc/pl/articles/1500000580222-Ephemeral-Messages-FAQ">Read more</a></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/2867da1/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">
|
||||
</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/5a80551/src/commands/base/FunctionCommand.ts#L18">src/commands/base/FunctionCommand.ts:18</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/2867da1/src/commands/types/InitOptions.ts#L97">src/commands/types/InitOptions.ts:97</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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/5a80551/src/commands/base/PermissionGuildCommand.ts#L22">src/commands/base/PermissionGuildCommand.ts:22</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/2867da1/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">
|
||||
</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/5a80551/src/commands/base/Command.ts#L20">src/commands/base/Command.ts:20</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">"simple"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"no_input"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/InitOptions.ts#L110">src/commands/types/InitOptions.ts:110</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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">"simple"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"no_input"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/ChatCommand.ts#L24">src/commands/ChatCommand.ts:24</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/2867da1/src/commands/types/InitOptions.ts#L79">src/commands/types/InitOptions.ts:79</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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/5a80551/src/commands/base/PermissionCommand.ts#L19">src/commands/base/PermissionCommand.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object with permissions' 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/2867da1/src/commands/types/InitOptions.ts#L135">src/commands/types/InitOptions.ts:135</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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/5a80551/src/commands/ChatCommand.ts#L49">src/commands/ChatCommand.ts:49</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/2867da1/src/commands/types/InitOptions.ts#L125">src/commands/types/InitOptions.ts:125</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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/5a80551/src/commands/ChatCommand.ts#L39">src/commands/ChatCommand.ts:39</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/2867da1/src/commands/types/InitOptions.ts#L130">src/commands/types/InitOptions.ts:130</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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/5a80551/src/commands/ChatCommand.ts#L44">src/commands/ChatCommand.ts:44</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#ephemeral" class="tsd-kind-icon">ephemeral</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>
|
||||
@@ -1,13 +1,13 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ChatCommandObject | 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="ChatCommandObject.html">ChatCommandObject</a></li></ul><h1>Interface ChatCommandObject</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>Discord CHAT_INPUT command object</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="APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a><ul class="tsd-hierarchy"><li><span class="target">ChatCommandObject</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 tsd-is-inherited"><a href="ChatCommandObject.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandObject.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandObject.html#options" class="tsd-kind-icon">options</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandObject.html#type" class="tsd-kind-icon">type</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 tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3>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="APICommandObject.html">APICommandObject</a>.<a href="APICommandObject.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/types/api.ts#L24">src/structures/types/api.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a><ul class="tsd-hierarchy"><li><span class="target">ChatCommandObject</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 tsd-is-inherited"><a href="ChatCommandObject.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandObject.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandObject.html#options" class="tsd-kind-icon">options</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandObject.html#type" class="tsd-kind-icon">type</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 tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3>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="APICommandObject.html">APICommandObject</a>.<a href="APICommandObject.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/apiTypes.ts#L23">src/structures/apiTypes.ts:23</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>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/2867da1/src/structures/types/api.ts#L42">src/structures/types/api.ts:42</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="description" class="tsd-anchor"></a><h3>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/5a80551/src/structures/apiTypes.ts#L40">src/structures/apiTypes.ts:40</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="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="APICommandObject.html">APICommandObject</a>.<a href="APICommandObject.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/types/api.ts#L19">src/structures/types/api.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="APICommandObject.html">APICommandObject</a>.<a href="APICommandObject.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/apiTypes.ts#L18">src/structures/apiTypes.ts:18</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="options" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> options</h3><div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">?:</span> <a href="ChatCommandOptionObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandOptionObject</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/types/api.ts#L47">src/structures/types/api.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="options" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> options</h3><div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">?:</span> <a href="ChatCommandOptionObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandOptionObject</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/apiTypes.ts#L45">src/structures/apiTypes.ts:45</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command options/parameters</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/types/api.ts#L37">src/structures/types/api.ts:37</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/apiTypes.ts#L35">src/structures/apiTypes.ts:35</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command type (forced to 1)</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="ChatCommandObject.html" class="tsd-kind-icon">Chat<wbr/>Command<wbr/>Object</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandObject.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandObject.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChatCommandObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandObject.html#options" class="tsd-kind-icon">options</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandObject.html#type" class="tsd-kind-icon">type</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>
|
||||
@@ -1,16 +1,16 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ChatCommandOptionObject | 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="ChatCommandOptionObject.html">ChatCommandOptionObject</a></li></ul><h1>Interface ChatCommandOptionObject</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>Discord CHAT_INPUT command option object</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">ChatCommandOptionObject</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="ChatCommandOptionObject.html#choices" class="tsd-kind-icon">choices</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandOptionObject.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandOptionObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandOptionObject.html#options" class="tsd-kind-icon">options</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandOptionObject.html#required" class="tsd-kind-icon">required</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandOptionObject.html#type" class="tsd-kind-icon">type</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="choices" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> choices</h3><div class="tsd-signature tsd-kind-icon">choices<span class="tsd-signature-symbol">?:</span> <a href="TextCommandOptionChoiceObject.html" class="tsd-signature-type" data-tsd-kind="Interface">TextCommandOptionChoiceObject</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/types/api.ts#L81">src/structures/types/api.ts:81</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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">ChatCommandOptionObject</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="ChatCommandOptionObject.html#choices" class="tsd-kind-icon">choices</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandOptionObject.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandOptionObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandOptionObject.html#options" class="tsd-kind-icon">options</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandOptionObject.html#required" class="tsd-kind-icon">required</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandOptionObject.html#type" class="tsd-kind-icon">type</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="choices" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> choices</h3><div class="tsd-signature tsd-kind-icon">choices<span class="tsd-signature-symbol">?:</span> <a href="TextCommandOptionChoiceObject.html" class="tsd-signature-type" data-tsd-kind="Interface">TextCommandOptionChoiceObject</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/apiTypes.ts#L78">src/structures/apiTypes.ts:78</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of command option choices</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>remarks</dt><dd><p><a href="ChatCommandOptionObject.html#type">type</a> must be set to <em>3</em> in order to implement choices</p>
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="description" class="tsd-anchor"></a><h3>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/2867da1/src/structures/types/api.ts#L64">src/structures/types/api.ts:64</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="description" class="tsd-anchor"></a><h3>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/5a80551/src/structures/apiTypes.ts#L61">src/structures/apiTypes.ts:61</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter description</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/types/api.ts#L59">src/structures/types/api.ts:59</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/apiTypes.ts#L56">src/structures/apiTypes.ts:56</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter name</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="options" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> options</h3><div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">?:</span> <a href="ChatCommandOptionObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandOptionObject</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/types/api.ts#L86">src/structures/types/api.ts:86</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="options" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> options</h3><div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">?:</span> <a href="ChatCommandOptionObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandOptionObject</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/apiTypes.ts#L83">src/structures/apiTypes.ts:83</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord nested options/parameters</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="required" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> required</h3><div class="tsd-signature tsd-kind-icon">required<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/2867da1/src/structures/types/api.ts#L74">src/structures/types/api.ts:74</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="required" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> required</h3><div class="tsd-signature tsd-kind-icon">required<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/5a80551/src/structures/apiTypes.ts#L71">src/structures/apiTypes.ts:71</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether this parameter is required to complete the request (command)\</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#ChatCommandOptionType" class="tsd-signature-type" data-tsd-kind="Type alias">ChatCommandOptionType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/types/api.ts#L69">src/structures/types/api.ts:69</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#ChatCommandOptionType" class="tsd-signature-type" data-tsd-kind="Type alias">ChatCommandOptionType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/apiTypes.ts#L66">src/structures/apiTypes.ts:66</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter type</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="ChatCommandOptionObject.html" class="tsd-kind-icon">Chat<wbr/>Command<wbr/>Option<wbr/>Object</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandOptionObject.html#choices" class="tsd-kind-icon">choices</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandOptionObject.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandOptionObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandOptionObject.html#options" class="tsd-kind-icon">options</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandOptionObject.html#required" class="tsd-kind-icon">required</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChatCommandOptionObject.html#type" class="tsd-kind-icon">type</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>
|
||||
@@ -1,3 +1,3 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>CommandPermission | 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="CommandPermission.html">CommandPermission</a></li></ul><h1>Interface CommandPermission</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>Discord permissions object</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">CommandPermission</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="CommandPermission.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CommandPermission.html#permission" class="tsd-kind-icon">permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CommandPermission.html#type" class="tsd-kind-icon">type</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="id" class="tsd-anchor"></a><h3>id</h3><div class="tsd-signature tsd-kind-icon">id<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/2867da1/src/structures/types/api.ts#L153">src/structures/types/api.ts:153</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="permission" class="tsd-anchor"></a><h3>permission</h3><div class="tsd-signature tsd-kind-icon">permission<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/2867da1/src/structures/types/api.ts#L155">src/structures/types/api.ts:155</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandPermissionType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandPermissionType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/types/api.ts#L154">src/structures/types/api.ts:154</a></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="CommandPermission.html" class="tsd-kind-icon">Command<wbr/>Permission</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CommandPermission.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CommandPermission.html#permission" class="tsd-kind-icon">permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CommandPermission.html#type" class="tsd-kind-icon">type</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>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">CommandPermission</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="CommandPermission.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CommandPermission.html#permission" class="tsd-kind-icon">permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CommandPermission.html#type" class="tsd-kind-icon">type</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="id" class="tsd-anchor"></a><h3>id</h3><div class="tsd-signature tsd-kind-icon">id<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/5a80551/src/structures/apiTypes.ts#L137">src/structures/apiTypes.ts:137</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="permission" class="tsd-anchor"></a><h3>permission</h3><div class="tsd-signature tsd-kind-icon">permission<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/5a80551/src/structures/apiTypes.ts#L139">src/structures/apiTypes.ts:139</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CommandPermissionType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandPermissionType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/apiTypes.ts#L138">src/structures/apiTypes.ts:138</a></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="CommandPermission.html" class="tsd-kind-icon">Command<wbr/>Permission</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CommandPermission.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CommandPermission.html#permission" class="tsd-kind-icon">permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CommandPermission.html#type" class="tsd-kind-icon">type</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>
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>CommandPermissionsInit | 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="CommandPermissionsInit.html">CommandPermissionsInit</a></li></ul><h1>Interface CommandPermissionsInit</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>Command permissions initialization object</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">CommandPermissionsInit</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="CommandPermissionsInit.html#checkType" class="tsd-kind-icon">check<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CommandPermissionsInit.html#resolvable" class="tsd-kind-icon">resolvable</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="checkType" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> check<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">check<wbr/>Type<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#PermissionCheckTypes" class="tsd-signature-type" data-tsd-kind="Type alias">PermissionCheckTypes</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/permissions.ts#L33">src/commands/types/permissions.ts:33</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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">CommandPermissionsInit</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="CommandPermissionsInit.html#checkType" class="tsd-kind-icon">check<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CommandPermissionsInit.html#resolvable" class="tsd-kind-icon">resolvable</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="checkType" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> check<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">check<wbr/>Type<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#PermissionCheckTypes" class="tsd-signature-type" data-tsd-kind="Type alias">PermissionCheckTypes</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/CommandPermissions.ts#L32">src/structures/CommandPermissions.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether to check if the caller has all defined permissions or at least one of them (applies only if the command uses Discord.js permission system)</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="resolvable" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> resolvable</h3><div class="tsd-signature tsd-kind-icon">resolvable<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">PermissionResolvable</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#PermissionFunction" class="tsd-signature-type" data-tsd-kind="Type alias">PermissionFunction</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/permissions.ts#L28">src/commands/types/permissions.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="resolvable" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> resolvable</h3><div class="tsd-signature tsd-kind-icon">resolvable<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">PermissionResolvable</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#PermissionFunction" class="tsd-signature-type" data-tsd-kind="Type alias">PermissionFunction</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/CommandPermissions.ts#L27">src/structures/CommandPermissions.ts:27</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Resolvable (Discord.js permission resolvables) or custom function that returns <em>boolean</em> value</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="CommandPermissionsInit.html" class="tsd-kind-icon">Command<wbr/>Permissions<wbr/>Init</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CommandPermissionsInit.html#checkType" class="tsd-kind-icon">check<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CommandPermissionsInit.html#resolvable" class="tsd-kind-icon">resolvable</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>
|
||||
@@ -1,14 +1,14 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ContextMenuCommandInit | 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="ContextMenuCommandInit.html">ContextMenuCommandInit</a></li></ul><h1>Interface ContextMenuCommandInit</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>Initialization options of context menu interactions</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">ContextMenuCommandInit</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 tsd-is-inherited"><a href="ContextMenuCommandInit.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ContextMenuCommandInit.html#contextType" class="tsd-kind-icon">context<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#permissions" class="tsd-kind-icon">permissions</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 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/2867da1/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">
|
||||
</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">ContextMenuCommandInit</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 tsd-is-inherited"><a href="ContextMenuCommandInit.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ContextMenuCommandInit.html#contextType" class="tsd-kind-icon">context<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#permissions" class="tsd-kind-icon">permissions</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 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/5a80551/src/commands/base/FunctionCommand.ts#L23">src/commands/base/FunctionCommand.ts:23</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"><a name="contextType" class="tsd-anchor"></a><h3>context<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">context<wbr/>Type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#ContextType" class="tsd-signature-type" data-tsd-kind="Type alias">ContextType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/InitOptions.ts#L148">src/commands/types/InitOptions.ts:148</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="contextType" class="tsd-anchor"></a><h3>context<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">context<wbr/>Type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#ContextType" class="tsd-signature-type" data-tsd-kind="Type alias">ContextType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/ContextMenuCommand.ts#L16">src/commands/ContextMenuCommand.ts:16</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Context menu target type</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/2867da1/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">
|
||||
</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/5a80551/src/commands/base/Command.ts#L25">src/commands/base/Command.ts:25</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 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/2867da1/src/commands/types/InitOptions.ts#L92">src/commands/types/InitOptions.ts:92</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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/5a80551/src/commands/base/PermissionGuildCommand.ts#L17">src/commands/base/PermissionGuildCommand.ts:17</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="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommandInit.html">PermissionGuildCommandInit</a>.<a href="PermissionGuildCommandInit.html#ephemeral">ephemeral</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/InitOptions.ts#L48">src/commands/types/InitOptions.ts:48</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionGuildCommandInit.html">PermissionGuildCommandInit</a>.<a href="PermissionGuildCommandInit.html#ephemeral">ephemeral</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L34">src/commands/base/FunctionCommand.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether a reply should be visible only to the caller</p>
|
||||
</div><div><ul>
|
||||
<li>NONE - bot replies are public and visible to everyone in a text channel</li>
|
||||
@@ -16,12 +16,12 @@
|
||||
<li>FULL - INTERACTIONS + responses to prefix interactions will be sent as direct messages to the command caller</li>
|
||||
</ul>
|
||||
<p><a href="https://support.discord.com/hc/pl/articles/1500000580222-Ephemeral-Messages-FAQ">Read more</a></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/2867da1/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">
|
||||
</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/5a80551/src/commands/base/FunctionCommand.ts#L18">src/commands/base/FunctionCommand.ts:18</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/2867da1/src/commands/types/InitOptions.ts#L97">src/commands/types/InitOptions.ts:97</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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/5a80551/src/commands/base/PermissionGuildCommand.ts#L22">src/commands/base/PermissionGuildCommand.ts:22</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/2867da1/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">
|
||||
</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/5a80551/src/commands/base/Command.ts#L20">src/commands/base/Command.ts:20</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 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/2867da1/src/commands/types/InitOptions.ts#L79">src/commands/types/InitOptions.ts:79</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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/5a80551/src/commands/base/PermissionCommand.ts#L19">src/commands/base/PermissionCommand.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object with permissions' options and resolvables</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="ContextMenuCommandInit.html" class="tsd-kind-icon">Context<wbr/>Menu<wbr/>Command<wbr/>Init</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#announceSuccess" class="tsd-kind-icon">announce<wbr/>Success</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ContextMenuCommandInit.html#contextType" class="tsd-kind-icon">context<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandInit.html#permissions" class="tsd-kind-icon">permissions</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>
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ContextMenuCommandObject | 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="ContextMenuCommandObject.html">ContextMenuCommandObject</a></li></ul><h1>Interface ContextMenuCommandObject</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>Context menu command object</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="APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a><ul class="tsd-hierarchy"><li><span class="target">ContextMenuCommandObject</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 tsd-is-inherited"><a href="ContextMenuCommandObject.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ContextMenuCommandObject.html#type" class="tsd-kind-icon">type</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 tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3>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="APICommandObject.html">APICommandObject</a>.<a href="APICommandObject.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/types/api.ts#L24">src/structures/types/api.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a><ul class="tsd-hierarchy"><li><span class="target">ContextMenuCommandObject</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 tsd-is-inherited"><a href="ContextMenuCommandObject.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ContextMenuCommandObject.html#type" class="tsd-kind-icon">type</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 tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3>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="APICommandObject.html">APICommandObject</a>.<a href="APICommandObject.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/apiTypes.ts#L23">src/structures/apiTypes.ts:23</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 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="APICommandObject.html">APICommandObject</a>.<a href="APICommandObject.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/types/api.ts#L19">src/structures/types/api.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="APICommandObject.html">APICommandObject</a>.<a href="APICommandObject.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/apiTypes.ts#L18">src/structures/apiTypes.ts:18</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="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">2</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/types/api.ts#L110">src/structures/types/api.ts:110</a></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="ContextMenuCommandObject.html" class="tsd-kind-icon">Context<wbr/>Menu<wbr/>Command<wbr/>Object</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandObject.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ContextMenuCommandObject.html#type" class="tsd-kind-icon">type</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>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">2</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/apiTypes.ts#L104">src/structures/apiTypes.ts:104</a></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="ContextMenuCommandObject.html" class="tsd-kind-icon">Context<wbr/>Menu<wbr/>Command<wbr/>Object</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandObject.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ContextMenuCommandObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ContextMenuCommandObject.html#type" class="tsd-kind-icon">type</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>
|
||||
@@ -1,10 +1,10 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>FunctionCommandInit | 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="FunctionCommandInit.html">FunctionCommandInit</a></li></ul><h1>Interface FunctionCommandInit</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>Initialization options of base executable 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="APICommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandInit</a><ul class="tsd-hierarchy"><li><span class="target">FunctionCommandInit</span><ul class="tsd-hierarchy"><li><a href="GuildCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">GuildCommandInit</a></li><li><a href="PermissionCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">PermissionCommandInit</a></li></ul></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="FunctionCommandInit.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="FunctionCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="FunctionCommandInit.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="FunctionCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="FunctionCommandInit.html#name" class="tsd-kind-icon">name</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="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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/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">
|
||||
</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="APICommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandInit</a><ul class="tsd-hierarchy"><li><span class="target">FunctionCommandInit</span><ul class="tsd-hierarchy"><li><a href="GuildCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">GuildCommandInit</a></li><li><a href="PermissionCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">PermissionCommandInit</a></li></ul></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="FunctionCommandInit.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="FunctionCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="FunctionCommandInit.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="FunctionCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="FunctionCommandInit.html#name" class="tsd-kind-icon">name</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="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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L23">src/commands/base/FunctionCommand.ts:23</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="APICommandInit.html">APICommandInit</a>.<a href="APICommandInit.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/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">
|
||||
</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="APICommandInit.html">APICommandInit</a>.<a href="APICommandInit.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L25">src/commands/base/Command.ts:25</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="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/InitOptions.ts#L48">src/commands/types/InitOptions.ts:48</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L34">src/commands/base/FunctionCommand.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether a reply should be visible only to the caller</p>
|
||||
</div><div><ul>
|
||||
<li>NONE - bot replies are public and visible to everyone in a text channel</li>
|
||||
@@ -12,8 +12,8 @@
|
||||
<li>FULL - INTERACTIONS + responses to prefix interactions will be sent as direct messages to the command caller</li>
|
||||
</ul>
|
||||
<p><a href="https://support.discord.com/hc/pl/articles/1500000580222-Ephemeral-Messages-FAQ">Read more</a></p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/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">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L18">src/commands/base/FunctionCommand.ts:18</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="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="APICommandInit.html">APICommandInit</a>.<a href="APICommandInit.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/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">
|
||||
</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="APICommandInit.html">APICommandInit</a>.<a href="APICommandInit.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L20">src/commands/base/Command.ts:20</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</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="FunctionCommandInit.html" class="tsd-kind-icon">Function<wbr/>Command<wbr/>Init</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="FunctionCommandInit.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="FunctionCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="FunctionCommandInit.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="FunctionCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="FunctionCommandInit.html#name" class="tsd-kind-icon">name</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>
|
||||
@@ -1,12 +1,12 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>GuildCommandInit | 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="GuildCommandInit.html">GuildCommandInit</a></li></ul><h1>Interface GuildCommandInit</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>Initialization options of base guild-scoped 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="FunctionCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">FunctionCommandInit</a><ul class="tsd-hierarchy"><li><span class="target">GuildCommandInit</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 tsd-is-inherited"><a href="GuildCommandInit.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="GuildCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GuildCommandInit.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="GuildCommandInit.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="GuildCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GuildCommandInit.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="GuildCommandInit.html#name" class="tsd-kind-icon">name</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 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="FunctionCommandInit.html">FunctionCommandInit</a>.<a href="FunctionCommandInit.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/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">
|
||||
</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="FunctionCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">FunctionCommandInit</a><ul class="tsd-hierarchy"><li><span class="target">GuildCommandInit</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 tsd-is-inherited"><a href="GuildCommandInit.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="GuildCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GuildCommandInit.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="GuildCommandInit.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="GuildCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GuildCommandInit.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="GuildCommandInit.html#name" class="tsd-kind-icon">name</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 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="FunctionCommandInit.html">FunctionCommandInit</a>.<a href="FunctionCommandInit.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L23">src/commands/base/FunctionCommand.ts:23</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="FunctionCommandInit.html">FunctionCommandInit</a>.<a href="FunctionCommandInit.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/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">
|
||||
</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="FunctionCommandInit.html">FunctionCommandInit</a>.<a href="FunctionCommandInit.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L25">src/commands/base/Command.ts:25</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="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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/InitOptions.ts#L61">src/commands/types/InitOptions.ts:61</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/GuildCommand.ts#L16">src/commands/base/GuildCommand.ts:16</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="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommandInit.html">FunctionCommandInit</a>.<a href="FunctionCommandInit.html#ephemeral">ephemeral</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/InitOptions.ts#L48">src/commands/types/InitOptions.ts:48</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommandInit.html">FunctionCommandInit</a>.<a href="FunctionCommandInit.html#ephemeral">ephemeral</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L34">src/commands/base/FunctionCommand.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether a reply should be visible only to the caller</p>
|
||||
</div><div><ul>
|
||||
<li>NONE - bot replies are public and visible to everyone in a text channel</li>
|
||||
@@ -14,10 +14,10 @@
|
||||
<li>FULL - INTERACTIONS + responses to prefix interactions will be sent as direct messages to the command caller</li>
|
||||
</ul>
|
||||
<p><a href="https://support.discord.com/hc/pl/articles/1500000580222-Ephemeral-Messages-FAQ">Read more</a></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="FunctionCommandInit.html">FunctionCommandInit</a>.<a href="FunctionCommandInit.html#function">function</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/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">
|
||||
</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="FunctionCommandInit.html">FunctionCommandInit</a>.<a href="FunctionCommandInit.html#function">function</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L18">src/commands/base/FunctionCommand.ts:18</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"><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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/InitOptions.ts#L66">src/commands/types/InitOptions.ts:66</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/GuildCommand.ts#L21">src/commands/base/GuildCommand.ts:21</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="FunctionCommandInit.html">FunctionCommandInit</a>.<a href="FunctionCommandInit.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/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">
|
||||
</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="FunctionCommandInit.html">FunctionCommandInit</a>.<a href="FunctionCommandInit.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L20">src/commands/base/Command.ts:20</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</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="GuildCommandInit.html" class="tsd-kind-icon">Guild<wbr/>Command<wbr/>Init</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="GuildCommandInit.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="GuildCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GuildCommandInit.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="GuildCommandInit.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="GuildCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GuildCommandInit.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="GuildCommandInit.html#name" class="tsd-kind-icon">name</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>
|
||||
@@ -1,19 +1,19 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>HelpMessageParams | 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="HelpMessageParams.html">HelpMessageParams</a></li></ul><h1>Interface HelpMessageParams</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>All properties used to customize the appearance of a help 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">HelpMessageParams</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="HelpMessageParams.html#bottomText" class="tsd-kind-icon">bottom<wbr/>Text</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#color" class="tsd-kind-icon">color</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#enabled" class="tsd-kind-icon">enabled</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#title" class="tsd-kind-icon">title</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#usage" class="tsd-kind-icon">usage</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.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="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/2867da1/src/commands/Help.ts#L29">src/commands/Help.ts:29</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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">HelpMessageParams</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="HelpMessageParams.html#bottomText" class="tsd-kind-icon">bottom<wbr/>Text</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#color" class="tsd-kind-icon">color</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#enabled" class="tsd-kind-icon">enabled</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#title" class="tsd-kind-icon">title</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#usage" class="tsd-kind-icon">usage</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.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="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/5a80551/src/commands/Help.ts#L27">src/commands/Help.ts:27</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="color" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> color</h3><div class="tsd-signature tsd-kind-icon">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/2867da1/src/commands/Help.ts#L35">src/commands/Help.ts:35</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="color" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> color</h3><div class="tsd-signature tsd-kind-icon">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/5a80551/src/commands/Help.ts#L32">src/commands/Help.ts:32</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="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/2867da1/src/commands/Help.ts#L41">src/commands/Help.ts:41</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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/5a80551/src/commands/Help.ts#L37">src/commands/Help.ts:37</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Description of the "help" command</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/2867da1/src/commands/Help.ts#L17">src/commands/Help.ts:17</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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/5a80551/src/commands/Help.ts#L17">src/commands/Help.ts:17</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether help message is enabled</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/Help.ts#L59">src/commands/Help.ts:59</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/Help.ts#L52">src/commands/Help.ts:52</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether the response message should be ephemeral</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/2867da1/src/commands/Help.ts#L23">src/commands/Help.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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/5a80551/src/commands/Help.ts#L22">src/commands/Help.ts:22</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Title field</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/2867da1/src/commands/Help.ts#L47">src/commands/Help.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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/5a80551/src/commands/Help.ts#L42">src/commands/Help.ts:42</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Usage of the "help" command</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/2867da1/src/commands/Help.ts#L53">src/commands/Help.ts:53</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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/5a80551/src/commands/Help.ts#L47">src/commands/Help.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether the "help" command should be 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="HelpMessageParams.html" class="tsd-kind-icon">Help<wbr/>Message<wbr/>Params</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#bottomText" class="tsd-kind-icon">bottom<wbr/>Text</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#color" class="tsd-kind-icon">color</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#enabled" class="tsd-kind-icon">enabled</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#title" class="tsd-kind-icon">title</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.html#usage" class="tsd-kind-icon">usage</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="HelpMessageParams.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>
|
||||
@@ -1,20 +1,20 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>InitOptions | 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="InitOptions.html">InitOptions</a></li></ul><h1>Interface InitOptions</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>Main object initialization options</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">InitOptions</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="InitOptions.html#applicationId" class="tsd-kind-icon">application<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#argumentSeparator" class="tsd-kind-icon">argument<wbr/>Separator</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#clientOptions" class="tsd-kind-icon">client<wbr/>Options</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#commandSeparator" class="tsd-kind-icon">command<wbr/>Separator</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#globalPrefix" class="tsd-kind-icon">global<wbr/>Prefix</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#help" class="tsd-kind-icon">help</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#token" class="tsd-kind-icon">token</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="applicationId" class="tsd-anchor"></a><h3>application<wbr/>Id</h3><div class="tsd-signature tsd-kind-icon">application<wbr/>Id<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/2867da1/src/structures/Bot.ts#L65">src/structures/Bot.ts:65</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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">InitOptions</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="InitOptions.html#applicationId" class="tsd-kind-icon">application<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#argumentSeparator" class="tsd-kind-icon">argument<wbr/>Separator</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#clientOptions" class="tsd-kind-icon">client<wbr/>Options</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#commandSeparator" class="tsd-kind-icon">command<wbr/>Separator</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#globalPrefix" class="tsd-kind-icon">global<wbr/>Prefix</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#help" class="tsd-kind-icon">help</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#token" class="tsd-kind-icon">token</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="applicationId" class="tsd-anchor"></a><h3>application<wbr/>Id</h3><div class="tsd-signature tsd-kind-icon">application<wbr/>Id<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/5a80551/src/structures/Bot.ts#L58">src/structures/Bot.ts:58</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord API application ID</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="argumentSeparator" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> argument<wbr/>Separator</h3><div class="tsd-signature tsd-kind-icon">argument<wbr/>Separator<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/2867da1/src/structures/Bot.ts#L35">src/structures/Bot.ts:35</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="argumentSeparator" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> argument<wbr/>Separator</h3><div class="tsd-signature tsd-kind-icon">argument<wbr/>Separator<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/5a80551/src/structures/Bot.ts#L33">src/structures/Bot.ts:33</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Separator used to split user input to a list of <a href="../classes/InputParameter.html">InputParameter</a>s (applies to prefix interactions)</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="clientOptions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> client<wbr/>Options</h3><div class="tsd-signature tsd-kind-icon">client<wbr/>Options<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ClientOptions</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Bot.ts#L47">src/structures/Bot.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="clientOptions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> client<wbr/>Options</h3><div class="tsd-signature tsd-kind-icon">client<wbr/>Options<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ClientOptions</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Bot.ts#L43">src/structures/Bot.ts:43</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Additional <a href="https://discord.js.org/#/docs/main/stable/typedef/ClientOptions">ClientOptions</a> for Discord.js <a href="https://discord.js.org/#/docs/main/stable/class/Client">Client</a> object</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="commandSeparator" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> command<wbr/>Separator</h3><div class="tsd-signature tsd-kind-icon">command<wbr/>Separator<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/2867da1/src/structures/Bot.ts#L41">src/structures/Bot.ts:41</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="commandSeparator" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> command<wbr/>Separator</h3><div class="tsd-signature tsd-kind-icon">command<wbr/>Separator<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/5a80551/src/structures/Bot.ts#L38">src/structures/Bot.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Separator used to split subcommands when using prefix interactions</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="globalPrefix" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> global<wbr/>Prefix</h3><div class="tsd-signature tsd-kind-icon">global<wbr/>Prefix<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/2867da1/src/structures/Bot.ts#L29">src/structures/Bot.ts:29</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="globalPrefix" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> global<wbr/>Prefix</h3><div class="tsd-signature tsd-kind-icon">global<wbr/>Prefix<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/5a80551/src/structures/Bot.ts#L28">src/structures/Bot.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Prefix used as a way to trigger the bot using messages in all guilds by default</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>remarks</dt><dd><p>If <em>undefined</em>, you can only interact with bot using slash commands or context menus</p>
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="help" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> help</h3><div class="tsd-signature tsd-kind-icon">help<span class="tsd-signature-symbol">?:</span> <a href="HelpMessageParams.html" class="tsd-signature-type" data-tsd-kind="Interface">HelpMessageParams</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Bot.ts#L53">src/structures/Bot.ts:53</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="help" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> help</h3><div class="tsd-signature tsd-kind-icon">help<span class="tsd-signature-symbol">?:</span> <a href="HelpMessageParams.html" class="tsd-signature-type" data-tsd-kind="Interface">HelpMessageParams</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Bot.ts#L48">src/structures/Bot.ts:48</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Help message appearance configuration</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Bot.ts#L21">src/structures/Bot.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Bot.ts#L21">src/structures/Bot.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Bot name</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="token" class="tsd-anchor"></a><h3>token</h3><div class="tsd-signature tsd-kind-icon">token<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/2867da1/src/structures/Bot.ts#L59">src/structures/Bot.ts:59</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="token" class="tsd-anchor"></a><h3>token</h3><div class="tsd-signature tsd-kind-icon">token<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/5a80551/src/structures/Bot.ts#L53">src/structures/Bot.ts:53</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord bot token</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="InitOptions.html" class="tsd-kind-icon">Init<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#applicationId" class="tsd-kind-icon">application<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#argumentSeparator" class="tsd-kind-icon">argument<wbr/>Separator</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#clientOptions" class="tsd-kind-icon">client<wbr/>Options</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#commandSeparator" class="tsd-kind-icon">command<wbr/>Separator</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#globalPrefix" class="tsd-kind-icon">global<wbr/>Prefix</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#help" class="tsd-kind-icon">help</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InitOptions.html#token" class="tsd-kind-icon">token</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>
|
||||
@@ -1,14 +1,14 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ParameterSchema | 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="ParameterSchema.html">ParameterSchema</a></li></ul><h1>Interface ParameterSchema</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>Properties required to build a <a href="../classes/Parameter.html">Parameter</a> object</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">ParameterSchema</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="ParameterSchema.html#choices" class="tsd-kind-icon">choices</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ParameterSchema.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ParameterSchema.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ParameterSchema.html#optional" class="tsd-kind-icon">optional</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ParameterSchema.html#type" class="tsd-kind-icon">type</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="choices" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> choices</h3><div class="tsd-signature tsd-kind-icon">choices<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/2867da1/src/structures/Parameter.ts#L74">src/structures/Parameter.ts:74</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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">ParameterSchema</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="ParameterSchema.html#choices" class="tsd-kind-icon">choices</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ParameterSchema.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ParameterSchema.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ParameterSchema.html#optional" class="tsd-kind-icon">optional</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ParameterSchema.html#type" class="tsd-kind-icon">type</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="choices" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> choices</h3><div class="tsd-signature tsd-kind-icon">choices<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/5a80551/src/structures/Parameter.ts#L67">src/structures/Parameter.ts:67</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>List of value choices</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>remarks</dt><dd><p>Available only when type is set to "string"</p>
|
||||
</dd></dl></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/2867da1/src/structures/Parameter.ts#L55">src/structures/Parameter.ts:55</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</dd></dl></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/5a80551/src/structures/Parameter.ts#L51">src/structures/Parameter.ts:51</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter description</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Parameter.ts#L49">src/structures/Parameter.ts:49</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Parameter.ts#L46">src/structures/Parameter.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter name</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="optional" class="tsd-anchor"></a><h3>optional</h3><div class="tsd-signature tsd-kind-icon">optional<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/2867da1/src/structures/Parameter.ts#L61">src/structures/Parameter.ts:61</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="optional" class="tsd-anchor"></a><h3>optional</h3><div class="tsd-signature tsd-kind-icon">optional<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/5a80551/src/structures/Parameter.ts#L56">src/structures/Parameter.ts:56</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether this parameter is optional</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#ParameterType" class="tsd-signature-type" data-tsd-kind="Type alias">ParameterType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Parameter.ts#L67">src/structures/Parameter.ts:67</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#ParameterType" class="tsd-signature-type" data-tsd-kind="Type alias">ParameterType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Parameter.ts#L61">src/structures/Parameter.ts:61</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Type of parameter data</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="ParameterSchema.html" class="tsd-kind-icon">Parameter<wbr/>Schema</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ParameterSchema.html#choices" class="tsd-kind-icon">choices</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ParameterSchema.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ParameterSchema.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ParameterSchema.html#optional" class="tsd-kind-icon">optional</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ParameterSchema.html#type" class="tsd-kind-icon">type</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>
|
||||
@@ -1,10 +1,10 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>PermissionCommandInit | 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="PermissionCommandInit.html">PermissionCommandInit</a></li></ul><h1>Interface PermissionCommandInit</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>Initialization options of base command with attached permissions</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="FunctionCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">FunctionCommandInit</a><ul class="tsd-hierarchy"><li><span class="target">PermissionCommandInit</span><ul class="tsd-hierarchy"><li><a href="SubCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandInit</a></li><li><a href="PermissionGuildCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">PermissionGuildCommandInit</a></li></ul></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 tsd-is-inherited"><a href="PermissionCommandInit.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="PermissionCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionCommandInit.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionCommandInit.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PermissionCommandInit.html#permissions" class="tsd-kind-icon">permissions</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 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="FunctionCommandInit.html">FunctionCommandInit</a>.<a href="FunctionCommandInit.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/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">
|
||||
</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="FunctionCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">FunctionCommandInit</a><ul class="tsd-hierarchy"><li><span class="target">PermissionCommandInit</span><ul class="tsd-hierarchy"><li><a href="SubCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandInit</a></li><li><a href="PermissionGuildCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">PermissionGuildCommandInit</a></li></ul></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 tsd-is-inherited"><a href="PermissionCommandInit.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="PermissionCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionCommandInit.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionCommandInit.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PermissionCommandInit.html#permissions" class="tsd-kind-icon">permissions</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 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="FunctionCommandInit.html">FunctionCommandInit</a>.<a href="FunctionCommandInit.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L23">src/commands/base/FunctionCommand.ts:23</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="FunctionCommandInit.html">FunctionCommandInit</a>.<a href="FunctionCommandInit.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/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">
|
||||
</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="FunctionCommandInit.html">FunctionCommandInit</a>.<a href="FunctionCommandInit.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L25">src/commands/base/Command.ts:25</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 tsd-is-inherited"><a name="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommandInit.html">FunctionCommandInit</a>.<a href="FunctionCommandInit.html#ephemeral">ephemeral</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/InitOptions.ts#L48">src/commands/types/InitOptions.ts:48</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><p>Inherited from <a href="FunctionCommandInit.html">FunctionCommandInit</a>.<a href="FunctionCommandInit.html#ephemeral">ephemeral</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L34">src/commands/base/FunctionCommand.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether a reply should be visible only to the caller</p>
|
||||
</div><div><ul>
|
||||
<li>NONE - bot replies are public and visible to everyone in a text channel</li>
|
||||
@@ -12,10 +12,10 @@
|
||||
<li>FULL - INTERACTIONS + responses to prefix interactions will be sent as direct messages to the command caller</li>
|
||||
</ul>
|
||||
<p><a href="https://support.discord.com/hc/pl/articles/1500000580222-Ephemeral-Messages-FAQ">Read more</a></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="FunctionCommandInit.html">FunctionCommandInit</a>.<a href="FunctionCommandInit.html#function">function</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/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">
|
||||
</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="FunctionCommandInit.html">FunctionCommandInit</a>.<a href="FunctionCommandInit.html#function">function</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L18">src/commands/base/FunctionCommand.ts:18</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="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="FunctionCommandInit.html">FunctionCommandInit</a>.<a href="FunctionCommandInit.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/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">
|
||||
</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="FunctionCommandInit.html">FunctionCommandInit</a>.<a href="FunctionCommandInit.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L20">src/commands/base/Command.ts:20</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="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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/InitOptions.ts#L79">src/commands/types/InitOptions.ts:79</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/PermissionCommand.ts#L19">src/commands/base/PermissionCommand.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object with permissions' options and resolvables</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="PermissionCommandInit.html" class="tsd-kind-icon">Permission<wbr/>Command<wbr/>Init</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionCommandInit.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="PermissionCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionCommandInit.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionCommandInit.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PermissionCommandInit.html#permissions" class="tsd-kind-icon">permissions</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>
|
||||
@@ -1,12 +1,12 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>PermissionGuildCommandInit | 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="PermissionGuildCommandInit.html">PermissionGuildCommandInit</a></li></ul><h1>Interface PermissionGuildCommandInit</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>Initialization options of base guild-scoped command with attached permisisions</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="PermissionCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">PermissionCommandInit</a><ul class="tsd-hierarchy"><li><span class="target">PermissionGuildCommandInit</span><ul class="tsd-hierarchy"><li><a href="ChatCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandInit</a></li><li><a href="ContextMenuCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">ContextMenuCommandInit</a></li></ul></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 tsd-is-inherited"><a href="PermissionGuildCommandInit.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="PermissionGuildCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PermissionGuildCommandInit.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionGuildCommandInit.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionGuildCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PermissionGuildCommandInit.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionGuildCommandInit.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionGuildCommandInit.html#permissions" class="tsd-kind-icon">permissions</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 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="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/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">
|
||||
</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="PermissionCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">PermissionCommandInit</a><ul class="tsd-hierarchy"><li><span class="target">PermissionGuildCommandInit</span><ul class="tsd-hierarchy"><li><a href="ChatCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandInit</a></li><li><a href="ContextMenuCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">ContextMenuCommandInit</a></li></ul></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 tsd-is-inherited"><a href="PermissionGuildCommandInit.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="PermissionGuildCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PermissionGuildCommandInit.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionGuildCommandInit.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionGuildCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PermissionGuildCommandInit.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionGuildCommandInit.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionGuildCommandInit.html#permissions" class="tsd-kind-icon">permissions</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 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="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L23">src/commands/base/FunctionCommand.ts:23</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="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/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">
|
||||
</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="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L25">src/commands/base/Command.ts:25</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="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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/InitOptions.ts#L92">src/commands/types/InitOptions.ts:92</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/PermissionGuildCommand.ts#L17">src/commands/base/PermissionGuildCommand.ts:17</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="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#ephemeral">ephemeral</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/InitOptions.ts#L48">src/commands/types/InitOptions.ts:48</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#ephemeral">ephemeral</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L34">src/commands/base/FunctionCommand.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether a reply should be visible only to the caller</p>
|
||||
</div><div><ul>
|
||||
<li>NONE - bot replies are public and visible to everyone in a text channel</li>
|
||||
@@ -14,12 +14,12 @@
|
||||
<li>FULL - INTERACTIONS + responses to prefix interactions will be sent as direct messages to the command caller</li>
|
||||
</ul>
|
||||
<p><a href="https://support.discord.com/hc/pl/articles/1500000580222-Ephemeral-Messages-FAQ">Read more</a></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="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#function">function</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/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">
|
||||
</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="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#function">function</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L18">src/commands/base/FunctionCommand.ts:18</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"><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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/InitOptions.ts#L97">src/commands/types/InitOptions.ts:97</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/PermissionGuildCommand.ts#L22">src/commands/base/PermissionGuildCommand.ts:22</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="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/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">
|
||||
</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="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L20">src/commands/base/Command.ts:20</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 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="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#permissions">permissions</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/InitOptions.ts#L79">src/commands/types/InitOptions.ts:79</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#permissions">permissions</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/PermissionCommand.ts#L19">src/commands/base/PermissionCommand.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object with permissions' options and resolvables</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="PermissionGuildCommandInit.html" class="tsd-kind-icon">Permission<wbr/>Guild<wbr/>Command<wbr/>Init</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionGuildCommandInit.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="PermissionGuildCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PermissionGuildCommandInit.html#dm" class="tsd-kind-icon">dm</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionGuildCommandInit.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionGuildCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PermissionGuildCommandInit.html#guilds" class="tsd-kind-icon">guilds</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionGuildCommandInit.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PermissionGuildCommandInit.html#permissions" class="tsd-kind-icon">permissions</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>
|
||||
@@ -1,3 +1,3 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>RegisteredCommandObject | 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="RegisteredCommandObject.html">RegisteredCommandObject</a></li></ul><h1>Interface RegisteredCommandObject</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>Discord registered command object</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">RegisteredCommandObject</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="RegisteredCommandObject.html#application_id" class="tsd-kind-icon">application_<wbr/>id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RegisteredCommandObject.html#default_permissions" class="tsd-kind-icon">default_<wbr/>permissions</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RegisteredCommandObject.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RegisteredCommandObject.html#guild_id" class="tsd-kind-icon">guild_<wbr/>id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RegisteredCommandObject.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RegisteredCommandObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RegisteredCommandObject.html#options" class="tsd-kind-icon">options</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RegisteredCommandObject.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RegisteredCommandObject.html#version" class="tsd-kind-icon">version</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="application_id" class="tsd-anchor"></a><h3>application_<wbr/>id</h3><div class="tsd-signature tsd-kind-icon">application_<wbr/>id<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/2867da1/src/structures/types/api.ts#L135">src/structures/types/api.ts:135</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="default_permissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> default_<wbr/>permissions</h3><div class="tsd-signature tsd-kind-icon">default_<wbr/>permissions<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/2867da1/src/structures/types/api.ts#L140">src/structures/types/api.ts:140</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="description" class="tsd-anchor"></a><h3>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/2867da1/src/structures/types/api.ts#L138">src/structures/types/api.ts:138</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="guild_id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> guild_<wbr/>id</h3><div class="tsd-signature tsd-kind-icon">guild_<wbr/>id<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/2867da1/src/structures/types/api.ts#L136">src/structures/types/api.ts:136</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="id" class="tsd-anchor"></a><h3>id</h3><div class="tsd-signature tsd-kind-icon">id<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/2867da1/src/structures/types/api.ts#L133">src/structures/types/api.ts:133</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/types/api.ts#L137">src/structures/types/api.ts:137</a></li></ul></aside></section><section class="tsd-panel tsd-member Line truncated
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">RegisteredCommandObject</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="RegisteredCommandObject.html#application_id" class="tsd-kind-icon">application_<wbr/>id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RegisteredCommandObject.html#default_permissions" class="tsd-kind-icon">default_<wbr/>permissions</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RegisteredCommandObject.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RegisteredCommandObject.html#guild_id" class="tsd-kind-icon">guild_<wbr/>id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RegisteredCommandObject.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RegisteredCommandObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RegisteredCommandObject.html#options" class="tsd-kind-icon">options</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RegisteredCommandObject.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RegisteredCommandObject.html#version" class="tsd-kind-icon">version</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="application_id" class="tsd-anchor"></a><h3>application_<wbr/>id</h3><div class="tsd-signature tsd-kind-icon">application_<wbr/>id<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/5a80551/src/structures/apiTypes.ts#L121">src/structures/apiTypes.ts:121</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="default_permissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> default_<wbr/>permissions</h3><div class="tsd-signature tsd-kind-icon">default_<wbr/>permissions<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/5a80551/src/structures/apiTypes.ts#L126">src/structures/apiTypes.ts:126</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="description" class="tsd-anchor"></a><h3>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/5a80551/src/structures/apiTypes.ts#L124">src/structures/apiTypes.ts:124</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="guild_id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> guild_<wbr/>id</h3><div class="tsd-signature tsd-kind-icon">guild_<wbr/>id<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/5a80551/src/structures/apiTypes.ts#L122">src/structures/apiTypes.ts:122</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="id" class="tsd-anchor"></a><h3>id</h3><div class="tsd-signature tsd-kind-icon">id<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/5a80551/src/structures/apiTypes.ts#L119">src/structures/apiTypes.ts:119</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/apiTypes.ts#L123">src/structures/apiTypes.ts:123</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-proLine truncated
|
||||
@@ -1,9 +1,9 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SubCommandGroupInit | 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="SubCommandGroupInit.html">SubCommandGroupInit</a></li></ul><h1>Interface SubCommandGroupInit</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 subcommand group</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="APICommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandInit</a><ul class="tsd-hierarchy"><li><span class="target">SubCommandGroupInit</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 tsd-is-inherited"><a href="SubCommandGroupInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandGroupInit.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandGroupInit.html#name" class="tsd-kind-icon">name</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 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="APICommandInit.html">APICommandInit</a>.<a href="APICommandInit.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/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">
|
||||
</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="APICommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandInit</a><ul class="tsd-hierarchy"><li><span class="target">SubCommandGroupInit</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 tsd-is-inherited"><a href="SubCommandGroupInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandGroupInit.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandGroupInit.html#name" class="tsd-kind-icon">name</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 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="APICommandInit.html">APICommandInit</a>.<a href="APICommandInit.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L25">src/commands/base/Command.ts:25</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/2867da1/src/commands/types/InitOptions.ts#L184">src/commands/types/InitOptions.ts:184</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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/5a80551/src/commands/SubCommandGroup.ts#L17">src/commands/SubCommandGroup.ts:17</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="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="APICommandInit.html">APICommandInit</a>.<a href="APICommandInit.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/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">
|
||||
</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="APICommandInit.html">APICommandInit</a>.<a href="APICommandInit.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L20">src/commands/base/Command.ts:20</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command name</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="SubCommandGroupInit.html" class="tsd-kind-icon">Sub<wbr/>Command<wbr/>Group<wbr/>Init</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandGroupInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandGroupInit.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandGroupInit.html#name" class="tsd-kind-icon">name</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>
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SubCommandGroupObject | 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="SubCommandGroupObject.html">SubCommandGroupObject</a></li></ul><h1>Interface SubCommandGroupObject</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>API representation of subcommand group</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a><ul class="tsd-hierarchy"><li><span class="target">SubCommandGroupObject</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 tsd-is-inherited"><a href="SubCommandGroupObject.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandGroupObject.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandGroupObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandGroupObject.html#options" class="tsd-kind-icon">options</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandGroupObject.html#type" class="tsd-kind-icon">type</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 tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3>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="APICommandObject.html">APICommandObject</a>.<a href="APICommandObject.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/types/api.ts#L24">src/structures/types/api.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="APICommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">APICommandObject</a><ul class="tsd-hierarchy"><li><span class="target">SubCommandGroupObject</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 tsd-is-inherited"><a href="SubCommandGroupObject.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandGroupObject.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandGroupObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandGroupObject.html#options" class="tsd-kind-icon">options</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandGroupObject.html#type" class="tsd-kind-icon">type</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 tsd-is-inherited"><a name="default_permission" class="tsd-anchor"></a><h3>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="APICommandObject.html">APICommandObject</a>.<a href="APICommandObject.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/apiTypes.ts#L23">src/structures/apiTypes.ts:23</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>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/2867da1/src/structures/types/api.ts#L125">src/structures/types/api.ts:125</a></li></ul></aside></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="APICommandObject.html">APICommandObject</a>.<a href="APICommandObject.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/types/api.ts#L19">src/structures/types/api.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="description" class="tsd-anchor"></a><h3>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/5a80551/src/structures/apiTypes.ts#L112">src/structures/apiTypes.ts:112</a></li></ul></aside></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="APICommandObject.html">APICommandObject</a>.<a href="APICommandObject.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/apiTypes.ts#L18">src/structures/apiTypes.ts:18</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="options" class="tsd-anchor"></a><h3>options</h3><div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <a href="ChatCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandObject</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/types/api.ts#L126">src/structures/types/api.ts:126</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">2</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/types/api.ts#L124">src/structures/types/api.ts:124</a></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="SubCommandGroupObject.html" class="tsd-kind-icon">Sub<wbr/>Command<wbr/>Group<wbr/>Object</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandGroupObject.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandGroupObject.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandGroupObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandGroupObject.html#options" class="tsd-kind-icon">options</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandGroupObject.html#type" class="tsd-kind-icon">type</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>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="options" class="tsd-anchor"></a><h3>options</h3><div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <a href="ChatCommandObject.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandObject</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/apiTypes.ts#L113">src/structures/apiTypes.ts:113</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">2</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/apiTypes.ts#L111">src/structures/apiTypes.ts:111</a></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="SubCommandGroupObject.html" class="tsd-kind-icon">Sub<wbr/>Command<wbr/>Group<wbr/>Object</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandGroupObject.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandGroupObject.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandGroupObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandGroupObject.html#options" class="tsd-kind-icon">options</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandGroupObject.html#type" class="tsd-kind-icon">type</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>
|
||||
@@ -1,12 +1,14 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SubCommandInit | 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="SubCommandInit.html">SubCommandInit</a></li></ul><h1>Interface SubCommandInit</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>Subcommand initialization options</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="PermissionCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">PermissionCommandInit</a><ul class="tsd-hierarchy"><li><span class="target">SubCommandInit</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 tsd-is-inherited"><a href="SubCommandInit.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="SubCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandInit.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandInit.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandInit.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandInit.html#parameters" class="tsd-kind-icon">parameters</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandInit.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandInit.html#usage" class="tsd-kind-icon">usage</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 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="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/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">
|
||||
</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="PermissionCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">PermissionCommandInit</a><ul class="tsd-hierarchy"><li><span class="target">SubCommandInit</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="SubCommandInit.html#aliases" class="tsd-kind-icon">aliases</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandInit.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="SubCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandInit.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandInit.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandInit.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandInit.html#parameters" class="tsd-kind-icon">parameters</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandInit.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandInit.html#usage" class="tsd-kind-icon">usage</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/5a80551/src/commands/SubCommand.ts#L30">src/commands/SubCommand.ts:30</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="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#announceSuccess">announceSuccess</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L23">src/commands/base/FunctionCommand.ts:23</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="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/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">
|
||||
</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="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#default_permission">default_permission</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L25">src/commands/base/Command.ts:25</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/2867da1/src/commands/types/InitOptions.ts#L161">src/commands/types/InitOptions.ts:161</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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/5a80551/src/commands/SubCommand.ts#L20">src/commands/SubCommand.ts:20</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="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#ephemeral">ephemeral</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/InitOptions.ts#L48">src/commands/types/InitOptions.ts:48</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="ephemeral" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ephemeral</h3><div class="tsd-signature tsd-kind-icon">ephemeral<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#EphemeralType" class="tsd-signature-type" data-tsd-kind="Type alias">EphemeralType</a></div><aside class="tsd-sources"><p>Inherited from <a href="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#ephemeral">ephemeral</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L34">src/commands/base/FunctionCommand.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Whether a reply should be visible only to the caller</p>
|
||||
</div><div><ul>
|
||||
<li>NONE - bot replies are public and visible to everyone in a text channel</li>
|
||||
@@ -14,14 +16,14 @@
|
||||
<li>FULL - INTERACTIONS + responses to prefix interactions will be sent as direct messages to the command caller</li>
|
||||
</ul>
|
||||
<p><a href="https://support.discord.com/hc/pl/articles/1500000580222-Ephemeral-Messages-FAQ">Read more</a></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="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#function">function</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/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">
|
||||
</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="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#function">function</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/FunctionCommand.ts#L18">src/commands/base/FunctionCommand.ts:18</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="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="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/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">
|
||||
</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="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/Command.ts#L20">src/commands/base/Command.ts:20</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">"simple"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"no_input"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/InitOptions.ts#L166">src/commands/types/InitOptions.ts:166</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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">"simple"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"no_input"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/SubCommand.ts#L25">src/commands/SubCommand.ts:25</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="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#permissions">permissions</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/InitOptions.ts#L79">src/commands/types/InitOptions.ts:79</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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="PermissionCommandInit.html">PermissionCommandInit</a>.<a href="PermissionCommandInit.html#permissions">permissions</a></p><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/base/PermissionCommand.ts#L19">src/commands/base/PermissionCommand.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object with permissions' options and resolvables</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/2867da1/src/commands/types/InitOptions.ts#L171">src/commands/types/InitOptions.ts:171</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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/5a80551/src/commands/SubCommand.ts#L35">src/commands/SubCommand.ts:35</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></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="SubCommandInit.html" class="tsd-kind-icon">Sub<wbr/>Command<wbr/>Init</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandInit.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="SubCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandInit.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandInit.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandInit.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandInit.html#parameters" class="tsd-kind-icon">parameters</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandInit.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandInit.html#usage" class="tsd-kind-icon">usage</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>
|
||||
</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="SubCommandInit.html" class="tsd-kind-icon">Sub<wbr/>Command<wbr/>Init</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandInit.html#aliases" class="tsd-kind-icon">aliases</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandInit.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="SubCommandInit.html#default_permission" class="tsd-kind-icon">default_<wbr/>permission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandInit.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandInit.html#ephemeral" class="tsd-kind-icon">ephemeral</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandInit.html#function" class="tsd-kind-icon">function</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandInit.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandInit.html#parameters" class="tsd-kind-icon">parameters</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubCommandInit.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubCommandInit.html#usage" class="tsd-kind-icon">usage</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>
|
||||
@@ -1,22 +1,22 @@
|
||||
<!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#description" class="tsd-kind-icon">description</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/2867da1/src/structures/SystemMessage.ts#L46">src/structures/SystemMessage.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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#description" class="tsd-kind-icon">description</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/5a80551/src/structures/SystemMessage.ts#L41">src/structures/SystemMessage.ts:41</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/2867da1/src/structures/SystemMessage.ts#L34">src/structures/SystemMessage.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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/5a80551/src/structures/SystemMessage.ts#L31">src/structures/SystemMessage.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Text below the title</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>deprecated</dt><dd></dd></dl></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/2867da1/src/structures/SystemMessage.ts#L72">src/structures/SystemMessage.ts:72</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div><dl class="tsd-comment-tags"><dt>deprecated</dt><dd></dd></dl></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/5a80551/src/structures/SystemMessage.ts#L63">src/structures/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="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/2867da1/src/structures/SystemMessage.ts#L40">src/structures/SystemMessage.ts:40</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</dd></dl></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/5a80551/src/structures/SystemMessage.ts#L36">src/structures/SystemMessage.ts:36</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="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/2867da1/src/structures/SystemMessage.ts#L52">src/structures/SystemMessage.ts:52</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></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/5a80551/src/structures/SystemMessage.ts#L46">src/structures/SystemMessage.ts:46</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/2867da1/src/structures/SystemMessage.ts#L21">src/structures/SystemMessage.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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/5a80551/src/structures/SystemMessage.ts#L20">src/structures/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/2867da1/src/structures/SystemMessage.ts#L65">src/structures/SystemMessage.ts:65</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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/5a80551/src/structures/SystemMessage.ts#L57">src/structures/SystemMessage.ts:57</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Footer text</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>deprecated</dt><dd></dd></dl></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/2867da1/src/structures/SystemMessage.ts#L58">src/structures/SystemMessage.ts:58</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div><dl class="tsd-comment-tags"><dt>deprecated</dt><dd></dd></dl></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/5a80551/src/structures/SystemMessage.ts#L51">src/structures/SystemMessage.ts:51</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/2867da1/src/structures/SystemMessage.ts#L27">src/structures/SystemMessage.ts:27</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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/5a80551/src/structures/SystemMessage.ts#L25">src/structures/SystemMessage.ts:25</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#description" class="tsd-kind-icon">description</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>
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SystemMessageData | 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="SystemMessageData.html">SystemMessageData</a></li></ul><h1>Interface SystemMessageData</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>System message data definition</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">SystemMessageData</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="SystemMessageData.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageData.html#error" class="tsd-kind-icon">error</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageData.html#phrase" class="tsd-kind-icon">phrase</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageData.html#user" class="tsd-kind-icon">user</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="command" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">?:</span> <a href="../classes/FunctionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCommand</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/SystemMessage.ts#L84">src/structures/SystemMessage.ts:84</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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">SystemMessageData</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="SystemMessageData.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageData.html#error" class="tsd-kind-icon">error</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageData.html#phrase" class="tsd-kind-icon">phrase</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageData.html#user" class="tsd-kind-icon">user</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="command" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">?:</span> <a href="../classes/FunctionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCommand</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/SystemMessage.ts#L75">src/structures/SystemMessage.ts:75</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>A <a href="../classes/Command.html">Command</a> instance</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="error" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> error</h3><div class="tsd-signature tsd-kind-icon">error<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol"> | </span><a href="../classes/PermissionsError.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionsError</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/SystemMessage.ts#L102">src/structures/SystemMessage.ts:102</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="error" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> error</h3><div class="tsd-signature tsd-kind-icon">error<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol"> | </span><a href="../classes/PermissionsError.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionsError</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/SystemMessage.ts#L90">src/structures/SystemMessage.ts:90</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Error object</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="phrase" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> phrase</h3><div class="tsd-signature tsd-kind-icon">phrase<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/2867da1/src/structures/SystemMessage.ts#L90">src/structures/SystemMessage.ts:90</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="phrase" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> phrase</h3><div class="tsd-signature tsd-kind-icon">phrase<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/5a80551/src/structures/SystemMessage.ts#L80">src/structures/SystemMessage.ts:80</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Phrase received from a Discord channel</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="user" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> user</h3><div class="tsd-signature tsd-kind-icon">user<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GuildMember</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">User</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/SystemMessage.ts#L96">src/structures/SystemMessage.ts:96</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="user" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> user</h3><div class="tsd-signature tsd-kind-icon">user<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GuildMember</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">User</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/SystemMessage.ts#L85">src/structures/SystemMessage.ts:85</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>User who used the bot</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="SystemMessageData.html" class="tsd-kind-icon">System<wbr/>Message<wbr/>Data</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageData.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageData.html#error" class="tsd-kind-icon">error</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageData.html#phrase" class="tsd-kind-icon">phrase</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SystemMessageData.html#user" class="tsd-kind-icon">user</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>
|
||||
@@ -1,3 +1,3 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>TextCommandOptionChoiceObject | 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="TextCommandOptionChoiceObject.html">TextCommandOptionChoiceObject</a></li></ul><h1>Interface TextCommandOptionChoiceObject</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>Discord CHAT_INPUT command choice object</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">TextCommandOptionChoiceObject</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="TextCommandOptionChoiceObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TextCommandOptionChoiceObject.html#value" class="tsd-kind-icon">value</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="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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/types/api.ts#L100">src/structures/types/api.ts:100</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="value" class="tsd-anchor"></a><h3>value</h3><div class="tsd-signature tsd-kind-icon">value<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/2867da1/src/structures/types/api.ts#L101">src/structures/types/api.ts:101</a></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="TextCommandOptionChoiceObject.html" class="tsd-kind-icon">Text<wbr/>Command<wbr/>Option<wbr/>Choice<wbr/>Object</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TextCommandOptionChoiceObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TextCommandOptionChoiceObject.html#value" class="tsd-kind-icon">value</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>
|
||||
</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">TextCommandOptionChoiceObject</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="TextCommandOptionChoiceObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TextCommandOptionChoiceObject.html#value" class="tsd-kind-icon">value</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="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"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/apiTypes.ts#L95">src/structures/apiTypes.ts:95</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="value" class="tsd-anchor"></a><h3>value</h3><div class="tsd-signature tsd-kind-icon">value<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/5a80551/src/structures/apiTypes.ts#L96">src/structures/apiTypes.ts:96</a></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="TextCommandOptionChoiceObject.html" class="tsd-kind-icon">Text<wbr/>Command<wbr/>Option<wbr/>Choice<wbr/>Object</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TextCommandOptionChoiceObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TextCommandOptionChoiceObject.html#value" class="tsd-kind-icon">value</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>
|
||||
+27
-27
@@ -1,23 +1,23 @@
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>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"><h1>commandbot</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><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>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class"><a href="classes/Bot.html" class="tsd-kind-icon">Bot</a></li><li class="tsd-kind-class"><a href="classes/ChatCommand.html" class="tsd-kind-icon">Chat<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/Command.html" class="tsd-kind-icon">Command</a></li><li class="tsd-kind-class"><a href="classes/CommandManager.html" class="tsd-kind-icon">Command<wbr/>Manager</a></li><li class="tsd-kind-class"><a href="classes/CommandPermissions.html" class="tsd-kind-icon">Command<wbr/>Permissions</a></li><li class="tsd-kind-class"><a href="classes/ContextMenuCommand.html" class="tsd-kind-icon">Context<wbr/>Menu<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/FunctionCommand.html" class="tsd-kind-icon">Function<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/GuildCommand.html" class="tsd-kind-icon">Guild<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/HelpMessage.html" class="tsd-kind-icon">Help<wbr/>Message</a></li><li class="tsd-kind-class"><a href="classes/InputManager.html" class="tsd-kind-icon">Input<wbr/>Manager</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/InputParameter.html" class="tsd-kind-icon">Input<wbr/>Parameter</a></li><li class="tsd-kind-class"><a href="classes/MissingParameterError.html" class="tsd-kind-icon">Missing<wbr/>Parameter<wbr/>Error</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/ObjectID.html" class="tsd-kind-icon">ObjectID</a></li><li class="tsd-kind-class"><a href="classes/OperationSuccess.html" class="tsd-kind-icon">Operation<wbr/>Success</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/Parameter.html" class="tsd-kind-icon">Parameter</a></li><li class="tsd-kind-class"><a href="classes/ParameterTypeError.html" class="tsd-kind-icon">Parameter<wbr/>Type<wbr/>Error</a></li><li class="tsd-kind-class"><a href="classes/PermissionCommand.html" class="tsd-kind-icon">Permission<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/PermissionGuildCommand.html" class="tsd-kind-icon">Permission<wbr/>Guild<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/PermissionsError.html" class="tsd-kind-icon">Permissions<wbr/>Error</a></li><li class="tsd-kind-class"><a href="classes/PrefixManager.html" class="tsd-kind-icon">Prefix<wbr/>Manager</a></li><li class="tsd-kind-class"><a href="classes/SubCommand.html" class="tsd-kind-icon">Sub<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/SubCommandGroup.html" class="tsd-kind-icon">Sub<wbr/>Command<wbr/>Group</a></li><li class="tsd-kind-class"><a href="classes/SystemMessageManager.html" class="tsd-kind-icon">System<wbr/>Message<wbr/>Manager</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/TargetID.html" class="tsd-kind-icon">TLine truncated
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>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"><h1>commandbot</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><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>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class"><a href="classes/Bot.html" class="tsd-kind-icon">Bot</a></li><li class="tsd-kind-class"><a href="classes/ChatCommand.html" class="tsd-kind-icon">Chat<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/Command.html" class="tsd-kind-icon">Command</a></li><li class="tsd-kind-class"><a href="classes/CommandManager.html" class="tsd-kind-icon">Command<wbr/>Manager</a></li><li class="tsd-kind-class"><a href="classes/CommandPermissions.html" class="tsd-kind-icon">Command<wbr/>Permissions</a></li><li class="tsd-kind-class"><a href="classes/ContextMenuCommand.html" class="tsd-kind-icon">Context<wbr/>Menu<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/FunctionCommand.html" class="tsd-kind-icon">Function<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/GuildCommand.html" class="tsd-kind-icon">Guild<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/HelpMessage.html" class="tsd-kind-icon">Help<wbr/>Message</a></li><li class="tsd-kind-class"><a href="classes/InputManager.html" class="tsd-kind-icon">Input<wbr/>Manager</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/InputParameter.html" class="tsd-kind-icon">Input<wbr/>Parameter</a></li><li class="tsd-kind-class"><a href="classes/MissingParameterError.html" class="tsd-kind-icon">Missing<wbr/>Parameter<wbr/>Error</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/ObjectID.html" class="tsd-kind-icon">ObjectID</a></li><li class="tsd-kind-class"><a href="classes/OperationSuccess.html" class="tsd-kind-icon">Operation<wbr/>Success</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/Parameter.html" class="tsd-kind-icon">Parameter</a></li><li class="tsd-kind-class"><a href="classes/ParameterTypeError.html" class="tsd-kind-icon">Parameter<wbr/>Type<wbr/>Error</a></li><li class="tsd-kind-class"><a href="classes/PermissionCommand.html" class="tsd-kind-icon">Permission<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/PermissionGuildCommand.html" class="tsd-kind-icon">Permission<wbr/>Guild<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/PermissionsError.html" class="tsd-kind-icon">Permissions<wbr/>Error</a></li><li class="tsd-kind-class"><a href="classes/PrefixManager.html" class="tsd-kind-icon">Prefix<wbr/>Manager</a></li><li class="tsd-kind-class"><a href="classes/SubCommand.html" class="tsd-kind-icon">Sub<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/SubCommandGroup.html" class="tsd-kind-icon">Sub<wbr/>Command<wbr/>Group</a></li><li class="tsd-kind-class"><a href="classes/SystemMessageManager.html" class="tsd-kind-icon">System<wbr/>Message<wbr/>Manager</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/TargetID.html" class="tsd-kind-icon">TLine truncated
|
||||
<p>Discord application command types
|
||||
CHAT_INPUT - chat interaction (prefix or slash commands)
|
||||
USER - context menu interaction for user
|
||||
MESSAGE - context menu interaction for message</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="BaseCommandType" class="tsd-anchor"></a><h3>Base<wbr/>Command<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Base<wbr/>Command<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"BASE"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"FUNCTION"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"GUILD"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"PERMISSION"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"PERMISSIONGUILD"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/commands.ts#L28">src/commands/types/commands.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="BaseCommandType" class="tsd-anchor"></a><h3>Base<wbr/>Command<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Base<wbr/>Command<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"BASE"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"FUNCTION"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"GUILD"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"PERMISSION"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"PERMISSIONGUILD"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/commandsTypes.ts#L17">src/commands/commandsTypes.ts:17</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Types of command bases</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a name="BaseCommands" class="tsd-anchor"></a><h3>Base<wbr/>Commands</h3><div class="tsd-signature tsd-kind-icon">Base<wbr/>Commands<T><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"BASE"</span><span class="tsd-signature-symbol"> ? </span><a href="classes/Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"FUNCTION"</span><span class="tsd-signature-symbol"> ? </span><a href="classes/FunctionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCommand</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"GUILD"</span><span class="tsd-signature-symbol"> ? </span><a href="classes/GuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">GuildCommand</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"PERMISSION"</span><span class="tsd-signature-symbol"> ? </span><a href="classes/PermissionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionCommand</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"PERMISSIONGUILD"</span><span class="tsd-signature-symbol"> ? </span><a href="classes/PermissionGuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionGuildCommand</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">never</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/commands.ts#L46">src/commands/types/commands.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a name="BaseCommands" class="tsd-anchor"></a><h3>Base<wbr/>Commands</h3><div class="tsd-signature tsd-kind-icon">Base<wbr/>Commands<T><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"BASE"</span><span class="tsd-signature-symbol"> ? </span><a href="classes/Command.html" class="tsd-signature-type" data-tsd-kind="Class">Command</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"FUNCTION"</span><span class="tsd-signature-symbol"> ? </span><a href="classes/FunctionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCommand</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"GUILD"</span><span class="tsd-signature-symbol"> ? </span><a href="classes/GuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">GuildCommand</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"PERMISSION"</span><span class="tsd-signature-symbol"> ? </span><a href="classes/PermissionCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionCommand</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"PERMISSIONGUILD"</span><span class="tsd-signature-symbol"> ? </span><a href="classes/PermissionGuildCommand.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionGuildCommand</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">never</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/commandsTypes.ts#L32">src/commands/commandsTypes.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Base command type selector</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="modules.html#BaseCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommandType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="ChatCommandOptionType" class="tsd-anchor"></a><h3>Chat<wbr/>Command<wbr/>Option<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Chat<wbr/>Command<wbr/>Option<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">2</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">4</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">5</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">6</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">7</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">8</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">9</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">10</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/types/api.ts#L93">src/structures/types/api.ts:93</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="modules.html#BaseCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">BaseCommandType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="ChatCommandOptionType" class="tsd-anchor"></a><h3>Chat<wbr/>Command<wbr/>Option<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Chat<wbr/>Command<wbr/>Option<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">2</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">4</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">5</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">6</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">7</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">8</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">9</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">10</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/apiTypes.ts#L89">src/structures/apiTypes.ts:89</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Acceptable CHAT_INPUT command option types (read more <a href="https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-option-type">here</a>)</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a name="ChildCommandInit" class="tsd-anchor"></a><h3>Child<wbr/>Command<wbr/>Init</h3><div class="tsd-signature tsd-kind-icon">Child<wbr/>Command<wbr/>Init<T><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"COMMAND"</span><span class="tsd-signature-symbol"> ? </span><a href="interfaces/SubCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandInit</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"GROUP"</span><span class="tsd-signature-symbol"> ? </span><a href="interfaces/SubCommandGroupInit.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandGroupInit</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">never</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/commands.ts#L96">src/commands/types/commands.ts:96</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a name="ChildCommandInit" class="tsd-anchor"></a><h3>Child<wbr/>Command<wbr/>Init</h3><div class="tsd-signature tsd-kind-icon">Child<wbr/>Command<wbr/>Init<T><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"COMMAND"</span><span class="tsd-signature-symbol"> ? </span><a href="interfaces/SubCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandInit</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"GROUP"</span><span class="tsd-signature-symbol"> ? </span><a href="interfaces/SubCommandGroupInit.html" class="tsd-signature-type" data-tsd-kind="Interface">SubCommandGroupInit</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">never</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/commandsTypes.ts#L77">src/commands/commandsTypes.ts:77</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Child command initializer selector</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="modules.html#ChildCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="ChildCommandResolvable" class="tsd-anchor"></a><h3>Child<wbr/>Command<wbr/>Resolvable</h3><div class="tsd-signature tsd-kind-icon">Child<wbr/>Command<wbr/>Resolvable<span class="tsd-signature-symbol">:</span> <a href="classes/SubCommandGroup.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommandGroup</a><span class="tsd-signature-symbol"> | </span><a href="classes/SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/commands.ts#L114">src/commands/types/commands.ts:114</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="modules.html#ChildCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="ChildCommandResolvable" class="tsd-anchor"></a><h3>Child<wbr/>Command<wbr/>Resolvable</h3><div class="tsd-signature tsd-kind-icon">Child<wbr/>Command<wbr/>Resolvable<span class="tsd-signature-symbol">:</span> <a href="classes/SubCommandGroup.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommandGroup</a><span class="tsd-signature-symbol"> | </span><a href="classes/SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/commandsTypes.ts#L92">src/commands/commandsTypes.ts:92</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Child command resolvables</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="ChildCommandType" class="tsd-anchor"></a><h3>Child<wbr/>Command<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Child<wbr/>Command<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"COMMAND"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"GROUP"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/commands.ts#L40">src/commands/types/commands.ts:40</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="ChildCommandType" class="tsd-anchor"></a><h3>Child<wbr/>Command<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Child<wbr/>Command<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"COMMAND"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"GROUP"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/commandsTypes.ts#L27">src/commands/commandsTypes.ts:27</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Child command types</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a name="ChildCommands" class="tsd-anchor"></a><h3>Child<wbr/>Commands</h3><div class="tsd-signature tsd-kind-icon">Child<wbr/>Commands<T><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"COMMAND"</span><span class="tsd-signature-symbol"> ? </span><a href="classes/SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"GROUP"</span><span class="tsd-signature-symbol"> ? </span><a href="classes/SubCommandGroup.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommandGroup</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">never</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/commands.ts#L68">src/commands/types/commands.ts:68</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a name="ChildCommands" class="tsd-anchor"></a><h3>Child<wbr/>Commands</h3><div class="tsd-signature tsd-kind-icon">Child<wbr/>Commands<T><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"COMMAND"</span><span class="tsd-signature-symbol"> ? </span><a href="classes/SubCommand.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommand</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"GROUP"</span><span class="tsd-signature-symbol"> ? </span><a href="classes/SubCommandGroup.html" class="tsd-signature-type" data-tsd-kind="Class">SubCommandGroup</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">never</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/commandsTypes.ts#L52">src/commands/commandsTypes.ts:52</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Child command type selector</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="modules.html#ChildCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="CommandFunction" class="tsd-anchor"></a><h3>Command<wbr/>Function</h3><div class="tsd-signature tsd-kind-icon">Command<wbr/>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="classes/InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="modules.html#CommandFunctionReturnTypes" class="tsd-signature-type" data-tsd-kind="Type alias">CommandFunctionReturnTypes</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/commands.ts#L148">src/commands/types/commands.ts:148</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="classes/InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="modules.html#CommandFunctionReturnTypes" class="tsd-signature-type" data-tsd-kind="Type alias">CommandFunctionReturnTypes</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="modules.html#ChildCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">ChildCommandType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="CommandFunction" class="tsd-anchor"></a><h3>Command<wbr/>Function</h3><div class="tsd-signature tsd-kind-icon">Command<wbr/>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="classes/InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="modules.html#CommandFunctionReturnTypes" class="tsd-signature-type" data-tsd-kind="Type alias">CommandFunctionReturnTypes</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/commandsTypes.ts#L123">src/commands/commandsTypes.ts:123</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="classes/InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="modules.html#CommandFunctionReturnTypes" class="tsd-signature-type" data-tsd-kind="Type alias">CommandFunctionReturnTypes</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command function definition</p>
|
||||
</div><div><p>If function returns (also after resolving a <em>Promise</em>):</p>
|
||||
<ul>
|
||||
@@ -29,23 +29,23 @@ MESSAGE - context menu interaction for message</p>
|
||||
<p>It is possible to manually send replies directly from the command function using the interaction property from <a href="classes/InputManager.html">InputManager</a> argument. If you are using slash commands don't forget to use the <em><a href="https://discord.js.org/#/docs/main/stable/class/CommandInteraction?scrollTo=editReply">CommandInteraction.prototype.editReply</a></em> method instead of the <em>reply</em> method since a <strong>reply is already deferred</strong> when a command function gets called (read more <a href="https://discord.com/developers/docs/interactions/receiving-and-responding">here</a>) If you try to create a new reply, you app will throw an error that will result a crash.</p>
|
||||
<p>If you manually reply to a slash command interaction and return <em>void</em> from the command function, a SUCCESS message will not be sent or reply will not get deleted (if you want to disable SUCCESS messages on prefix interactions set <em>announceSuccess</em> property to <em>false</em>).</p>
|
||||
<p>If command function throws an error, it will automatically get caught and your bot will send an ERROR message. The app <strong>will not</strong> crash.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>input: <a href="classes/InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="modules.html#CommandFunctionReturnTypes" class="tsd-signature-type" data-tsd-kind="Type alias">CommandFunctionReturnTypes</a></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="CommandFunctionReturnTypes" class="tsd-anchor"></a><h3>Command<wbr/>Function<wbr/>Return<wbr/>Types</h3><div class="tsd-signature tsd-kind-icon">Command<wbr/>Function<wbr/>Return<wbr/>Types<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MessageEmbed</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ReplyMessageOptions</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MessageEmbed</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ReplyMessageOptions</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/commands.ts#L130">src/commands/types/commands.ts:130</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>input: <a href="classes/InputManager.html" class="tsd-signature-type" data-tsd-kind="Class">InputManager</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="modules.html#CommandFunctionReturnTypes" class="tsd-signature-type" data-tsd-kind="Type alias">CommandFunctionReturnTypes</a></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="CommandFunctionReturnTypes" class="tsd-anchor"></a><h3>Command<wbr/>Function<wbr/>Return<wbr/>Types</h3><div class="tsd-signature tsd-kind-icon">Command<wbr/>Function<wbr/>Return<wbr/>Types<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MessageEmbed</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ReplyMessageOptions</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MessageEmbed</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ReplyMessageOptions</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/commandsTypes.ts#L106">src/commands/commandsTypes.ts:106</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>All types that can be returned from a command function</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a name="CommandInit" class="tsd-anchor"></a><h3>Command<wbr/>Init</h3><div class="tsd-signature tsd-kind-icon">Command<wbr/>Init<T><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"CHAT"</span><span class="tsd-signature-symbol"> ? </span><a href="interfaces/ChatCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandInit</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"CONTEXT"</span><span class="tsd-signature-symbol"> ? </span><a href="interfaces/ContextMenuCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">ContextMenuCommandInit</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">never</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/commands.ts#L90">src/commands/types/commands.ts:90</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a name="CommandInit" class="tsd-anchor"></a><h3>Command<wbr/>Init</h3><div class="tsd-signature tsd-kind-icon">Command<wbr/>Init<T><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"CHAT"</span><span class="tsd-signature-symbol"> ? </span><a href="interfaces/ChatCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">ChatCommandInit</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"CONTEXT"</span><span class="tsd-signature-symbol"> ? </span><a href="interfaces/ContextMenuCommandInit.html" class="tsd-signature-type" data-tsd-kind="Interface">ContextMenuCommandInit</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">never</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/commandsTypes.ts#L72">src/commands/commandsTypes.ts:72</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command initializer selector</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="CommandPermissionType" class="tsd-anchor"></a><h3>Command<wbr/>Permission<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Command<wbr/>Permission<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ROLE"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"USER"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/types/api.ts#L147">src/structures/types/api.ts:147</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="CommandPermissionType" class="tsd-anchor"></a><h3>Command<wbr/>Permission<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Command<wbr/>Permission<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ROLE"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"USER"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/apiTypes.ts#L132">src/structures/apiTypes.ts:132</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Discord permission types</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="CommandType" class="tsd-anchor"></a><h3>Command<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Command<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"CHAT"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"CONTEXT"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/commands.ts#L34">src/commands/types/commands.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="CommandType" class="tsd-anchor"></a><h3>Command<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Command<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"CHAT"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"CONTEXT"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/commandsTypes.ts#L22">src/commands/commandsTypes.ts:22</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command types</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a name="Commands" class="tsd-anchor"></a><h3>Commands</h3><div class="tsd-signature tsd-kind-icon">Commands<T><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"CHAT"</span><span class="tsd-signature-symbol"> ? </span><a href="classes/ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"CONTEXT"</span><span class="tsd-signature-symbol"> ? </span><a href="classes/ContextMenuCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ContextMenuCommand</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">never</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/commands.ts#L62">src/commands/types/commands.ts:62</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a name="Commands" class="tsd-anchor"></a><h3>Commands</h3><div class="tsd-signature tsd-kind-icon">Commands<T><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"CHAT"</span><span class="tsd-signature-symbol"> ? </span><a href="classes/ChatCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ChatCommand</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"CONTEXT"</span><span class="tsd-signature-symbol"> ? </span><a href="classes/ContextMenuCommand.html" class="tsd-signature-type" data-tsd-kind="Class">ContextMenuCommand</a><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">never</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/commandsTypes.ts#L47">src/commands/commandsTypes.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Command type selector</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="ContextType" class="tsd-anchor"></a><h3>Context<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Context<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"USER"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"MESSAGE"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/commands.ts#L124">src/commands/types/commands.ts:124</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="modules.html#CommandType" class="tsd-signature-type" data-tsd-kind="Type alias">CommandType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="ContextType" class="tsd-anchor"></a><h3>Context<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Context<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"USER"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"MESSAGE"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/commandsTypes.ts#L101">src/commands/commandsTypes.ts:101</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Context menu command types</p>
|
||||
</div><div><ul>
|
||||
<li>USER - right-click context menu interactions on users</li>
|
||||
<li>MESSAGE - right-click context menu interactions on messages</li>
|
||||
</ul>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="EphemeralType" class="tsd-anchor"></a><h3>Ephemeral<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Ephemeral<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"NONE"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"INTERACTIONS"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"FULL"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/commands.ts#L176">src/commands/types/commands.ts:176</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="EphemeralType" class="tsd-anchor"></a><h3>Ephemeral<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Ephemeral<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"NONE"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"INTERACTIONS"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"FULL"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/commands/commandsTypes.ts#L134">src/commands/commandsTypes.ts:134</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Ephemeral response types</p>
|
||||
</div><div><ul>
|
||||
<li>NONE - bot replies are public and visible to everyone in a text channel</li>
|
||||
@@ -53,13 +53,13 @@ MESSAGE - context menu interaction for message</p>
|
||||
<li>FULL - INTERACTIONS + responses to prefix interactions will be sent as direct messages to the command caller</li>
|
||||
</ul>
|
||||
<p><a href="https://support.discord.com/hc/pl/articles/1500000580222-Ephemeral-Messages-FAQ">Read more</a></p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a name="InputParameterValue" class="tsd-anchor"></a><h3>Input<wbr/>Parameter<wbr/>Value</h3><div class="tsd-signature tsd-kind-icon">Input<wbr/>Parameter<wbr/>Value<T><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </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><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"boolean"</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"number"</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"user"</span><span class="tsd-signature-symbol"> ? </span><a href="classes/ObjectID.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"user"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"role"</span><span class="tsd-signature-symbol"> ? </span><a href="classes/ObjectID.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"role"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"channel"</span><span class="tsd-signature-symbol"> ? </span><a href="classes/ObjectID.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"channel"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"mentionable"</span><span class="tsd-signature-symbol"> ? </span><a href="classes/ObjectID.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"mentionable"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">never</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Parameter.ts#L18">src/structures/Parameter.ts:18</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a name="InputParameterValue" class="tsd-anchor"></a><h3>Input<wbr/>Parameter<wbr/>Value</h3><div class="tsd-signature tsd-kind-icon">Input<wbr/>Parameter<wbr/>Value<T><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </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><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"boolean"</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"number"</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"user"</span><span class="tsd-signature-symbol"> ? </span><a href="classes/ObjectID.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"user"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"role"</span><span class="tsd-signature-symbol"> ? </span><a href="classes/ObjectID.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"role"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"channel"</span><span class="tsd-signature-symbol"> ? </span><a href="classes/ObjectID.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"channel"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"mentionable"</span><span class="tsd-signature-symbol"> ? </span><a href="classes/ObjectID.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"mentionable"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">never</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Parameter.ts#L17">src/structures/Parameter.ts:17</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Input parameter value resolvable selector</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="modules.html#ParameterType" class="tsd-signature-type" data-tsd-kind="Type alias">ParameterType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="MessageType" class="tsd-anchor"></a><h3>Message<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Message<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"PERMISSION"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ERROR"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"NOT_FOUND"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"SUCCESS"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/SystemMessage.ts#L10">src/structures/SystemMessage.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="modules.html#ParameterType" class="tsd-signature-type" data-tsd-kind="Type alias">ParameterType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="MessageType" class="tsd-anchor"></a><h3>Message<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Message<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"PERMISSION"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ERROR"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"NOT_FOUND"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"SUCCESS"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/SystemMessage.ts#L10">src/structures/SystemMessage.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Types of system messages</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a name="ObjectIdReturnType" class="tsd-anchor"></a><h3>Object<wbr/>Id<wbr/>Return<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Object<wbr/>Id<wbr/>Return<wbr/>Type<T><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"channel"</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">VoiceChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CategoryChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">NewsChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">StageChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">StoreChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"user"</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">GuildMember</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"role"</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Role</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"mentionable"</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">VoiceChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CategoryChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">NewsChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">StageChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">StoreChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GuildMember</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Role</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">never</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Parameter.ts#L91">src/structures/Parameter.ts:91</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a name="ObjectIdReturnType" class="tsd-anchor"></a><h3>Object<wbr/>Id<wbr/>Return<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Object<wbr/>Id<wbr/>Return<wbr/>Type<T><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"channel"</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">VoiceChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CategoryChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">NewsChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">StageChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">StoreChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"user"</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">GuildMember</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"role"</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Role</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"mentionable"</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">VoiceChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CategoryChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">NewsChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">StageChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">StoreChannel</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GuildMember</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Role</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">never</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Parameter.ts#L82">src/structures/Parameter.ts:82</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p><em>ObjectID.prototype.toObject()</em> return type selector</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="modules.html#ObjectIdType" class="tsd-signature-type" data-tsd-kind="Type alias">ObjectIdType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="ObjectIdType" class="tsd-anchor"></a><h3>Object<wbr/>Id<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Object<wbr/>Id<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"user"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"role"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"channel"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"mentionable"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Parameter.ts#L85">src/structures/Parameter.ts:85</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="modules.html#ObjectIdType" class="tsd-signature-type" data-tsd-kind="Type alias">ObjectIdType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="ObjectIdType" class="tsd-anchor"></a><h3>Object<wbr/>Id<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Object<wbr/>Id<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"user"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"role"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"channel"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"mentionable"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Parameter.ts#L77">src/structures/Parameter.ts:77</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Types of Discord objects (IDs contained in an <a href="classes/ObjectID.html">ObjectID</a> wrapper)</p>
|
||||
<ul>
|
||||
<li><strong>user</strong> - server users list shown as selection menu in Discord</li>
|
||||
@@ -67,25 +67,25 @@ MESSAGE - context menu interaction for message</p>
|
||||
<li><strong>channel</strong> - server text, voice, stage, and category channels list shown as selection menu in Discord</li>
|
||||
<li><strong>mentionable</strong> - all objects that can be mentioned list shown as selection menu in Discord</li>
|
||||
</ul>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="ParameterResolvable" class="tsd-anchor"></a><h3>Parameter<wbr/>Resolvable</h3><div class="tsd-signature tsd-kind-icon">Parameter<wbr/>Resolvable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="classes/ObjectID.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><a href="classes/TargetID.html" class="tsd-signature-type" data-tsd-kind="Class">TargetID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Parameter.ts#L38">src/structures/Parameter.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="ParameterResolvable" class="tsd-anchor"></a><h3>Parameter<wbr/>Resolvable</h3><div class="tsd-signature tsd-kind-icon">Parameter<wbr/>Resolvable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="classes/ObjectID.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><a href="classes/TargetID.html" class="tsd-signature-type" data-tsd-kind="Class">TargetID</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Parameter.ts#L36">src/structures/Parameter.ts:36</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>All parameter resolvables</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="ParameterType" class="tsd-anchor"></a><h3>Parameter<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Parameter<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"string"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"boolean"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"number"</span><span class="tsd-signature-symbol"> | </span><a href="modules.html#ObjectIdType" class="tsd-signature-type" data-tsd-kind="Type alias">ObjectIdType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Parameter.ts#L12">src/structures/Parameter.ts:12</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="ParameterType" class="tsd-anchor"></a><h3>Parameter<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Parameter<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"string"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"boolean"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"number"</span><span class="tsd-signature-symbol"> | </span><a href="modules.html#ObjectIdType" class="tsd-signature-type" data-tsd-kind="Type alias">ObjectIdType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Parameter.ts#L12">src/structures/Parameter.ts:12</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Parameter type values</p>
|
||||
<ul>
|
||||
<li><strong>string</strong> - text value</li>
|
||||
<li><strong>boolean</strong> - True or False</li>
|
||||
<li><strong>number</strong> - number (double) value</li>
|
||||
</ul>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="PermissionCheckTypes" class="tsd-anchor"></a><h3>Permission<wbr/>Check<wbr/>Types</h3><div class="tsd-signature tsd-kind-icon">Permission<wbr/>Check<wbr/>Types<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ALL"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ANY"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/commands/types/permissions.ts#L11">src/commands/types/permissions.ts:11</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="PermissionCheckTypes" class="tsd-anchor"></a><h3>Permission<wbr/>Check<wbr/>Types</h3><div class="tsd-signature tsd-kind-icon">Permission<wbr/>Check<wbr/>Types<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ALL"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ANY"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/CommandPermissions.ts#L12">src/structures/CommandPermissions.ts:12</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Permission checking methods</p>
|
||||
</div><div><p>ALL - uses <a href="https://discord.js.org/#/docs/main/stable/class/Permissions?scrollTo=has"><em>Permissions.prototype.has</em></a> method</p>
|
||||
<p>ANY - uses <a href="https://discord.js.org/#/docs/main/stable/class/Permissions?scrollTo=any"><em>Permissions.prototype.any</em></a> method</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="PermissionFunction" class="tsd-anchor"></a><h3>Permission<wbr/>Function</h3><div class="tsd-signature tsd-kind-icon">Permission<wbr/>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>i<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Interaction</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol">)</span><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/2867da1/src/commands/types/permissions.ts#L17">src/commands/types/permissions.ts:17</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>i<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Interaction</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="PermissionFunction" class="tsd-anchor"></a><h3>Permission<wbr/>Function</h3><div class="tsd-signature tsd-kind-icon">Permission<wbr/>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>i<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Interaction</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol">)</span><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/5a80551/src/structures/CommandPermissions.ts#L17">src/structures/CommandPermissions.ts:17</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>i<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Interaction</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Definition of permission function</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>i: <span class="tsd-signature-type">Interaction</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Message</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="ScopeResolvable" class="tsd-anchor"></a><h3>Scope<wbr/>Resolvable</h3><div class="tsd-signature tsd-kind-icon">Scope<wbr/>Resolvable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Guild</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/PrefixManager.ts#L9">src/structures/PrefixManager.ts:9</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>i: <span class="tsd-signature-type">Interaction</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Message</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="ScopeResolvable" class="tsd-anchor"></a><h3>Scope<wbr/>Resolvable</h3><div class="tsd-signature tsd-kind-icon">Scope<wbr/>Resolvable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Guild</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/PrefixManager.ts#L9">src/structures/PrefixManager.ts:9</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Prefix scope types</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a name="TargetIdReturnType" class="tsd-anchor"></a><h3>Target<wbr/>Id<wbr/>Return<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Target<wbr/>Id<wbr/>Return<wbr/>Type<T><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"USER"</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">GuildMember</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"MESSAGE"</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">never</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Parameter.ts#L111">src/structures/Parameter.ts:111</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a name="TargetIdReturnType" class="tsd-anchor"></a><h3>Target<wbr/>Id<wbr/>Return<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Target<wbr/>Id<wbr/>Return<wbr/>Type<T><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"USER"</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">GuildMember</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"MESSAGE"</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">never</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Parameter.ts#L100">src/structures/Parameter.ts:100</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p><em>TargetID.prototype.toObject()</em> return type selector</p>
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="modules.html#TargetType" class="tsd-signature-type" data-tsd-kind="Type alias">TargetType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="TargetType" class="tsd-anchor"></a><h3>Target<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Target<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"MESSAGE"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"USER"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/2867da1/src/structures/Parameter.ts#L105">src/structures/Parameter.ts:105</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="modules.html#TargetType" class="tsd-signature-type" data-tsd-kind="Type alias">TargetType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="TargetType" class="tsd-anchor"></a><h3>Target<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Target<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"MESSAGE"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"USER"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/5a80551/src/structures/Parameter.ts#L95">src/structures/Parameter.ts:95</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Types of Discord context menu targets (IDs contained in a <a href="classes/TargetID.html">TargetID</a> wrapper)</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="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class"><a href="classes/Bot.html" class="tsd-kind-icon">Bot</a></li><li class="tsd-kind-class"><a href="classes/ChatCommand.html" class="tsd-kind-icon">Chat<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/Command.html" class="tsd-kind-icon">Command</a></li><li class="tsd-kind-class"><a href="classes/CommandManager.html" class="tsd-kind-icon">Command<wbr/>Manager</a></li><li class="tsd-kind-class"><a href="classes/CommandPermissions.html" class="tsd-kind-icon">Command<wbr/>Permissions</a></li><li class="tsd-kind-class"><a href="classes/ContextMenuCommand.html" class="tsd-kind-icon">Context<wbr/>Menu<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/FunctionCommand.html" class="tsd-kind-icon">Function<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/GuildCommand.html" class="tsd-kind-icon">Guild<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/HelpMessage.html" class="tsd-kind-icon">Help<wbr/>Message</a></li><li class="tsd-kind-class"><a href="classes/InputManager.html" class="tsd-kind-icon">Input<wbr/>Manager</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/InputParameter.html" class="tsd-kind-icon">Input<wbr/>Parameter</a></li><li class="tsd-kind-class"><a href="classes/MissingParameterError.html" class="tsd-kind-icon">Missing<wbr/>Parameter<wbr/>Error</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/ObjectID.html" class="tsd-kind-icon">ObjectID</a></li><li class="tsd-kind-class"><a href="classes/OperationSuccess.html" class="tsd-kind-icon">Operation<wbr/>Success</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/Parameter.html" class="tsd-kind-icon">Parameter</a></li><li class="tsd-kind-class"><a href="classes/ParameterTypeError.html" class="tsd-kind-icon">Parameter<wbr/>Type<wbr/>Error</a></li><li class="tsd-kind-class"><a href="classes/PermissionCommand.html" class="tsd-kind-icon">Permission<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/PermissionGuildCommand.html" class="tsd-kind-icon">Permission<wbr/>Guild<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/PermissionsError.html" class="tsd-kind-icon">Permissions<wbr/>Error</a></li><li class="tsd-kind-class"><a href="classes/PrefixManager.html" class="tsd-kind-icon">Prefix<wbr/>Manager</a></li><li class="tsd-kind-class"><a href="classes/SubCommand.html" class="tsd-kind-icon">Sub<wbr/>Command</a></li><li class="tsd-kind-class"><a href="classes/SubCommandGroup.html" class="tsd-kind-icon">Sub<wbr/>Command<wbr/>Group</a></li><li class="tsd-kind-class"><a href="classes/SystemMessageManager.html" class="tsd-kind-icon">System<wbr/>Message<wbr/>Manager</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/TargetID.html" class="tsd-kind-icon">TargetID</a></li><li class="tsd-kind-interface"><a href="interfaces/APICommandInit.html" class="tsd-kind-icon">APICommand<wbr/>Init</a></li><li class="tsd-kind-interface"><a href="interfaces/APICommandObject.html" class="tsd-kind-icon">APICommand<wbr/>Object</a></li><li class="tsd-kind-interface"><a href="interfaces/ChatCommandInit.html" class="tsd-kind-icon">Chat<wbr/>Command<wbr/>Init</a></li><li class="tsd-kind-interface"><a href="interfaces/ChatCommandObject.html" class="tsd-kind-icon">Chat<wbr/>Command<wbr/>Object</a></li><li class="tsd-kind-interface"><a href="interfaces/ChatCommandOptionObject.html" class="tsd-kind-icon">Chat<wbr/>Command<wbr/>Option<wbr/>Object</a></li><li class="tsd-kind-interface"><a href="interfaces/CommandPermission.html" class="tsd-kind-icon">Command<wbr/>Permission</a></li><li class="tsd-kind-interface"><a href="interfaces/CommandPermissionsInit.html" class="tsd-kind-icon">Command<wbr/>Permissions<wbr/>Init</a></li><li class="tsd-kind-interface"><a href="interfaces/ContextMenuCommandInit.html" class="tsd-kind-icon">Context<wbr/>Menu<wbr/>Command<wbr/>Init</a></li><li class="tsd-kind-interface"><a href="interfaces/ContextMenuCommandObject.html" class="tsd-kind-icon">Context<wbr/>Menu<wbr/>Command<wbr/>Object</a></li><li class="tsd-kind-interface"><a href="interfaces/FunctionCommandInit.html" class="tsd-kind-icon">Function<wbr/>Command<wbr/>Init</a></li><li class="tsd-kind-interface"><a href="interfaces/GuildCommandInit.html" class="tsd-kind-icon">Guild<wbr/>Command<wbr/>Init</a></li><li class="tsd-kind-interface"><a href="interfaces/HelpMessageParams.html" class="tsd-kind-icon">Help<wbr/>Message<wbr/>Params</a></li><li class="tsd-kind-interface"><a href="interfaces/InitOptions.html" class="tsd-kind-icon">Init<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/ParameterSchema.html" class="tsd-kind-icon">ParLine truncated
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "commandbot",
|
||||
"version": "4.1.0",
|
||||
"version": "4.2.0",
|
||||
"description": "A framework that helps you create your own Discord bot easier.",
|
||||
"main": "dist/cjs/index.js",
|
||||
"module": "dist/mjs/index.js",
|
||||
|
||||
Reference in new issue
Block a user