@azure/web-pubsub-client package

Klasy

InvocationError

Błąd wyrzucany, gdy wywołanie się nie powiedzie lub zostanie anulowane.

SendMessageError

Błąd podczas wysyłania komunikatu nie powiodło się

WebPubSubClient

Klient WebPubSub

Interfejsy

AbortGroupStreamOptions

Opcje przerwania grupowego streamu.

AckMessage

Komunikat ack

AckMessageError

Szczegóły błędu w usłudze AckMessage

CancelInvocationMessage

Anuluj wiadomość wywołania

ConnectedMessage

Połączona wiadomość

DisconnectedMessage

Komunikat rozłączony

EndGroupStreamOptions

Opcje streamów końcowych grup.

GetClientAccessUrlOptions

Opcje uruchamiania

GroupDataMessage

Komunikat grupowania danych

GroupStateItem

Wpis stanu pojedynczego połączenia w grupie

GroupStateSnapshotMessage

Wiadomość snapshot Group State, wysłana po pomyślnym subskrypcji GroupState

GroupStateUpdateMessage

Wiadomość aktualizacji stanu grupy, wysyłana po zmianie stanu połączenia

GroupStream

Pojedynczy grupowy strumień przychodzący.

GroupStreamMessage

Jeden fragment strumienia grupowego.

GroupStreamSubscription

Subskrypcja zwrócona przez client.onGroupStream(...).

GroupStreamWriteOptions

Opcje zapisu strumienia grupowego.

GroupStreamWriter

Abstrakcja pisarza strumienia grupowego do wysyłania jednego strumienia logicznego do grupy.

InvocationErrorOptions
InvokeEventOptions

Opcje operacji wywołania zdarzeń

InvokeEventResult

Wynik wywołania zdarzenia

InvokeMessage

Wezwanie wiadomości

InvokeResponseError

Szczegóły błędu odpowiedzi wywołania

InvokeResponseMessage

Wywołaj komunikat odpowiedzi

JoinGroupMessage

Dołącz do wiadomości grupy

JoinGroupOptions

Opcje operacji dołączania do grupy

LeaveGroupMessage

Pozostaw wiadomość grupy

LeaveGroupOptions

Pozostaw opcje operacji grupy

OnConnectedArgs

Parametr wywołania zwrotnego onConnected

OnDisconnectedArgs

Parametr wywołania zwrotnego onDisconnected

OnGroupDataMessageArgs

Parametr wywołania zwrotnego onGroupDataMessage

OnGroupStreamOptions

Opcje kontrolujące sposób śledzenia i wysyłania strumieni grupowych przychodzących dla pojedynczego callback zarejestrowanego przez .client.onGroupStream(callback, options)

Granularność jest dwupoziomowa:

  • Wartości opcji są przypisane do rejestracji (czyli dla każdego handlera): każde onGroupStream wywołanie ma swoje wartości, a różne handlery mogą używać różnych wartości.
  • Efekty opcji są stosowane niezależnie do każdego strumienia, rozpoznanego przez (group, streamId) jego parę. Strumienie współczesne — nawet dwa strumienie w tej samej grupie obserwowane przez tego samego handlera — każdy mają własny timer bezczynności i handleFromStart własną bramę. Nic nie jest udostępniane ani agregowane między strumieniami czy grupami.
OnRejoinGroupFailedArgs

Parametr wywołania zwrotnego RejoinGroupFailed

OnServerDataMessageArgs

Parametr wywołania zwrotnego onDataMessage

OnStoppedArgs

Parametr wywołania zwrotnego OnStopped

OpenGroupStreamOptions

otwórz opcje operacyjne w GroupStream.

PingMessage

Komunikat ping

PongMessage

Wiadomość z ponga

SendEventMessage

Wysyłanie niestandardowego komunikatu o zdarzeniu

SendEventOptions

Opcje operacji wysyłania zdarzeń

SendMessageErrorOptions
SendToGroupMessage

Wyślij do wiadomości grupy

SendToGroupOptions

Opcje operacji wysyłania do grupy

SequenceAckMessage

Sekwencja komunikatu ack

ServerDataMessage

Komunikat o danych serwera

SetGroupStateMessage

Ustaw komunikat stanu grupy

StartOptions

Opcje uruchamiania

StartStreamOptions

Deskryptor strumienia dołączony do ramki sterującej sendToGroup, która otwiera strumień.

StreamAckMessage

Stream ack message.

StreamClosedMessage

Transmisja zamknięta.

StreamDataError

Szczegóły błędu strumienia.

StreamDataMessage

Wiadomość o przesyłaniu danych strumieniowych. Ładunek z reprezentuje jedynie streamId keepalive.

StreamEndError

Błąd na końcu strumienia, który strumień wychodzący może wysłać do usługi. To usługa decyduje o wysokiej klasyfikacji nazw błędu.

StreamEndMessage

Wiadomość zakończona przez stream.

StreamInfo

Metadane strumienia dołączone do wiadomości danych w ciągu strumienia.

StreamNackMessage

Streamuj wiadomość nack.

SubscribeGroupStateMessage

Subskrybuj grupę o stanie

UnsubscribeGroupStateMessage

Komunikat o stanie wypisu grupy

WebPubSubClientCredential

Poświadczenie WebPubSubClient

WebPubSubClientOptions

Opcje klienta

WebPubSubClientProtocol

Interfejs, który ma zostać zaimplementowany dla podprotokolu pubsub sieci Web

WebPubSubMessageBase

Typowe wiadomości pubsub sieci Web

WebPubSubResult

Wynik ack

WebPubSubRetryOptions

Opcje ponawiania prób

Aliasy typu

DownstreamMessageType

Typy komunikatów podrzędnych

JSONTypes

Typy, które można serializować i wysyłać jako dane JSON.

RetryMode

Opisuje typ trybu ponawiania prób

UpstreamMessageType

Typy komunikatów nadrzędnych

WebPubSubDataType

Typ danych

WebPubSubMessage

Komunikat pubsub sieci Web

Funkcje

WebPubSubJsonProtocol()

Zwraca protokół "json.webpubsub.azure.v1"

WebPubSubJsonReliableProtocol()

Zwraca protokół "json.reliable.webpubsub.azure.v1"

Szczegóły funkcji

WebPubSubJsonProtocol()

Zwraca protokół "json.webpubsub.azure.v1"

function WebPubSubJsonProtocol(): WebPubSubClientProtocol

Zwraca

WebPubSubJsonReliableProtocol()

Zwraca protokół "json.reliable.webpubsub.azure.v1"

function WebPubSubJsonReliableProtocol(): WebPubSubClientProtocol

Zwraca