Class: StreamWebSocketService

Gala Launchpad SDK 9.0.0-rc.5

---

Gala Launchpad SDK 9.0.0-rc.5 / index / StreamWebSocketService

Class: StreamWebSocketService

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:95

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

Constructors

Constructor

new StreamWebSocketService(config, debug?): StreamWebSocketService

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:126

Parameters

config

StreamWebSocketConfig

debug?

boolean

Returns

StreamWebSocketService

Overrides

LoggerBase.constructor

Methods

addCallbacks()

addCallbacks(callbacks): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:363

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

callbacks

StreamEventCallbacks

Returns

Unsubscribe

Function that removes the callbacks this call added

Since

9.0.0

---

authenticate()

authenticate(token?): Promise<boolean>

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:219

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 true without 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

token?

string

JWT to authenticate with (default: the token provider's current token)

Returns

Promise<boolean>

Since

5.1.0

---

connect()

connect(): Promise<void>

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:170

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

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:240

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

---

disconnect()

disconnect(): void

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:564

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

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:569

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

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:492

The site-wide switches announced since the feed was joined (undefined: none announced yet).

Returns

SiteConfigState

Since

9.0.0

---

getSocket()

getSocket(): Socket<DefaultEventsMap, DefaultEventsMap> | null

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:557

Get the underlying Socket.IO instance

Returns

Socket<DefaultEventsMap, DefaultEventsMap> | null

---

getSubscribedTokens()

getSubscribedTokens(): string[]

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:547

Get list of tokens whose room has a subscriber

Returns

string[]

---

isAuthenticatedForChat()

isAuthenticatedForChat(): boolean

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:244

Check if authenticated for chat operations

Returns

boolean

---

isConnected()

isConnected(): boolean

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:248

Check if connected to the WebSocket server

Returns

boolean

---

isSubscribedToGlobalFeed()

isSubscribedToGlobalFeed(): boolean

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:553

Check if the global feed has a subscriber

Returns

boolean

Since

7.0.0

---

joinTokenRoom()

joinTokenRoom(tokenName): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:307

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

tokenName

string

Returns

Unsubscribe

This hold's own release

Since

9.0.0

---

onConnectionStateChange()

onConnectionStateChange(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:192

Listen for the connection coming up (true) and going down (false).

Parameters

listener

(connected) => void

Returns

Unsubscribe

Function to stop listening

Since

9.0.0

---

onReconnect()

onReconnect(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:200

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

listener

() => void

Returns

Unsubscribe

Function to stop listening

Since

9.0.0

---

sendChatMessage()

sendChatMessage(tokenName, content): void

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:257

Send a chat message via WebSocket (faster than REST)

Parameters

tokenName

string

Token name for the chat room

content

string

Message content

Returns

void

Throws

ValidationError if not authenticated or not connected

---

sendReaction()

sendReaction(tokenName, emoji, streamTime?): void

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:270

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

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

---

sendTypingStart()

sendTypingStart(tokenName): void

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:278

Send typing indicator start event (the server auto-expires it after 5 seconds)

Parameters

tokenName

string

Token name for the chat room

Returns

void

Throws

ValidationError if not authenticated or not connected

Since

5.11.0

---

sendTypingStop()

sendTypingStop(tokenName): void

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:286

Send typing indicator stop event

Parameters

tokenName

string

Token name for the chat room

Returns

void

Throws

ValidationError if not authenticated or not connected

Since

5.11.0

---

subscribeAIModerationComplete()

subscribeAIModerationComplete(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:522

An AI analysis of a flag finished (AI_MODERATION_COMPLETE, the overseer room).

Parameters

listener

RealtimeListener<"AI_MODERATION_COMPLETE">

Returns

Unsubscribe

Since

9.0.0

---

subscribeAIModerationFailed()

subscribeAIModerationFailed(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:524

An AI analysis of a flag failed (AI_MODERATION_FAILED, the overseer room).

Parameters

listener

RealtimeListener<"AI_MODERATION_FAILED">

Returns

Unsubscribe

Since

9.0.0

---

subscribeAIModerationGlobalStatus()

subscribeAIModerationGlobalStatus(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:484

AI moderation was switched on or off site-wide (AI_MODERATION_GLOBAL_STATUS). Joins the global feed.

Parameters

listener

RealtimeListener<"AI_MODERATION_GLOBAL_STATUS">

Returns

Unsubscribe

Since

9.0.0

---

subscribeApiKeyCreated()

subscribeApiKeyCreated(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:500

An API key was created (API_KEY_CREATED).

Parameters

listener

RealtimeListener<"API_KEY_CREATED">

Returns

Unsubscribe

Since

6.0.0

---

subscribeApiKeyRevoked()

subscribeApiKeyRevoked(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:504

An API key was revoked (API_KEY_REVOKED).

Parameters

listener

RealtimeListener<"API_KEY_REVOKED">

Returns

Unsubscribe

Since

6.0.0

---

subscribeApiKeyUpdated()

subscribeApiKeyUpdated(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:502

An API key was updated (API_KEY_UPDATED).

Parameters

listener

RealtimeListener<"API_KEY_UPDATED">

Returns

Unsubscribe

Since

6.0.0

---

subscribeBalanceUpdated()

subscribeBalanceUpdated(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:442

The authenticated user's balance change after a trade (BALANCE_UPDATED) of a token.

Parameters

tokenName

string

listener

RealtimeListener<"BALANCE_UPDATED">

Returns

Unsubscribe

Since

9.0.0

---

subscribeBanEnforcement()

subscribeBanEnforcement(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:530

A banned user's action was refused (BAN_ENFORCEMENT).

Parameters

listener

RealtimeListener<"BAN_ENFORCEMENT">

Returns

Unsubscribe

Since

9.0.0

---

subscribeChatDeleted()

subscribeChatDeleted(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:422

Deleted chat messages (STREAM_CHAT_DELETED) of a token.

Parameters

tokenName

string

listener

RealtimeListener<"STREAM_CHAT_DELETED">

Returns

Unsubscribe

Since

9.0.0

---

subscribeChatErrors()

subscribeChatErrors(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:536

A chat message was refused (stream_chat_error), any token.

Parameters

listener

RealtimeListener<"stream_chat_error">

Returns

Unsubscribe

Since

9.0.0

---

subscribeChatGlobalStatus()

subscribeChatGlobalStatus(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:478

Chat was switched on or off site-wide (STREAM_CHAT_GLOBAL_STATUS). Joins the global feed.

Parameters

listener

RealtimeListener<"STREAM_CHAT_GLOBAL_STATUS">

Returns

Unsubscribe

Since

9.0.0

---

subscribeChatMessages()

subscribeChatMessages(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:416

New chat messages (STREAM_CHAT_MESSAGE) of a token.

Parameters

tokenName

string

listener

RealtimeListener<"STREAM_CHAT_MESSAGE">

Returns

Unsubscribe

Since

9.0.0

---

subscribeChatPinned()

subscribeChatPinned(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:424

Pinned chat messages (STREAM_CHAT_PINNED) of a token.

Parameters

tokenName

string

listener

RealtimeListener<"STREAM_CHAT_PINNED">

Returns

Unsubscribe

Since

9.0.0

---

subscribeChatSent()

subscribeChatSent(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:418

Confirmation that this socket's chat message was stored (STREAM_CHAT_SENT).

Parameters

tokenName

string

listener

RealtimeListener<"STREAM_CHAT_SENT">

Returns

Unsubscribe

Since

9.0.0

---

subscribeChatSlowMode()

subscribeChatSlowMode(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:430

A token's chat slow mode changed (SLOW_MODE_CHANGED).

Parameters

tokenName

string

listener

RealtimeListener<"SLOW_MODE_CHANGED">

Returns

Unsubscribe

Since

9.0.0

---

subscribeChatStatus()

subscribeChatStatus(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:428

A token's chat was enabled or disabled (CHAT_STATUS_CHANGED).

Parameters

tokenName

string

listener

RealtimeListener<"CHAT_STATUS_CHANGED">

Returns

Unsubscribe

Since

9.0.0

---

subscribeChatUnpinned()

subscribeChatUnpinned(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:426

Unpinned chat messages (STREAM_CHAT_UNPINNED) of a token.

Parameters

tokenName

string

listener

RealtimeListener<"STREAM_CHAT_UNPINNED">

Returns

Unsubscribe

Since

9.0.0

---

subscribeChatUpdated()

subscribeChatUpdated(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:420

Edited chat messages (STREAM_CHAT_UPDATED) of a token.

Parameters

tokenName

string

listener

RealtimeListener<"STREAM_CHAT_UPDATED">

Returns

Unsubscribe

Since

9.0.0

---

subscribeComment()

subscribeComment<E>(event, tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:314

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

E

E extends "COMMENT_CREATED" | "COMMENT_UPDATED" | "COMMENT_DELETED"

Parameters

event

E

tokenName

string

listener

RealtimeListener<E>

Returns

Unsubscribe

Since

9.0.0

---

subscribeCommentCreated()

subscribeCommentCreated(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:466

New comments (COMMENT_CREATED) on a token. Joins the token's comment room.

Parameters

tokenName

string

listener

RealtimeListener<"COMMENT_CREATED">

Returns

Unsubscribe

Since

6.0.0

---

subscribeCommentDeleted()

subscribeCommentDeleted(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:470

Deleted comments (COMMENT_DELETED) on a token. Joins the token's comment room.

Parameters

tokenName

string

listener

RealtimeListener<"COMMENT_DELETED">

Returns

Unsubscribe

Since

9.0.0

---

subscribeCommentsGlobalStatus()

subscribeCommentsGlobalStatus(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:480

Comments were switched on or off site-wide (COMMENTS_GLOBAL_STATUS). Joins the global feed.

Parameters

listener

RealtimeListener<"COMMENTS_GLOBAL_STATUS">

Returns

Unsubscribe

Since

9.0.0

---

subscribeCommentUpdated()

subscribeCommentUpdated(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:468

Edited comments (COMMENT_UPDATED) on a token. Joins the token's comment room.

Parameters

tokenName

string

listener

RealtimeListener<"COMMENT_UPDATED">

Returns

Unsubscribe

Since

9.0.0

---

subscribeContentFlagged()

subscribeContentFlagged(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:518

Content was flagged, any token (CONTENT_FLAGGED, the overseer room).

Parameters

listener

RealtimeListener<"CONTENT_FLAGGED">

Returns

Unsubscribe

Since

9.0.0

---

subscribeContentReactionAdded()

subscribeContentReactionAdded(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:436

A reaction was added to a message (CONTENT_REACTION_ADDED) of a token.

Parameters

tokenName

string

listener

RealtimeListener<"CONTENT_REACTION_ADDED">

Returns

Unsubscribe

Since

9.0.0

---

subscribeContentReactionRemoved()

subscribeContentReactionRemoved(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:438

A reaction was removed from a message (CONTENT_REACTION_REMOVED) of a token.

Parameters

tokenName

string

listener

RealtimeListener<"CONTENT_REACTION_REMOVED">

Returns

Unsubscribe

Since

9.0.0

---

subscribeCountdownUpdated()

subscribeCountdownUpdated(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:405

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

tokenName

string

listener

RealtimeListener<"STREAM_COUNTDOWN_UPDATED">

Returns

Unsubscribe

Since

9.0.0

---

subscribeDownloadReady()

subscribeDownloadReady(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:400

A recording's download is ready (DOWNLOAD_READY, sent to the stream owner).

Parameters

tokenName

string

listener

RealtimeListener<"DOWNLOAD_READY">

Returns

Unsubscribe

Since

9.0.0

---

subscribeEngagementStatsUpdated()

subscribeEngagementStatsUpdated(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:414

Chat and comment counts (ENGAGEMENT_STATS_UPDATED) of a token, about every 15 seconds.

Parameters

tokenName

string

listener

RealtimeListener<"ENGAGEMENT_STATS_UPDATED">

Returns

Unsubscribe

Since

8.5.0

---

subscribeEvent()

subscribeEvent<E>(event, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:329

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

E

E extends keyof RealtimeEventPayloads

Parameters

event

E

listener

RealtimeListener<E>

Returns

Unsubscribe

Since

9.0.0

---

subscribeEventsFirehose()

subscribeEventsFirehose(listener, filters?): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:340

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

listener

RealtimeListener<"EVENT">

Called for each event that passes filters

filters?

EventsFirehoseFilters

Optional client-side filters

Returns

Unsubscribe

Since

9.0.0

---

subscribeException()

subscribeException(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:543

A server handler failed (exception): an unauthenticated call, an invalid token. Authentication failures also resolve the pending StreamWebSocketService.authenticate with false.

Parameters

listener

RealtimeListener<"exception">

Returns

Unsubscribe

Since

9.0.0

---

subscribeFeed()

subscribeFeed<E>(event, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:321

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

E

E extends FeedEventName

Parameters

event

E

listener

RealtimeListener<E>

Returns

Unsubscribe

Since

9.0.0

---

subscribeFeedTokenEvents()

subscribeFeedTokenEvents(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:347

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

listener

(event) => void | Promise<void>

Returns

Unsubscribe

Since

9.0.0

---

subscribeFlagResolved()

subscribeFlagResolved(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:520

A flag was resolved, any token (FLAG_RESOLVED, the overseer room).

Parameters

listener

RealtimeListener<"FLAG_RESOLVED">

Returns

Unsubscribe

Since

9.0.0

---

subscribeGlobalModeratorAdded()

subscribeGlobalModeratorAdded(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:510

The authenticated user was added as a moderator, any token (MODERATOR_ADDED, the user room).

Parameters

listener

RealtimeListener<"MODERATOR_ADDED">

Returns

Unsubscribe

Since

9.0.0

---

subscribeGlobalModeratorInviteCreated()

subscribeGlobalModeratorInviteCreated(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:516

A moderator invite the authenticated user made, any token (MODERATOR_INVITE_CREATED).

Parameters

listener

RealtimeListener<"MODERATOR_INVITE_CREATED">

Returns

Unsubscribe

Since

9.0.0

---

subscribeGlobalModeratorRemoved()

subscribeGlobalModeratorRemoved(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:512

The authenticated user was removed as a moderator, any token (MODERATOR_REMOVED).

Parameters

listener

RealtimeListener<"MODERATOR_REMOVED">

Returns

Unsubscribe

Since

9.0.0

---

subscribeGlobalModeratorRoleUpdated()

subscribeGlobalModeratorRoleUpdated(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:514

The authenticated user's moderator role changed, any token (MODERATOR_ROLE_UPDATED).

Parameters

listener

RealtimeListener<"MODERATOR_ROLE_UPDATED">

Returns

Unsubscribe

Since

9.0.0

---

subscribeGlobalTokenBanned()

subscribeGlobalTokenBanned(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:506

A token was banned, any token (TOKEN_BANNED, the overseer room).

Parameters

listener

RealtimeListener<"TOKEN_BANNED">

Returns

Unsubscribe

Since

9.0.0

---

subscribeGlobalTokenUnbanned()

subscribeGlobalTokenUnbanned(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:508

A token ban was lifted, any token (TOKEN_UNBANNED, the overseer room).

Parameters

listener

RealtimeListener<"TOKEN_UNBANNED">

Returns

Unsubscribe

Since

9.0.0

---

subscribeHolderCountUpdated()

subscribeHolderCountUpdated(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:462

A token's holder count changed (HOLDER_COUNT_UPDATED).

Parameters

tokenName

string

listener

RealtimeListener<"HOLDER_COUNT_UPDATED">

Returns

Unsubscribe

Since

6.0.0

---

subscribeLanguageUpdated()

subscribeLanguageUpdated(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:410

The stream language changed (STREAM_LANGUAGE_UPDATED). Fed from TOKEN_CONFIG_UPDATED.

Parameters

tokenName

string

listener

RealtimeListener<"STREAM_LANGUAGE_UPDATED">

Returns

Unsubscribe

Since

9.0.0

---

subscribeModeratorAdded()

subscribeModeratorAdded(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:450

A moderator was added (MODERATOR_ADDED) to a token.

Parameters

tokenName

string

listener

RealtimeListener<"MODERATOR_ADDED">

Returns

Unsubscribe

Since

6.0.0

---

subscribeModeratorInviteCreated()

subscribeModeratorInviteCreated(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:448

A moderator invite was created (MODERATOR_INVITE_CREATED) for a token.

Parameters

tokenName

string

listener

RealtimeListener<"MODERATOR_INVITE_CREATED">

Returns

Unsubscribe

Since

8.5.0

---

subscribeModeratorRemoved()

subscribeModeratorRemoved(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:452

A moderator was removed (MODERATOR_REMOVED) from a token.

Parameters

tokenName

string

listener

RealtimeListener<"MODERATOR_REMOVED">

Returns

Unsubscribe

Since

6.0.0

---

subscribeModeratorRoleUpdated()

subscribeModeratorRoleUpdated(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:454

A moderator's role changed (MODERATOR_ROLE_UPDATED) on a token.

Parameters

tokenName

string

listener

RealtimeListener<"MODERATOR_ROLE_UPDATED">

Returns

Unsubscribe

Since

6.0.0

---

subscribeOverseerAdded()

subscribeOverseerAdded(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:494

An overseer was added (OVERSEER_ADDED).

Parameters

listener

RealtimeListener<"OVERSEER_ADDED">

Returns

Unsubscribe

Since

6.0.0

---

subscribeOverseerRemoved()

subscribeOverseerRemoved(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:496

An overseer was removed (OVERSEER_REMOVED).

Parameters

listener

RealtimeListener<"OVERSEER_REMOVED">

Returns

Unsubscribe

Since

6.0.0

---

subscribePoolBadgeAssigned()

subscribePoolBadgeAssigned(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:460

A badge was assigned to a token (POOL_BADGE_ASSIGNED).

Parameters

tokenName

string

listener

RealtimeListener<"POOL_BADGE_ASSIGNED">

Returns

Unsubscribe

Since

6.0.0

---

subscribePoolCreated()

subscribePoolCreated(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:474

A token pool was created (POOL_CREATED). Joins the global feed.

Parameters

listener

RealtimeListener<"POOL_CREATED">

Returns

Unsubscribe

Since

9.0.0

---

subscribePoolMetadataUpdated()

subscribePoolMetadataUpdated(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:456

A token's metadata changed (POOL_METADATA_UPDATED).

Parameters

tokenName

string

listener

RealtimeListener<"POOL_METADATA_UPDATED">

Returns

Unsubscribe

Since

6.0.0

---

subscribePoolSocialLinksUpdated()

subscribePoolSocialLinksUpdated(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:458

A token's social links changed (POOL_SOCIAL_LINKS_UPDATED).

Parameters

tokenName

string

listener

RealtimeListener<"POOL_SOCIAL_LINKS_UPDATED">

Returns

Unsubscribe

Since

6.0.0

---

subscribeReactionErrors()

subscribeReactionErrors(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:534

A reaction was refused (stream_reaction_error), any token.

Parameters

listener

RealtimeListener<"stream_reaction_error">

Returns

Unsubscribe

Since

9.0.0

---

subscribeReactions()

subscribeReactions(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:434

Ephemeral emoji reactions (STREAM_REACTION) of a token.

Parameters

tokenName

string

listener

RealtimeListener<"STREAM_REACTION">

Returns

Unsubscribe

Since

9.0.0

---

subscribeRecordingsCountUpdated()

subscribeRecordingsCountUpdated(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:396

Recording count changes (RECORDINGS_COUNT_UPDATED) of a token.

Parameters

tokenName

string

listener

RealtimeListener<"RECORDINGS_COUNT_UPDATED">

Returns

Unsubscribe

Since

9.0.0

---

subscribeRecordingStatus()

subscribeRecordingStatus(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:394

Recording changes (RECORDING_STATUS) of a token.

Parameters

tokenName

string

listener

RealtimeListener<"RECORDING_STATUS">

Returns

Unsubscribe

Since

9.0.0

---

subscribeSimulcastStatus()

subscribeSimulcastStatus(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:398

Simulcast target changes (SIMULCAST_STATUS) of a token.

Parameters

tokenName

string

listener

RealtimeListener<"SIMULCAST_STATUS">

Returns

Unsubscribe

Since

9.0.0

---

subscribeSiteConfigChanged()

subscribeSiteConfigChanged(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:486

A site-wide switch changed (SITE_CONFIG_CHANGED). Joins the global feed.

Parameters

listener

RealtimeListener<"SITE_CONFIG_CHANGED">

Returns

Unsubscribe

Since

9.0.0

---

subscribeStatsUpdated()

subscribeStatsUpdated(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:472

Price, market cap and supply after a trade (STATS_UPDATED), every token. Joins the global feed.

Parameters

listener

RealtimeListener<"STATS_UPDATED">

Returns

Unsubscribe

Since

8.3.0

---

subscribeStreamControlStatusChanged()

subscribeStreamControlStatusChanged(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:412

Stream control changes (STREAM_CONTROL_STATUS_CHANGED) of a token.

Parameters

tokenName

string

listener

RealtimeListener<"STREAM_CONTROL_STATUS_CHANGED">

Returns

Unsubscribe

Since

9.0.0

---

subscribeStreamGlobalStatus()

subscribeStreamGlobalStatus(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:476

Streaming was switched on or off site-wide (STREAM_GLOBAL_STATUS). Joins the global feed.

Parameters

listener

RealtimeListener<"STREAM_GLOBAL_STATUS">

Returns

Unsubscribe

Since

9.0.0

---

subscribeStreamStatus()

subscribeStreamStatus(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:390

Stream status changes (STREAM_STATUS) of a token.

Parameters

tokenName

string

listener

RealtimeListener<"STREAM_STATUS">

Returns

Unsubscribe

Since

9.0.0

---

subscribeToGlobalFeed()

subscribeToGlobalFeed(callbacks?): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:355

Subscribe to the global feed with a callback object: each onX becomes its own subscriber.

Parameters

callbacks?

GlobalFeedEventCallbacks

Returns

Unsubscribe

Function that removes every callback this call registered (and leaves the feed room if nothing else needs it)

Since

7.0.0

---

subscribeToken()

subscribeToken<E>(event, tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:298

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

E

E extends "STREAM_STATUS" | "CONTENT_FLAGGED" | "FLAG_RESOLVED" | "STREAM_CHAT_MESSAGE" | "STREAM_CHAT_UPDATED" | "STREAM_CHAT_DELETED" | "STREAM_CHAT_PINNED" | "STREAM_CHAT_UNPINNED" | "CHAT_STATUS_CHANGED" | "VIEWER_COUNT" | "RECORDING_STATUS" | "SIMULCAST_STATUS" | "DOWNLOAD_READY" | "RECORDINGS_COUNT_UPDATED" | "USER_TYPING" | "STREAM_REACTION" | "CONTENT_REACTION_ADDED" | "CONTENT_REACTION_REMOVED" | "STREAM_COUNTDOWN_UPDATED" | "STREAM_LANGUAGE_UPDATED" | "STREAM_CONTROL_STATUS_CHANGED" | "token_subscribed" | "token_unsubscribed" | "ENGAGEMENT_STATS_UPDATED" | "STREAM_CHAT_SENT" | "SLOW_MODE_CHANGED" | "stream_chat_error" | "stream_reaction_error" | "TRADE_EXECUTED" | "BALANCE_UPDATED" | "STATS_UPDATED" | "TOKEN_BANNED" | "TOKEN_UNBANNED" | "MODERATOR_INVITE_CREATED" | "MODERATOR_ADDED" | "MODERATOR_REMOVED" | "MODERATOR_ROLE_UPDATED" | "POOL_METADATA_UPDATED" | "POOL_SOCIAL_LINKS_UPDATED" | "POOL_BADGE_ASSIGNED" | "TOKEN_CONFIG_UPDATED" | "HOLDER_COUNT_UPDATED"

Parameters

event

E

A token room event

tokenName

string

Token name

listener

RealtimeListener<E>

Called for every occurrence about that token

Returns

Unsubscribe

This subscriber's own unsubscribe

Since

9.0.0

---

subscribeTokenBanned()

subscribeTokenBanned(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:444

A token was banned (TOKEN_BANNED).

Parameters

tokenName

string

listener

RealtimeListener<"TOKEN_BANNED">

Returns

Unsubscribe

Since

6.0.0

---

subscribeTokenConfigUpdated()

subscribeTokenConfigUpdated(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:464

A token's configuration changed (TOKEN_CONFIG_UPDATED, a delta of the changed fields).

Parameters

tokenName

string

listener

RealtimeListener<"TOKEN_CONFIG_UPDATED">

Returns

Unsubscribe

Since

8.4.0

---

subscribeTokenUnbanned()

subscribeTokenUnbanned(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:446

A token ban was lifted (TOKEN_UNBANNED).

Parameters

tokenName

string

listener

RealtimeListener<"TOKEN_UNBANNED">

Returns

Unsubscribe

Since

6.0.0

---

subscribeToStream()

subscribeToStream(tokenName, callbacks?): Promise<StreamSubscribedEvent>

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:379

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

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)

---

subscribeTradeExecuted()

subscribeTradeExecuted(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:440

Trades (TRADE_EXECUTED) of a token.

Parameters

tokenName

string

listener

RealtimeListener<"TRADE_EXECUTED">

Returns

Unsubscribe

Since

6.0.0

---

subscribeTradeUpdateNotify()

subscribeTradeUpdateNotify(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:532

The most recent trades, broadcast to every client (TRADE_UPDATE_NOTIFY).

Parameters

listener

RealtimeListener<"TRADE_UPDATE_NOTIFY">

Returns

Unsubscribe

Since

9.0.0

---

subscribeTypingIndicator()

subscribeTypingIndicator(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:432

Who is typing in a token's chat (USER_TYPING).

Parameters

tokenName

string

listener

RealtimeListener<"USER_TYPING">

Returns

Unsubscribe

Since

9.0.0

---

subscribeUserBanned()

subscribeUserBanned(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:526

The authenticated user was banned (USER_BANNED; overseers see every ban).

Parameters

listener

RealtimeListener<"USER_BANNED">

Returns

Unsubscribe

Since

9.0.0

---

subscribeUserProfileUpdated()

subscribeUserProfileUpdated(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:498

The authenticated user's profile changed (USER_PROFILE_UPDATED).

Parameters

listener

RealtimeListener<"USER_PROFILE_UPDATED">

Returns

Unsubscribe

Since

6.0.0

---

subscribeUserUnbanned()

subscribeUserUnbanned(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:528

The authenticated user was unbanned (USER_UNBANNED; overseers see every unban).

Parameters

listener

RealtimeListener<"USER_UNBANNED">

Returns

Unsubscribe

Since

9.0.0

---

subscribeViewerCount()

subscribeViewerCount(tokenName, listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:392

Viewer count changes (VIEWER_COUNT) of a token.

Parameters

tokenName

string

listener

RealtimeListener<"VIEWER_COUNT">

Returns

Unsubscribe

Since

9.0.0

---

subscribeWebhooksGlobalStatus()

subscribeWebhooksGlobalStatus(listener): Unsubscribe

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:482

Webhooks were switched on or off site-wide (WEBHOOKS_GLOBAL_STATUS). Joins the global feed.

Parameters

listener

RealtimeListener<"WEBHOOKS_GLOBAL_STATUS">

Returns

Unsubscribe

Since

9.0.0

---

unsubscribeFromStream()

unsubscribeFromStream(tokenName): void

Defined in: packages/launchpad-sdk/dist/services/StreamWebSocketService.d.ts:388

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

tokenName

string

Token name to unsubscribe from

Returns

void