WebPubSubClient class

Paquet:

@azure/web-pubsub-client

Client WebPubSub

Constructeurs

WebPubSubClient(string, WebPubSubClientOptions)	Créer une instance de WebPubSubClient
WebPubSubClient(WebPubSubClientCredential, WebPubSubClientOptions)	Créer une instance de WebPubSubClient

Méthodes

invokeEvent(string, JSONTypes | ArrayBuffer, WebPubSubDataType, InvokeEventOptions)	Invoquez un événement en amont et attendez la réponse corrélée.
joinGroup(string, JoinGroupOptions)	Joindre le client au groupe
leaveGroup(string, LeaveGroupOptions)	Quitter le client du groupe
off("connected", (e: OnConnectedArgs) => void)	Supprimer le gestionnaire pour l’événement connecté
off("disconnected", (e: OnDisconnectedArgs) => void)	Supprimer le gestionnaire pour l’événement déconnecté
off("group-message", (e: OnGroupDataMessageArgs) => void)	Supprimer le gestionnaire pour le message de groupe
off("rejoin-group-failed", (e: OnRejoinGroupFailedArgs) => void)	Échec de la suppression du gestionnaire pour la jointurage du groupe
off("server-message", (e: OnServerDataMessageArgs) => void)	Supprimer le gestionnaire pour le message du serveur
off("stopped", (e: OnStoppedArgs) => void)	Supprimer le gestionnaire pour l’événement arrêté
on("connected", (e: OnConnectedArgs) => void)	Ajouter un gestionnaire pour un événement connecté
on("disconnected", (e: OnDisconnectedArgs) => void)	Ajouter un gestionnaire pour un événement déconnecté
on("group-message", (e: OnGroupDataMessageArgs) => void)	Ajouter un gestionnaire pour les messags de groupe
on("rejoin-group-failed", (e: OnRejoinGroupFailedArgs) => void)	Échec de l’ajout d’un gestionnaire pour rejoindre le groupe
on("server-message", (e: OnServerDataMessageArgs) => void)	Ajouter un gestionnaire pour les messages serveur
on("stopped", (e: OnStoppedArgs) => void)	Ajouter un gestionnaire pour l’événement arrêté
sendEvent(string, JSONTypes | ArrayBuffer, WebPubSubDataType, SendEventOptions)	Envoyer un événement personnalisé au serveur.
sendToGroup(string, JSONTypes | ArrayBuffer, WebPubSubDataType, SendToGroupOptions)	Envoyer un message au groupe.
start(StartOptions)	Commencez à commencer au service.
stop()	Arrêtez le client.

Détails du constructeur

WebPubSubClient(string, WebPubSubClientOptions)

Créer une instance de WebPubSubClient

new WebPubSubClient(clientAccessUrl: string, options?: WebPubSubClientOptions)

Paramètres

clientAccessUrl

string

URI à connecter

options

WebPubSubClientOptions

Options du client

WebPubSubClient(WebPubSubClientCredential, WebPubSubClientOptions)

Créer une instance de WebPubSubClient

new WebPubSubClient(credential: WebPubSubClientCredential, options?: WebPubSubClientOptions)

Paramètres

credential

WebPubSubClientCredential

Informations d’identification à utiliser lors de la connexion

options

WebPubSubClientOptions

Options du client

Détails de la méthode

invokeEvent(string, JSONTypes | ArrayBuffer, WebPubSubDataType, InvokeEventOptions)

Invoquez un événement en amont et attendez la réponse corrélée.

function invokeEvent(eventName: string, content: JSONTypes | ArrayBuffer, dataType: WebPubSubDataType, options?: InvokeEventOptions): Promise<InvokeEventResult>

Paramètres

eventName

string

Nom de l’événement

content

JSONTypes | ArrayBuffer

La charge utile

dataType

WebPubSubDataType

Type de charge utile

options

InvokeEventOptions

Options d’invoquation

Retours

Promise<InvokeEventResult>

joinGroup(string, JoinGroupOptions)

Joindre le client au groupe

function joinGroup(groupName: string, options?: JoinGroupOptions): Promise<WebPubSubResult>

Paramètres

groupName

string

Nom du groupe

options

JoinGroupOptions

Options de groupe de jointure

Retours

Promise<WebPubSubResult>

leaveGroup(string, LeaveGroupOptions)

Quitter le client du groupe

function leaveGroup(groupName: string, options?: LeaveGroupOptions): Promise<WebPubSubResult>

Paramètres

groupName

string

Nom du groupe

options

LeaveGroupOptions

Retours

Promise<WebPubSubResult>

off("connected", (e: OnConnectedArgs) => void)

Supprimer le gestionnaire pour l’événement connecté

function off(event: "connected", listener: (e: OnConnectedArgs) => void)

Paramètres

event

"connected"

Nom de l’événement

listener

(e: OnConnectedArgs) => void

Gestionnaire

off("disconnected", (e: OnDisconnectedArgs) => void)

Supprimer le gestionnaire pour l’événement déconnecté

