index/classes/StreamWebSocketService.md
Stream WebSocket Service
Example
const ws = new StreamWebSocketService({ url: getEnvironmentConfig('stage').launchpadBaseUrl });
// Two components watch the same token: both are served, the room is joined once.
const offStatus = ws.subscribeStreamStatus('mytoken', (event) => console.log(event.status));
const offTrades = ws.subscribeTradeExecuted('mytoken', (event) => console.log(event.tradeType));
// Leaving the last subscriber leaves the room.
offStatus();
offTrades();
ws.disconnect();
Extends
LoggerBase
logger base
Constructors
Constructor
new StreamWebSocketService(
config,debug?):StreamWebSocketService
Parameters
| Parameter | Type |
|---|---|
config | StreamWebSocketConfig |
debug? | boolean |
Returns
StreamWebSocketService
Overrides
LoggerBase.constructor
stream web socket service config logger base
Methods
addCallbacks()
addCallbacks(
callbacks):Unsubscribe
Add a callback object's callbacks as subscribers of their events on every token, joining no room. Each callback is its own subscriber; none replaces another.
Parameters
| Parameter | Type |
|---|---|
callbacks | StreamEventCallbacks |
Returns
Function that removes the callbacks this call added
Since
9.0.0
add callbacks stream event
authenticate()
authenticate(
token?):Promise<boolean>
Authenticate the connection (opening it first if needed).
Resolves true when the server answers authenticated; false when it answers exception or
stream_chat_auth_error, when the answer does not come within subscriptionTimeout, when the
connection drops meanwhile, when there is no token, or when a newer authenticate / deauthenticate
replaced this call.
- The same token on the same connection resolves
truewithout sending anything. - The same token while that token is being authenticated shares the pending call.
- A different token replaces the pending one (that call resolves
false); the new token is sent after the server has answered the one in flight, so the server's final identity is the newest token. - Without a token argument the service asks its
tokenProvider(so a refreshed token is used).
Parameters
| Parameter | Type | Description |
|---|---|---|
token? | string | JWT to authenticate with (default: the token provider's current token) |
Returns
Promise<boolean>
Since
5.1.0
stream chat auth error subscription timeout token provider
connect()
connect():
Promise<void>
Connect to the stream WebSocket server.
Idempotent and safe to call concurrently: there is one socket however many callers wait for it. Calling it while connected resolves at once; while socket.io is retrying it waits for the next connection.
Returns
Promise<void>
Promise that resolves when connected, rejects when the next connection attempt fails
Throws
ConfigurationError if Socket.IO is not available (the promise rejects)
deauthenticate()
deauthenticate():
void
Forget the authenticated identity.
Cancels a pending authenticate, stops re-authenticating on reconnect, and: the server has no message
that drops a socket's identity (its user room, and the overseer room, stay joined until the connection
closes), so when the socket was authenticated it is closed and opened again. The registry survives; the
new connection joins the public rooms again and onReconnect listeners fire.
Returns
void
Since
9.0.0
on reconnect
disconnect()
disconnect():
void
Close the socket and release everything the service holds: every socket listener (the Socket's and
the Manager's), every timer, every subscriber, every pending connect / authenticate / subscribe (they
settle: connects reject, authenticates resolve false, subscribes reject). An unsubscribe handed out
earlier stays harmless. The service can connect and subscribe again afterwards.
Returns
void
dispose()
dispose():
void
StreamWebSocketService.disconnect, and the service refuses everything afterwards (a subscribe returns an inert unsubscribe, a connect rejects). Called when the owning SDK is disposed.
Returns
void
getSiteConfigState()
getSiteConfigState():
SiteConfigState
The site-wide switches announced since the feed was joined (undefined: none announced yet).
Returns
Since
9.0.0
get site config state
getSocket()
getSocket():
Socket<DefaultEventsMap,DefaultEventsMap> |null
Get the underlying Socket.IO instance
Returns
Socket<DefaultEventsMap, DefaultEventsMap> | null
get socket default events map
getSubscribedTokens()
getSubscribedTokens():
string[]
Get list of tokens whose room has a subscriber
Returns
string[]
get subscribed tokens
isAuthenticatedForChat()
isAuthenticatedForChat():
boolean
Check if authenticated for chat operations
Returns
boolean
is authenticated for chat
isConnected()
isConnected():
boolean
Check if connected to the WebSocket server
Returns
boolean
is connected
isSubscribedToGlobalFeed()
isSubscribedToGlobalFeed():
boolean
Check if the global feed has a subscriber
Returns
boolean
Since
7.0.0
is subscribed to global feed
joinTokenRoom()
joinTokenRoom(
tokenName):Unsubscribe
Hold a token's room without listening to any event of it: the room is joined for as long as this (or any other subscriber of the token) is registered. For a caller that wants the room to stay joined while its listeners come and go.
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
Returns
This hold's own release
Since
9.0.0
join token room name
onConnectionStateChange()
onConnectionStateChange(
listener):Unsubscribe
Listen for the connection coming up (true) and going down (false).
Parameters
| Parameter | Type |
|---|---|
listener | (connected) => void |
Returns
Function to stop listening
Since
9.0.0
on connection state change
onReconnect()
onReconnect(
listener):Unsubscribe
Listen for the socket coming back after a drop. Fires after the service has re-authenticated and re-joined its rooms, never for the first connection. Use it to refetch what was missed.
Parameters
| Parameter | Type |
|---|---|
listener | () => void |
Returns
Function to stop listening
Since
9.0.0
on reconnect
sendChatMessage()
sendChatMessage(
tokenName,content):void
Send a chat message via WebSocket (faster than REST)
Parameters
| Parameter | Type | Description |
|---|---|---|
tokenName | string | Token name for the chat room |
content | string | Message content |
Returns
void
Throws
ValidationError if not authenticated or not connected
send chat message token name
sendReaction()
sendReaction(
tokenName,emoji,streamTime?):void
Send an ephemeral emoji reaction to a live stream
Reactions are broadcast to all viewers but NOT persisted to database. Rate limiting is enforced server-side (burst of 10, then 0.5/sec refill).
Parameters
| Parameter | Type | Description |
|---|---|---|
tokenName | string | Token name for the stream |
emoji | string | Emoji to send (single emoji or short sequence, max 15 chars) |
streamTime? | number | Current stream timecode in seconds (for viewer sync) |
Returns
void
Throws
ValidationError if not authenticated or not connected
Since
5.2.0
send reaction token name stream time
sendTypingStart()
sendTypingStart(
tokenName):void
Send typing indicator start event (the server auto-expires it after 5 seconds)
Parameters
| Parameter | Type | Description |
|---|---|---|
tokenName | string | Token name for the chat room |
Returns
void
Throws
ValidationError if not authenticated or not connected
Since
5.11.0
send typing start token name
sendTypingStop()
sendTypingStop(
tokenName):void
Send typing indicator stop event
Parameters
| Parameter | Type | Description |
|---|---|---|
tokenName | string | Token name for the chat room |
Returns
void
Throws
ValidationError if not authenticated or not connected
Since
5.11.0
send typing stop token name
subscribeAIModerationComplete()
subscribeAIModerationComplete(
listener):Unsubscribe
An AI analysis of a flag finished (AI_MODERATION_COMPLETE, the overseer room).
Parameters
| Parameter | Type |
|---|---|
listener | RealtimeListener<"AI_MODERATION_COMPLETE"> |
Returns
Since
9.0.0
subscribe ai moderation complete realtime listener
subscribeAIModerationFailed()
subscribeAIModerationFailed(
listener):Unsubscribe
An AI analysis of a flag failed (AI_MODERATION_FAILED, the overseer room).
Parameters
| Parameter | Type |
|---|---|
listener | RealtimeListener<"AI_MODERATION_FAILED"> |
Returns
Since
9.0.0
subscribe ai moderation failed realtime listener
subscribeAIModerationGlobalStatus()
subscribeAIModerationGlobalStatus(
listener):Unsubscribe
AI moderation was switched on or off site-wide (AI_MODERATION_GLOBAL_STATUS). Joins the global feed.
Parameters
| Parameter | Type |
|---|---|
listener | RealtimeListener<"AI_MODERATION_GLOBAL_STATUS"> |
Returns
Since
9.0.0
subscribe ai moderation global status realtime listener
subscribeApiKeyCreated()
subscribeApiKeyCreated(
listener):Unsubscribe
An API key was created (API_KEY_CREATED).
Parameters
| Parameter | Type |
|---|---|
listener | RealtimeListener<"API_KEY_CREATED"> |
Returns
Since
6.0.0
subscribe api key created realtime listener
subscribeApiKeyRevoked()
subscribeApiKeyRevoked(
listener):Unsubscribe
An API key was revoked (API_KEY_REVOKED).
Parameters
| Parameter | Type |
|---|---|
listener | RealtimeListener<"API_KEY_REVOKED"> |
Returns
Since
6.0.0
subscribe api key revoked realtime listener
subscribeApiKeyUpdated()
subscribeApiKeyUpdated(
listener):Unsubscribe
An API key was updated (API_KEY_UPDATED).
Parameters
| Parameter | Type |
|---|---|
listener | RealtimeListener<"API_KEY_UPDATED"> |
Returns
Since
6.0.0
subscribe api key updated realtime listener
subscribeBalanceUpdated()
subscribeBalanceUpdated(
tokenName,listener):Unsubscribe
The authenticated user's balance change after a trade (BALANCE_UPDATED) of a token.
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"BALANCE_UPDATED"> |
Returns
Since
9.0.0
subscribe balance updated token name realtime listener
subscribeBanEnforcement()
subscribeBanEnforcement(
listener):Unsubscribe
A banned user's action was refused (BAN_ENFORCEMENT).
Parameters
| Parameter | Type |
|---|---|
listener | RealtimeListener<"BAN_ENFORCEMENT"> |
Returns
Since
9.0.0
subscribe ban enforcement realtime listener
subscribeChatDeleted()
subscribeChatDeleted(
tokenName,listener):Unsubscribe
Deleted chat messages (STREAM_CHAT_DELETED) of a token.
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"STREAM_CHAT_DELETED"> |
Returns
Since
9.0.0
subscribe chat deleted token name stream realtime listener
subscribeChatErrors()
subscribeChatErrors(
listener):Unsubscribe
A chat message was refused (stream_chat_error), any token.
Parameters
| Parameter | Type |
|---|---|
listener | RealtimeListener<"stream_chat_error"> |
Returns
Since
9.0.0
subscribe chat errors stream error realtime listener
subscribeChatGlobalStatus()
subscribeChatGlobalStatus(
listener):Unsubscribe
Chat was switched on or off site-wide (STREAM_CHAT_GLOBAL_STATUS). Joins the global feed.
Parameters
| Parameter | Type |
|---|---|
listener | RealtimeListener<"STREAM_CHAT_GLOBAL_STATUS"> |
Returns
Since
9.0.0
subscribe chat global status stream realtime listener
subscribeChatMessages()
subscribeChatMessages(
tokenName,listener):Unsubscribe
New chat messages (STREAM_CHAT_MESSAGE) of a token.
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"STREAM_CHAT_MESSAGE"> |
Returns
Since
9.0.0
subscribe chat messages token name stream message realtime listener
subscribeChatPinned()
subscribeChatPinned(
tokenName,listener):Unsubscribe
Pinned chat messages (STREAM_CHAT_PINNED) of a token.
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"STREAM_CHAT_PINNED"> |
Returns
Since
9.0.0
subscribe chat pinned token name stream realtime listener
subscribeChatSent()
subscribeChatSent(
tokenName,listener):Unsubscribe
Confirmation that this socket's chat message was stored (STREAM_CHAT_SENT).
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"STREAM_CHAT_SENT"> |
Returns
Since
9.0.0
subscribe chat sent token name stream realtime listener
subscribeChatSlowMode()
subscribeChatSlowMode(
tokenName,listener):Unsubscribe
A token's chat slow mode changed (SLOW_MODE_CHANGED).
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"SLOW_MODE_CHANGED"> |
Returns
Since
9.0.0
subscribe chat slow mode token name changed realtime listener
subscribeChatStatus()
subscribeChatStatus(
tokenName,listener):Unsubscribe
A token's chat was enabled or disabled (CHAT_STATUS_CHANGED).
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"CHAT_STATUS_CHANGED"> |
Returns
Since
9.0.0
subscribe chat status token name changed realtime listener
subscribeChatUnpinned()
subscribeChatUnpinned(
tokenName,listener):Unsubscribe
Unpinned chat messages (STREAM_CHAT_UNPINNED) of a token.
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"STREAM_CHAT_UNPINNED"> |
Returns
Since
9.0.0
subscribe chat unpinned token name stream realtime listener
subscribeChatUpdated()
subscribeChatUpdated(
tokenName,listener):Unsubscribe
Edited chat messages (STREAM_CHAT_UPDATED) of a token.
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"STREAM_CHAT_UPDATED"> |
Returns
Since
9.0.0
subscribe chat updated token name stream realtime listener
subscribeComment()
subscribeComment<
E>(event,tokenName,listener):Unsubscribe
Subscribe to a comment room event. The token's comment room (not its token room) is joined for as long as any comment subscriber of the token is registered.
Type Parameters
| Type Parameter |
|---|
E extends "COMMENT_CREATED" | "COMMENT_UPDATED" | "COMMENT_DELETED" |
Parameters
| Parameter | Type |
|---|---|
event | E |
tokenName | string |
listener | RealtimeListener<E> |
Returns
Since
9.0.0
subscribe comment token name created updated deleted realtime listener
subscribeCommentCreated()
subscribeCommentCreated(
tokenName,listener):Unsubscribe
New comments (COMMENT_CREATED) on a token. Joins the token's comment room.
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"COMMENT_CREATED"> |
Returns
Since
6.0.0
subscribe comment created token name realtime listener
subscribeCommentDeleted()
subscribeCommentDeleted(
tokenName,listener):Unsubscribe
Deleted comments (COMMENT_DELETED) on a token. Joins the token's comment room.
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"COMMENT_DELETED"> |
Returns
Since
9.0.0
subscribe comment deleted token name realtime listener
subscribeCommentsGlobalStatus()
subscribeCommentsGlobalStatus(
listener):Unsubscribe
Comments were switched on or off site-wide (COMMENTS_GLOBAL_STATUS). Joins the global feed.
Parameters
| Parameter | Type |
|---|---|
listener | RealtimeListener<"COMMENTS_GLOBAL_STATUS"> |
Returns
Since
9.0.0
subscribe comments global status realtime listener
subscribeCommentUpdated()
subscribeCommentUpdated(
tokenName,listener):Unsubscribe
Edited comments (COMMENT_UPDATED) on a token. Joins the token's comment room.
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"COMMENT_UPDATED"> |
Returns
Since
9.0.0
subscribe comment updated token name realtime listener
subscribeContentFlagged()
subscribeContentFlagged(
listener):Unsubscribe
Content was flagged, any token (CONTENT_FLAGGED, the overseer room).
Parameters
| Parameter | Type |
|---|---|
listener | RealtimeListener<"CONTENT_FLAGGED"> |
Returns
Since
9.0.0
subscribe content flagged realtime listener
subscribeContentReactionAdded()
subscribeContentReactionAdded(
tokenName,listener):Unsubscribe
A reaction was added to a message (CONTENT_REACTION_ADDED) of a token.
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"CONTENT_REACTION_ADDED"> |
Returns
Since
9.0.0
subscribe content reaction added token name realtime listener
subscribeContentReactionRemoved()
subscribeContentReactionRemoved(
tokenName,listener):Unsubscribe
A reaction was removed from a message (CONTENT_REACTION_REMOVED) of a token.
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"CONTENT_REACTION_REMOVED"> |
Returns
Since
9.0.0
subscribe content reaction removed token name realtime listener
subscribeCountdownUpdated()
subscribeCountdownUpdated(
tokenName,listener):Unsubscribe
The next live stream's countdown changed (STREAM_COUNTDOWN_UPDATED). Fed from TOKEN_CONFIG_UPDATED
(the backend folds the countdown into the config delta).
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"STREAM_COUNTDOWN_UPDATED"> |
Returns
Since
9.0.0
subscribe countdown updated token name stream config realtime listener
subscribeDownloadReady()
subscribeDownloadReady(
tokenName,listener):Unsubscribe
A recording's download is ready (DOWNLOAD_READY, sent to the stream owner).
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"DOWNLOAD_READY"> |
Returns
Since
9.0.0
subscribe download ready token name realtime listener
subscribeEngagementStatsUpdated()
subscribeEngagementStatsUpdated(
tokenName,listener):Unsubscribe
Chat and comment counts (ENGAGEMENT_STATS_UPDATED) of a token, about every 15 seconds.
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"ENGAGEMENT_STATS_UPDATED"> |
Returns
Since
8.5.0
subscribe engagement stats updated token name realtime listener
subscribeEvent()
subscribeEvent<
E>(event,listener):Unsubscribe
Subscribe to every occurrence of an event the socket receives, for any token, joining no room. For the events the server sends to the connection's own rooms (the user room and the overseer room, joined by authenticating) and the broadcasts.
Type Parameters
| Type Parameter |
|---|
E extends keyof RealtimeEventPayloads |
Parameters
| Parameter | Type |
|---|---|
event | E |
listener | RealtimeListener<E> |
Returns
Since
9.0.0
subscribe event realtime payloads listener
subscribeEventsFirehose()
subscribeEventsFirehose(
listener,filters?):Unsubscribe
Subscribe to the overseers' events firehose. ONE server subscription serves every subscriber; each
subscriber's filters are applied here (the server filters nothing). The server admits overseers
only, so the room is joined once the socket is authenticated (and re-joined, after
re-authenticating, on every reconnect).
Parameters
| Parameter | Type | Description |
|---|---|---|
listener | RealtimeListener<"EVENT"> | Called for each event that passes filters |
filters? | EventsFirehoseFilters | Optional client-side filters |
Returns
Since
9.0.0
subscribe events firehose realtime listener filters
subscribeException()
subscribeException(
listener):Unsubscribe
A server handler failed (exception): an unauthenticated call, an invalid token. Authentication
failures also resolve the pending StreamWebSocketService.authenticate with false.
Parameters
| Parameter | Type |
|---|---|
listener | RealtimeListener<"exception"> |
Returns
Since
9.0.0
subscribe exception realtime listener
subscribeFeed()
subscribeFeed<
E>(event,listener):Unsubscribe
Subscribe to a global feed event, for every token. The feed room is joined for as long as any feed subscriber is registered. Feed subscribers are served whether or not the token's own room is joined.
Type Parameters
| Type Parameter |
|---|
E extends FeedEventName |
Parameters
| Parameter | Type |
|---|---|
event | E |
listener | RealtimeListener<E> |
Returns
Since
9.0.0
subscribe feed event name realtime listener
subscribeFeedTokenEvents()
subscribeFeedTokenEvents(
listener):Unsubscribe
Subscribe to every global feed token event through one callback. Each occurrence is handed over with
the event's name, so a caller tells them apart by event.
Parameters
| Parameter | Type |
|---|---|
listener | (event) => void | Promise<void> |
Returns
Since
9.0.0
subscribe feed token events
subscribeFlagResolved()
subscribeFlagResolved(
listener):Unsubscribe
A flag was resolved, any token (FLAG_RESOLVED, the overseer room).
Parameters
| Parameter | Type |
|---|---|
listener | RealtimeListener<"FLAG_RESOLVED"> |
Returns
Since
9.0.0
subscribe flag resolved realtime listener
subscribeGlobalModeratorAdded()
subscribeGlobalModeratorAdded(
listener):Unsubscribe
The authenticated user was added as a moderator, any token (MODERATOR_ADDED, the user room).
Parameters
| Parameter | Type |
|---|---|
listener | RealtimeListener<"MODERATOR_ADDED"> |
Returns
Since
9.0.0
subscribe global moderator added realtime listener
subscribeGlobalModeratorInviteCreated()
subscribeGlobalModeratorInviteCreated(
listener):Unsubscribe
A moderator invite the authenticated user made, any token (MODERATOR_INVITE_CREATED).
Parameters
| Parameter | Type |
|---|---|
listener | RealtimeListener<"MODERATOR_INVITE_CREATED"> |
Returns
Since
9.0.0
subscribe global moderator invite created realtime listener
subscribeGlobalModeratorRemoved()
subscribeGlobalModeratorRemoved(
listener):Unsubscribe
The authenticated user was removed as a moderator, any token (MODERATOR_REMOVED).
Parameters
| Parameter | Type |
|---|---|
listener | RealtimeListener<"MODERATOR_REMOVED"> |
Returns
Since
9.0.0
subscribe global moderator removed realtime listener
subscribeGlobalModeratorRoleUpdated()
subscribeGlobalModeratorRoleUpdated(
listener):Unsubscribe
The authenticated user's moderator role changed, any token (MODERATOR_ROLE_UPDATED).
Parameters
| Parameter | Type |
|---|---|
listener | RealtimeListener<"MODERATOR_ROLE_UPDATED"> |
Returns
Since
9.0.0
subscribe global moderator role updated realtime listener
subscribeGlobalTokenBanned()
subscribeGlobalTokenBanned(
listener):Unsubscribe
A token was banned, any token (TOKEN_BANNED, the overseer room).
Parameters
| Parameter | Type |
|---|---|
listener | RealtimeListener<"TOKEN_BANNED"> |
Returns
Since
9.0.0
subscribe global token banned realtime listener
subscribeGlobalTokenUnbanned()
subscribeGlobalTokenUnbanned(
listener):Unsubscribe
A token ban was lifted, any token (TOKEN_UNBANNED, the overseer room).
Parameters
| Parameter | Type |
|---|---|
listener | RealtimeListener<"TOKEN_UNBANNED"> |
Returns
Since
9.0.0
subscribe global token unbanned realtime listener
subscribeHolderCountUpdated()
subscribeHolderCountUpdated(
tokenName,listener):Unsubscribe
A token's holder count changed (HOLDER_COUNT_UPDATED).
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"HOLDER_COUNT_UPDATED"> |
Returns
Since
6.0.0
subscribe holder count updated token name realtime listener
subscribeLanguageUpdated()
subscribeLanguageUpdated(
tokenName,listener):Unsubscribe
The stream language changed (STREAM_LANGUAGE_UPDATED). Fed from TOKEN_CONFIG_UPDATED.
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"STREAM_LANGUAGE_UPDATED"> |
Returns
Since
9.0.0
subscribe language updated token name stream config realtime listener
subscribeModeratorAdded()
subscribeModeratorAdded(
tokenName,listener):Unsubscribe
A moderator was added (MODERATOR_ADDED) to a token.
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"MODERATOR_ADDED"> |
Returns
Since
6.0.0
subscribe moderator added token name realtime listener
subscribeModeratorInviteCreated()
subscribeModeratorInviteCreated(
tokenName,listener):Unsubscribe
A moderator invite was created (MODERATOR_INVITE_CREATED) for a token.
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"MODERATOR_INVITE_CREATED"> |
Returns
Since
8.5.0
subscribe moderator invite created token name realtime listener
subscribeModeratorRemoved()
subscribeModeratorRemoved(
tokenName,listener):Unsubscribe
A moderator was removed (MODERATOR_REMOVED) from a token.
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"MODERATOR_REMOVED"> |
Returns
Since
6.0.0
subscribe moderator removed token name realtime listener
subscribeModeratorRoleUpdated()
subscribeModeratorRoleUpdated(
tokenName,listener):Unsubscribe
A moderator's role changed (MODERATOR_ROLE_UPDATED) on a token.
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"MODERATOR_ROLE_UPDATED"> |
Returns
Since
6.0.0
subscribe moderator role updated token name realtime listener
subscribeOverseerAdded()
subscribeOverseerAdded(
listener):Unsubscribe
An overseer was added (OVERSEER_ADDED).
Parameters
| Parameter | Type |
|---|---|
listener | RealtimeListener<"OVERSEER_ADDED"> |
Returns
Since
6.0.0
subscribe overseer added realtime listener
subscribeOverseerRemoved()
subscribeOverseerRemoved(
listener):Unsubscribe
An overseer was removed (OVERSEER_REMOVED).
Parameters
| Parameter | Type |
|---|---|
listener | RealtimeListener<"OVERSEER_REMOVED"> |
Returns
Since
6.0.0
subscribe overseer removed realtime listener
subscribePoolBadgeAssigned()
subscribePoolBadgeAssigned(
tokenName,listener):Unsubscribe
A badge was assigned to a token (POOL_BADGE_ASSIGNED).
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"POOL_BADGE_ASSIGNED"> |
Returns
Since
6.0.0
subscribe pool badge assigned token name realtime listener
subscribePoolCreated()
subscribePoolCreated(
listener):Unsubscribe
A token pool was created (POOL_CREATED). Joins the global feed.
Parameters
| Parameter | Type |
|---|---|
listener | RealtimeListener<"POOL_CREATED"> |
Returns
Since
9.0.0
subscribe pool created realtime listener
subscribePoolMetadataUpdated()
subscribePoolMetadataUpdated(
tokenName,listener):Unsubscribe
A token's metadata changed (POOL_METADATA_UPDATED).
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"POOL_METADATA_UPDATED"> |
Returns
Since
6.0.0
subscribe pool metadata updated token name realtime listener
subscribePoolSocialLinksUpdated()
subscribePoolSocialLinksUpdated(
tokenName,listener):Unsubscribe
A token's social links changed (POOL_SOCIAL_LINKS_UPDATED).
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"POOL_SOCIAL_LINKS_UPDATED"> |
Returns
Since
6.0.0
subscribe pool social links updated token name realtime listener
subscribeReactionErrors()
subscribeReactionErrors(
listener):Unsubscribe
A reaction was refused (stream_reaction_error), any token.
Parameters
| Parameter | Type |
|---|---|
listener | RealtimeListener<"stream_reaction_error"> |
Returns
Since
9.0.0
subscribe reaction errors stream error realtime listener
subscribeReactions()
subscribeReactions(
tokenName,listener):Unsubscribe
Ephemeral emoji reactions (STREAM_REACTION) of a token.
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"STREAM_REACTION"> |
Returns
Since
9.0.0
subscribe reactions token name stream reaction realtime listener
subscribeRecordingsCountUpdated()
subscribeRecordingsCountUpdated(
tokenName,listener):Unsubscribe
Recording count changes (RECORDINGS_COUNT_UPDATED) of a token.
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"RECORDINGS_COUNT_UPDATED"> |
Returns
Since
9.0.0
subscribe recordings count updated token name realtime listener
subscribeRecordingStatus()
subscribeRecordingStatus(
tokenName,listener):Unsubscribe
Recording changes (RECORDING_STATUS) of a token.
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"RECORDING_STATUS"> |
Returns
Since
9.0.0
subscribe recording status token name realtime listener
subscribeSimulcastStatus()
subscribeSimulcastStatus(
tokenName,listener):Unsubscribe
Simulcast target changes (SIMULCAST_STATUS) of a token.
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"SIMULCAST_STATUS"> |
Returns
Since
9.0.0
subscribe simulcast status token name realtime listener
subscribeSiteConfigChanged()
subscribeSiteConfigChanged(
listener):Unsubscribe
A site-wide switch changed (SITE_CONFIG_CHANGED). Joins the global feed.
Parameters
| Parameter | Type |
|---|---|
listener | RealtimeListener<"SITE_CONFIG_CHANGED"> |
Returns
Since
9.0.0
subscribe site config changed realtime listener
subscribeStatsUpdated()
subscribeStatsUpdated(
listener):Unsubscribe
Price, market cap and supply after a trade (STATS_UPDATED), every token. Joins the global feed.
Parameters
| Parameter | Type |
|---|---|
listener | RealtimeListener<"STATS_UPDATED"> |
Returns
Since
8.3.0
subscribe stats updated realtime listener
subscribeStreamControlStatusChanged()
subscribeStreamControlStatusChanged(
tokenName,listener):Unsubscribe
Stream control changes (STREAM_CONTROL_STATUS_CHANGED) of a token.
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"STREAM_CONTROL_STATUS_CHANGED"> |
Returns
Since
9.0.0
subscribe stream control status changed token name realtime listener
subscribeStreamGlobalStatus()
subscribeStreamGlobalStatus(
listener):Unsubscribe
Streaming was switched on or off site-wide (STREAM_GLOBAL_STATUS). Joins the global feed.
Parameters
| Parameter | Type |
|---|---|
listener | RealtimeListener<"STREAM_GLOBAL_STATUS"> |
Returns
Since
9.0.0
subscribe stream global status realtime listener
subscribeStreamStatus()
subscribeStreamStatus(
tokenName,listener):Unsubscribe
Stream status changes (STREAM_STATUS) of a token.
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"STREAM_STATUS"> |
Returns
Since
9.0.0
subscribe stream status token name realtime listener
subscribeToGlobalFeed()
subscribeToGlobalFeed(
callbacks?):Unsubscribe
Subscribe to the global feed with a callback object: each onX becomes its own subscriber.
Parameters
| Parameter | Type |
|---|---|
callbacks? | GlobalFeedEventCallbacks |
Returns
Function that removes every callback this call registered (and leaves the feed room if nothing else needs it)
Since
7.0.0
subscribe to global feed event callbacks
subscribeToken()
subscribeToken<
E>(event,tokenName,listener):Unsubscribe
Subscribe to a token room event. The token's room is joined for as long as any subscriber of the token (any event) is registered.
Type Parameters
Parameters
| Parameter | Type | Description |
|---|---|---|
event | E | A token room event |
tokenName | string | Token name |
listener | RealtimeListener<E> | Called for every occurrence about that token |
Returns
This subscriber's own unsubscribe
Since
9.0.0
subscribe token name stream status content flagged flag resolved chat message updated deleted pinned unpinned changed viewer count recording simulcast download ready recordings user typing reaction added removed countdown language control subscribed unsubscribed engagement stats sent slow mode error trade executed balance banned unbanned moderator invite created role pool metadata social links badge assigned config holder realtime listener
subscribeTokenBanned()
subscribeTokenBanned(
tokenName,listener):Unsubscribe
A token was banned (TOKEN_BANNED).
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"TOKEN_BANNED"> |
Returns
Since
6.0.0
subscribe token banned name realtime listener
subscribeTokenConfigUpdated()
subscribeTokenConfigUpdated(
tokenName,listener):Unsubscribe
A token's configuration changed (TOKEN_CONFIG_UPDATED, a delta of the changed fields).
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"TOKEN_CONFIG_UPDATED"> |
Returns
Since
8.4.0
subscribe token config updated name realtime listener
subscribeTokenUnbanned()
subscribeTokenUnbanned(
tokenName,listener):Unsubscribe
A token ban was lifted (TOKEN_UNBANNED).
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"TOKEN_UNBANNED"> |
Returns
Since
6.0.0
subscribe token unbanned name realtime listener
subscribeToStream()
subscribeToStream(
tokenName,callbacks?):Promise<StreamSubscribedEvent>
Subscribe to a token's events with a callback object, and wait for the server to confirm the room.
Each callback in callbacks is a subscriber of that token; the room is joined while at least one
subscribeToStream call for it, or any other subscriber, is registered. Calling it again for a token
ADDS callbacks: it never replaces the ones already registered.
StreamWebSocketService.unsubscribeFromStream removes what subscribeToStream registered.
Parameters
| Parameter | Type | Description |
|---|---|---|
tokenName | string | Token name to subscribe to |
callbacks? | StreamEventCallbacks | Event callbacks for this token |
Returns
Promise<StreamSubscribedEvent>
Promise that resolves when the server confirms the room
Throws
ValidationError if the token name is empty
Throws
Error if the connection fails or the confirmation times out (what this call registered is then released)
subscribe to stream token name subscribed event callbacks
subscribeTradeExecuted()
subscribeTradeExecuted(
tokenName,listener):Unsubscribe
Trades (TRADE_EXECUTED) of a token.
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"TRADE_EXECUTED"> |
Returns
Since
6.0.0
subscribe trade executed token name realtime listener
subscribeTradeUpdateNotify()
subscribeTradeUpdateNotify(
listener):Unsubscribe
The most recent trades, broadcast to every client (TRADE_UPDATE_NOTIFY).
Parameters
| Parameter | Type |
|---|---|
listener | RealtimeListener<"TRADE_UPDATE_NOTIFY"> |
Returns
Since
9.0.0
subscribe trade update notify realtime listener
subscribeTypingIndicator()
subscribeTypingIndicator(
tokenName,listener):Unsubscribe
Who is typing in a token's chat (USER_TYPING).
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"USER_TYPING"> |
Returns
Since
9.0.0
subscribe typing indicator token name user realtime listener
subscribeUserBanned()
subscribeUserBanned(
listener):Unsubscribe
The authenticated user was banned (USER_BANNED; overseers see every ban).
Parameters
| Parameter | Type |
|---|---|
listener | RealtimeListener<"USER_BANNED"> |
Returns
Since
9.0.0
subscribe user banned realtime listener
subscribeUserProfileUpdated()
subscribeUserProfileUpdated(
listener):Unsubscribe
The authenticated user's profile changed (USER_PROFILE_UPDATED).
Parameters
| Parameter | Type |
|---|---|
listener | RealtimeListener<"USER_PROFILE_UPDATED"> |
Returns
Since
6.0.0
subscribe user profile updated realtime listener
subscribeUserUnbanned()
subscribeUserUnbanned(
listener):Unsubscribe
The authenticated user was unbanned (USER_UNBANNED; overseers see every unban).
Parameters
| Parameter | Type |
|---|---|
listener | RealtimeListener<"USER_UNBANNED"> |
Returns
Since
9.0.0
subscribe user unbanned realtime listener
subscribeViewerCount()
subscribeViewerCount(
tokenName,listener):Unsubscribe
Viewer count changes (VIEWER_COUNT) of a token.
Parameters
| Parameter | Type |
|---|---|
tokenName | string |
listener | RealtimeListener<"VIEWER_COUNT"> |
Returns
Since
9.0.0
subscribe viewer count token name realtime listener
subscribeWebhooksGlobalStatus()
subscribeWebhooksGlobalStatus(
listener):Unsubscribe
Webhooks were switched on or off site-wide (WEBHOOKS_GLOBAL_STATUS). Joins the global feed.
Parameters
| Parameter | Type |
|---|---|
listener | RealtimeListener<"WEBHOOKS_GLOBAL_STATUS"> |
Returns
Since
9.0.0
subscribe webhooks global status realtime listener
unsubscribeFromStream()
unsubscribeFromStream(
tokenName):void
Remove everything subscribeToStream registered for a token. Other subscribers of the token (from the
subscribe* methods) are untouched, and the room is left only when none remains.
Parameters
| Parameter | Type | Description |
|---|---|---|
tokenName | string | Token name to unsubscribe from |
Returns
void
unsubscribe from stream token name subscribe to