Share via

MqttConnectResponse interface

Package:
@azure/web-pubsub-express

Success respones of the connect event.

Extends
ConnectResponse

Properties

mqtt

The MQTT specific properties in a successful MQTT connection event response.

Inherited Properties

groups

Set the groups the connection would like to join.
roles

Set the roles the connection belongs to.
subprotocol

Set the subprotocol for the connection to complete WebSocket handshake.
userId

Set the userId for the connection.

Property Details

mqtt

The MQTT specific properties in a successful MQTT connection event response.

mqtt?: MqttConnectResponseProperties

Property Value

MqttConnectResponseProperties

Inherited Property Details

groups

Set the groups the connection would like to join.

groups?: string[]

Property Value

string[]

Inherited From ConnectResponse.groups

roles

Set the roles the connection belongs to.

roles?: string[]

Property Value

string[]

Inherited From ConnectResponse.roles

subprotocol

Set the subprotocol for the connection to complete WebSocket handshake.

subprotocol?: string

Property Value

string

Inherited From ConnectResponse.subprotocol

userId

Set the userId for the connection.

userId?: string

Property Value

string

Inherited From ConnectResponse.userId