diff --git a/src/app/channel/activeChannel.js b/src/app/channel/activeChannel.js index 4e42f8d..2627fa3 100644 --- a/src/app/channel/activeChannel.js +++ b/src/app/channel/activeChannel.js @@ -32,14 +32,39 @@ class activeChannel{ * @param {Mongoose.Document} chanDB - chanDB to rehydrate buffer from */ constructor(server, chanDB){ + /** + * Parent Server Object + */ this.server = server; + + /** + * Current Channel Name + */ this.name = chanDB.name; + + /** + * List of channel-wide toke commands + */ this.tokeCommands = chanDB.tokeCommands; - //Keeping these in a map was originally a vestige but it's more preformant than an array or object so :P + + /** + * List of connected users + */ this.userList = new Map(); + + /** + * Child Queue Object + */ this.queue = new queue(server, chanDB, this); + + /** + * Child Playlist Handler Object + */ this.playlistHandler = new playlistHandler(server, chanDB, this); - //Define the chat buffer + + /** + * Child Chat Buffer Object + */ this.chatBuffer = new chatBuffer(server, chanDB, this); } diff --git a/src/app/channel/channelManager.js b/src/app/channel/channelManager.js index 545d37e..f264204 100644 --- a/src/app/channel/channelManager.js +++ b/src/app/channel/channelManager.js @@ -36,15 +36,20 @@ class channelManager{ * @param {Server} io - Socket.io server instanced passed down from server.js */ constructor(io){ - //Set the socket.io server + /** + * Socket.io server instance passed down from server.js + */ this.io = io; - //Load + /** + * Map containing all active channels running on the server + */ this.activeChannels = new Map; - //Load server components + /** + * Global Chat Handler Object + */ this.chatHandler = new chatHandler(this); - //this.mediaYanker = new mediaYanker(this); //Handle connections from socket.io io.on("connection", this.handleConnection.bind(this) ); diff --git a/src/app/channel/chat.js b/src/app/channel/chat.js index 5a181c8..b26fc17 100644 --- a/src/app/channel/chat.js +++ b/src/app/channel/chat.js @@ -28,11 +28,34 @@ class chat{ * @param {Array} links - Array of URLs/Links included in the message. */ constructor(user, flair, highLevel, msg, type, links){ + /** + * User who sent the message + */ this.user = user; + + /** + * Flair ID String for the flair used to send the message + */ this.flair = flair; + + /** + * Number representing current high level + */ this.highLevel = highLevel; + + /** + * COntents of the message, with links replaced with numbered file-seperator marks + */ this.msg = msg; + + /** + * Message Type Identifier, used for client-side processing. + */ this.type = type; + + /** + * Array of URLs/Links included in the message. + */ this.links = links; } } diff --git a/src/app/channel/chatBuffer.js b/src/app/channel/chatBuffer.js index a60bcab..6968e36 100644 --- a/src/app/channel/chatBuffer.js +++ b/src/app/channel/chatBuffer.js @@ -27,26 +27,48 @@ class chatBuffer{ * @param {activeChannel} channel - Parent Channel Object */ constructor(server, chanDB, channel){ - //Grab parent server and chan objects + /** + * Parent Server Object + */ this.server = server; + + /** + * Parent CHannel Object + */ this.channel = channel; //If we have no chanDB.chatBuffer if(chanDB == null || chanDB.chatBuffer == null){ - //Create RAM-based buffer array + /** + * RAM-Based buffer containing array of previous chats + */ this.buffer = []; //Otherwise }else{ - //Pull buffer from DB + /** + * RAM-Based buffer containing array of previous chats + */ this.buffer = chanDB.chatBuffer; } - //Create variables to hold timers for deciding when to write RAM buffer to DB - //Goes off 'this.inactivityDelay' seconds after the last chat was sent, assuming it isn't interrupted by new chats + /** + * Inactivity Timer, goes off after x seconds of chat inactivity + */ this.inactivityTimer = null; + + /** + * Inactivity Timer Delay + */ this.inactivityDelay = 10; - //Goes off 'this.busyDelay' minutes after the first chat message in the current volley of messages. Get's cancelled before being called if this.inactivityTimer goes off. + + /** + * Goes off after x minutes of solid chatroom activity (no inactivityTimer call in x minutes) + */ this.busyTimer = null; + + /** + * Busy Timer Delay + */ this.busyDelay = 5; } diff --git a/src/app/channel/chatHandler.js b/src/app/channel/chatHandler.js index eafe2d9..e1d2f9b 100644 --- a/src/app/channel/chatHandler.js +++ b/src/app/channel/chatHandler.js @@ -34,11 +34,19 @@ class chatHandler{ * @param {channelManager} server - Parent Server Object */ constructor(server){ - //Set server + /** + * Parent Server Object + */ this.server = server; - //Initialize command preprocessor + + /** + * Child Command Pre-Processor Object + */ this.commandPreprocessor = new commandPreprocessor(server, this) - //Max chat buffer size + + /** + * Max chat buffer message count + */ this.chatBufferSize = 50; } diff --git a/src/app/channel/commandPreprocessor.js b/src/app/channel/commandPreprocessor.js index 448198d..8b75261 100644 --- a/src/app/channel/commandPreprocessor.js +++ b/src/app/channel/commandPreprocessor.js @@ -33,9 +33,24 @@ class commandPreprocessor{ * @param {chatHandler} chatHandler - Parent Chat Handler Object */ constructor(server, chatHandler){ + /** + * Parent Server Object + */ this.server = server; + + /** + * Parent Chat Handler Object + */ this.chatHandler = chatHandler; + + /** + * Child Command Processor Object + */ this.commandProcessor = new commandProcessor(server, chatHandler); + + /** + * Child Tokebot Object + */ this.tokebot = new tokebot(server, chatHandler); } diff --git a/src/app/channel/connectedUser.js b/src/app/channel/connectedUser.js index 3bae407..3fe59d5 100644 --- a/src/app/channel/connectedUser.js +++ b/src/app/channel/connectedUser.js @@ -34,23 +34,55 @@ class connectedUser{ * @param {Socket} socket - Socket associated with the users connection */ constructor(userDB, chanRank, channel, socket){ + /** + * User ID Number + */ this.id = userDB.id; + + /** + * User Name + */ this.user = userDB.user; + + /** + * User Rank + */ this.rank = userDB.rank; + + /** + * User High-Level + */ this.highLevel = userDB.highLevel; //Check to make sure users flair entry from DB is good if(userDB.flair != null){ - //Use flair from DB + //Set flair from DB + /** + * User Flair + */ this.flair = userDB.flair.name; //Otherwise }else{ //Gracefully default to classic + /** + * User Flair + */ this.flair = 'classic'; } + /** + * User Channel-Rank + */ this.chanRank = chanRank; + + /** + * Connected Channel + */ this.channel = channel; + + /** + * List of active sockets to current channel + */ this.sockets = [socket.id]; } diff --git a/src/app/channel/media/media.js b/src/app/channel/media/media.js index 2edad7a..a072e6e 100644 --- a/src/app/channel/media/media.js +++ b/src/app/channel/media/media.js @@ -29,12 +29,39 @@ class media{ * @param {String} rawLink - URL to raw file copy of media, not applicable to all sources */ constructor(title, fileName, url, id, type, duration, rawLink = url){ + /** + * Chosen title of media + */ this.title = title; + + /** + * Original filename/title of media provided by source + */ this.fileName = fileName + + /** + * Original URL to file + */ this.url = url; + + /** + * Video ID from source (IE: youtube watch code/archive.org file path) + */ this.id = id; + + /** + * Original video source + */ this.type = type; + + /** + * Length of media in seconds + */ this.duration = duration; + + /** + * URL to raw file copy of media, not applicable to all sources + */ this.rawLink = rawLink; } } diff --git a/src/app/channel/media/playlistHandler.js b/src/app/channel/media/playlistHandler.js index 7aeba35..9345590 100644 --- a/src/app/channel/media/playlistHandler.js +++ b/src/app/channel/media/playlistHandler.js @@ -34,9 +34,14 @@ class playlistHandler{ * @param {activeChannel} channel - Parent Channel object for desired channel queue */ constructor(server, channel){ - //Set server + /** + * Parent Server Object + */ this.server = server - //Set channel + + /** + * Parent Channel Object for desired channel queue + */ this.channel = channel; } diff --git a/src/app/channel/media/queue.js b/src/app/channel/media/queue.js index be69ddd..f4cfe3e 100644 --- a/src/app/channel/media/queue.js +++ b/src/app/channel/media/queue.js @@ -34,38 +34,67 @@ class queue{ * @param {activeChannel} channel - Parent Channel object for desired channel queue */ constructor(server, chanDB, channel){ - //Set server + /** + * Parent Server Object + */ this.server = server - //Set channel + /** + * Parent Chennel Object for desired channel queue + */ this.channel = channel; - //Create map to hold currently queued media + /** + * Map containing current schedule + */ this.schedule = new Map(); - //Create variable to hold sync delta in ms + /** + * Sync Delta in MS + */ this.syncDelta = 1000; - //Create variable to hold current timestamp within the video + /** + * Current Timestamp in Media + */ this.timestamp = 0; //Delay between pre-switch function call and start of media //This should be enough time to do things like pre-fetch updated raw links from youtube + /** + * Time before media switch to run pre-switch method call against next media + */ this.preSwitchDelta = 10 * 1000; - //Create variable to hold sync timer + /** + * Syncronization Timer + */ this.syncTimer = null; - //Create variable to hold next playing item timer + /** + * Next Media Timer + */ this.nextTimer = null; - //Create vairable to hold pre-switch timer + /** + * Next Media Pre-Switch Timer + */ this.preSwitchTimer = null; - //Create variable to hold currently playing media object + /** + * Currently Playing Media Item + */ this.nowPlaying = null; - //Create variable to hold item that was playing during the last liveStream (can't check against full duration since it might've been stopped for other reasons) + /** + * Media interrupted by current live-stream + */ this.liveRemainder = null; - //Create variable to hold current live mode + /** + * Current live-stream schedule mode + */ this.liveMode = null; - //Create variable to lock standard queuing functions during livestreams + /** + * Locks scheduling functionality during livestreams + */ this.streamLock = false; - //create boolean to hold schedule lock + /** + * Locks schedule upon admin request + */ this.locked = false; //Rehydrate channel queue from database diff --git a/src/app/channel/media/queuedMedia.js b/src/app/channel/media/queuedMedia.js index 02bab6d..c92d7d0 100644 --- a/src/app/channel/media/queuedMedia.js +++ b/src/app/channel/media/queuedMedia.js @@ -32,13 +32,25 @@ class queuedMedia extends media{ constructor(title, fileName, url, id, type, duration, rawLink, startTime, startTimeStamp = 0, earlyEnd, uuid){ //Call derived constructor super(title, fileName, url, id, type, duration, rawLink); - //Set media start time + + /** + * JS Epoch (millis) representing start time + */ this.startTime = startTime; - //Set the media start time stamp + + /** + * Media start time stamp in seconds (relative to duration) + */ this.startTimeStamp = startTimeStamp; - //Create empty variable to hold early end if media is stopped early + + /** + * Media ent timestamp in seconds (relative to duration) + */ this.earlyEnd = earlyEnd; - //Set status for discriminator key + + /** + * Media status type + */ this.status = 'queued'; //If we have a null uuid (can't use default argument because of 'this') @@ -47,6 +59,9 @@ class queuedMedia extends media{ //That way even if we have six copies of the same video queued, we can still uniquely idenitify each instance this.genUUID(); }else{ + /** + * Media object's unique identifier + */ this.uuid = uuid; } } diff --git a/src/app/channel/tokebot.js b/src/app/channel/tokebot.js index 02bbc3c..7d1f005 100644 --- a/src/app/channel/tokebot.js +++ b/src/app/channel/tokebot.js @@ -30,23 +30,49 @@ class tokebot{ * @param {chatHandler} chatHandler - Parent Chat Handler Object */ constructor(server, chatHandler){ - //Set parents + /** + * Parent Server Object + */ this.server = server; + + /** + * Parent Chat Handler + */ this.chatHandler = chatHandler; - //Set timeouts to null + /** + * Toke Timer + */ this.tokeTimer = null; + + /** + * Cooldown Timer + */ this.cooldownTimer = null; - //Set start times + /** + * Toke time + */ this.tokeTime = 60; + + /** + * Cooldown Time + */ this.cooldownTime = 120; - //Create counter variable + /** + * Toke Counter + */ this.tokeCounter = 0; + + /** + * Cooldown Counter + */ this.cooldownCounter = 0; - //Create tokers list + /** + * List of current tokers + */ this.tokers = new Map(); //Load in toke commands from the DB diff --git a/www/doc/client/addURLPopup.html b/www/doc/client/addURLPopup.html index f37cb94..e6104d1 100644 --- a/www/doc/client/addURLPopup.html +++ b/www/doc/client/addURLPopup.html @@ -875,7 +875,7 @@
diff --git a/www/doc/client/cPanel.html b/www/doc/client/cPanel.html index 1192d30..19062d4 100644 --- a/www/doc/client/cPanel.html +++ b/www/doc/client/cPanel.html @@ -2602,7 +2602,7 @@
diff --git a/www/doc/client/channel.html b/www/doc/client/channel.html index 75abd0f..9263f28 100644 --- a/www/doc/client/channel.html +++ b/www/doc/client/channel.html @@ -1254,7 +1254,7 @@
diff --git a/www/doc/client/channel.js.html b/www/doc/client/channel.js.html index 8df3ff0..5c0f5d9 100644 --- a/www/doc/client/channel.js.html +++ b/www/doc/client/channel.js.html @@ -289,7 +289,7 @@ const client = new channel();
diff --git a/www/doc/client/chat.js.html b/www/doc/client/chat.js.html index 78164b3..5f67aa8 100644 --- a/www/doc/client/chat.js.html +++ b/www/doc/client/chat.js.html @@ -662,7 +662,7 @@ L /**
diff --git a/www/doc/client/chatBox.html b/www/doc/client/chatBox.html index 67c27d7..1f8d8ba 100644 --- a/www/doc/client/chatBox.html +++ b/www/doc/client/chatBox.html @@ -4650,7 +4650,7 @@ Also prevents horizontal scroll-bars from chat/window resizing
diff --git a/www/doc/client/chatPostprocessor.html b/www/doc/client/chatPostprocessor.html index 210e01a..be966ee 100644 --- a/www/doc/client/chatPostprocessor.html +++ b/www/doc/client/chatPostprocessor.html @@ -1794,7 +1794,7 @@ Internal command used by several text filters to prevent code re-writes
diff --git a/www/doc/client/chatPostprocessor.js.html b/www/doc/client/chatPostprocessor.js.html index 76f0bcf..d30e3b0 100644 --- a/www/doc/client/chatPostprocessor.js.html +++ b/www/doc/client/chatPostprocessor.js.html @@ -671,7 +671,7 @@ class chatPostprocessor{
diff --git a/www/doc/client/clearPopup.html b/www/doc/client/clearPopup.html index 17ca5ee..6e4a31f 100644 --- a/www/doc/client/clearPopup.html +++ b/www/doc/client/clearPopup.html @@ -790,7 +790,7 @@
diff --git a/www/doc/client/commandPreprocessor.html b/www/doc/client/commandPreprocessor.html index 49196d1..ac91717 100644 --- a/www/doc/client/commandPreprocessor.html +++ b/www/doc/client/commandPreprocessor.html @@ -1912,7 +1912,7 @@
diff --git a/www/doc/client/commandPreprocessor.js.html b/www/doc/client/commandPreprocessor.js.html index 6cc1133..0db8cb4 100644 --- a/www/doc/client/commandPreprocessor.js.html +++ b/www/doc/client/commandPreprocessor.js.html @@ -371,7 +371,7 @@ class commandProcessor{
diff --git a/www/doc/client/commandProcessor.html b/www/doc/client/commandProcessor.html index 9b278c6..cdc04ad 100644 --- a/www/doc/client/commandProcessor.html +++ b/www/doc/client/commandProcessor.html @@ -421,7 +421,7 @@
diff --git a/www/doc/client/cpanel.js.html b/www/doc/client/cpanel.js.html index 85475ec..5700081 100644 --- a/www/doc/client/cpanel.js.html +++ b/www/doc/client/cpanel.js.html @@ -515,7 +515,7 @@ class poppedPanel{
diff --git a/www/doc/client/defaultTitlesPopup.html b/www/doc/client/defaultTitlesPopup.html index a4612e6..84cd14a 100644 --- a/www/doc/client/defaultTitlesPopup.html +++ b/www/doc/client/defaultTitlesPopup.html @@ -960,7 +960,7 @@
diff --git a/www/doc/client/emotePanel.html b/www/doc/client/emotePanel.html index 51ae3df..34fc44d 100644 --- a/www/doc/client/emotePanel.html +++ b/www/doc/client/emotePanel.html @@ -2249,7 +2249,7 @@
diff --git a/www/doc/client/global.html b/www/doc/client/global.html index 04f0bc5..1a922e3 100644 --- a/www/doc/client/global.html +++ b/www/doc/client/global.html @@ -208,7 +208,7 @@
diff --git a/www/doc/client/hlsBase.html b/www/doc/client/hlsBase.html index 96474c8..6081ec1 100644 --- a/www/doc/client/hlsBase.html +++ b/www/doc/client/hlsBase.html @@ -2919,7 +2919,7 @@
diff --git a/www/doc/client/hlsLiveStreamHandler.html b/www/doc/client/hlsLiveStreamHandler.html index 2215d4a..f416f08 100644 --- a/www/doc/client/hlsLiveStreamHandler.html +++ b/www/doc/client/hlsLiveStreamHandler.html @@ -2896,7 +2896,7 @@
diff --git a/www/doc/client/index.html b/www/doc/client/index.html index 014a751..b6270c1 100644 --- a/www/doc/client/index.html +++ b/www/doc/client/index.html @@ -87,7 +87,7 @@ This new codebase intends to solve the following issues with the current CyTube
diff --git a/www/doc/client/mediaHandler.html b/www/doc/client/mediaHandler.html index a8ebff2..cdd3857 100644 --- a/www/doc/client/mediaHandler.html +++ b/www/doc/client/mediaHandler.html @@ -2701,7 +2701,7 @@
diff --git a/www/doc/client/mediaHandler.js.html b/www/doc/client/mediaHandler.js.html index 5eb03e5..86f2176 100644 --- a/www/doc/client/mediaHandler.js.html +++ b/www/doc/client/mediaHandler.js.html @@ -835,7 +835,7 @@ class hlsLiveStreamHandler extends hlsBase{
diff --git a/www/doc/client/newPlaylistPopup.html b/www/doc/client/newPlaylistPopup.html index 53bdd5c..238d33b 100644 --- a/www/doc/client/newPlaylistPopup.html +++ b/www/doc/client/newPlaylistPopup.html @@ -705,7 +705,7 @@
diff --git a/www/doc/client/nullHandler.html b/www/doc/client/nullHandler.html index d0ee7c4..2dfa74c 100644 --- a/www/doc/client/nullHandler.html +++ b/www/doc/client/nullHandler.html @@ -2873,7 +2873,7 @@
diff --git a/www/doc/client/panelObj.html b/www/doc/client/panelObj.html index 0d0161f..532c441 100644 --- a/www/doc/client/panelObj.html +++ b/www/doc/client/panelObj.html @@ -909,7 +909,7 @@
diff --git a/www/doc/client/panels_emotePanel.js.html b/www/doc/client/panels_emotePanel.js.html index 9cef131..0fb1aa4 100644 --- a/www/doc/client/panels_emotePanel.js.html +++ b/www/doc/client/panels_emotePanel.js.html @@ -353,7 +353,7 @@ class emotePanel extends panelObj{
diff --git a/www/doc/client/panels_queuePanel_playlistManager.js.html b/www/doc/client/panels_queuePanel_playlistManager.js.html index cf51d00..5607115 100644 --- a/www/doc/client/panels_queuePanel_playlistManager.js.html +++ b/www/doc/client/panels_queuePanel_playlistManager.js.html @@ -983,7 +983,7 @@ class renamePopup{
diff --git a/www/doc/client/panels_queuePanel_queuePanel.js.html b/www/doc/client/panels_queuePanel_queuePanel.js.html index 88fb0ec..da15fb4 100644 --- a/www/doc/client/panels_queuePanel_queuePanel.js.html +++ b/www/doc/client/panels_queuePanel_queuePanel.js.html @@ -1679,7 +1679,7 @@ class clearPopup{
diff --git a/www/doc/client/panels_settingsPanel.js.html b/www/doc/client/panels_settingsPanel.js.html index be0bdba..6762a8d 100644 --- a/www/doc/client/panels_settingsPanel.js.html +++ b/www/doc/client/panels_settingsPanel.js.html @@ -103,7 +103,7 @@ class settingsPanel extends panelObj{
diff --git a/www/doc/client/player.html b/www/doc/client/player.html index 010c7aa..c72854b 100644 --- a/www/doc/client/player.html +++ b/www/doc/client/player.html @@ -3374,7 +3374,7 @@ Might seem weird to keep this here instead of the HLS handler, but remember we m
diff --git a/www/doc/client/player.js.html b/www/doc/client/player.js.html index 433f762..2358ef6 100644 --- a/www/doc/client/player.js.html +++ b/www/doc/client/player.js.html @@ -474,7 +474,7 @@ class player{
diff --git a/www/doc/client/playlistManager.html b/www/doc/client/playlistManager.html index c5d099d..3881d82 100644 --- a/www/doc/client/playlistManager.html +++ b/www/doc/client/playlistManager.html @@ -3631,7 +3631,7 @@
diff --git a/www/doc/client/poppedPanel.html b/www/doc/client/poppedPanel.html index 6f39b48..743f9d8 100644 --- a/www/doc/client/poppedPanel.html +++ b/www/doc/client/poppedPanel.html @@ -1442,7 +1442,7 @@
diff --git a/www/doc/client/queuePanel.html b/www/doc/client/queuePanel.html index cee7e1f..12d0ad8 100644 --- a/www/doc/client/queuePanel.html +++ b/www/doc/client/queuePanel.html @@ -5313,7 +5313,7 @@
diff --git a/www/doc/client/rawFileBase.html b/www/doc/client/rawFileBase.html index c28becc..7a4231e 100644 --- a/www/doc/client/rawFileBase.html +++ b/www/doc/client/rawFileBase.html @@ -2914,7 +2914,7 @@
diff --git a/www/doc/client/rawFileHandler.html b/www/doc/client/rawFileHandler.html index a130f13..2c6d1fe 100644 --- a/www/doc/client/rawFileHandler.html +++ b/www/doc/client/rawFileHandler.html @@ -2896,7 +2896,7 @@
diff --git a/www/doc/client/renamePopup.html b/www/doc/client/renamePopup.html index d3afa2d..ae15123 100644 --- a/www/doc/client/renamePopup.html +++ b/www/doc/client/renamePopup.html @@ -875,7 +875,7 @@
diff --git a/www/doc/client/reschedulePopup.html b/www/doc/client/reschedulePopup.html index 94fb5a3..5a9562d 100644 --- a/www/doc/client/reschedulePopup.html +++ b/www/doc/client/reschedulePopup.html @@ -1050,7 +1050,7 @@
diff --git a/www/doc/client/schedulePopup.html b/www/doc/client/schedulePopup.html index 0c053a5..551ec2c 100644 --- a/www/doc/client/schedulePopup.html +++ b/www/doc/client/schedulePopup.html @@ -960,7 +960,7 @@
diff --git a/www/doc/client/settingsPanel.html b/www/doc/client/settingsPanel.html index 8372d57..96c0fbb 100644 --- a/www/doc/client/settingsPanel.html +++ b/www/doc/client/settingsPanel.html @@ -1156,7 +1156,7 @@
diff --git a/www/doc/client/userList.html b/www/doc/client/userList.html index 240eb75..38fa33f 100644 --- a/www/doc/client/userList.html +++ b/www/doc/client/userList.html @@ -1191,7 +1191,7 @@
diff --git a/www/doc/client/userlist.js.html b/www/doc/client/userlist.js.html index 7a25e12..0de2826 100644 --- a/www/doc/client/userlist.js.html +++ b/www/doc/client/userlist.js.html @@ -252,7 +252,7 @@ class userList{
diff --git a/www/doc/client/youtubeEmbedHandler.html b/www/doc/client/youtubeEmbedHandler.html index 0f43fa4..dfcadfb 100644 --- a/www/doc/client/youtubeEmbedHandler.html +++ b/www/doc/client/youtubeEmbedHandler.html @@ -2891,7 +2891,7 @@
diff --git a/www/doc/server/activeChannel.html b/www/doc/server/activeChannel.html index b627572..ae4c046 100644 --- a/www/doc/server/activeChannel.html +++ b/www/doc/server/activeChannel.html @@ -215,6 +215,444 @@ +

Members

+ + + +

chatBuffer

+ + + + +
+ Child Chat Buffer Object +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

name

+ + + + +
+ Current Channel Name +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

playlistHandler

+ + + + +
+ Child Playlist Handler Object +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

queue

+ + + + +
+ Child Queue Object +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

server

+ + + + +
+ Parent Server Object +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

tokeCommands

+ + + + +
+ List of channel-wide toke commands +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

userList

+ + + + +
+ List of connected users +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +

Methods

@@ -326,7 +764,7 @@
Source:
@@ -414,7 +852,7 @@
Source:
@@ -597,7 +1035,7 @@
Source:
@@ -734,7 +1172,7 @@
Source:
@@ -786,7 +1224,7 @@
diff --git a/www/doc/server/app_channel_activeChannel.js.html b/www/doc/server/app_channel_activeChannel.js.html index 0416210..36ac21f 100644 --- a/www/doc/server/app_channel_activeChannel.js.html +++ b/www/doc/server/app_channel_activeChannel.js.html @@ -60,14 +60,39 @@ class activeChannel{ * @param {Mongoose.Document} chanDB - chanDB to rehydrate buffer from */ constructor(server, chanDB){ + /** + * Parent Server Object + */ this.server = server; + + /** + * Current Channel Name + */ this.name = chanDB.name; + + /** + * List of channel-wide toke commands + */ this.tokeCommands = chanDB.tokeCommands; - //Keeping these in a map was originally a vestige but it's more preformant than an array or object so :P + + /** + * List of connected users + */ this.userList = new Map(); + + /** + * Child Queue Object + */ this.queue = new queue(server, chanDB, this); + + /** + * Child Playlist Handler Object + */ this.playlistHandler = new playlistHandler(server, chanDB, this); - //Define the chat buffer + + /** + * Child Chat Buffer Object + */ this.chatBuffer = new chatBuffer(server, chanDB, this); } @@ -196,7 +221,7 @@ module.exports = activeChannel;
diff --git a/www/doc/server/app_channel_channelManager.js.html b/www/doc/server/app_channel_channelManager.js.html index d735a64..0f89896 100644 --- a/www/doc/server/app_channel_channelManager.js.html +++ b/www/doc/server/app_channel_channelManager.js.html @@ -64,15 +64,20 @@ class channelManager{ * @param {Server} io - Socket.io server instanced passed down from server.js */ constructor(io){ - //Set the socket.io server + /** + * Socket.io server instance passed down from server.js + */ this.io = io; - //Load + /** + * Map containing all active channels running on the server + */ this.activeChannels = new Map; - //Load server components + /** + * Global Chat Handler Object + */ this.chatHandler = new chatHandler(this); - //this.mediaYanker = new mediaYanker(this); //Handle connections from socket.io io.on("connection", this.handleConnection.bind(this) ); @@ -347,7 +352,7 @@ module.exports = channelManager;
diff --git a/www/doc/server/app_channel_chat.js.html b/www/doc/server/app_channel_chat.js.html index 1e4952e..0523137 100644 --- a/www/doc/server/app_channel_chat.js.html +++ b/www/doc/server/app_channel_chat.js.html @@ -56,11 +56,34 @@ class chat{ * @param {Array} links - Array of URLs/Links included in the message. */ constructor(user, flair, highLevel, msg, type, links){ + /** + * User who sent the message + */ this.user = user; + + /** + * Flair ID String for the flair used to send the message + */ this.flair = flair; + + /** + * Number representing current high level + */ this.highLevel = highLevel; + + /** + * COntents of the message, with links replaced with numbered file-seperator marks + */ this.msg = msg; + + /** + * Message Type Identifier, used for client-side processing. + */ this.type = type; + + /** + * Array of URLs/Links included in the message. + */ this.links = links; } } @@ -81,7 +104,7 @@ module.exports = chat;
diff --git a/www/doc/server/app_channel_chatBuffer.js.html b/www/doc/server/app_channel_chatBuffer.js.html index b6e068c..c308556 100644 --- a/www/doc/server/app_channel_chatBuffer.js.html +++ b/www/doc/server/app_channel_chatBuffer.js.html @@ -55,26 +55,48 @@ class chatBuffer{ * @param {activeChannel} channel - Parent Channel Object */ constructor(server, chanDB, channel){ - //Grab parent server and chan objects + /** + * Parent Server Object + */ this.server = server; + + /** + * Parent CHannel Object + */ this.channel = channel; //If we have no chanDB.chatBuffer if(chanDB == null || chanDB.chatBuffer == null){ - //Create RAM-based buffer array + /** + * RAM-Based buffer containing array of previous chats + */ this.buffer = []; //Otherwise }else{ - //Pull buffer from DB + /** + * RAM-Based buffer containing array of previous chats + */ this.buffer = chanDB.chatBuffer; } - //Create variables to hold timers for deciding when to write RAM buffer to DB - //Goes off 'this.inactivityDelay' seconds after the last chat was sent, assuming it isn't interrupted by new chats + /** + * Inactivity Timer, goes off after x seconds of chat inactivity + */ this.inactivityTimer = null; + + /** + * Inactivity Timer Delay + */ this.inactivityDelay = 10; - //Goes off 'this.busyDelay' minutes after the first chat message in the current volley of messages. Get's cancelled before being called if this.inactivityTimer goes off. + + /** + * Goes off after x minutes of solid chatroom activity (no inactivityTimer call in x minutes) + */ this.busyTimer = null; + + /** + * Busy Timer Delay + */ this.busyDelay = 5; } @@ -178,7 +200,7 @@ module.exports = chatBuffer;
diff --git a/www/doc/server/app_channel_chatHandler.js.html b/www/doc/server/app_channel_chatHandler.js.html index 2fdd6ec..61e138b 100644 --- a/www/doc/server/app_channel_chatHandler.js.html +++ b/www/doc/server/app_channel_chatHandler.js.html @@ -62,11 +62,19 @@ class chatHandler{ * @param {channelManager} server - Parent Server Object */ constructor(server){ - //Set server + /** + * Parent Server Object + */ this.server = server; - //Initialize command preprocessor + + /** + * Child Command Pre-Processor Object + */ this.commandPreprocessor = new commandPreprocessor(server, this) - //Max chat buffer size + + /** + * Max chat buffer message count + */ this.chatBufferSize = 50; } @@ -376,7 +384,7 @@ module.exports = chatHandler;
diff --git a/www/doc/server/app_channel_commandPreprocessor.js.html b/www/doc/server/app_channel_commandPreprocessor.js.html index a9e0b48..ec3ce09 100644 --- a/www/doc/server/app_channel_commandPreprocessor.js.html +++ b/www/doc/server/app_channel_commandPreprocessor.js.html @@ -61,9 +61,24 @@ class commandPreprocessor{ * @param {chatHandler} chatHandler - Parent Chat Handler Object */ constructor(server, chatHandler){ + /** + * Parent Server Object + */ this.server = server; + + /** + * Parent Chat Handler Object + */ this.chatHandler = chatHandler; + + /** + * Child Command Processor Object + */ this.commandProcessor = new commandProcessor(server, chatHandler); + + /** + * Child Tokebot Object + */ this.tokebot = new tokebot(server, chatHandler); } @@ -473,7 +488,7 @@ module.exports = commandPreprocessor;
diff --git a/www/doc/server/app_channel_connectedUser.js.html b/www/doc/server/app_channel_connectedUser.js.html index 2c71b12..e2681db 100644 --- a/www/doc/server/app_channel_connectedUser.js.html +++ b/www/doc/server/app_channel_connectedUser.js.html @@ -62,23 +62,55 @@ class connectedUser{ * @param {Socket} socket - Socket associated with the users connection */ constructor(userDB, chanRank, channel, socket){ + /** + * User ID Number + */ this.id = userDB.id; + + /** + * User Name + */ this.user = userDB.user; + + /** + * User Rank + */ this.rank = userDB.rank; + + /** + * User High-Level + */ this.highLevel = userDB.highLevel; //Check to make sure users flair entry from DB is good if(userDB.flair != null){ - //Use flair from DB + //Set flair from DB + /** + * User Flair + */ this.flair = userDB.flair.name; //Otherwise }else{ //Gracefully default to classic + /** + * User Flair + */ this.flair = 'classic'; } + /** + * User Channel-Rank + */ this.chanRank = chanRank; + + /** + * Connected Channel + */ this.channel = channel; + + /** + * List of active sockets to current channel + */ this.sockets = [socket.id]; } @@ -334,7 +366,7 @@ module.exports = connectedUser;
diff --git a/www/doc/server/app_channel_media_media.js.html b/www/doc/server/app_channel_media_media.js.html index c6d3c26..9d013e6 100644 --- a/www/doc/server/app_channel_media_media.js.html +++ b/www/doc/server/app_channel_media_media.js.html @@ -57,12 +57,39 @@ class media{ * @param {String} rawLink - URL to raw file copy of media, not applicable to all sources */ constructor(title, fileName, url, id, type, duration, rawLink = url){ + /** + * Chosen title of media + */ this.title = title; + + /** + * Original filename/title of media provided by source + */ this.fileName = fileName + + /** + * Original URL to file + */ this.url = url; + + /** + * Video ID from source (IE: youtube watch code/archive.org file path) + */ this.id = id; + + /** + * Original video source + */ this.type = type; + + /** + * Length of media in seconds + */ this.duration = duration; + + /** + * URL to raw file copy of media, not applicable to all sources + */ this.rawLink = rawLink; } } @@ -83,7 +110,7 @@ module.exports = media;
diff --git a/www/doc/server/app_channel_media_playlistHandler.js.html b/www/doc/server/app_channel_media_playlistHandler.js.html index 919fa37..7bde234 100644 --- a/www/doc/server/app_channel_media_playlistHandler.js.html +++ b/www/doc/server/app_channel_media_playlistHandler.js.html @@ -62,9 +62,14 @@ class playlistHandler{ * @param {activeChannel} channel - Parent Channel object for desired channel queue */ constructor(server, channel){ - //Set server + /** + * Parent Server Object + */ this.server = server - //Set channel + + /** + * Parent Channel Object for desired channel queue + */ this.channel = channel; } @@ -1180,7 +1185,7 @@ module.exports = playlistHandler;
diff --git a/www/doc/server/app_channel_media_queue.js.html b/www/doc/server/app_channel_media_queue.js.html index bdacf29..48e21d0 100644 --- a/www/doc/server/app_channel_media_queue.js.html +++ b/www/doc/server/app_channel_media_queue.js.html @@ -62,38 +62,67 @@ class queue{ * @param {activeChannel} channel - Parent Channel object for desired channel queue */ constructor(server, chanDB, channel){ - //Set server + /** + * Parent Server Object + */ this.server = server - //Set channel + /** + * Parent Chennel Object for desired channel queue + */ this.channel = channel; - //Create map to hold currently queued media + /** + * Map containing current schedule + */ this.schedule = new Map(); - //Create variable to hold sync delta in ms + /** + * Sync Delta in MS + */ this.syncDelta = 1000; - //Create variable to hold current timestamp within the video + /** + * Current Timestamp in Media + */ this.timestamp = 0; //Delay between pre-switch function call and start of media //This should be enough time to do things like pre-fetch updated raw links from youtube + /** + * Time before media switch to run pre-switch method call against next media + */ this.preSwitchDelta = 10 * 1000; - //Create variable to hold sync timer + /** + * Syncronization Timer + */ this.syncTimer = null; - //Create variable to hold next playing item timer + /** + * Next Media Timer + */ this.nextTimer = null; - //Create vairable to hold pre-switch timer + /** + * Next Media Pre-Switch Timer + */ this.preSwitchTimer = null; - //Create variable to hold currently playing media object + /** + * Currently Playing Media Item + */ this.nowPlaying = null; - //Create variable to hold item that was playing during the last liveStream (can't check against full duration since it might've been stopped for other reasons) + /** + * Media interrupted by current live-stream + */ this.liveRemainder = null; - //Create variable to hold current live mode + /** + * Current live-stream schedule mode + */ this.liveMode = null; - //Create variable to lock standard queuing functions during livestreams + /** + * Locks scheduling functionality during livestreams + */ this.streamLock = false; - //create boolean to hold schedule lock + /** + * Locks schedule upon admin request + */ this.locked = false; //Rehydrate channel queue from database @@ -1795,7 +1824,7 @@ module.exports = queue;
diff --git a/www/doc/server/app_channel_media_queuedMedia.js.html b/www/doc/server/app_channel_media_queuedMedia.js.html index 7ddc804..10fbf45 100644 --- a/www/doc/server/app_channel_media_queuedMedia.js.html +++ b/www/doc/server/app_channel_media_queuedMedia.js.html @@ -60,13 +60,25 @@ class queuedMedia extends media{ constructor(title, fileName, url, id, type, duration, rawLink, startTime, startTimeStamp = 0, earlyEnd, uuid){ //Call derived constructor super(title, fileName, url, id, type, duration, rawLink); - //Set media start time + + /** + * JS Epoch (millis) representing start time + */ this.startTime = startTime; - //Set the media start time stamp + + /** + * Media start time stamp in seconds (relative to duration) + */ this.startTimeStamp = startTimeStamp; - //Create empty variable to hold early end if media is stopped early + + /** + * Media ent timestamp in seconds (relative to duration) + */ this.earlyEnd = earlyEnd; - //Set status for discriminator key + + /** + * Media status type + */ this.status = 'queued'; //If we have a null uuid (can't use default argument because of 'this') @@ -75,6 +87,9 @@ class queuedMedia extends media{ //That way even if we have six copies of the same video queued, we can still uniquely idenitify each instance this.genUUID(); }else{ + /** + * Media object's unique identifier + */ this.uuid = uuid; } } @@ -165,7 +180,7 @@ module.exports = queuedMedia;
diff --git a/www/doc/server/app_channel_tokebot.js.html b/www/doc/server/app_channel_tokebot.js.html index 1f8a045..b9ddf53 100644 --- a/www/doc/server/app_channel_tokebot.js.html +++ b/www/doc/server/app_channel_tokebot.js.html @@ -58,23 +58,49 @@ class tokebot{ * @param {chatHandler} chatHandler - Parent Chat Handler Object */ constructor(server, chatHandler){ - //Set parents + /** + * Parent Server Object + */ this.server = server; + + /** + * Parent Chat Handler + */ this.chatHandler = chatHandler; - //Set timeouts to null + /** + * Toke Timer + */ this.tokeTimer = null; + + /** + * Cooldown Timer + */ this.cooldownTimer = null; - //Set start times + /** + * Toke time + */ this.tokeTime = 60; + + /** + * Cooldown Time + */ this.cooldownTime = 120; - //Create counter variable + /** + * Toke Counter + */ this.tokeCounter = 0; + + /** + * Cooldown Counter + */ this.cooldownCounter = 0; - //Create tokers list + /** + * List of current tokers + */ this.tokers = new Map(); //Load in toke commands from the DB @@ -273,7 +299,7 @@ module.exports = tokebot;
diff --git a/www/doc/server/channelManager.html b/www/doc/server/channelManager.html index 0f5fc9d..92ec556 100644 --- a/www/doc/server/channelManager.html +++ b/www/doc/server/channelManager.html @@ -192,6 +192,196 @@ +

Members

+ + + +

activeChannels

+ + + + +
+ Map containing all active channels running on the server +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

chatHandler

+ + + + +
+ Global Chat Handler Object +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

io

+ + + + +
+ Socket.io server instance passed down from server.js +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +

Methods

@@ -303,7 +493,7 @@
Source:
@@ -413,7 +603,7 @@
Source:
@@ -573,7 +763,7 @@
Source:
@@ -710,7 +900,7 @@
Source:
@@ -847,7 +1037,7 @@
Source:
@@ -1006,7 +1196,7 @@
Source:
@@ -1176,7 +1366,7 @@
Source:
@@ -1313,7 +1503,7 @@
Source:
@@ -1460,7 +1650,7 @@
Source:
@@ -1620,7 +1810,7 @@
Source:
@@ -1780,7 +1970,7 @@
Source:
@@ -1917,7 +2107,7 @@
Source:
@@ -1991,7 +2181,7 @@
diff --git a/www/doc/server/chat.html b/www/doc/server/chat.html index c0e99fb..c899ba0 100644 --- a/www/doc/server/chat.html +++ b/www/doc/server/chat.html @@ -307,6 +307,382 @@ +

Members

+ + + +

flair

+ + + + +
+ Flair ID String for the flair used to send the message +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

highLevel

+ + + + +
+ Number representing current high level +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
+ Array of URLs/Links included in the message. +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

msg

+ + + + +
+ COntents of the message, with links replaced with numbered file-seperator marks +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

type

+ + + + +
+ Message Type Identifier, used for client-side processing. +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

user

+ + + + +
+ User who sent the message +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + @@ -329,7 +705,7 @@
diff --git a/www/doc/server/chatBuffer.html b/www/doc/server/chatBuffer.html index c8c390e..3e36519 100644 --- a/www/doc/server/chatBuffer.html +++ b/www/doc/server/chatBuffer.html @@ -238,6 +238,506 @@ +

Members

+ + + +

buffer

+ + + + +
+ RAM-Based buffer containing array of previous chats +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

buffer

+ + + + +
+ RAM-Based buffer containing array of previous chats +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

busyDelay

+ + + + +
+ Busy Timer Delay +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

busyTimer

+ + + + +
+ Goes off after x minutes of solid chatroom activity (no inactivityTimer call in x minutes) +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

channel

+ + + + +
+ Parent CHannel Object +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

inactivityDelay

+ + + + +
+ Inactivity Timer Delay +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

inactivityTimer

+ + + + +
+ Inactivity Timer, goes off after x seconds of chat inactivity +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

server

+ + + + +
+ Parent Server Object +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +

Methods

@@ -300,7 +800,7 @@
Source:
@@ -388,7 +888,7 @@
Source:
@@ -525,7 +1025,7 @@
Source:
@@ -685,7 +1185,7 @@
Source:
@@ -777,7 +1277,7 @@ Left here since it seems like good form anywho, since this would be a private, o
Source:
@@ -829,7 +1329,7 @@ Left here since it seems like good form anywho, since this would be a private, o
diff --git a/www/doc/server/chatHandler.html b/www/doc/server/chatHandler.html index e89a68b..e80c42f 100644 --- a/www/doc/server/chatHandler.html +++ b/www/doc/server/chatHandler.html @@ -192,6 +192,196 @@ +

Members

+ + + +

chatBufferSize

+ + + + +
+ Max chat buffer message count +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

commandPreprocessor

+ + + + +
+ Child Command Pre-Processor Object +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

server

+ + + + +
+ Parent Server Object +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +

Methods

@@ -326,7 +516,7 @@
Source:
@@ -486,7 +676,7 @@
Source:
@@ -623,7 +813,7 @@
Source:
@@ -783,7 +973,7 @@
Source:
@@ -943,7 +1133,7 @@
Source:
@@ -1103,7 +1293,7 @@
Source:
@@ -1410,7 +1600,7 @@
Source:
@@ -1570,7 +1760,7 @@
Source:
@@ -1850,7 +2040,7 @@
Source:
@@ -1987,7 +2177,7 @@
Source:
@@ -2147,7 +2337,7 @@
Source:
@@ -2445,7 +2635,7 @@
Source:
@@ -2605,7 +2795,7 @@
Source:
@@ -2765,7 +2955,7 @@
Source:
@@ -2925,7 +3115,7 @@
Source:
@@ -3108,7 +3298,7 @@
Source:
@@ -3314,7 +3504,7 @@
Source:
@@ -3474,7 +3664,7 @@
Source:
@@ -3634,7 +3824,7 @@
Source:
@@ -3686,7 +3876,7 @@
diff --git a/www/doc/server/commandPreprocessor.html b/www/doc/server/commandPreprocessor.html index 4da5243..40d41c5 100644 --- a/www/doc/server/commandPreprocessor.html +++ b/www/doc/server/commandPreprocessor.html @@ -215,6 +215,258 @@ +

Members

+ + + +

chatHandler

+ + + + +
+ Parent Chat Handler Object +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

commandProcessor

+ + + + +
+ Child Command Processor Object +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

server

+ + + + +
+ Parent Server Object +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

tokebot

+ + + + +
+ Child Tokebot Object +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +

Methods

@@ -326,7 +578,7 @@
Source:
@@ -463,7 +715,7 @@
Source:
@@ -623,7 +875,7 @@
Source:
@@ -760,7 +1012,7 @@
Source:
@@ -897,7 +1149,7 @@
Source:
@@ -1056,7 +1308,7 @@
Source:
@@ -1194,7 +1446,7 @@ These arrays are used to handle further command/chat processing
Source:
@@ -1246,7 +1498,7 @@ These arrays are used to handle further command/chat processing
diff --git a/www/doc/server/commandProcessor.html b/www/doc/server/commandProcessor.html index 217bc3d..5dd0ee6 100644 --- a/www/doc/server/commandProcessor.html +++ b/www/doc/server/commandProcessor.html @@ -169,7 +169,7 @@
Source:
@@ -326,7 +326,7 @@
Source:
@@ -485,7 +485,7 @@
Source:
@@ -644,7 +644,7 @@
Source:
@@ -803,7 +803,7 @@
Source:
@@ -962,7 +962,7 @@
Source:
@@ -1121,7 +1121,7 @@
Source:
@@ -1280,7 +1280,7 @@
Source:
@@ -1439,7 +1439,7 @@
Source:
@@ -1598,7 +1598,7 @@
Source:
@@ -1757,7 +1757,7 @@
Source:
@@ -1831,7 +1831,7 @@
diff --git a/www/doc/server/connectedUser.html b/www/doc/server/connectedUser.html index c67fe94..46f1b8c 100644 --- a/www/doc/server/connectedUser.html +++ b/www/doc/server/connectedUser.html @@ -261,6 +261,568 @@ +

Members

+ + + +

chanRank

+ + + + +
+ User Channel-Rank +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

channel

+ + + + +
+ Connected Channel +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

flair

+ + + + +
+ User Flair +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

flair

+ + + + +
+ User Flair +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

highLevel

+ + + + +
+ User High-Level +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

id

+ + + + +
+ User ID Number +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

rank

+ + + + +
+ User Rank +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

sockets

+ + + + +
+ List of active sockets to current channel +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

user

+ + + + +
+ User Name +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +

Methods

@@ -407,7 +969,7 @@
Source:
@@ -574,7 +1136,7 @@ Having to crawl through these sockets is that. Because the other ways seem more
Source:
@@ -757,7 +1319,7 @@ Having to crawl through these sockets is that. Because the other ways seem more
Source:
@@ -894,7 +1456,7 @@ Having to crawl through these sockets is that. Because the other ways seem more
Source:
@@ -1054,7 +1616,7 @@ Having to crawl through these sockets is that. Because the other ways seem more
Source:
@@ -1191,7 +1753,7 @@ Having to crawl through these sockets is that. Because the other ways seem more
Source:
@@ -1279,7 +1841,7 @@ Having to crawl through these sockets is that. Because the other ways seem more
Source:
@@ -1416,7 +1978,7 @@ Having to crawl through these sockets is that. Because the other ways seem more
Source:
@@ -1553,7 +2115,7 @@ Having to crawl through these sockets is that. Because the other ways seem more
Source:
@@ -1690,7 +2252,7 @@ Having to crawl through these sockets is that. Because the other ways seem more
Source:
@@ -1827,7 +2389,7 @@ Having to crawl through these sockets is that. Because the other ways seem more
Source:
@@ -1879,7 +2441,7 @@ Having to crawl through these sockets is that. Because the other ways seem more
diff --git a/www/doc/server/global.html b/www/doc/server/global.html index 8c2d71d..be3a8c9 100644 --- a/www/doc/server/global.html +++ b/www/doc/server/global.html @@ -7377,7 +7377,7 @@ Warns server admin against unsafe config options.
diff --git a/www/doc/server/index.html b/www/doc/server/index.html index 85fe372..3237879 100644 --- a/www/doc/server/index.html +++ b/www/doc/server/index.html @@ -87,7 +87,7 @@ This new codebase intends to solve the following issues with the current CyTube
diff --git a/www/doc/server/media.html b/www/doc/server/media.html index 578a2d9..e5da199 100644 --- a/www/doc/server/media.html +++ b/www/doc/server/media.html @@ -330,6 +330,444 @@ +

Members

+ + + +

duration

+ + + + +
+ Length of media in seconds +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

fileName

+ + + + +
+ Original filename/title of media provided by source +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

id

+ + + + +
+ Video ID from source (IE: youtube watch code/archive.org file path) +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
+ URL to raw file copy of media, not applicable to all sources +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

title

+ + + + +
+ Chosen title of media +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

type

+ + + + +
+ Original video source +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

url

+ + + + +
+ Original URL to file +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + @@ -352,7 +790,7 @@
diff --git a/www/doc/server/playlistHandler.html b/www/doc/server/playlistHandler.html index c544c67..26c8cb0 100644 --- a/www/doc/server/playlistHandler.html +++ b/www/doc/server/playlistHandler.html @@ -215,6 +215,134 @@ +

Members

+ + + +

channel

+ + + + +
+ Parent Channel Object for desired channel queue +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

server

+ + + + +
+ Parent Server Object +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +

Methods

@@ -372,7 +500,7 @@
Source:
@@ -532,7 +660,7 @@
Source:
@@ -737,7 +865,7 @@
Source:
@@ -920,7 +1048,7 @@
Source:
@@ -1103,7 +1231,7 @@
Source:
@@ -1240,7 +1368,7 @@
Source:
@@ -1445,7 +1573,7 @@
Source:
@@ -1605,7 +1733,7 @@
Source:
@@ -1810,7 +1938,7 @@
Source:
@@ -1947,7 +2075,7 @@
Source:
@@ -2130,7 +2258,7 @@
Source:
@@ -2313,7 +2441,7 @@
Source:
@@ -2473,7 +2601,7 @@
Source:
@@ -2656,7 +2784,7 @@
Source:
@@ -2839,7 +2967,7 @@
Source:
@@ -2999,7 +3127,7 @@
Source:
@@ -3159,7 +3287,7 @@
Source:
@@ -3342,7 +3470,7 @@
Source:
@@ -3525,7 +3653,7 @@
Source:
@@ -3685,7 +3813,7 @@
Source:
@@ -3913,7 +4041,7 @@
Source:
@@ -4096,7 +4224,7 @@
Source:
@@ -4302,7 +4430,7 @@
Source:
@@ -4508,7 +4636,7 @@
Source:
@@ -4691,7 +4819,7 @@
Source:
@@ -4851,7 +4979,7 @@
Source:
@@ -5056,7 +5184,7 @@
Source:
@@ -5108,7 +5236,7 @@
diff --git a/www/doc/server/queue.html b/www/doc/server/queue.html index d0b5249..0b25760 100644 --- a/www/doc/server/queue.html +++ b/www/doc/server/queue.html @@ -238,6 +238,878 @@ +

Members

+ + + +

channel

+ + + + +
+ Parent Chennel Object for desired channel queue +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

liveMode

+ + + + +
+ Current live-stream schedule mode +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

liveRemainder

+ + + + +
+ Media interrupted by current live-stream +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

locked

+ + + + +
+ Locks schedule upon admin request +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

nextTimer

+ + + + +
+ Next Media Timer +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

nowPlaying

+ + + + +
+ Currently Playing Media Item +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

preSwitchDelta

+ + + + +
+ Time before media switch to run pre-switch method call against next media +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

preSwitchTimer

+ + + + +
+ Next Media Pre-Switch Timer +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

schedule

+ + + + +
+ Map containing current schedule +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

server

+ + + + +
+ Parent Server Object +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

streamLock

+ + + + +
+ Locks scheduling functionality during livestreams +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

syncDelta

+ + + + +
+ Sync Delta in MS +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

syncTimer

+ + + + +
+ Syncronization Timer +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

timestamp

+ + + + +
+ Current Timestamp in Media +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +

Methods

@@ -349,7 +1221,7 @@
Source:
@@ -486,7 +1358,7 @@
Source:
@@ -646,7 +1518,7 @@
Source:
@@ -806,7 +1678,7 @@
Source:
@@ -1036,7 +1908,7 @@
Source:
@@ -1196,7 +2068,7 @@
Source:
@@ -1333,7 +2205,7 @@
Source:
@@ -1492,7 +2364,7 @@
Source:
@@ -1713,7 +2585,7 @@
Source:
@@ -1872,7 +2744,7 @@
Source:
@@ -2019,7 +2891,7 @@
Source:
@@ -2178,7 +3050,7 @@
Source:
@@ -2348,7 +3220,7 @@
Source:
@@ -2485,7 +3357,7 @@
Source:
@@ -2667,7 +3539,7 @@
Source:
@@ -2827,7 +3699,7 @@
Source:
@@ -2987,7 +3859,7 @@
Source:
@@ -3124,7 +3996,7 @@
Source:
@@ -3261,7 +4133,7 @@
Source:
@@ -3431,7 +4303,7 @@
Source:
@@ -3576,7 +4448,7 @@
Source:
@@ -3713,7 +4585,7 @@
Source:
@@ -3939,7 +4811,7 @@
Source:
@@ -4187,7 +5059,7 @@
Source:
@@ -4393,7 +5265,7 @@
Source:
@@ -4762,7 +5634,7 @@ https://community.appsmith.com/content/blog/dark-side-foreach-why-you-should-thi
Source:
@@ -4899,7 +5771,7 @@ https://community.appsmith.com/content/blog/dark-side-foreach-why-you-should-thi
Source:
@@ -5098,7 +5970,7 @@ https://community.appsmith.com/content/blog/dark-side-foreach-why-you-should-thi
Source:
@@ -5235,7 +6107,7 @@ https://community.appsmith.com/content/blog/dark-side-foreach-why-you-should-thi
Source:
@@ -5382,7 +6254,7 @@ https://community.appsmith.com/content/blog/dark-side-foreach-why-you-should-thi
Source:
@@ -5527,7 +6399,7 @@ https://community.appsmith.com/content/blog/dark-side-foreach-why-you-should-thi
Source:
@@ -5616,7 +6488,7 @@ Called auto-magically by the Synchronization Timer
Source:
@@ -5753,7 +6625,7 @@ Called auto-magically by the Synchronization Timer
Source:
@@ -5805,7 +6677,7 @@ Called auto-magically by the Synchronization Timer
diff --git a/www/doc/server/queuedMedia.html b/www/doc/server/queuedMedia.html index b1943d8..71aff30 100644 --- a/www/doc/server/queuedMedia.html +++ b/www/doc/server/queuedMedia.html @@ -292,6 +292,789 @@ +

Members

+ + + +

duration

+ + + + +
+ Length of media in seconds +
+ + + + + + + +
+ + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

earlyEnd

+ + + + +
+ Media ent timestamp in seconds (relative to duration) +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

fileName

+ + + + +
+ Original filename/title of media provided by source +
+ + + + + + + +
+ + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

id

+ + + + +
+ Video ID from source (IE: youtube watch code/archive.org file path) +
+ + + + + + + +
+ + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
+ URL to raw file copy of media, not applicable to all sources +
+ + + + + + + +
+ + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

startTime

+ + + + +
+ JS Epoch (millis) representing start time +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

startTimeStamp

+ + + + +
+ Media start time stamp in seconds (relative to duration) +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

status

+ + + + +
+ Media status type +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

title

+ + + + +
+ Chosen title of media +
+ + + + + + + +
+ + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

type

+ + + + +
+ Original video source +
+ + + + + + + +
+ + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

url

+ + + + +
+ Original URL to file +
+ + + + + + + +
+ + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

uuid

+ + + + +
+ Media object's unique identifier +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +

Methods

@@ -354,7 +1137,7 @@
Source:
@@ -499,7 +1282,7 @@
Source:
@@ -692,7 +1475,7 @@
Source:
@@ -874,7 +1657,7 @@
Source:
@@ -936,7 +1719,7 @@
diff --git a/www/doc/server/schemas_channel_channelBanSchema.js.html b/www/doc/server/schemas_channel_channelBanSchema.js.html index 85ed105..3e4b950 100644 --- a/www/doc/server/schemas_channel_channelBanSchema.js.html +++ b/www/doc/server/schemas_channel_channelBanSchema.js.html @@ -101,7 +101,7 @@ module.exports = channelBanSchema;
diff --git a/www/doc/server/schemas_channel_channelPermissionSchema.js.html b/www/doc/server/schemas_channel_channelPermissionSchema.js.html index f333bae..cf71747 100644 --- a/www/doc/server/schemas_channel_channelPermissionSchema.js.html +++ b/www/doc/server/schemas_channel_channelPermissionSchema.js.html @@ -169,7 +169,7 @@ module.exports = channelPermissionSchema;
diff --git a/www/doc/server/schemas_channel_channelSchema.js.html b/www/doc/server/schemas_channel_channelSchema.js.html index 747a402..1e5c01a 100644 --- a/www/doc/server/schemas_channel_channelSchema.js.html +++ b/www/doc/server/schemas_channel_channelSchema.js.html @@ -934,7 +934,7 @@ module.exports = mongoose.model("channel", channelSchema);
diff --git a/www/doc/server/schemas_channel_chatSchema.js.html b/www/doc/server/schemas_channel_chatSchema.js.html index abe226c..b557c8e 100644 --- a/www/doc/server/schemas_channel_chatSchema.js.html +++ b/www/doc/server/schemas_channel_chatSchema.js.html @@ -96,7 +96,7 @@ module.exports = chatSchema;
diff --git a/www/doc/server/schemas_channel_media_mediaSchema.js.html b/www/doc/server/schemas_channel_media_mediaSchema.js.html index 691feec..57f659a 100644 --- a/www/doc/server/schemas_channel_media_mediaSchema.js.html +++ b/www/doc/server/schemas_channel_media_mediaSchema.js.html @@ -96,7 +96,7 @@ module.exports = mediaSchema;
diff --git a/www/doc/server/schemas_channel_media_playlistMediaSchema.js.html b/www/doc/server/schemas_channel_media_playlistMediaSchema.js.html index e01c115..9251f83 100644 --- a/www/doc/server/schemas_channel_media_playlistMediaSchema.js.html +++ b/www/doc/server/schemas_channel_media_playlistMediaSchema.js.html @@ -124,7 +124,7 @@ module.exports = mediaSchema.discriminator('saved', playlistMediaProperties); diff --git a/www/doc/server/schemas_channel_media_playlistSchema.js.html b/www/doc/server/schemas_channel_media_playlistSchema.js.html index b6a48ed..a96f843 100644 --- a/www/doc/server/schemas_channel_media_playlistSchema.js.html +++ b/www/doc/server/schemas_channel_media_playlistSchema.js.html @@ -174,7 +174,7 @@ module.exports = playlistSchema;
diff --git a/www/doc/server/schemas_channel_media_queuedMediaSchema.js.html b/www/doc/server/schemas_channel_media_queuedMediaSchema.js.html index c23211b..72b130a 100644 --- a/www/doc/server/schemas_channel_media_queuedMediaSchema.js.html +++ b/www/doc/server/schemas_channel_media_queuedMediaSchema.js.html @@ -113,7 +113,7 @@ module.exports = mediaSchema.discriminator('queued', queuedProperties); diff --git a/www/doc/server/schemas_emoteSchema.js.html b/www/doc/server/schemas_emoteSchema.js.html index 442d3fd..290a7a5 100644 --- a/www/doc/server/schemas_emoteSchema.js.html +++ b/www/doc/server/schemas_emoteSchema.js.html @@ -164,7 +164,7 @@ module.exports = mongoose.model("emote", emoteSchema);
diff --git a/www/doc/server/schemas_flairSchema.js.html b/www/doc/server/schemas_flairSchema.js.html index 819824b..5762297 100644 --- a/www/doc/server/schemas_flairSchema.js.html +++ b/www/doc/server/schemas_flairSchema.js.html @@ -118,7 +118,7 @@ module.exports = mongoose.model("flair", flairSchema);
diff --git a/www/doc/server/schemas_permissionSchema.js.html b/www/doc/server/schemas_permissionSchema.js.html index 9152edb..9279114 100644 --- a/www/doc/server/schemas_permissionSchema.js.html +++ b/www/doc/server/schemas_permissionSchema.js.html @@ -356,7 +356,7 @@ module.exports = mongoose.model("permissions", permissionSchema);
diff --git a/www/doc/server/schemas_statSchema.js.html b/www/doc/server/schemas_statSchema.js.html index 2010006..b0d25bd 100644 --- a/www/doc/server/schemas_statSchema.js.html +++ b/www/doc/server/schemas_statSchema.js.html @@ -240,7 +240,7 @@ module.exports = mongoose.model("statistics", statSchema);
diff --git a/www/doc/server/schemas_tokebot_tokeCommandSchema.js.html b/www/doc/server/schemas_tokebot_tokeCommandSchema.js.html index daa18c1..41394d7 100644 --- a/www/doc/server/schemas_tokebot_tokeCommandSchema.js.html +++ b/www/doc/server/schemas_tokebot_tokeCommandSchema.js.html @@ -160,7 +160,7 @@ module.exports = mongoose.model("tokeCommand", tokeCommandSchema);
diff --git a/www/doc/server/schemas_user_emailChangeSchema.js.html b/www/doc/server/schemas_user_emailChangeSchema.js.html index 1a1592d..cc7e325 100644 --- a/www/doc/server/schemas_user_emailChangeSchema.js.html +++ b/www/doc/server/schemas_user_emailChangeSchema.js.html @@ -222,7 +222,7 @@ module.exports = mongoose.model("emailChange", emailChangeSchema);
diff --git a/www/doc/server/schemas_user_passwordResetSchema.js.html b/www/doc/server/schemas_user_passwordResetSchema.js.html index 4768a5c..936897b 100644 --- a/www/doc/server/schemas_user_passwordResetSchema.js.html +++ b/www/doc/server/schemas_user_passwordResetSchema.js.html @@ -198,7 +198,7 @@ module.exports = mongoose.model("passwordReset", passwordResetSchema);
diff --git a/www/doc/server/schemas_user_userBanSchema.js.html b/www/doc/server/schemas_user_userBanSchema.js.html index 3606178..5c4ba1b 100644 --- a/www/doc/server/schemas_user_userBanSchema.js.html +++ b/www/doc/server/schemas_user_userBanSchema.js.html @@ -521,7 +521,7 @@ module.exports = mongoose.model("userBan", userBanSchema);
diff --git a/www/doc/server/schemas_user_userSchema.js.html b/www/doc/server/schemas_user_userSchema.js.html index c717362..3b0cf92 100644 --- a/www/doc/server/schemas_user_userSchema.js.html +++ b/www/doc/server/schemas_user_userSchema.js.html @@ -888,7 +888,7 @@ module.exports.userModel = mongoose.model("user", userSchema);
diff --git a/www/doc/server/tokebot.html b/www/doc/server/tokebot.html index 45a896d..6b01394 100644 --- a/www/doc/server/tokebot.html +++ b/www/doc/server/tokebot.html @@ -215,6 +215,568 @@ +

Members

+ + + +

chatHandler

+ + + + +
+ Parent Chat Handler +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

cooldownCounter

+ + + + +
+ Cooldown Counter +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

cooldownTime

+ + + + +
+ Cooldown Time +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

cooldownTimer

+ + + + +
+ Cooldown Timer +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

server

+ + + + +
+ Parent Server Object +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

tokeCounter

+ + + + +
+ Toke Counter +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

tokeTime

+ + + + +
+ Toke time +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

tokeTimer

+ + + + +
+ Toke Timer +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

tokers

+ + + + +
+ List of current tokers +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +

Methods

@@ -278,7 +840,7 @@ I would now, but I don't want to break shit in a comment-only commit.
Source:
@@ -366,7 +928,7 @@ I would now, but I don't want to break shit in a comment-only commit.
Source:
@@ -454,7 +1016,7 @@ I would now, but I don't want to break shit in a comment-only commit.
Source:
@@ -542,7 +1104,7 @@ I would now, but I don't want to break shit in a comment-only commit.
Source:
@@ -630,7 +1192,7 @@ I would now, but I don't want to break shit in a comment-only commit.
Source:
@@ -767,7 +1329,7 @@ I would now, but I don't want to break shit in a comment-only commit.
Source:
@@ -841,7 +1403,7 @@ I would now, but I don't want to break shit in a comment-only commit.
diff --git a/www/doc/server/utils_altchaUtils.js.html b/www/doc/server/utils_altchaUtils.js.html index 492ca5b..46f55cd 100644 --- a/www/doc/server/utils_altchaUtils.js.html +++ b/www/doc/server/utils_altchaUtils.js.html @@ -118,7 +118,7 @@ module.exports.verify = async function(payload, uniqueSecret = ''){
diff --git a/www/doc/server/utils_configCheck.js.html b/www/doc/server/utils_configCheck.js.html index c642d74..e1f29e3 100644 --- a/www/doc/server/utils_configCheck.js.html +++ b/www/doc/server/utils_configCheck.js.html @@ -108,7 +108,7 @@ module.exports.securityCheck = function(){
diff --git a/www/doc/server/utils_hashUtils.js.html b/www/doc/server/utils_hashUtils.js.html index 0fb01b8..df88622 100644 --- a/www/doc/server/utils_hashUtils.js.html +++ b/www/doc/server/utils_hashUtils.js.html @@ -103,7 +103,7 @@ module.exports.hashIP = function(ip){
diff --git a/www/doc/server/utils_linkUtils.js.html b/www/doc/server/utils_linkUtils.js.html index 3716202..81c2fbd 100644 --- a/www/doc/server/utils_linkUtils.js.html +++ b/www/doc/server/utils_linkUtils.js.html @@ -146,7 +146,7 @@ module.exports.markLink = async function(link){
diff --git a/www/doc/server/utils_loggerUtils.js.html b/www/doc/server/utils_loggerUtils.js.html index 40ed5cf..4022e62 100644 --- a/www/doc/server/utils_loggerUtils.js.html +++ b/www/doc/server/utils_loggerUtils.js.html @@ -207,7 +207,7 @@ module.exports.errorMiddleware = function(err, req, res, next){
diff --git a/www/doc/server/utils_mailUtils.js.html b/www/doc/server/utils_mailUtils.js.html index 991adcb..d3aa7e2 100644 --- a/www/doc/server/utils_mailUtils.js.html +++ b/www/doc/server/utils_mailUtils.js.html @@ -140,7 +140,7 @@ module.exports.sendAddressVerification = async function(requestDB, userDB, newEm
diff --git a/www/doc/server/utils_media_internetArchiveUtils.js.html b/www/doc/server/utils_media_internetArchiveUtils.js.html index 1c949a8..743934c 100644 --- a/www/doc/server/utils_media_internetArchiveUtils.js.html +++ b/www/doc/server/utils_media_internetArchiveUtils.js.html @@ -154,7 +154,7 @@ module.exports.fetchMetadata = async function(fullID, title){
diff --git a/www/doc/server/utils_media_yanker.js.html b/www/doc/server/utils_media_yanker.js.html index d310e11..205359a 100644 --- a/www/doc/server/utils_media_yanker.js.html +++ b/www/doc/server/utils_media_yanker.js.html @@ -193,7 +193,7 @@ module.exports.getMediaType = async function(url){
diff --git a/www/doc/server/utils_media_ytdlpUtils.js.html b/www/doc/server/utils_media_ytdlpUtils.js.html index 23afb14..aeaa8ca 100644 --- a/www/doc/server/utils_media_ytdlpUtils.js.html +++ b/www/doc/server/utils_media_ytdlpUtils.js.html @@ -186,7 +186,7 @@ async function ytdlpFetch(link, format = 'b'){
diff --git a/www/doc/server/utils_regexUtils.js.html b/www/doc/server/utils_regexUtils.js.html index 2b7433d..6d5b3f6 100644 --- a/www/doc/server/utils_regexUtils.js.html +++ b/www/doc/server/utils_regexUtils.js.html @@ -69,7 +69,7 @@ module.exports.escapeRegex = function(string){
diff --git a/www/doc/server/utils_scheduler.js.html b/www/doc/server/utils_scheduler.js.html index 8f35179..8bfbd80 100644 --- a/www/doc/server/utils_scheduler.js.html +++ b/www/doc/server/utils_scheduler.js.html @@ -105,7 +105,7 @@ module.exports.kickoff = function(){
diff --git a/www/doc/server/utils_sessionUtils.js.html b/www/doc/server/utils_sessionUtils.js.html index e94d4ae..a4afb44 100644 --- a/www/doc/server/utils_sessionUtils.js.html +++ b/www/doc/server/utils_sessionUtils.js.html @@ -236,7 +236,7 @@ module.exports.maxAttempts = maxAttempts;