ConnectionContext interface

パッケージ:

@azure/web-pubsub-express

クライアント WebSocket 接続を表す接続コンテキスト。

プロパティ

clientProtocol	クライアント プロトコルの種類。
connectionId	接続の ID。
eventName	この CloudEvents 要求のイベント名。
hub	接続が属しているハブ。
mqtt	クライアント WebSocket 接続が接続時に持つ MQTT プロパティ (MQTT 接続のみ)。
origin	この CloudEvents 要求の送信元。
signature	ネットワーク接続のサービスによって生成される一意の識別子。
states	接続の追加の状態を取得します。このような状態は、接続の有効期間中に予約されます。
subprotocol	この接続のサブプロトコル。
userId	接続のユーザー ID。

プロパティの詳細

clientProtocol

クライアント プロトコルの種類。

clientProtocol: WebPubSubClientProtocol

プロパティ値

WebPubSubClientProtocol

connectionId

接続の ID。

connectionId: string

プロパティ値

string

eventName

この CloudEvents 要求のイベント名。

eventName: string

プロパティ値

string

hub

接続が属しているハブ。

hub: string

プロパティ値

string

mqtt

クライアント WebSocket 接続が接続時に持つ MQTT プロパティ (MQTT 接続のみ)。

mqtt?: MqttConnectionContextProperties

プロパティ値

MqttConnectionContextProperties

origin

この CloudEvents 要求の送信元。

origin: string

プロパティ値

string

signature

ネットワーク接続のサービスによって生成される一意の識別子。

signature: string

プロパティ値

string

states

接続の追加の状態を取得します。このような状態は、接続の有効期間中に予約されます。

states: Record<string, any>

プロパティ値

Record<string, any>

subprotocol

この接続のサブプロトコル。

subprotocol?: string

プロパティ値

string

userId

接続のユーザー ID。

userId?: string

プロパティ値

string