ConnectResponseHandler interface

Balíček:

@azure/web-pubsub-express

Obslužná rutina pro nastavení odpovědi na událost připojení

Metody

fail(400 | 401 | 500, string)	Vrátí neúspěšnou odpověď a služba odmítne připojení klienta WebSocket.
failWith(ConnectErrorResponse | MqttConnectErrorResponse)	Vrátí neúspěšnou odpověď s vlastnostmi odpovědi MQTT a služba odmítne připojení WebSocket klienta.
setState(string, unknown)	Nastavení stavu připojení
success(ConnectResponse | MqttConnectResponse)	Vrátí odpověď na úspěch služby.

Podrobnosti metody

fail(400 | 401 | 500, string)

Vrátí neúspěšnou odpověď a služba odmítne připojení klienta WebSocket.

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

Parametry

code

400 | 401 | 500

Kód může být chyba uživatele 400, 401 neautorizováno a chyba serveru 500.

detail

string

Podrobnosti o chybě.

failWith(ConnectErrorResponse | MqttConnectErrorResponse)

Vrátí neúspěšnou odpověď s vlastnostmi odpovědi MQTT a služba odmítne připojení WebSocket klienta.

function failWith(response: ConnectErrorResponse | MqttConnectErrorResponse)

Parametry

response

ConnectErrorResponse | MqttConnectErrorResponse

Odpověď na connect událost, která obsahuje buď výchozí vlastnosti odpovědi WebPubSub nebo MQTT.

setState(string, unknown)

Nastavení stavu připojení

function setState(name: string, value: unknown)

Parametry

name

string

Název státu

value

unknown

Hodnota stavu

success(ConnectResponse | MqttConnectResponse)

Vrátí odpověď na úspěch služby.

function success(response?: ConnectResponse | MqttConnectResponse)

Parametry

response

ConnectResponse | MqttConnectResponse

Odpověď na událost připojení.