UserEventResponseHandler interface

Paquete:

@azure/web-pubsub-express

Controlador para establecer la respuesta de eventos de usuario

Métodos

fail(400 | 401 | 500, string)	Devuelve una respuesta con error y el servicio cerrará la conexión webSocket del cliente.
setState(string, unknown)	Establecimiento del estado de la conexión
success(string | ArrayBuffer, "binary" | "text" | "json")	Devuelve la respuesta correcta con los datos que se van a entregar a la conexión webSocket del cliente.

Detalles del método

fail(400 | 401 | 500, string)

Devuelve una respuesta con error y el servicio cerrará 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.

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(string | ArrayBuffer, "binary" | "text" | "json")

Devuelve la respuesta correcta con los datos que se van a entregar a la conexión webSocket del cliente.

function success(data?: string | ArrayBuffer, dataType?: "binary" | "text" | "json")

Parámetros

data

string | ArrayBuffer

Los datos de carga que se van a devolver al cliente. Encadenifique el mensaje si es un objeto JSON.

dataType

"binary" | "text" | "json"

Tipo de los datos de carga.