UserEventResponseHandler interface

Paket:

@azure/web-pubsub-express

Hanteraren för att ange svar från användarhändelser

Metoder

fail(400 | 401 | 500, string)	Returnera ett misslyckat svar och tjänsten stänger klientens WebSocket-anslutning.
setState(string, unknown)	Ange tillståndet för anslutningen
success(string | ArrayBuffer, "binary" | "text" | "json")	Returnera lyckat svar med data som ska levereras till klientens WebSocket-anslutning.

Metodinformation

fail(400 | 401 | 500, string)

Returnera ett misslyckat svar och tjänsten stänger klientens WebSocket-anslutning.

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

Parametrar

code

400 | 401 | 500

Koden kan vara 400 användarfel, 401 obehörigt och 500-serverfel.

detail

string

Information om felet.

setState(string, unknown)

Ange tillståndet för anslutningen

function setState(name: string, value: unknown)

Parametrar

name

string

Namnet på tillståndet

value

unknown

Värdet för tillståndet

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

Returnera lyckat svar med data som ska levereras till klientens WebSocket-anslutning.

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

Parametrar

data

string | ArrayBuffer

Nyttolastdata som ska returneras till klienten. Strängbelägga meddelandet om det är ett JSON-objekt.

dataType

"binary" | "text" | "json"

Typ av nyttolastdata.