CommandBot/docs/classes/PrefixManager.html

<!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&#39;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></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/71b0f28/src/structures/PrefixManager.ts#L39">src/structures/PrefixManager.ts:39</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"> = &quot;GLOBAL&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/structures/PrefixManager.ts#L25">src/structures/PrefixManager.ts:25</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">&lt;</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">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GRZ4NA/DiscordCommands/blob/71b0f28/src/structures/PrefixManager.ts#L18">src/structures/PrefixManager.ts:18</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/71b0f28/src/structures/PrefixManager.ts#L32">src/structures/PrefixManager.ts:32</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/71b0f28/src/structures/PrefixManager.ts#L53">src/structures/PrefixManager.ts:53</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><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/71b0f28/src/structures/PrefixManager.ts#L63">src/structures/PrefixManager.ts:63</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/71b0f28/src/structures/PrefixManager.ts#L95">src/structures/PrefixManager.ts:95</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/71b0f28/src/structures/PrefixManager.ts#L78">src/structures/PrefixManager.ts:78</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>
</div></div></li><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">void</span></h4></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="PrefixManager.html" class="tsd-kind-icon">Prefix<wbr/>Manager</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="PrefixManager.html#constructor" class="tsd-kind-icon">constructor</a></li><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><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-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></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>