MqttConnectRequest interface
Request for the MQTT connect event.
- Extends
Properties
| mqtt | The MQTT specific properties in the MQTT connect event request. |
Inherited Properties
| claims | The claims that the client WebSocket connection has when it connects. |
| client |
The client certificate info that the client WebSocket connection uses to connect. |
| context | The context of current CloudEvents request. |
| headers | The headers that the client WebSocket connection has when it connects. |
| queries | The queries that the client WebSocket connection has when it connects. |
| query | The query that the client WebSocket connection has when it connects. |
| subprotocols | The subprotocols that the client WebSocket connection uses to do handshake. |
Property Details
mqtt
The MQTT specific properties in the MQTT connect event request.
mqtt: MqttConnectPropertiesProperty Value
Inherited Property Details
claims
The claims that the client WebSocket connection has when it connects.
claims?: Record<string, string[]>Property Value
Record<string, string[]>
Inherited From ConnectRequest.claims
clientCertificates
The client certificate info that the client WebSocket connection uses to connect.
clientCertificates?: Certificate[]Property Value
Inherited From ConnectRequest.clientCertificates
context
The context of current CloudEvents request.
context: ConnectionContextProperty Value
Inherited From ConnectRequest.context
headers
The headers that the client WebSocket connection has when it connects.
headers?: Record<string, string[]>Property Value
Record<string, string[]>
Inherited From ConnectRequest.headers
queries
The queries that the client WebSocket connection has when it connects.
queries?: Record<string, string[]>Property Value
Record<string, string[]>
Inherited From ConnectRequest.queries
query
Warning
This API is now deprecated.
Please use queries instead.
The query that the client WebSocket connection has when it connects.
query?: Record<string, string[]>Property Value
Record<string, string[]>
Inherited From ConnectRequest.query
subprotocols
The subprotocols that the client WebSocket connection uses to do handshake.
subprotocols?: string[]Property Value
string[]
Inherited From ConnectRequest.subprotocols