Lightcord/LightcordApi/docs/modules/_components_private_notices...

233 lines
14 KiB
HTML

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>&quot;components/private/Notices&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="_components_private_notices_.html">&quot;components/private/Notices&quot;</a>
</li>
</ul>
<h1>Module &quot;components/private/Notices&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 tsd-has-type-parameter"><a href="../classes/_components_private_notices_.notices.html" class="tsd-kind-icon">Notices</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="_components_private_notices_.html#notice" class="tsd-kind-icon">notice</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_components_private_notices_.html#noticewithoutid" class="tsd-kind-icon">notice<wbr>WithoutID</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Variables</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="_components_private_notices_.html#events" class="tsd-kind-icon">events</a></li>
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="_components_private_notices_.html#notices-1" class="tsd-kind-icon">notices</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="notice" class="tsd-anchor"></a>
<h3>notice</h3>
<div class="tsd-signature tsd-kind-icon">notice<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> &amp; </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/components/private/Notices.tsx:48</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
<a name="noticewithoutid" class="tsd-anchor"></a>
<h3>notice<wbr>WithoutID</h3>
<div class="tsd-signature tsd-kind-icon">notice<wbr>WithoutID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>buttonText<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>text<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"default"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"info"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"success"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"danger"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"streamerMode"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"download"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"notification"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"premium"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"richPresence"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"premiumTier1"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"premiumTier2"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"facebook"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"brand"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"survey"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"spotify"</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in lightcordapi/src/components/private/Notices.tsx:41</li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> button<wbr>Text<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>text<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"default"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"info"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"success"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"danger"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"streamerMode"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"download"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"notification"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"premium"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"richPresence"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"premiumTier1"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"premiumTier2"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"facebook"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"brand"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"survey"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"spotify"</span></h5>
</li>
</ul>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Variables</h2>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
<a name="events" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> events</h3>
<div class="tsd-signature tsd-kind-icon">events<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventEmitter</span><span class="tsd-signature-symbol"> = new EventEmitter()</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in lightcordapi/src/components/private/Notices.tsx:5</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
<a name="notices-1" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> notices</h3>
<div class="tsd-signature tsd-kind-icon">notices<span class="tsd-signature-symbol">:</span> <a href="_components_private_notices_.html#notice" class="tsd-signature-type">notice</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in lightcordapi/src/components/private/Notices.tsx:39</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="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
<li class="current tsd-kind-module">
<a href="_components_private_notices_.html">&quot;components/private/<wbr>Notices&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 tsd-has-type-parameter">
<a href="../classes/_components_private_notices_.notices.html" class="tsd-kind-icon">Notices</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="_components_private_notices_.html#notice" class="tsd-kind-icon">notice</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="_components_private_notices_.html#noticewithoutid" class="tsd-kind-icon">notice<wbr>WithoutID</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-module">
<a href="_components_private_notices_.html#events" class="tsd-kind-icon">events</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-module">
<a href="_components_private_notices_.html#notices-1" class="tsd-kind-icon">notices</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>