Our RSI WS API instance
Our RSI API instance
used internally to represent what lobbies we're listening to
used internally to store the original state of things
the currently bookmarked channels
the communities we have access to
information on the bot member
notifications of the bot
the list of private lobbies (i.e private messages)
a role list
our websocket connection to spectrum
Return an event each time the broadcaster is sucessfully connected
the event
Returns every currently acessible lobbies
the array of lobbies the bot has access to
Returns a community the bot can see by name CASE INSENSITIVE
the name the category
Community if found, null otherwise.
Getter function for _SubscribedLobbies
the array of currently subscribed to lobbies
Checks if the supplied lobby is currently subscribed
a SpectrumLobby object
whether or not we're subscribed to this lobby
Updates the state with a new identify packet
the identify packet as sent by the RSI API
Declare a global message listener for every message the bot will get to see.
the callback function on message.
Method to re-send our current state to Spectrum on connection drop
Sets the bot public presence on spectrum
the status
the "sub-status"
Fonction to set the ws status as connected and listen for the ready signal.
Subscribes to a given lobby
the lobby to subscribe to
Convenience promise to track the first initialization of the API
a promise that will be true (and consumed) the next time the broadcaster is up and ready.
Generated using TypeDoc
State Represents the current state of our Spectrum informations watching the websocket to synchronise server-side and client-side information