@azure/web-pubsub-client package

Klassen

InvocationError

Fout gegooid wanneer een aanroep mislukt of wordt geannuleerd.

SendMessageError

Fout bij verzenden van bericht is mislukt

WebPubSubClient

De WebPubSub-client

Interfaces

AbortGroupStreamOptions

Stop-groep streamopties.

AckMessage

Het ack-bericht

AckMessageError

Foutdetails in AckMessage

CancelInvocationMessage

Aanroepbericht annuleren

ConnectedMessage

Verbonden bericht

DisconnectedMessage

Niet-verbonden bericht

EndGroupStreamOptions

Einde groepsstreamopties.

GetClientAccessUrlOptions

De startopties

GroupDataMessage

Bericht over groepsgegevens

GroupStateItem

De statusvermelding van een enkele verbinding binnen een groep

GroupStateSnapshotMessage

Groepsstatussnapshotbericht, verzonden na een succesvolle subscribeGroupState

GroupStateUpdateMessage

Groepsstatusupdatebericht, verzonden wanneer de status van een verbinding verandert

GroupStream

Een enkele inkomende groepsstroom.

GroupStreamMessage

Eén inkomend fragment van een groepsstroom.

GroupStreamSubscription

Abonnement teruggegeven door client.onGroupStream(...).

GroupStreamWriteOptions

Opties voor het schrijven van groepsstreams.

GroupStreamWriter

Abstractie van groepsstroomschrijver voor het sturen van één logische stroom naar een groep.

InvocationErrorOptions
InvokeEventOptions

Opties voor eventoperaties aanroepen

InvokeEventResult

Resultaat van invokeEvent

InvokeMessage

Aanroep bericht

InvokeResponseError

Oproep foutdetails voor de respons

InvokeResponseMessage

Oproep responsbericht

JoinGroupMessage

Bericht deelnemen aan groep

JoinGroupOptions

Bewerkingsopties voor joingroepen

LeaveGroupMessage

Groepsbericht verlaten

LeaveGroupOptions

Groepsbewerkingsopties verlaten

OnConnectedArgs

Parameter van OnConnected callback

OnDisconnectedArgs

Parameter van OnDisconnected callback

OnGroupDataMessageArgs

Parameter van callback van OnGroupDataMessage

OnGroupStreamOptions

Opties die bepalen hoe inkomende groepsstromen worden gevolgd en verzonden voor een enkele terugbel, geregistreerd via client.onGroupStream(callback, options).

Granulariteit is tweelaag:

  • De optiewaarden zijn beperkt tot de registratie (dus per handler): elke onGroupStream call draagt zijn eigen waarden, en verschillende handlers kunnen verschillende waarden gebruiken.
  • De optie-effecten worden onafhankelijk toegepast op elke stroom, geïdentificeerd door het (group, streamId) paar. Gelijktijdige streams — zelfs twee streams in dezelfde groep die door dezelfde handler worden geobserveerd — krijgen elk hun eigen idle timer en hun eigen handleFromStart gate. Niets wordt gedeeld of geaggregeerd over stromen of groepen heen.
OnRejoinGroupFailedArgs

Parameter van RejoinGroupFailed callback

OnServerDataMessageArgs

Parameter van callback van OnDataMessage

OnStoppedArgs

Parameter van OnStopped callback

OpenGroupStreamOptions

openGroupStream operatieopties.

PingMessage

Pingbericht

PongMessage

Het pong-bericht

SendEventMessage

Aangepast gebeurtenisbericht verzenden

SendEventOptions

Opties voor het verzenden van gebeurtenisbewerkingen

SendMessageErrorOptions
SendToGroupMessage

Bericht verzenden naar groep

SendToGroupOptions

Opties voor verzenden naar groepsbewerking

SequenceAckMessage

ACK-bericht sequentieer

ServerDataMessage

Servergegevensbericht

SetGroupStateMessage

Set groepstoestandbericht

StartOptions

De startopties

StartStreamOptions

Streamdescriptor gekoppeld aan een sendToGroup-controleframe dat een stream opent.

StreamAckMessage

Stream ack-bericht.

StreamClosedMessage

Bericht van stream gesloten.

StreamDataError

Foutinformatie in de stream.

StreamDataMessage

Stream data bericht. Een payload met vertegenwoordigt alleen streamId een keepalive.

StreamEndError

Stream-eindfout die een uitgaande stream naar de service kan sturen. De dienst bepaalt de classificatie van de foutnaam op hoog niveau.

StreamEndMessage

Bericht einde stream.

StreamInfo

Streammetadata gekoppeld aan een downstream databericht.

StreamNackMessage

Stream het bericht van Nack.

SubscribeGroupStateMessage

Bericht over de status van de groep abonneren

UnsubscribeGroupStateMessage

Groepsstatusbericht ontmelden

WebPubSubClientCredential

De referenties van WebPubSubClient

WebPubSubClientOptions

De clientopties

WebPubSubClientProtocol

De interface die moet worden geïmplementeerd voor een web-pubsubsubprotocol

WebPubSubMessageBase

Het algemene bericht van een web-pubsub

WebPubSubResult

Het resultaat van ack

WebPubSubRetryOptions

De opties voor opnieuw proberen

Type-aliassen

DownstreamMessageType

Typen voor downstreamberichten

JSONTypes

Typen die kunnen worden geserialiseerd en verzonden als JSON.

RetryMode

Beschrijft het type Modus voor opnieuw proberen

UpstreamMessageType

Typen voor upstream-berichten

WebPubSubDataType

Het gegevenstype

WebPubSubMessage

Het web-pubsubbericht

Functies

WebPubSubJsonProtocol()

Het protocol json.webpubsub.azure.v1 retourneren

WebPubSubJsonReliableProtocol()

Het protocol 'json.reliable.webpubsub.azure.v1' retourneren

Functiedetails

WebPubSubJsonProtocol()

Het protocol json.webpubsub.azure.v1 retourneren

function WebPubSubJsonProtocol(): WebPubSubClientProtocol

Retouren

WebPubSubJsonReliableProtocol()

Het protocol 'json.reliable.webpubsub.azure.v1' retourneren

function WebPubSubJsonReliableProtocol(): WebPubSubClientProtocol

Retouren