維護一個串流連接。要處理進來的串流事件，
請使用
`Datatype.RBXScriptSignal:Connect()`將回呼函數連接到每個事件。


當伺服器成功關閉連接或用戶調用
`Class.WebStreamClient:Close()`時觸發。


WebStreamClient.Closed

如果在建立連接或在連接過程中收到錯誤，則觸發。


WebStreamClient.Error

responseStatusCode

標準的 HTTP 錯誤狀態碼（例如，404，500）。


errorMessage

包含有關錯誤詳細信息的描述性訊息。


每次從伺服器接收到消息時觸發。格式根據 `Enum.WebStreamClientType` 而異。


WebStreamClient.MessageReceived

message

從伺服器串流接收到的消息數據有效負載。


每次從伺服器接收到消息時觸發。


當客戶端與伺服器之間成功建立連接時觸發，允許事件開始串流。提供原始格式的任何響應標頭，可以用於驗證。


WebStreamClient.Opened

標準的 HTTP 成功狀態碼（例如，200）。


headers

伺服器發送的原始 HTTP 響應標頭。


當客戶端與伺服器之間成功建立連接時觸發，允許事件開始串流。


關閉客戶端，終止正在進行的請求。如果成功，將觸發
`Class.WebStreamClient.Closed` 事件。


WebStreamClient:Close

關閉客戶端，終止正在進行的請求。


將數據排入隊列，以便通過連接傳輸到伺服器。僅適用於使用 `Enum.WebStreamClientType.WebSocket` 創建的客戶端。對於其他客戶端類型，則無效。


WebStreamClient:Send

data

要發送到伺服器的文本字符串。


將數據排入隊列，以便通過串流連接傳輸到伺服器。


WebStreamClient

客戶端當前的 `Enum.WebStreamClientState`。


WebStreamClient.ConnectionState

`Object` 是 Roblox 類別層級中所有類別的基礎類別。
所有 Roblox 引擎定義的其他類別都繼承了 `Object` 的所有成員。
無法直接創建 `Object`。

本範例展示了普通物件和 `Value` 物件上 `Changed` 事件的微妙之處。


此範例代碼演示了父物件中的 Changed 事件觸發。

此事件在物件屬性被更改後立即觸發，具有一些例外情況（見下文）。更改後屬性的的新值不會作為參數傳遞。相反，你可以使用 `object[property]` 來訪問它：

```
object.Changed:Connect(function(property)
	print("新屬性的值是", object[property])
end)
```

- 如果你只對監聽特定屬性的變更感興趣，建議使用
  `Class.Object:GetPropertyChangedSignal()|GetPropertyChangedSignal()`
  方法。
- 要監聽屬性中的變化，請參見
  `Class.Instance:GetAttributeChangedSignal()` 和
  `Class.Instance.AttributeChanged`。
- 要檢測子物件的添加或移除，請參見
  `Class.Instance.ChildAdded` 和 `Class.Instance.ChildRemoved`。

對於像 `Class.IntValue` 和 `Class.StringValue` 這樣的 `Class.ValueBase` 物件，
此事件僅在物件的 `Value` 屬性變更時觸發。要檢測在 `Class.ValueBase` 物件中的其他變更，
使用 `Class.Object:GetPropertyChangedSignal()|GetPropertyChangedSignal()`。

#### 限制

此事件對於與物理相關的變更**不**會觸發，例如當 `Class.BasePart.CFrame|CFrame`、
`Class.BasePart.AssemblyLinearVelocity|AssemblyLinearVelocity`、
`Class.BasePart.AssemblyAngularVelocity|AssemblyAngularVelocity`、
`Class.BasePart.Position|Position` 或
`Class.BasePart.Orientation|Orientation` 的屬性因重力而改變。要檢測這些屬性的變更，
考慮使用基於物理的事件，如 `Class.RunService.PreSimulation`。
類似地，當 `Class.BasePart.AssemblyMass|AssemblyMass` 由於材料、大小或密度的變化而更新時，`Changed` 事件不會觸發（但如果你修改了部件的大小，則 `Class.BasePart.Mass|Mass` 的事件會觸發）。

