@@ -28,15 +28,6 @@ description: |
2828 random 128‑bit labels which can be treated as probabilistically unique in a
2929 variety of scenarios.
3030
31- Within Studio, use
32- `Class.HttpService:CreateWebStreamClient()|CreateWebStreamClient()` to process
33- data in real-time from HTTP servers that support streaming protocols such as
34- [SSE](https://en.wikipedia.org/wiki/Server-sent_events) or
35- [chunked transfer encoding](https://en.wikipedia.org/wiki/Chunked_transfer_encoding).
36- You can connect callback functions to stream events, allowing you to process
37- data immediately as it arrives instead of waiting for the entire response to
38- complete.
39-
4031 Only send HTTP requests to trusted third-party platforms to avoid introducing
4132 unnecessary security risks to your experience.
4233code_samples :
@@ -80,46 +71,6 @@ properties:
8071 capabilities :
8172 - Network
8273methods :
83- - name : HttpService:CreateWebStreamClient
84- summary : |
85- Creates a client that opens a persistent connection to stream data.
86- description : |
87- This method creates a client that establishes a long-lived connection to
88- servers utilizing various streaming technologies, such as
89- [Server-Sent Events (SSE)](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events).
90- After the connection is established, the client fires signals that you can
91- connect callback functions to. Use these callbacks to process messages as
92- soon as they arrive, as well as respond to open, close, and error events.
93-
94- There is a limit of six total `Enum.WebStreamClientType.SSE` or
95- `Enum.WebStreamClientType.RawStream` clients allowed at one time. Close
96- streams that you no longer need with `Class.WebStreamClient:Close()`.
97- code_samples :
98- - HttpService-CreateSSEWebStreamClient
99- - HttpService-CreateRawStreamWebStreamClient
100- parameters :
101- - name : streamClientType
102- type : WebStreamClientType
103- default :
104- summary : |
105- The type of streaming connection to intiialize the client with.
106- - name : requestOptions
107- type : Dictionary
108- default :
109- summary : |
110- A dictionary containing information to be requested from the server.
111- It is identical to `requestOptions` in
112- `Class.HttpService:RequestAsync()`.
113- returns :
114- - type : WebStreamClient
115- summary : |
116- A stateful client that emits events in the stream lifecycle.
117- tags : []
118- deprecation_message : ' '
119- security : None
120- thread_safety : Unsafe
121- capabilities :
122- - Network
12374 - name : HttpService:GenerateGUID
12475 summary : |
12576 Generates a UUID/GUID random string, optionally with curly braces.
0 commit comments