@azure/web-pubsub-client package
Klassen
| InvocationError |
Fehler wird ausgelöst, wenn ein Aufruf fehlschlägt oder abgebrochen wird. |
| SendMessageError |
Fehler beim Senden einer Nachricht |
| WebPubSubClient |
Der WebPubSub-Client |
Schnittstellen
| AbortGroupStreamOptions |
Gruppen-Stream-Optionen abbrechen. |
| AckMessage |
Die ack-Nachricht |
| AckMessageError |
Fehlerdetails in AckMessage |
| CancelInvocationMessage |
Invocation-Nachricht abbrechen |
| ConnectedMessage |
Verbundene Nachricht |
| DisconnectedMessage |
Nachricht getrennt |
| EndGroupStreamOptions |
Beenden Sie Gruppen-Stream-Optionen. |
| GetClientAccessUrlOptions |
Die Startoptionen |
| GroupDataMessage |
Gruppieren einer Datennachricht |
| GroupStateItem |
Der Zustandseintrag einer einzelnen Verbindung innerhalb einer Gruppe |
| GroupStateSnapshotMessage |
Gruppenstatus-Snapshot-Nachricht, gesendet nach einem erfolgreichen subscribeGroupState |
| GroupStateUpdateMessage |
Gruppenstatus-Update-Nachricht, gesendet, wenn sich der Zustand einer Verbindung ändert |
| GroupStream |
Ein einzelner eingehender Gruppenstrom. |
| GroupStreamMessage |
Ein eingehendes Fragment eines Gruppenstroms. |
| GroupStreamSubscription |
Abonnement zurückgegeben von |
| GroupStreamWriteOptions |
Gruppen-Stream-Schreiboptionen. |
| GroupStreamWriter |
Group Stream Writer Abstraktion zum Senden eines logischen Streams an eine Gruppe. |
| InvocationErrorOptions | |
| InvokeEventOptions |
Aufruf-Event-Operationsoptionen |
| InvokeEventResult |
Ergebnis von invokeEvent |
| InvokeMessage |
Aufruf-Nachricht |
| InvokeResponseError |
Details zum Aufruf von Antwortfehlern |
| InvokeResponseMessage |
Antwort aufrufen |
| JoinGroupMessage |
Gruppennachricht beitreten |
| JoinGroupOptions |
Optionen für den Gruppenbeitritt |
| LeaveGroupMessage |
Gruppennachricht verlassen |
| LeaveGroupOptions |
Verlassen von Gruppenvorgangsoptionen |
| OnConnectedArgs |
Parameter des OnConnected-Rückrufs |
| OnDisconnectedArgs |
Parameter des OnDisconnected-Rückrufs |
| OnGroupDataMessageArgs |
Parameter des OnGroupDataMessage-Rückrufs |
| OnGroupStreamOptions |
Optionen, die steuern, wie eingehende Gruppenströme für einen einzelnen Rückruf verfolgt und versendet werden, der über registriert wird Die Granularität ist zweistufig:
|
| OnRejoinGroupFailedArgs |
Parameter des RejoinGroupFailed-Rückrufs |
| OnServerDataMessageArgs |
Parameter des OnDataMessage-Rückrufs |
| OnStoppedArgs |
Parameter des OnStopped-Rückrufs |
| OpenGroupStreamOptions |
openGroupStream-Operationsoptionen. |
| PingMessage |
Ping-Nachricht |
| PongMessage |
Die Pong-Botschaft |
| SendEventMessage |
Senden einer benutzerdefinierten Ereignisnachricht |
| SendEventOptions |
Optionen zum Senden von Ereignisvorgängen |
| SendMessageErrorOptions | |
| SendToGroupMessage |
An Gruppennachricht senden |
| SendToGroupOptions |
Optionen für "An Gruppenvorgang senden" |
| SequenceAckMessage |
Sequenzieren einer Acknachricht |
| ServerDataMessage |
Serverdatennachricht |
| SetGroupStateMessage |
Gruppenzustandsnachricht setzen |
| StartOptions |
Die Startoptionen |
| StartStreamOptions |
Stream-Deskriptor ist an ein sendToGroup-Kontrollframe angehängt, das einen Stream öffnet. |
| StreamAckMessage |
Ack-Nachricht streamen. |
| StreamClosedMessage |
Stream geschlossene Nachricht. |
| StreamDataError |
Fehlerdetails im Stream. |
| StreamDataMessage |
Stream-Daten-Nachricht. Eine Nutzlast mit repräsentiert nur |
| StreamEndError |
Stream-Endfehler, den ein ausgehender Stream an den Service senden kann. Der Dienst entscheidet die Klassifikation des Fehlernamens auf hoher Ebene. |
| StreamEndMessage |
Stream beendet Nachricht. |
| StreamInfo |
Stream-Metadaten werden einer nachgeschalteten Datennachricht zugeordnet. |
| StreamNackMessage |
Stream Nack-Nachricht. |
| SubscribeGroupStateMessage |
Zustandsnachricht der Gruppe abonnieren |
| UnsubscribeGroupStateMessage |
Gruppen-Statusnachricht entmelden |
| WebPubSubClientCredential |
Die WebPubSubClient-Anmeldeinformationen |
| WebPubSubClientOptions |
Die Clientoptionen |
| WebPubSubClientProtocol |
Die Schnittstelle, die für ein Web pubsub subprotocol implementiert werden soll |
| WebPubSubMessageBase |
Die allgemeine Web pubsub-Nachricht |
| WebPubSubResult |
Das Ergebnis "ack" |
| WebPubSubRetryOptions |
Die Wiederholungsoptionen |
Typaliase
| DownstreamMessageType |
Typen für nachgeschaltete Nachrichten |
| JSONTypes |
Typen, die als JSON serialisiert und gesendet werden können. |
| RetryMode |
Beschreibt den Typ "Wiederholungsmodus" |
| UpstreamMessageType |
Typen für Upstreamnachrichten |
| WebPubSubDataType |
Der Datentyp |
| WebPubSubMessage |
Die Web-Pubsub-Nachricht |
Functions
| Web |
Zurückgeben des Protokolls "json.webpubsub.azure.v1" |
| Web |
Zurückgeben des Protokolls "json.reliable.webpubsub.azure.v1" |
Details zur Funktion
WebPubSubJsonProtocol()
Zurückgeben des Protokolls "json.webpubsub.azure.v1"
function WebPubSubJsonProtocol(): WebPubSubClientProtocol
Gibt zurück
WebPubSubJsonReliableProtocol()
Zurückgeben des Protokolls "json.reliable.webpubsub.azure.v1"
function WebPubSubJsonReliableProtocol(): WebPubSubClientProtocol