@azure/web-pubsub-client package

類別

InvocationError

當召喚失敗或被取消時會拋出錯誤。

SendMessageError

傳送訊息失敗時發生錯誤

WebPubSubClient

WebPubSub 用戶端

介面

AbortGroupStreamOptions

取消群組串流選項。

AckMessage

ack 訊息

AckMessageError

AckMessage 中的錯誤詳細數據

CancelInvocationMessage

取消召喚訊息

ConnectedMessage

已連線的訊息

DisconnectedMessage

已中斷連線的訊息

EndGroupStreamOptions

結束群組串流選項。

GetClientAccessUrlOptions

開始選項

GroupDataMessage

群組資料訊息

GroupStateItem

單一連線在群組中的狀態條目

GroupStateSnapshotMessage

群組狀態快照訊息,在成功訂閱群組狀態後發送

GroupStateUpdateMessage

群組狀態更新訊息,當連線狀態變更時推送

GroupStream

單一的入站群組串流。

GroupStreamMessage

群組串流的一個入站片段。

GroupStreamSubscription

訂閱回來 client.onGroupStream(...)

GroupStreamWriteOptions

群組串流寫入選項。

GroupStreamWriter

群組串流寫入抽象,用於將一個邏輯串流傳送到群組。

InvocationErrorOptions
InvokeEventOptions

呼叫事件操作選項

InvokeEventResult

invokeEvent 的結果

InvokeMessage

呼叫訊息

InvokeResponseError

呼叫回應錯誤細節

InvokeResponseMessage

呼叫回應訊息

JoinGroupMessage

聯結群組訊息

JoinGroupOptions

聯結群組作業選項

LeaveGroupMessage

離開群組訊息

LeaveGroupOptions

離開群組作業選項

OnConnectedArgs

OnConnected 回呼的參數

OnDisconnectedArgs

OnDisconnected 回呼的參數

OnGroupDataMessageArgs

OnGroupDataMessage 回呼的參數

OnGroupStreamOptions

控制如何追蹤及派遣單一回撥的進站群組串流選項,註冊為 client.onGroupStream(callback, options)

粒度有兩層次:

  • 選項 會依註冊值(即每個處理器)作用域:每個 onGroupStream 呼叫攜帶自己的值,不同處理器可能使用不同的值。
  • 選擇 權效應 獨立應用於每個流,並以其 (group, streamId) 配對來識別。 同時進行的串流——即使是同一組中由同一處理器觀察的兩條串流——各自擁有自己的閒置計時器和閘 handleFromStart 門。 沒有任何資訊流或群組間會共享或彙整。
OnRejoinGroupFailedArgs

RejoinGroupFailed 回呼的參數

OnServerDataMessageArgs

OnDataMessage 回呼的參數

OnStoppedArgs

OnStopped 回呼的參數

OpenGroupStreamOptions

開放GroupStream操作選項。

PingMessage

Ping 訊息

PongMessage

乒乓訊息

SendEventMessage

傳送自定義事件訊息

SendEventOptions

傳送事件作業選項

SendMessageErrorOptions
SendToGroupMessage

傳送至群組訊息

SendToGroupOptions

傳送至群組作業選項

SequenceAckMessage

時序ack 訊息

ServerDataMessage

伺服器資料訊息

SetGroupStateMessage

設定群組狀態訊息

StartOptions

開始選項

StartStreamOptions

串流描述符附加在 sendToGroup 控制框架上,該框架會開啟串流。

StreamAckMessage

串流 Ack 訊息。

StreamClosedMessage

串流 關閉訊息。

StreamDataError

串流錯誤詳情。

StreamDataMessage

串流資料訊息。 只有 streamId 的有效載荷代表保持活狀態。

StreamEndError

串流結束錯誤,出站串流可以傳送給服務。 服務單位決定高階錯誤名稱分類。

StreamEndMessage

串流 結束訊息。

StreamInfo

串流元資料附加於下游資料訊息。

StreamNackMessage

串流 nack 訊息。

SubscribeGroupStateMessage

訂閱群組狀態訊息

UnsubscribeGroupStateMessage

取消訂閱群組狀態訊息

WebPubSubClientCredential

WebPubSubClient 認證

WebPubSubClientOptions

用戶端選項

WebPubSubClientProtocol

要針對 Web pubsub 子程式實作的介面

WebPubSubMessageBase

Web pubsub 訊息的常見之處

WebPubSubResult

ack 結果

WebPubSubRetryOptions

重試選項

類型別名

DownstreamMessageType

下游訊息的類型

JSONTypes

可串行化並傳送為 JSON 的類型。

RetryMode

描述重試模式類型

UpstreamMessageType

上游訊息的類型

WebPubSubDataType

數據類型

WebPubSubMessage

Web pubsub 訊息

函式

WebPubSubJsonProtocol()

傳回 「json.webpubsub.azure.v1」 通訊協定

WebPubSubJsonReliableProtocol()

傳回 「json.reliable.webpubsub.azure.v1」 通訊協定

函式詳細資料

WebPubSubJsonProtocol()

傳回 「json.webpubsub.azure.v1」 通訊協定

function WebPubSubJsonProtocol(): WebPubSubClientProtocol

傳回

WebPubSubJsonReliableProtocol()

傳回 「json.reliable.webpubsub.azure.v1」 通訊協定

function WebPubSubJsonReliableProtocol(): WebPubSubClientProtocol

傳回