@azure/web-pubsub-client package

Classes

InvocationError

Erreur lancée lorsqu’une invocation échoue ou est annulée.

SendMessageError

Erreur lors de l’envoi d’un message ayant échoué

WebPubSubClient

Client WebPubSub

Interfaces

AbortGroupStreamOptions

Annulez les options de flux de groupe.

AckMessage

Message d’ack

AckMessageError

Détails de l’erreur dans AckMessage

CancelInvocationMessage

Annuler le message d’invocation

ConnectedMessage

Message connecté

DisconnectedMessage

Message déconnecté

EndGroupStreamOptions

Options de fin de groupe pour stream.

GetClientAccessUrlOptions

Options de démarrage

GroupDataMessage

Message de données de groupe

GroupStateItem

L’entrée d’état d’une seule connexion au sein d’un groupe

GroupStateSnapshotMessage

Message d’instantané d’état du groupe, envoyé après un subscribeGroupState réussi

GroupStateUpdateMessage

Message de mise à jour de l’état du groupe, envoyé lorsque l’état d’une connexion change

GroupStream

Un seul flux de groupe entrant.

GroupStreamMessage

Un fragment entrant d’un flux groupé.

GroupStreamSubscription

Abonnement retourné par client.onGroupStream(...).

GroupStreamWriteOptions

Options d’écriture de flux de groupe.

GroupStreamWriter

Abstraction du groupe de streams writer pour envoyer un flux logique à un groupe.

InvocationErrorOptions
InvokeEventOptions

Options d’opération d’invocation d’événement

InvokeEventResult

Résultat d’invokeEvent

InvokeMessage

Invoke message

InvokeResponseError

Détails de l’erreur d’invocation de réponse

InvokeResponseMessage

Message d’invocation de réponse

JoinGroupMessage

Joindre un message de groupe

JoinGroupOptions

Options d’opération de groupe de jointure

LeaveGroupMessage

Quitter le message de groupe

LeaveGroupOptions

Quitter les options d’opération de groupe

OnConnectedArgs

Paramètre du rappel OnConnected

OnDisconnectedArgs

Paramètre du rappel OnDisconnected

OnGroupDataMessageArgs

Paramètre du rappel OnGroupDataMessage

OnGroupStreamOptions

Options contrôlant comment les flux de groupes entrants sont suivis et envoyés pour un seul rappel enregistré via client.onGroupStream(callback, options).

La granularité est à deux niveaux :

  • Les valeurs des options sont rattachées à l’enregistrement (c’est-à-dire par handler) : chaque onGroupStream appel porte ses propres valeurs, et différents gestionnaires peuvent utiliser des valeurs différentes.
  • Les effets d’option sont appliqués indépendamment à chaque flux, identifié par sa (group, streamId) paire. Les flux simultanés — même deux flux dans le même groupe observés par le même gestionnaire — ont chacun leur propre minuteur d’inactivité et leur propre handleFromStart porte. Rien n’est partagé ou agrégé entre flux ou groupes.
OnRejoinGroupFailedArgs

Paramètre du rappel RejoinGroupFailed

OnServerDataMessageArgs

Paramètre du rappel OnDataMessage

OnStoppedArgs

Paramètre du rappel OnStopped

OpenGroupStreamOptions

Options d’opération openGroupStream.

PingMessage

Message de ping

PongMessage

Le message du pong

SendEventMessage

Envoyer un message d’événement personnalisé

SendEventOptions

Options d’opération d’envoi d’événements

SendMessageErrorOptions
SendToGroupMessage

Envoyer au message de groupe

SendToGroupOptions

Options d’envoi à l’opération de groupe

SequenceAckMessage

Message d’ack de séquence

ServerDataMessage

Message de données du serveur

SetGroupStateMessage

Message d’état de groupe de définissage

StartOptions

Options de démarrage

StartStreamOptions

Descripteur de flux attaché à une trame de contrôle sendToGroup qui ouvre un flux.

StreamAckMessage

Message de streaming.

StreamClosedMessage

Message fermé du flux.

StreamDataError

Détails d’erreur de flux.

StreamDataMessage

Message de données en stream. Une charge utile ne représente qu’un streamId keepalive.

StreamEndError

Erreur de fin de flux qu’un flux sortant peut envoyer au service. Le service décide de la classification des noms d’erreur de haut niveau.

StreamEndMessage

Fin du message du stream.

StreamInfo

Métadonnées de flux attachées à un message de données en aval.

StreamNackMessage

Message de flux de navigation.

SubscribeGroupStateMessage

Message d’état du groupe Subscribe

UnsubscribeGroupStateMessage

Message d’état de désabonnement du groupe

WebPubSubClientCredential

Informations d’identification WebPubSubClient

WebPubSubClientOptions

Options du client

WebPubSubClientProtocol

Interface à implémenter pour un sous-protocole pubsub web

WebPubSubMessageBase

La commune du message pubsub web

WebPubSubResult

Résultat d’ack

WebPubSubRetryOptions

Options de nouvelle tentative

Alias de type

DownstreamMessageType

Types pour les messages en aval

JSONTypes

Types qui peuvent être sérialisés et envoyés en tant que JSON.

RetryMode

Décrit le type de mode nouvelle tentative

UpstreamMessageType

Types pour les messages en amont

WebPubSubDataType

Type de données

WebPubSubMessage

Le message web pubsub

Functions

WebPubSubJsonProtocol()

Renvoyer le protocole « json.webpubsub.azure.v1 »

WebPubSubJsonReliableProtocol()

Renvoyer le protocole « json.reliable.webpubsub.azure.v1 »

Informations relatives à la fonction

WebPubSubJsonProtocol()

Renvoyer le protocole « json.webpubsub.azure.v1 »

function WebPubSubJsonProtocol(): WebPubSubClientProtocol

Retours

WebPubSubJsonReliableProtocol()

Renvoyer le protocole « json.reliable.webpubsub.azure.v1 »

function WebPubSubJsonReliableProtocol(): WebPubSubClientProtocol

Retours