Compartilhar via


UserEventResponseHandler interface

O manipulador para definir a resposta de evento do usuário

Métodos

fail(400 | 401 | 500, string)

Retornar resposta com falha e o serviço fechará a conexão WebSocket do cliente.

setState(string, unknown)

Definir o estado da conexão

success(string | ArrayBuffer, "binary" | "text" | "json")

Retornar resposta de êxito com dados a serem entregues à conexão WebSocket do cliente.

Detalhes do método

fail(400 | 401 | 500, string)

Retornar resposta com falha e o serviço fechará a conexão WebSocket do cliente.

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

Parâmetros

code

400 | 401 | 500

O código pode ter 400 erros de usuário, 401 não autorizados e 500 de servidor.

detail

string

O detalhe do erro.

setState(string, unknown)

Definir o estado da conexão

function setState(name: string, value: unknown)

Parâmetros

name

string

O nome do estado

value

unknown

O valor do estado

success(string | ArrayBuffer, "binary" | "text" | "json")

Retornar resposta de êxito com dados a serem entregues à conexão WebSocket do cliente.

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

Parâmetros

data

string | ArrayBuffer

Os dados de carga a serem retornados ao cliente. Stringify a mensagem se for um objeto JSON.

dataType

"binary" | "text" | "json"

O tipo dos dados de carga.