UserEventResponseHandler interface

Paquet:

@azure/web-pubsub-express

Gestionnaire permettant de définir la réponse aux événements de l’utilisateur

Méthodes

fail(400 | 401 | 500, string)	Retourne une réponse ayant échoué et le service ferme la connexion WebSocket du client.
setState(string, unknown)	Définir l’état de la connexion
success(string | ArrayBuffer, "binary" | "text" | "json")	Retournez la réponse de réussite avec les données à remettre à la connexion WebSocket cliente.

Détails de la méthode

fail(400 | 401 | 500, string)

Retourne une réponse ayant échoué et le service ferme la connexion WebSocket du client.

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

Paramètres

code

400 | 401 | 500

Le code peut être une erreur utilisateur 400, 401 non autorisé et 500 erreur serveur.

detail

string

Détail de l’erreur.

setState(string, unknown)

Définir l’état de la connexion

function setState(name: string, value: unknown)

Paramètres

name

string

Nom de l’état

value

unknown

Valeur de l’état

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

Retournez la réponse de réussite avec les données à remettre à la connexion WebSocket cliente.

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

Paramètres

data

string | ArrayBuffer

Données de charge utile à retourner au client. Chaînez le message s’il s’agit d’un objet JSON.

dataType

"binary" | "text" | "json"

Type des données de charge utile.