ConnectResponseHandler interface

Paquete:

@azure/web-pubsub-express

Controlador para establecer la respuesta de eventos de conexión

Métodos

fail(400 | 401 | 500, string)	Devuelve una respuesta con error y el servicio rechazará la conexión webSocket del cliente.
failWith(ConnectErrorResponse | MqttConnectErrorResponse)	Devuelva la respuesta fallida con las propiedades de respuesta MQTT y el servicio rechazará la conexión WebSocket del cliente.
setState(string, unknown)	Establecimiento del estado de la conexión
success(ConnectResponse | MqttConnectResponse)	Devuelve la respuesta correcta al servicio.

Detalles del método

fail(400 | 401 | 500, string)

Devuelve una respuesta con error y el servicio rechazará la conexión webSocket del cliente.

function fail(code: 400 | 401 | 500, detail?: string)

Parámetros

code

400 | 401 | 500

El código puede ser 400 errores de usuario, 401 no autorizado y 500 errores de servidor.

detail

string

Detalle del error.

failWith(ConnectErrorResponse | MqttConnectErrorResponse)

Devuelva la respuesta fallida con las propiedades de respuesta MQTT y el servicio rechazará la conexión WebSocket del cliente.

function failWith(response: ConnectErrorResponse | MqttConnectErrorResponse)

Parámetros

response

ConnectErrorResponse | MqttConnectErrorResponse

La respuesta para el evento connect que contiene las propiedades de respuesta predeterminadas de WebPubSub o MQTT.

setState(string, unknown)

Establecimiento del estado de la conexión

function setState(name: string, value: unknown)

Parámetros

name

string

Nombre del estado

value

unknown

Valor del estado

success(ConnectResponse | MqttConnectResponse)

Devuelve la respuesta correcta al servicio.

function success(response?: ConnectResponse | MqttConnectResponse)

Parámetros

response

ConnectResponse | MqttConnectResponse

Respuesta del evento connect.