ConnectionContext interface

套件:

@azure/web-pubsub-express

表示用戶端 WebSocket 連線的連接內容。

屬性

clientProtocol	用戶端協議的類型。
connectionId	連接的識別碼。
eventName	此 CloudEvents 要求的事件名稱。
hub	線上所屬的中樞。
mqtt	用戶端 WebSocket 連接在連接時具有的 MQTT 屬性（僅適用於 MQTT 連接）。
origin	CloudEvents 要求的來源。
signature	網路連接服務生成的唯一標識碼。
states	取得連線的其他狀態，這類狀態會在連線的存留期內保留。
subprotocol	此連線的子程式。
userId	線上的使用者識別碼。

屬性詳細資料

clientProtocol

用戶端協議的類型。

clientProtocol: WebPubSubClientProtocol

屬性值

WebPubSubClientProtocol

connectionId

連接的識別碼。

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

線上的使用者識別碼。

userId?: string

屬性值

string