WebStreamClient¶
Not yet Class NotCreatable NotReplicated
Maintains a streaming connection.
Not implemented yet
This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.
0 Nova members · 13 modern Roblox members not implemented yet
Description¶
Maintains a streaming connection. To process stream events as they arrive, connect callback functions to each event using RBXScriptSignal.Connect().
Inheritance¶
Object → WebStreamClient
Properties¶
| Member | Signature | Summary |
|---|---|---|
ConnectionState |
ConnectionState: WebStreamClientState |
The current WebStreamClientState of the client. |
Methods¶
| Member | Signature | Summary |
|---|---|---|
Close |
WebStreamClient:Close(): null |
Closes the client, aborting the ongoing request. |
Send |
WebStreamClient:Send(data: string): null |
Enqueues data to be transmitted to the server over the streaming connection. |
Events¶
| Member | Signature | Summary |
|---|---|---|
Closed |
Closed() |
Fires when the streaming connection is closed, either by the server or by a call to WebStreamClient.Close(). |
Error |
Error(responseStatusCode: int, errorMessage: string) |
Fires if an error is received while establishing the connection or during the connection lifetime. |
MessageReceived |
MessageReceived(message: string) |
Fires each time a message is received from the server. |
Opened |
Opened(responseStatusCode: int, headers: string) |
Fires when the a connection is successfully established between the client and server, allowing for events to begin streaming. |
Roblox reference: WebStreamClient
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.