Skip to content
Roblox API Reference

WebStreamClient

Maintains a streaming connection.
  • Not creatable
  • Not replicated
Memory category
Instances
Own members
7
Inherited members
6
Subclasses
0
Siblings
30

Properties3

Inherited fromObject2

Property categoryData

Defined byWebStreamClient1

Property categoryData

  • WebStreamClient.ConnectionState: Enum.WebStreamClientState
    The current WebStreamClientState of the client.
    • Read only
    • Capabilities: Network
    • Save only

Methods5

Inherited fromObject3
  • Object:GetPropertyChangedSignal(property: string): RBXScriptSignal
    Get an event that fires when a given property of the object changes.
    Parameters
    ParameterDescription
    property: string
    The property to connect to.
    Returns
    TypeDescription
    RBXScriptSignal
    A signal that fires whenever the property changes.
  • Object:IsA(className: string): boolean
    Returns true if an object's class matches or inherits from a given class.
    • Custom Lua state
    • Thread safe
    Parameters
    ParameterDescription
    className: string
    The class against which the Object's class will be checked. Case-sensitive.
    Returns
    TypeDescription
    boolean
    Describes whether the Object's class matched or is a subclass of the given class.
  • Object:isA(className: string): boolean
    Deprecated: This deprecated function is a variant of Object:IsA() which should be used instead.
    • Deprecated
    • Custom Lua state
    Parameters
    Parameter
    className: string
    Returns
    Type
    boolean

    Use IsA instead.

Defined byWebStreamClient2
  • WebStreamClient:Close()
    Closes the client, aborting the ongoing request.
    • Capabilities: Network
  • WebStreamClient:Send(data: string)
    Enqueues data to be transmitted to the server over the streaming connection.
    • Capabilities: Network
    Parameters
    ParameterDescription
    data: string
    Text string to send to the server.

Events5

Inherited fromObject1
Defined byWebStreamClient4
  • WebStreamClient.Closed: RBXScriptSignal<()>
    Fires when the streaming connection is closed, either by the server or by a call to WebStreamClient:Close().
    • Capabilities: Network
  • WebStreamClient.Error: RBXScriptSignal<(responseStatusCode: number,errorMessage: string,)>
    Fires if an error is received while establishing the connection or during the connection lifetime.
    • Capabilities: Network
    Parameters
    Parameter
    responseStatusCode: number
    errorMessage: string
  • WebStreamClient.MessageReceived: RBXScriptSignal<(message: string)>
    Fires each time a message is received from the server.
    • Capabilities: Network
    Parameters
    Parameter
    message: string
  • WebStreamClient.Opened: RBXScriptSignal<(responseStatusCode: number,headers: string,)>
    Fires when the a connection is successfully established between the client and server, allowing for events to begin streaming.
    • Capabilities: Network
    Parameters
    Parameter
    responseStatusCode: number
    headers: string