function off(event: "disconnected", listener: (e: OnDisconnectedArgs) => void)

Paramètres

event

"disconnected"

Nom de l’événement

listener

(e: OnDisconnectedArgs) => void

Gestionnaire

off("group-message", (e: OnGroupDataMessageArgs) => void)

Supprimer le gestionnaire pour le message de groupe

function off(event: "group-message", listener: (e: OnGroupDataMessageArgs) => void)

Paramètres

event

"group-message"

Nom de l’événement

listener

(e: OnGroupDataMessageArgs) => void

Gestionnaire

off("rejoin-group-failed", (e: OnRejoinGroupFailedArgs) => void)

Échec de la suppression du gestionnaire pour la jointurage du groupe

function off(event: "rejoin-group-failed", listener: (e: OnRejoinGroupFailedArgs) => void)

Paramètres

event

"rejoin-group-failed"

Nom de l’événement

listener

(e: OnRejoinGroupFailedArgs) => void

Gestionnaire

off("server-message", (e: OnServerDataMessageArgs) => void)

Supprimer le gestionnaire pour le message du serveur

function off(event: "server-message", listener: (e: OnServerDataMessageArgs) => void)

Paramètres

event

"server-message"

Nom de l’événement

listener

(e: OnServerDataMessageArgs) => void

Gestionnaire

off("stopped", (e: OnStoppedArgs) => void)

Supprimer le gestionnaire pour l’événement arrêté

function off(event: "stopped", listener: (e: OnStoppedArgs) => void)

Paramètres

event

"stopped"

Nom de l’événement

listener

(e: OnStoppedArgs) => void

Gestionnaire

on("connected", (e: OnConnectedArgs) => void)

Ajouter un gestionnaire pour un événement connecté

function on(event: "connected", listener: (e: OnConnectedArgs) => void)

Paramètres

event

"connected"

Nom de l’événement

listener

(e: OnConnectedArgs) => void

Gestionnaire

on("disconnected", (e: OnDisconnectedArgs) => void)

Ajouter un gestionnaire pour un événement déconnecté

function on(event: "disconnected", listener: (e: OnDisconnectedArgs) => void)

Paramètres

event

"disconnected"

Nom de l’événement

listener

(e: OnDisconnectedArgs) => void

Gestionnaire

on("group-message", (e: OnGroupDataMessageArgs) => void)

Ajouter un gestionnaire pour les messags de groupe

function on(event: "group-message", listener: (e: OnGroupDataMessageArgs) => void)

Paramètres

event

"group-message"

Nom de l’événement

listener

(e: OnGroupDataMessageArgs) => void

Gestionnaire

on("rejoin-group-failed", (e: OnRejoinGroupFailedArgs) => void)

Échec de l’ajout d’un gestionnaire pour rejoindre le groupe

function on(event: "rejoin-group-failed", listener: (e: OnRejoinGroupFailedArgs) => void)

Paramètres

event

"rejoin-group-failed"

Nom de l’événement

listener

(e: OnRejoinGroupFailedArgs) => void

Gestionnaire

on("server-message", (e: OnServerDataMessageArgs) => void)

Ajouter un gestionnaire pour les messages serveur

function on(event: "server-message", listener: (e: OnServerDataMessageArgs) => void)

Paramètres

event

"server-message"

Nom de l’événement

listener

(e: OnServerDataMessageArgs) => void

Gestionnaire

on("stopped", (e: OnStoppedArgs) => void)

Ajouter un gestionnaire pour l’événement arrêté

function on(event: "stopped", listener: (e: OnStoppedArgs) => void)

Paramètres

event

"stopped"

Nom de l’événement

listener

(e: OnStoppedArgs) => void

Gestionnaire

sendEvent(string, JSONTypes | ArrayBuffer, WebPubSubDataType, SendEventOptions)

Envoyer un événement personnalisé au serveur.

function sendEvent(eventName: string, content: JSONTypes | ArrayBuffer, dataType: WebPubSubDataType, options?: SendEventOptions): Promise<WebPubSubResult>

Paramètres

eventName

string

Nom de l’événement

content

JSONTypes | ArrayBuffer

Contenu des données

dataType

WebPubSubDataType

Type de données

options

SendEventOptions

Options

Retours

Promise<WebPubSubResult>

sendToGroup(string, JSONTypes | ArrayBuffer, WebPubSubDataType, SendToGroupOptions)

Envoyer un message au groupe.

function sendToGroup(groupName: string, content: JSONTypes | ArrayBuffer, dataType: WebPubSubDataType, options?: SendToGroupOptions): Promise<WebPubSubResult>

Paramètres

groupName

string

Nom du groupe

content

JSONTypes | ArrayBuffer

Contenu des données

dataType

WebPubSubDataType

Type de données

options

SendToGroupOptions

Options

Retours

Promise<WebPubSubResult>

start(StartOptions)

Commencez à commencer au service.

function start(options?: StartOptions): Promise<void>

Paramètres

options

StartOptions

Retours

Promise<void>

stop()

Arrêtez le client.

function stop()