ConnectionContext interface

Package:

@azure/web-pubsub-express

The connection context representing the client WebSocket connection.

Properties

clientProtocol	The type of client protocol.
connectionId	The Id of the connection.
eventName	The event name of this CloudEvents request.
hub	The hub the connection belongs to.
mqtt	The MQTT properties that the client WebSocket connection has when it connects (For MQTT connection only).
origin	The origin this CloudEvents request comes from.
signature	The unique identifier generated by the service of the network connection.
states	Get the additional states for the connection, such states are perserved throughout the lifetime of the connection.
subprotocol	The subprotocol of this connection.
userId	The user id of the connection.

Property Details

clientProtocol

The type of client protocol.

clientProtocol: WebPubSubClientProtocol

Property Value

WebPubSubClientProtocol

connectionId

The Id of the connection.

connectionId: string

Property Value

string

eventName

The event name of this CloudEvents request.

eventName: string

Property Value

string

hub

The hub the connection belongs to.

hub: string

Property Value

string

mqtt

The MQTT properties that the client WebSocket connection has when it connects (For MQTT connection only).

mqtt?: MqttConnectionContextProperties

Property Value

MqttConnectionContextProperties

origin

The origin this CloudEvents request comes from.

origin: string

Property Value

string

signature

The unique identifier generated by the service of the network connection.

signature: string

Property Value

string

states

Get the additional states for the connection, such states are perserved throughout the lifetime of the connection.

states: Record<string, any>

Property Value

Record<string, any>

subprotocol

The subprotocol of this connection.

subprotocol?: string

Property Value

string

userId

The user id of the connection.

userId?: string

Property Value

string