lightcordwarez
/
Lightcord
mirror of https://github.com/Lightcord/Lightcord.git
1
0
Fork 0
Code Issues Releases Wiki Activity
Lightcord/LightcordApi/docs/modules/_modules_discordtools_.html

292 lines
18 KiB
HTML
Raw Blame History

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>&quot;modules/DiscordTools&quot; | lightcordapi</title>
<meta name="description" content="Documentation for lightcordapi">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</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">lightcordapi</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>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</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="../globals.html">Globals</a>
</li>
<li>
<a href="_modules_discordtools_.html">&quot;modules/DiscordTools&quot;</a>
</li>
</ul>
<h1>Module &quot;modules/DiscordTools&quot;</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 tsd-parent-kind-module"><a href="../classes/_modules_discordtools_.notice.html" class="tsd-kind-icon">Notice</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Type aliases</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_modules_discordtools_.html#noticedata" class="tsd-kind-icon">Notice<wbr>Data</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_modules_discordtools_.html#notificationdata" class="tsd-kind-icon">Notification<wbr>Data</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_modules_discordtools_.html#sound" class="tsd-kind-icon">Sound</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-not-exported">
<h3>Variables</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported"><a href="_modules_discordtools_.html#soundmodule" class="tsd-kind-icon">sound<wbr>Module</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-not-exported">
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_modules_discordtools_.html#eventhandler" class="tsd-kind-icon">Event<wbr>Handler</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Type aliases</h2>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
<a name="noticedata" class="tsd-anchor"></a>
<h3>Notice<wbr>Data</h3>
<div class="tsd-signature tsd-kind-icon">Notice<wbr>Data<span class="tsd-signature-symbol">:</span> <a href="_components_private_notices_.html#noticewithoutid" class="tsd-signature-type">noticeWithoutID</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in lightcordapi/src/modules/DiscordTools.ts:71</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
<a name="notificationdata" class="tsd-anchor"></a>
<h3>Notification<wbr>Data</h3>
<div class="tsd-signature tsd-kind-icon">Notification<wbr>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>icon<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>onClick<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>onClose<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>onShow<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>title<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 lightcordapi/src/modules/DiscordTools.ts:62</li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>icon<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Click<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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-parent-kind-variable">
<li class="tsd-signature tsd-kind-icon"><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Close<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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-parent-kind-variable">
<li class="tsd-signature tsd-kind-icon"><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Show<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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-parent-kind-variable">
<li class="tsd-signature tsd-kind-icon"><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
<a name="sound" class="tsd-anchor"></a>
<h3>Sound</h3>
<div class="tsd-signature tsd-kind-icon">Sound<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"call_calling"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"call_ringing"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"call_ringing_beat"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ddr-down"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ddr-left"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ddr-right"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ddr-up"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"deafen"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"discodo"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"disconnect"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"human_man"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"mention1"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"mention2"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"mention3"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"message1"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"message2"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"message3"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"mute"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"overlayunlock"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ptt_start"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ptt_stop"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"reconnect"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"robot_man"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"stream_ended"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"stream_started"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"stream_user_joined"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"stream_user_left"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"undeafen"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"unmute"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"user_join"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"user_leave"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"user_moved"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in lightcordapi/src/modules/DiscordTools.ts:60</li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
<h2>Variables</h2>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
<a name="soundmodule" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagLet">Let</span> sound<wbr>Module</h3>
<div class="tsd-signature tsd-kind-icon">sound<wbr>Module<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in lightcordapi/src/modules/DiscordTools.ts:11</li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
<h2>Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
<a name="eventhandler" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> Event<wbr>Handler</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">Event<wbr>Handler<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">
<aside class="tsd-sources">
<ul>
<li>Defined in lightcordapi/src/modules/DiscordTools.ts:73</li>
</ul>
</aside>
<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="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
<li class="current tsd-kind-module">
<a href="_modules_discordtools_.html">&quot;modules/<wbr>Discord<wbr>Tools&quot;</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="../classes/_modules_discordtools_.notice.html" class="tsd-kind-icon">Notice</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="_modules_discordtools_.html#noticedata" class="tsd-kind-icon">Notice<wbr>Data</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="_modules_discordtools_.html#notificationdata" class="tsd-kind-icon">Notification<wbr>Data</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="_modules_discordtools_.html#sound" class="tsd-kind-icon">Sound</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
<a href="_modules_discordtools_.html#soundmodule" class="tsd-kind-icon">sound<wbr>Module</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
<a href="_modules_discordtools_.html#eventhandler" class="tsd-kind-icon">Event<wbr>Handler</a>
</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-namespace"><span class="tsd-kind-icon">Namespace</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
</ul>
</div>
</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/js/main.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink