rainbownapkin/canopy
1
0
Fork 0
Code Issues 2 Pull requests Actions Packages Projects Releases Wiki Activity
canopy/www/doc/client/emotePanel.html

2258 lines
24 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: emotePanel</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: emotePanel</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>emotePanel<span class="signature">(client, panelDocument)</span><span class="type-signature"></span></h2>
<div class="class-description">Class representing Emote Panel UX</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="emotePanel"><span class="type-signature"></span>new emotePanel<span class="signature">(client, panelDocument)</span><span class="type-signature"></span></h4>
<div class="description">
Instantiates a new Panel Object
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>client</code></td>
<td class="type">
<span class="param-type"><a href="channel.html">channel</a></span>
</td>
<td class="description last">Parent client Management Object</td>
</tr>
<tr>
<td class="name"><code>panelDocument</code></td>
<td class="type">
<span class="param-type">Document</span>
</td>
<td class="description last">Panel Document</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="panels_emotePanel.js.html">panels/emotePanel.js</a>, <a href="panels_emotePanel.js.html#line21">line 21</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li><a href="panelObj.html">panelObj</a></li>
</ul>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="client"><span class="type-signature"></span>client<span class="type-signature"></span></h4>
<div class="description">
Parent Client Management object
</div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="panelObj.html#client">panelObj#client</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cpanel.js.html">cpanel.js</a>, <a href="cpanel.js.html#line295">line 295</a>
</li></ul></dd>
</dl>
<h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"></span></h4>
<div class="description">
Panel Name
</div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="panelObj.html#name">panelObj#name</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cpanel.js.html">cpanel.js</a>, <a href="cpanel.js.html#line275">line 275</a>
</li></ul></dd>
</dl>
<h4 class="name" id="ownerDoc"><span class="type-signature"></span>ownerDoc<span class="type-signature"></span></h4>
<div class="description">
Current root document panel doc lives within
</div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="panelObj.html#ownerDoc">panelObj#ownerDoc</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cpanel.js.html">cpanel.js</a>, <a href="cpanel.js.html#line290">line 290</a>
</li></ul></dd>
</dl>
<h4 class="name" id="pageURL"><span class="type-signature"></span>pageURL<span class="type-signature"></span></h4>
<div class="description">
Panel Default Page URL
</div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="panelObj.html#pageURL">panelObj#pageURL</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cpanel.js.html">cpanel.js</a>, <a href="cpanel.js.html#line280">line 280</a>
</li></ul></dd>
</dl>
<h4 class="name" id="panelDocument"><span class="type-signature"></span>panelDocument<span class="type-signature"></span></h4>
<div class="description">
Panel Document
</div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="panelObj.html#panelDocument">panelObj#panelDocument</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cpanel.js.html">cpanel.js</a>, <a href="cpanel.js.html#line285">line 285</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="addPersonalEmote"><span class="type-signature"></span>addPersonalEmote<span class="signature">(event)</span><span class="type-signature"></span></h4>
<div class="description">
Requests server to add emote to list of personal emotes
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>event</code></td>
<td class="type">
<span class="param-type">Event</span>
</td>
<td class="description last">Event passed down by event listener</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="panels_emotePanel.js.html">panels/emotePanel.js</a>, <a href="panels_emotePanel.js.html#line150">line 150</a>
</li></ul></dd>
</dl>
<h4 class="name" id="closer"><span class="type-signature"></span>closer<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Called upon panel close/exit
</div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="panelObj.html#closer">panelObj#closer</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cpanel.js.html">cpanel.js</a>, <a href="cpanel.js.html#line321">line 321</a>
</li></ul></dd>
</dl>
<h4 class="name" id="deletePersonalEmote"><span class="type-signature"></span>deletePersonalEmote<span class="signature">(name)</span><span class="type-signature"></span></h4>
<div class="description">
Requests server to remove emote from list of personal emotes
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">Name of emote to delete</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="panels_emotePanel.js.html">panels/emotePanel.js</a>, <a href="panels_emotePanel.js.html#line167">line 167</a>
</li></ul></dd>
</dl>
<h4 class="name" id="docSwitch"><span class="type-signature"></span>docSwitch<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Handles Document/Panel Changes
</div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="panelObj.html#docSwitch">panelObj#docSwitch</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cpanel.js.html">cpanel.js</a>, <a href="cpanel.js.html#line313">line 313</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getPage"><span class="type-signature">(async) </span>getPage<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
<div class="description">
Fetches panel page from the server
</div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="panelObj.html#getPage">panelObj#getPage</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cpanel.js.html">cpanel.js</a>, <a href="cpanel.js.html#line302">line 302</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Raw panel doc HTML
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
<h4 class="name" id="renderEmoteLists"><span class="type-signature"></span>renderEmoteLists<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Renders out emote list to panel document
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="panels_emotePanel.js.html">panels/emotePanel.js</a>, <a href="panels_emotePanel.js.html#line175">line 175</a>
</li></ul></dd>
</dl>
<h4 class="name" id="renderEmotes"><span class="type-signature"></span>renderEmotes<span class="signature">(emoteList, container, personal)</span><span class="type-signature"></span></h4>
<div class="description">
Renders out emotes to emote lists
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>emoteList</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="default">
</td>
<td class="description last">list of emotes to render</td>
</tr>
<tr>
<td class="name"><code>container</code></td>
<td class="type">
<span class="param-type">Node</span>
</td>
<td class="default">
</td>
<td class="description last">Container to render emotes out to</td>
</tr>
<tr>
<td class="name"><code>personal</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
false
</td>
<td class="description last">Denotes whether or not we're rendering personal emotes</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="panels_emotePanel.js.html">panels/emotePanel.js</a>, <a href="panels_emotePanel.js.html#line212">line 212</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setupInput"><span class="type-signature"></span>setupInput<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Defines input-related event handlers
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="panels_emotePanel.js.html">panels/emotePanel.js</a>, <a href="panels_emotePanel.js.html#line65">line 65</a>
</li></ul></dd>
</dl>
<h4 class="name" id="toggleChanEmotes"><span class="type-signature"></span>toggleChanEmotes<span class="signature">(event)</span><span class="type-signature"></span></h4>
<div class="description">
Toggles Channel emote display
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>event</code></td>
<td class="type">
<span class="param-type">Event</span>
</td>
<td class="description last">Event passed down by event listener</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="panels_emotePanel.js.html">panels/emotePanel.js</a>, <a href="panels_emotePanel.js.html#line104">line 104</a>
</li></ul></dd>
</dl>
<h4 class="name" id="toggleEmotes"><span class="type-signature"></span>toggleEmotes<span class="signature">(icon, list)</span><span class="type-signature"></span></h4>
<div class="description">
Toggles a specified emote list on or off
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>icon</code></td>
<td class="type">
<span class="param-type">Node</span>
</td>
<td class="description last">Toggle Icon for given list</td>
</tr>
<tr>
<td class="name"><code>list</code></td>
<td class="type">
<span class="param-type">Node</span>
</td>
<td class="description last">Emote list container to toggle</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="panels_emotePanel.js.html">panels/emotePanel.js</a>, <a href="panels_emotePanel.js.html#line121">line 121</a>
</li></ul></dd>
</dl>
<h4 class="name" id="togglePersonalEmotes"><span class="type-signature"></span>togglePersonalEmotes<span class="signature">(event)</span><span class="type-signature"></span></h4>
<div class="description">
Toggles Personal emote display
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>event</code></td>
<td class="type">
<span class="param-type">Event</span>
</td>
<td class="description last">Event passed down by event listener</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="panels_emotePanel.js.html">panels/emotePanel.js</a>, <a href="panels_emotePanel.js.html#line112">line 112</a>
</li></ul></dd>
</dl>
<h4 class="name" id="toggleSiteEmotes"><span class="type-signature"></span>toggleSiteEmotes<span class="signature">(event)</span><span class="type-signature"></span></h4>
<div class="description">
Toggles Site emote display
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>event</code></td>
<td class="type">
<span class="param-type">Event</span>
</td>
<td class="description last">Event passed down by event listener</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="panels_emotePanel.js.html">panels/emotePanel.js</a>, <a href="panels_emotePanel.js.html#line96">line 96</a>
</li></ul></dd>
</dl>
<h4 class="name" id="useEmote"><span class="type-signature"></span>useEmote<span class="signature">(emote)</span><span class="type-signature"></span></h4>
<div class="description">
Concatenates specified emote into chat prompt input
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>emote</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">Emote to concat into chat</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="panels_emotePanel.js.html">panels/emotePanel.js</a>, <a href="panels_emotePanel.js.html#line135">line 135</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="addURLPopup.html">addURLPopup</a></li><li><a href="cPanel.html">cPanel</a></li><li><a href="channel.html">channel</a></li><li><a href="chatBox.html">chatBox</a></li><li><a href="chatPostprocessor.html">chatPostprocessor</a></li><li><a href="clearPopup.html">clearPopup</a></li><li><a href="commandPreprocessor.html">commandPreprocessor</a></li><li><a href="commandProcessor.html">commandProcessor</a></li><li><a href="defaultTitlesPopup.html">defaultTitlesPopup</a></li><li><a href="emotePanel.html">emotePanel</a></li><li><a href="hlsBase.html">hlsBase</a></li><li><a href="hlsLiveStreamHandler.html">hlsLiveStreamHandler</a></li><li><a href="mediaHandler.html">mediaHandler</a></li><li><a href="newPlaylistPopup.html">newPlaylistPopup</a></li><li><a href="nullHandler.html">nullHandler</a></li><li><a href="panelObj.html">panelObj</a></li><li><a href="player.html">player</a></li><li><a href="playlistManager.html">playlistManager</a></li><li><a href="poppedPanel.html">poppedPanel</a></li><li><a href="queuePanel.html">queuePanel</a></li><li><a href="rawFileBase.html">rawFileBase</a></li><li><a href="rawFileHandler.html">rawFileHandler</a></li><li><a href="renamePopup.html">renamePopup</a></li><li><a href="reschedulePopup.html">reschedulePopup</a></li><li><a href="schedulePopup.html">schedulePopup</a></li><li><a href="settingsPanel.html">settingsPanel</a></li><li><a href="userList.html">userList</a></li><li><a href="youtubeEmbedHandler.html">youtubeEmbedHandler</a></li></ul><h3>Global</h3><ul><li><a href="global.html#onYouTubeIframeAPIReady">onYouTubeIframeAPIReady</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Sat Sep 06 2025 00:30:26 GMT-0400 (Eastern Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>
Reference in a new issue View git blame Copy permalink