Share via

ConnectionContext interface

  • Reference
Package:
@azure/web-pubsub-express

The connection context representing the client WebSocket connection.

Properties

connectionId

The Id of the connection.
eventName

The event name of this CloudEvents request.
hub

The hub the connection belongs to.
origin

The origin this CloudEvents request comes from.
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

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

origin

The origin this CloudEvents request comes from.

origin: 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