@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 |
|
| GroupStreamWriteOptions |
ストリーム書き込みオプションをグループ化しましょう。 |
| GroupStreamWriter |
グループストリームライター抽象化は、1つの論理ストリームをグループに送信するためのものです。 |
| InvocationErrorOptions | |
| InvokeEventOptions |
イベント操作オプションの呼び出し |
| InvokeEventResult |
invokeEventの結果 |
| InvokeMessage |
インヴォークメッセージ |
| InvokeResponseError |
応答エラーの詳細を呼び出し |
| InvokeResponseMessage |
応答メッセージを呼び出します |
| JoinGroupMessage |
グループに参加するメッセージ |
| JoinGroupOptions |
グループ結合操作のオプション |
| LeaveGroupMessage |
グループ メッセージを残す |
| LeaveGroupOptions |
グループ操作オプションを残す |
| OnConnectedArgs |
OnConnected コールバックのパラメーター |
| OnDisconnectedArgs |
OnDisconnected コールバックのパラメーター |
| OnGroupDataMessageArgs |
OnGroupDataMessage コールバックのパラメーター |
| OnGroupStreamOptions |
粒度は2レベルです:
|
| OnRejoinGroupFailedArgs |
RejoinGroupFailed コールバックのパラメーター |
| OnServerDataMessageArgs |
OnDataMessage コールバックのパラメーター |
| OnStoppedArgs |
OnStopped コールバックのパラメーター |
| OpenGroupStreamOptions |
OpenGroupStreamの運用オプション。 |
| PingMessage |
ピンメッセージ |
| PongMessage |
ポンメッセージ |
| SendEventMessage |
カスタム イベント メッセージを送信する |
| SendEventOptions |
イベントの送信操作オプション |
| SendMessageErrorOptions | |
| SendToGroupMessage |
グループ メッセージに送信する |
| SendToGroupOptions |
グループへの送信操作のオプション |
| SequenceAckMessage |
シーケンス確認メッセージ |
| ServerDataMessage |
サーバー データ メッセージ |
| SetGroupStateMessage |
グループ状態メッセージを設定してください |
| StartOptions |
開始オプション |
| StartStreamOptions |
ストリームディスクリプタは、ストリームを開くsendToGroupコントロールフレームに付随します。 |
| StreamAckMessage |
アクメッセージを配信してください。 |
| StreamClosedMessage |
配信終了メッセージ。 |
| StreamDataError |
ストリームエラーの詳細。 |
| StreamDataMessage |
データメッセージをストリーミングします。 ペイロードが |
| StreamEndError |
ストリーム終了エラーは、アウトバウンドストリームがサービスに送信できるものです。 サービス側が高レベルのエラー名の分類を決定します。 |
| StreamEndMessage |
配信終了メッセージ。 |
| StreamInfo |
ストリームメタデータは下流のデータメッセージに付随します。 |
| StreamNackMessage |
ナックメッセージをストリーミングしてください。 |
| SubscribeGroupStateMessage |
グループステートメッセージの購読 |
| UnsubscribeGroupStateMessage |
グループ状態メッセージの停止 |
| WebPubSubClientCredential |
WebPubSubClient 資格情報 |
| WebPubSubClientOptions |
クライアント オプション |
| WebPubSubClientProtocol |
Web pubsub サブプロトコル用に実装されるインターフェイス |
| WebPubSubMessageBase |
Web pubsub メッセージの共通点 |
| WebPubSubResult |
確認結果 |
| WebPubSubRetryOptions |
再試行オプション |
型エイリアス
| DownstreamMessageType |
ダウンストリーム メッセージの種類 |
| JSONTypes |
JSON としてシリアル化および送信できる型。 |
| RetryMode |
再試行モードの種類について説明します |
| UpstreamMessageType |
アップストリーム メッセージの種類 |
| WebPubSubDataType |
データ型 |
| WebPubSubMessage |
Web pubsub メッセージ |
関数
| Web |
"json.webpubsub.azure.v1" プロトコルを返します |
| Web |
"json.reliable.webpubsub.azure.v1" プロトコルを返します |
関数の詳細
WebPubSubJsonProtocol()
"json.webpubsub.azure.v1" プロトコルを返します
function WebPubSubJsonProtocol(): WebPubSubClientProtocol返品
WebPubSubJsonReliableProtocol()
"json.reliable.webpubsub.azure.v1" プロトコルを返します
function WebPubSubJsonReliableProtocol(): WebPubSubClientProtocol