backup payload
clientId used as x-tavern-id for some calls
amount of reconnect (on ws drop) before identify again
amount of reconnect (on connection loss) tries we still have
the RSI API instance
main wss endpoint
state of the system
Wss Client for spectrum
Wss Connection for spectrum
Calls the RSI API to search the given name and tries to come up with the best match possibles. will not return the BOT's own identity
the text to search by
an array of Users sorted by best likelyhood as calculated by RSI
Getter function for the current state of Spectrum
the State object
Decodes the wss token and decypher the x-tavern-id
the token returned by the identify call
First API Call to be made on Spectrum Launch Will populate token and x-tavern-id
Convenience method for initSpectrum() Launch spectrum as a given user with password
the username
the password
a promise which is true when the connection is ready
Main method to launch bot and connect to Spectrum. Either anonymously or with crenditials if username and password are set.
a promise which is true when the connection is ready
Used internally to trigger the ws subscribtion when we're identified to spectrum
the Identify packet payload
if the connection was successfull
Convenience method to launch spectrum ws
Ensures the RSI Login is sucesfull
Default ErrorCallback for wss
the wss connectFailed error
Default Callback on sucessfull wss Connection
the wss connection object
Generated using TypeDoc
Main API Class for Spectrum BOT Performs every spectrum user actions via wss or api calls
Spectrum