Skip to content

Commit 659d7fd

Browse files
update Open Source Docs from Roblox internal teams
1 parent 6fe19ff commit 659d7fd

File tree

5 files changed

+0
-275
lines changed

5 files changed

+0
-275
lines changed

content/common/navigation/engine/reference.yaml

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3231,11 +3231,6 @@ navigation:
32313231
type: engineapi
32323232
source: /reference/engine/classes/TerrainWriteOperation.yaml
32333233
ignoreTranslation: true
3234-
- title: WebStreamClient
3235-
path: /reference/engine/classes/WebStreamClient
3236-
type: engineapi
3237-
source: /reference/engine/classes/WebStreamClient.yaml
3238-
ignoreTranslation: true
32393234
- title: Data Types
32403235
path: /reference/engine/datatypes
32413236
source: /reference/engine/datatypes.md
@@ -5879,16 +5874,6 @@ navigation:
58795874
type: engineapi
58805875
source: /reference/engine/enums/WebSocketState.yaml
58815876
ignoreTranslation: true
5882-
- title: WebStreamClientState
5883-
path: /reference/engine/enums/WebStreamClientState
5884-
type: engineapi
5885-
source: /reference/engine/enums/WebStreamClientState.yaml
5886-
ignoreTranslation: true
5887-
- title: WebStreamClientType
5888-
path: /reference/engine/enums/WebStreamClientType
5889-
type: engineapi
5890-
source: /reference/engine/enums/WebStreamClientType.yaml
5891-
ignoreTranslation: true
58925877
- title: WeldConstraintPreserve
58935878
path: /reference/engine/enums/WeldConstraintPreserve
58945879
type: engineapi

content/en-us/reference/engine/classes/HttpService.yaml

Lines changed: 0 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -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.
4233
code_samples:
@@ -80,46 +71,6 @@ properties:
8071
capabilities:
8172
- Network
8273
methods:
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.

content/en-us/reference/engine/classes/WebStreamClient.yaml

Lines changed: 0 additions & 135 deletions
This file was deleted.

content/en-us/reference/engine/enums/WebStreamClientState.yaml

Lines changed: 0 additions & 42 deletions
This file was deleted.

content/en-us/reference/engine/enums/WebStreamClientType.yaml

Lines changed: 0 additions & 34 deletions
This file was deleted.

0 commit comments

Comments
 (0)