UserEventResponseHandler interface

Pakiet:

@azure/web-pubsub-express

Procedura obsługi ustawiania odpowiedzi zdarzenia użytkownika

Metody

fail(400 | 401 | 500, string)	Zwrócona odpowiedź zakończyła się niepowodzeniem, a usługa zamknie połączenie klienta Protokołu WebSocket.
setState(string, unknown)	Ustawianie stanu połączenia
success(string | ArrayBuffer, "binary" | "text" | "json")	Zwróć odpowiedź z informacją o powodzeniu z danymi, które mają zostać dostarczone do połączenia klienta protokołu WebSocket.

Szczegóły metody

fail(400 | 401 | 500, string)

Zwrócona odpowiedź zakończyła się niepowodzeniem, a usługa zamknie połączenie klienta Protokołu WebSocket.

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

Parametry

code

400 | 401 | 500

Kod może być błędem 400 użytkowników, błędem 401 brak autoryzacji i błędem serwera 500.

detail

string

Szczegóły błędu.

setState(string, unknown)

Ustawianie stanu połączenia

function setState(name: string, value: unknown)

Parametry

name

string

Nazwa stanu

value

unknown

Wartość stanu

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

Zwróć odpowiedź z informacją o powodzeniu z danymi, które mają zostać dostarczone do połączenia klienta protokołu WebSocket.

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

Parametry

data

string | ArrayBuffer

Dane ładunku, które mają zostać zwrócone do klienta. Ciągifikuj komunikat, jeśli jest to obiekt JSON.

dataType

"binary" | "text" | "json"

Typ danych ładunku.