UserEventResponseHandler interface

Pacchetto:

@azure/web-pubsub-express

Gestore per impostare la risposta dell'evento utente

Metodi

fail(400 | 401 | 500, string)	Restituisce una risposta non riuscita e il servizio chiuderà la connessione WebSocket client.
setState(string, unknown)	Impostare lo stato della connessione
success(string | ArrayBuffer, "binary" | "text" | "json")	Restituisce la risposta di esito positivo con i dati da recapitare alla connessione WebSocket client.

Dettagli metodo

fail(400 | 401 | 500, string)

Restituisce una risposta non riuscita e il servizio chiuderà la connessione WebSocket client.

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

Parametri

code

400 | 401 | 500

Il codice può essere 400 errore utente, 401 errore non autorizzato e 500 server.

detail

string

Dettagli dell'errore.

setState(string, unknown)

Impostare lo stato della connessione

function setState(name: string, value: unknown)

Parametri

name

string

Nome dello stato

value

unknown

Valore dello stato

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

Restituisce la risposta di esito positivo con i dati da recapitare alla connessione WebSocket client.

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

Parametri

data

string | ArrayBuffer

Dati del payload da restituire al client. Impostare come stringa il messaggio se si tratta di un oggetto JSON.

dataType

"binary" | "text" | "json"

Tipo dei dati del payload.