@azure/web-pubsub-client package

Klasser

InvocationError

Fel kastas när en anropning misslyckas eller avbryts.

SendMessageError

Fel när meddelandet skickades misslyckades

WebPubSubClient

WebPubSub-klienten

Gränssnitt

AbortGroupStreamOptions

Avbryt gruppströmningsalternativ.

AckMessage

Ack-meddelandet

AckMessageError

Felinformation i AckMessage

CancelInvocationMessage

Avbryt anropsmeddelandet

ConnectedMessage

Anslutet meddelande

DisconnectedMessage

Frånkopplat meddelande

EndGroupStreamOptions

Avsluta gruppströmningsalternativen.

GetClientAccessUrlOptions

Startalternativen

GroupDataMessage

Gruppdatameddelande

GroupStateItem

En enskild anslutnings tillståndspost inom en grupp

GroupStateSnapshotMessage

Meddelande om gruppstatussnapshot, skickat efter en lyckad subscribeGroupState

GroupStateUpdateMessage

Meddelandet om uppdatering av gruppstatus, skickas när en anslutnings tillstånd ändras

GroupStream

En enda inkommande gruppström.

GroupStreamMessage

Ett inkommande fragment av en gruppström.

GroupStreamSubscription

Prenumeration returnerad av client.onGroupStream(...).

GroupStreamWriteOptions

Alternativ för gruppskrivning i strömmen.

GroupStreamWriter

Gruppströmsskrivarabstraktion för att skicka en logisk ström till en grupp.

InvocationErrorOptions
InvokeEventOptions

Anropa eventoperationsalternativ

InvokeEventResult

Resultat av invokeEvent

InvokeMessage

Anropa meddelandet

InvokeResponseError

Anropa svarsfeldetaljer

InvokeResponseMessage

Anropa svarsmeddelandet

JoinGroupMessage

Meddelande om att ansluta till grupp

JoinGroupOptions

Alternativ för att koppla gruppåtgärder

LeaveGroupMessage

Lämna gruppmeddelande

LeaveGroupOptions

Lämna alternativ för gruppåtgärder

OnConnectedArgs

Parameter för OnConnected-återanrop

OnDisconnectedArgs

Parametern onDisconnected callback

OnGroupDataMessageArgs

Parameter för Återanrop till OnGroupDataMessage

OnGroupStreamOptions

Alternativ som styr hur inkommande gruppströmmar spåras och skickas ut för en enda återuppringning registrerad via client.onGroupStream(callback, options).

Granulariteten är tvånivå:

  • Optionsvärdena är begränsade till registreringen (dvs. per handler): varje onGroupStream anrop bär sina egna värden, och olika hanterare kan använda olika värden.
  • Optionseffekterna tillämpas oberoende på varje ström, identifierade av dess (group, streamId) par. Samtidiga strömmar – även två strömmar i samma grupp som observeras av samma hanterare – får var och en sin egen vilotimer och egen handleFromStart grind. Inget delas eller aggregeras mellan strömmar eller grupper.
OnRejoinGroupFailedArgs

Parameter för Återanrop till RejoinGroupFailed

OnServerDataMessageArgs

Parameter för återanrop till OnDataMessage

OnStoppedArgs

Parameter för onStopad motringning

OpenGroupStreamOptions

openGroupStream-operationsalternativ.

PingMessage

Pingmeddelande

PongMessage

Pong-meddelandet

SendEventMessage

Skicka anpassat händelsemeddelande

SendEventOptions

Alternativ för att skicka händelseåtgärder

SendMessageErrorOptions
SendToGroupMessage

Skicka till gruppmeddelande

SendToGroupOptions

Alternativ för att skicka till gruppåtgärd

SequenceAckMessage

Sekvens-ack-meddelande

ServerDataMessage

Serverdatameddelande

SetGroupStateMessage

Sätt grupptillståndsmeddelande

StartOptions

Startalternativen

StartStreamOptions

Strömbeskrivare kopplad till en sendToGroup-kontrollram som öppnar en ström.

StreamAckMessage

Strömma ack-meddelande.

StreamClosedMessage

Strömma meddelandet stängt.

StreamDataError

Detaljer om strömfel.

StreamDataMessage

Strömdatameddelande. En nyttolast med representerar endast streamId en keepalive.

StreamEndError

Strömslutsfel som en utgående ström kan skicka till tjänsten. Tjänsten avgör klassificeringen av felnamn på hög nivå.

StreamEndMessage

Stream avsluta meddelandet.

StreamInfo

Strömmetadata bifogad till ett nedströms datameddelande.

StreamNackMessage

Streama nack-meddelandet.

SubscribeGroupStateMessage

Prenumerera grupp-tillståndsmeddelande

UnsubscribeGroupStateMessage

Avprenumerera grupptillståndsmeddelande

WebPubSubClientCredential

WebPubSubClient-autentiseringsuppgifterna

WebPubSubClientOptions

Klientalternativen

WebPubSubClientProtocol

Gränssnittet som ska implementeras för en underprotokol för webbpub

WebPubSubMessageBase

Det vanliga med webbpubliceringsmeddelande

WebPubSubResult

Ack-resultatet

WebPubSubRetryOptions

Alternativen för återförsök

Typalias

DownstreamMessageType

Typer för underordnade meddelanden

JSONTypes

Typer som kan serialiseras och skickas som JSON.

RetryMode

Beskriver typ av återförsöksläge

UpstreamMessageType

Typer för överordnade meddelanden

WebPubSubDataType

Datatypen

WebPubSubMessage

Webbpublicsubmeddelandet

Funktioner

WebPubSubJsonProtocol()

Returnera protokollet "json.webpubsub.azure.v1"

WebPubSubJsonReliableProtocol()

Returnera protokollet "json.reliable.webpubsub.azure.v1"

Funktionsinformation

WebPubSubJsonProtocol()

Returnera protokollet "json.webpubsub.azure.v1"

function WebPubSubJsonProtocol(): WebPubSubClientProtocol

Returer

WebPubSubJsonReliableProtocol()

Returnera protokollet "json.reliable.webpubsub.azure.v1"

function WebPubSubJsonReliableProtocol(): WebPubSubClientProtocol

Returer