對於頻繁變化的屬性，`Changed` 事件可能不會為每次修改觸發，或者根本不會觸發。**如果屬性改變影響你的遊戲邏輯，請仔細測試**以確保事件按你預期觸發。

Object.Changed

property

在物件的屬性更改後立即觸發，但有一些限制。

此代碼範例展示了如何在變更事件發生之前保存一個值，以便獲取有關變更的更多信息。

此代碼範例展示了 `Changed` 事件和由 `GetPropertyChangedSignal` 返回的事件之間的等價性。

此方法返回一個事件，其行為與 `Class.Object.Changed|Changed` 事件完全相同，
除了它僅在指定屬性變更時觸發。通常使用此方法而不是使用
連接到 `Class.Object.Changed|Changed` 的函數來檢查屬性名稱會是一個
不錯的主意。對同一物件以相同屬性名稱的隨後呼叫將返回相同事件。

`Class.ValueBase` 物件，如 `Class.IntValue` 和 `Class.StringValue`，
使用一個修改過的 `Class.Object.Changed|Changed` 事件，當其 `Value` 屬性
的內容變更時觸發。因此，此方法提供了檢測那些物件的其他屬性更改的方式。

請注意，此事件不會將任何參數傳遞給連接的函數，
因此必須在腳本中直接讀取變更的屬性值。

#### 限制

此方法返回的事件對於物理相關的變更**不會**觸發，例如當 `Class.BasePart.CFrame|CFrame`、
`Class.BasePart.AssemblyLinearVelocity|AssemblyLinearVelocity`、
`Class.BasePart.AssemblyAngularVelocity|AssemblyAngularVelocity`、
`Class.BasePart.Position|Position` 或 `Class.BasePart.Orientation|Orientation` 屬性
的變化是由重力引起的。為了檢測這些屬性的變更，請考慮使用類似 `Class.RunService.PreSimulation` 的
基於物理的事件。

此外，返回的事件可能不會在每次對非常頻繁變更的屬性進行修改時觸發，
或者對這些屬性根本不會觸發。建議仔細測試影響遊戲邏輯的屬性變化。

Object:GetPropertyChangedSignal

獲取在物件的指定屬性變更時觸發的事件。

演示如何使用 `Class.Instance:IsA()` 確定 Workspace 的類別。

Workspace 的類別為 'Workspace'，因此第一個陳述為真。Workspace
不是 'BasePart' 類別，因此第二個陳述為假。Workspace
繼承自 Instance，因此它的類別為 'Instance'，因此第三
個陳述為真。


