@azure/web-pubsub-client package

Třídy

InvocationError

Chyba vyhozená, když volání selže nebo je zrušeno.

SendMessageError

Chyba při neúspěšném odesílání zprávy

WebPubSubClient

Klient WebPubSub

Rozhraní

AbortGroupStreamOptions

Možnosti přerušit skupinové streamování.

AckMessage

Zpráva ack

AckMessageError

Podrobnosti o chybě v AckMessage

CancelInvocationMessage

Zrušit zprávu o vyvolání

ConnectedMessage

Připojená zpráva

DisconnectedMessage

Odpojená zpráva

EndGroupStreamOptions

Možnosti streamování na konci skupiny.

GetClientAccessUrlOptions

Možnosti spuštění

GroupDataMessage

Zpráva seskupování dat

GroupStateItem

Stavový záznam jednoho spojení ve skupině

GroupStateSnapshotMessage

Snapshot Group State, odesláný po úspěšném odběru GroupState

GroupStateUpdateMessage

Zpráva o aktualizaci stavu skupiny, která se vtiskne, když se změní stav spojení

GroupStream

Jeden příchozí skupinový stream.

GroupStreamMessage

Jeden příchozí fragment skupinového streamu.

GroupStreamSubscription

Předplatné vráceno .client.onGroupStream(...)

GroupStreamWriteOptions

Možnosti zápisu do skupinového proudu.

GroupStreamWriter

Abstrakce skupinového zapisovače proudu pro odeslání jednoho logického proudu do skupiny.

InvocationErrorOptions
InvokeEventOptions

Volání možností operace události

InvokeEventResult

Výsledek callEvent

InvokeMessage

Vyvolání zprávy

InvokeResponseError

Podrobnosti chyby v odpovědi vyvolání

InvokeResponseMessage

Vyvolání odpovědi

JoinGroupMessage

Zpráva o připojení ke skupině

JoinGroupOptions

Možnosti operace připojení ke skupině

LeaveGroupMessage

Opustit zprávu skupiny

LeaveGroupOptions

Ponechte možnosti operace skupiny.

OnConnectedArgs

Parametr zpětného volání OnConnected

OnDisconnectedArgs

Parametr zpětného volání OnDisconnected

OnGroupDataMessageArgs

Parametr zpětného volání OnGroupDataMessage

OnGroupStreamOptions

Možnosti ovládající způsob, jakým jsou příchozí skupinové streamy sledovány a odesílány pro jeden callback registrovaný přes client.onGroupStream(callback, options).

Granularita je dvouúrovňová:

  • Hodnoty opcí jsou omezeny na registraci (tj. na každého handlera): každé onGroupStream volání nese své vlastní hodnoty a různí handleři mohou používat různé hodnoty.
  • Opční efekty se aplikují nezávisle na každý proud, identifikovaný jeho (group, streamId) párem. Současné toky — dokonce i dva proudy ve stejné skupině pozorované stejným handlerem — mají každý svůj vlastní nečinný časovač a handleFromStart vlastní bránu. Nic se nesdílí ani agreguje napříč streamy nebo skupinami.
OnRejoinGroupFailedArgs

Parametr zpětného volání RejoinGroupFailed

OnServerDataMessageArgs

Parametr zpětného volání OnDataMessage

OnStoppedArgs

Parametr zpětného volání OnStopped

OpenGroupStreamOptions

otevřít možnosti provozu GroupStream.

PingMessage

Ping zpráva

PongMessage

Poselství pong

SendEventMessage

Odeslání vlastní zprávy události

SendEventOptions

Možnosti operace odesílání událostí

SendMessageErrorOptions
SendToGroupMessage

Zpráva Odeslat do skupiny

SendToGroupOptions

Možnosti operace Odeslání do skupiny

SequenceAckMessage

Sekvenční zpráva ack

ServerDataMessage

Serverová datová zpráva

SetGroupStateMessage

Nastavte skupinovou zprávu o stavu

StartOptions

Možnosti spuštění

StartStreamOptions

Stream descriptor připojený k řídicímu rámci sendToGroup, který otevírá stream.

StreamAckMessage

Stream ack zpráva.

StreamClosedMessage

Stream uzavřená zpráva.

StreamDataError

Detail chyby streamu.

StreamDataMessage

Zpráva o streamování dat. Užitečné zatížení s představuje pouze streamId keepalive.

StreamEndError

Chyba na konci proudu, kterou může odchozí proud poslat do služby. Služba rozhoduje o klasifikaci názvů chyb na vysoké úrovni.

StreamEndMessage

Stream ukončit zprávu.

StreamInfo

Metadata streamu připojená ke zprávě o datech v nižším proudu.

StreamNackMessage

Streamujte zprávu o nacku.

SubscribeGroupStateMessage

Přihlásit se ke skupinové zprávě o stavu

UnsubscribeGroupStateMessage

Zpráva o stavu skupiny odhlásit

WebPubSubClientCredential

Přihlašovací údaje WebPubSubClient

WebPubSubClientOptions

Možnosti klienta

WebPubSubClientProtocol

Rozhraní, které se má implementovat pro subprotocol podsítě webové pubsub

WebPubSubMessageBase

Běžná zpráva pubsub webového pubsub

WebPubSubResult

Výsledek acku

WebPubSubRetryOptions

Možnosti opakování

Aliasy typu

DownstreamMessageType

Typy podřízených zpráv

JSONTypes

Typy, které lze serializovat a posílat jako JSON.

RetryMode

Popisuje typ režimu opakování.

UpstreamMessageType

Typy pro upstreamové zprávy

WebPubSubDataType

Datový typ

WebPubSubMessage

Zpráva webové pubsub

Funkce

WebPubSubJsonProtocol()

Vrácení protokolu json.webpubsub.azure.v1

WebPubSubJsonReliableProtocol()

Vrátí protokol json.reliable.webpubsub.azure.v1.

Podrobnosti funkce

WebPubSubJsonProtocol()

Vrácení protokolu json.webpubsub.azure.v1

function WebPubSubJsonProtocol(): WebPubSubClientProtocol

Návraty

WebPubSubJsonReliableProtocol()

Vrátí protokol json.reliable.webpubsub.azure.v1.

function WebPubSubJsonReliableProtocol(): WebPubSubClientProtocol

Návraty