IsA 如果物件的類別是 **等同於** 或 **子類別** 的給定類別，
則返回 true。此函數類似於其他語言中的 **instanceof** 操作符，
是一種 [類型自省](https://en.wikipedia.org/wiki/Type_introspection) 的形式。要
忽略類別繼承，請直接測試 `Class.Object.ClassName|ClassName`
屬性。對於檢查本機 Luau 數據類型（數字、字串等），使用 `type` 和 `typeof` 函數。

此函數最常用於測試一個物件是否是某種部件，如 `Class.Part` 或 `Class.WedgePart`，
這些是從 `Class.BasePart`（一個抽象類別）繼承的。例如，如果你的目標是更改角色的所有肢體顏色，
你可以使用 `Class.Instance:GetChildren()|GetChildren` 迭代子物件，
然後使用 IsA 過濾出缺乏 `Datatype.BrickColor` 屬性的非 `Class.BasePart` 物件：

```lua
local Players = game:GetService("Players")

local function paintFigure(character, color)
	-- 迭代角色的子物件
	for _, child in character:GetChildren() do
		-- 過濾掉非部件物件，如 Shirt、Pants 和 Humanoid
		-- R15 使用 MeshPart 而 R6 使用 Part，
		-- 所以我們這裡使用 BasePart 來檢測兩者：
		if child:IsA("BasePart") then
			child.BrickColor = color
		end
	end
end
paintFigure(Players.Player.Character, BrickColor.new("Bright blue"))
```
由於所有類別均繼承自 `Class.Object`，呼叫 `object:IsA("Object")` 將
始終返回 true。

Object:IsA

className

將檢查物件類別的類別。
區分大小寫。

描述物件的類別是否匹配或是給定類別的子類別。

如果物件的類別與給定類別匹配或繼承，則返回 true。

Object:isA

Object

一個只讀字串，表示這個 `Class.Object` 所屬的類別。

此屬性可以與用來透過類型識別物件的各種其他函數一起使用，例如
`Class.Object:IsA()` 或 `Class.Instance:FindFirstChildOfClass()`。

請注意，此屬性為只讀，無法由腳本更改。
希望更改物件類別的開發者必須創建一個新的 `Class.Object`。

與 `Class.Object:IsA()` 不同，ClassName 可以用來檢查物件
是否屬於特定類別，而不考慮類別繼承。例如：
```
for _, child in workspace:GetChildren() do
    if child.ClassName == "Part" then
        print("找到了 Part")
        -- 會找到模型中的 Parts，但不會找到 TrussParts、WedgeParts 等
    end
end
```

Object.ClassName

一個只讀字串，表示這個 `Class.Object` 所屬的類別。

Object.className

`Object` 是 Roblox 類別層級中所有類別的基礎類別。

/reference/engine/classes/WebStreamClient.yaml

Luau

在特定事件發生時運行連接的函數的對象。

Data Type

RBXScriptSignal

WebStreamClientState 表示 WebStreamClient 物件的當前狀態。

Enum

Enum.WebStreamClientState

一種值為 true 或 false 的資料類型。

boolean

number

一系列字元，如字母、數字和符號。

string

體驗

虛擬人偶

素材

範例與專案

引擎 API

開放式雲端 API

Studio

分析

平台

教學

創作者計畫

教育

課程

學習

此方法不同步且會傳回一個「Operation」，代表該操作的目前狀態。其中包含一個端點路徑，您可以輪詢以獲得實際回應和適用的中繼資料。詳情請參閱關於長期執行操作的[說明文件]({longRunningOperationsLink})。
            
以下部分描述操作完成時提供的回應和中繼資料物件。

Beta 測試終點已準備好公開使用。可能出現導致功能無法正常運作的變更，但機率不高。

這些開放式雲端文件頁面將於 2026 年 3 月 31 日移除。屆時，系統會自動將你重新導向至新版開放式雲端文件。{linkStart}瞭解詳情{linkEnd}

這些舊版開放式雲端頁面將於 2026 年 3 月 31 日移除，並重新導向至新頁面。{linkStart}瞭解詳情{linkEnd}

實驗端點已可供公開使用，但隨著 API 合約結束，可能會偶爾發生重大變更。

此終點可在體驗內透過 {httpServiceLinkStart}HttpService{httpServiceLinkEnd} 使用 API 金鑰呼叫。

建立資源時可設定此欄位，但可能無法在後續請求中修改。

建立資源時可設定這些欄位，但可能無法在後續請求中修改。

此欄位可在請求中提供，但永遠不會包含在回應中。

舊版本驗證方法。可用時，請務必使用 API 金鑰或 OAuth 2.0。

每個 API 金鑰：每個 IP 位址每 {periodInSeconds} 秒 {maxInPeriod} 個請求

無需驗證即可呼叫。通常會大幅降低速率限制。可用時，請務必使用 API 金鑰或 OAuth 2.0。

對於每個群組，只需提供架構中下列任一欄位，其餘可省略。

你隨時可以重新加入。{linkStart}歡迎提供回饋。{linkEnd}

你正在檢視舊版文件。{linkStart}歡迎提供回饋。{linkEnd}

你可以隨時選擇退出，並重新導向回舊版參考頁面。{linkStart}歡迎提供任何回饋。{linkEnd}

你正在檢視新版文件。{linkStart}歡迎提供回饋。{linkEnd}

此欄位可在回應中設定，但將在請求中被忽略。

注意：在高流量期間，速率限制可能會降低。部分端點有額外的速率限制。[深入瞭解速率限制]({link})。

使用者或群組所有 API 金鑰每日 {limit} 次要求數

使用者或群組所有 API 金鑰每小時 {limit} 次要求數

使用者或群組所有 API 金鑰每分鐘 {limit} 次要求數

使用者或群組所有 API 金鑰每秒 {limit} 次要求數

每位 API 金鑰擁有者每分鐘 {limit} 次要求數

每位應用程式使用者每日 {limit} 次要求數

每位應用程式使用者每小時 {limit} 次要求數

每位應用程式使用者每分鐘 {limit} 次要求數

每位應用程式使用者每秒 {limit} 次要求數

每位 API 金鑰擁有者每秒 {limit} 次要求數

範圍控制憑證的權限。憑證只能存取你選取的範圍所支援的端點。

穩定終點已準備好投入正式環境，在其生命週期中幾乎不會發生破壞性變更。

此目標可讓你將金鑰存取權限制為所選的{requiredParts}

此目標可讓你將金鑰存取權限制為所選的{requiredParts}和{optionalParts}

目標類型是用來限制憑證對於資源的權限。即使你的帳戶擁有其他資源的權限，也只能對所選資源執行操作。某些操作範圍不包含特定目標部分。在這種情況下，所有相關資源皆可操作。

對於使用者擁有的 API 金鑰，無需選擇宇宙的頂層部分。在這種情況下，你的 API 金鑰將可存取你所擁有的使用者體驗內容，以及你具備正確群組權限的所有群組體驗內容。

「立即試試」功能尚未支援需要 API 金鑰或 OAuth 2.0 驗證的端點

為了安全起見，Cookie 驗證在高風險操作中已停用。

關鍵風險端點極為敏感，為了安全起見，已停用「立即試試」功能

注意：此程式碼範例中不包含驗證標頭資訊。你可能需要為此指令新增驗證標頭，才能正常運作。

這是一個高風險端點，用以修改或刪除關鍵資料。測試時請格外小心。

此 API 端點已被歸類為高風險，且可能會影響即時資料或使用者帳號。

對於高風險 API 的驗證請求，可能會造成無法撤銷的變更。請在繼續之前仔細檢查請求參數。

這是一個低風險端點，用以擷取資料。測試這個端點通常是安全的。

這是一個中等風險端點，用以修改資料。請謹慎地使用非關鍵帳戶測試，因為變更可能是永久性的。

為了確保帳號安全，切勿從其他來源貼上文字，或將此頁面的資訊傳送給其他人。

你即將使用實際帳號憑證來測試已發布的 API 端點。

除非你了解即將進行的 API 呼叫可能涉及的後果，方可繼續操作。在測試之前，請仔細閱讀 API 文件。

API 呼叫將透過你已驗證的工作階段進行

這些皆為實際 API 呼叫，可能會影響你的帳號或資料

部分操作可能會修改或刪除資料

此終點已被這些建議的替代終點取代：

需要以下範圍才能呼叫此端點。若要了解更多
關於產生正確金鑰的資訊，請參閱[管理 API 金鑰]({apiKeyReferenceDocLink})。

若要了解更多關於產生金鑰的資訊，請參閱[管理 API 金鑰]({apiKeyReferenceDocLink})。

根據相對基本網址的路徑，可使用下列終點。

此字串的格式為 [FieldMask](/cloud/reference/types#fieldmask)。

JSON 值可為「null」、「boolean」、「string」、「number」、「array」或「object」。

若想使用此端點，您的 OAuth 2.0 應用程式需要以下範圍。有關如何註冊 OAuth 2.0 應用程式的更多資訊，請查看[應用程式註冊和審查]({oauth2ReferenceDocLink})。

若要了解更多關於如何註冊 OAuth 2.0 應用程式的資訊，請參閱[App 註冊與審核]({oauth2ReferenceDocLink})。

以下物件描述被接受或退回的負載。若要獲得更多關於物件使用時機的資訊，請查看個別終點。

需要以下範圍才能呼叫此端點。

資源路徑

此字串的格式為 [Timestamp](/cloud/reference/types#timestamp)。

若想使用此端點，您的 OAuth 2.0 應用程式需要以下範圍。有關如何註冊 OAuth 2.0 應用程式的更多資訊，請查看 [應用程式註冊和審查]（{oauth2ReferenceDocLink}）。

不推薦

你正在檢視新版 Open Cloud 參考資料。

你已選擇退出新版 Open Cloud 參考資料。

建立、更新並管理你的廣告活動。

這可以查看有關您資產的資訊。

這可以上傳和更新 Roblox 的資產。

這項操作可讓你查看主體（包括群組和體驗）的素材權限，以及帳號可存取的素材。

這會允許授予素材權限給您的帳號可存取的任何對象（包含群組和體驗）及素材。

這項操作可讓你代為檢視虛擬人偶自動設定工作的狀態和結果。

這項操作可讓你代為建立和管理虛擬人偶自動設定工作。

授予更新使用者所擁有之徽章的能力。

這會允許查看您商品的相關資訊。

這麼做可對已同步的商品進行變更。

此操作可讓你檢視商務聯絡對象的資訊。

這會允許對您的商務商家連結進行編輯。

這能讓您檢視您創作者商店商品的相關資訊。

這能讓您修改您創作者商店商品的相關資訊。

這項操作可以讓你查看創作者商店儲存項目的相關資訊。

這項操作可讓你修改創作者商店儲存項目的相關資訊。

授予代為建立資料存儲的存取權。

授予代為刪除資料存儲的權限。

授予讀取資料存儲清單的存取權。

授予為資料存儲拍攝快照的存取權。

授予在資料存儲中建立條目的存取權。

授予標記指定條目以進行刪除的存取權。

授予可列出資料存儲項目的存取權。

授予在資料存儲中讀取指定條目的存取權。

授予更新項目值、屬性和使用者的存取權。

授予可刪除資料存儲條目修訂版的存取權。

授予可列出資料存儲條目修訂版的存取權。

授予可讀取資料存儲條目修訂版的存取權。

授予檢視授權使用者開發者產品設定詳細資訊的權限。

授予編輯授權使用者開發者產品的權限。

這會允許查看您宇宙環境的相關資訊。

授予檢視授權使用者遊戲通行證設定詳細資訊的權限。

授予編輯授權使用者遊戲通行證的權限。

授予檢視帳號社群論壇資訊的權限。

授予管理帳號社群論壇資訊的權限。

這會允許查看您社群的相關資訊。

這能讓您管理自己帳號的社群加入申請和低階社群成員的角色更新。

允許你修改個體的屬性資料（目前僅支援指令碼）。

這可以查看有關您道具欄的資訊。

授予管理使用者資產的存取權。

授予管理您徽章和花費 Robux 的權限。

授予更新授權使用者徽章的權限。

授予管理您開發者產品的權限。

授予存取權限，以讀取你已開啟通知的體驗相關資訊。

授予存取權限，代你開啟或關閉體驗通知。

授予讀取與寫入您在地化表格的權限。

授予管理您擁有之所有體驗的團隊協作權限。

授予管理您的體驗及部分體驗相關資訊（例如：在地化資訊）的權限。

授予讀取您體驗之在地化資訊的權限。

授予修改您體驗在地化偏好的權限。

授予管理您使用者帳號的權限。

授予修改使用者在地化偏好的權限。

允許你檢視關聯地點的 Luau 執行任務狀態、紀錄和結果。

允許你為關聯地點建立新的 Luau 執行任務。

授予非同步清除宇宙中所有資料結構的存取權。

授予建立新佇列項目的存取權。

授予從佇列前端捨棄讀取項目的存取權。

授予從佇列前端讀取項目的權限。

授予讀取記憶存儲項目的存取權。

授予建立、更新和刪除地圖項目的存取權。

給予代替使用者發布訊息的能力。

這能讓您的體驗向使用者傳送通知。

（棄用）授予在已排序資料存儲中讀取條目清單的存取權。

（棄用）授予在已排序資料存儲中建立新條目的存取權。

授予從已排序資料存儲中列出條目的存取權。

授予在已排序資料存儲中建立條目的存取權。

此將允許列出與您的體驗相關的機密資料。

此將允許建立並更新與您的體驗相關的機密資料。

此權限可讓你提交評估工作，並檢視工作結果。

授予讀取您訂閱產品相關資訊的權限。

這項操作可讓你代為讀取縮圖資訊。

授予發佈新版本體驗到 Roblox 的權限。

授予編輯授權使用者體驗的權限。

讓您檢視體驗中的使用者限制。

讓您在體驗中編輯使用者限制。

這項操作將允許檢視傳送至你帳號的通知。

授予讀取權限，查看授權使用者的高級會員與驗證狀態。

此舉可以讓你查看授權使用者的社群帳號。

這將授予讀取您個人檔案資訊的權限。