@azure/web-pubsub-client package

Kelas

InvocationError

Kesalahan muncul saat pemanggilan gagal atau dibatalkan.

SendMessageError

Kesalahan saat mengirim pesan gagal

WebPubSubClient

Klien WebPubSub

Antarmuka

AbortGroupStreamOptions

Membatalkan opsi streaming grup.

AckMessage

Pesan ack

AckMessageError

Detail kesalahan dalam AckMessage

CancelInvocationMessage

Batalkan pesan pemanggilan

ConnectedMessage

Pesan tersambung

DisconnectedMessage

Pesan terputus

EndGroupStreamOptions

Akhiri opsi streaming grup.

GetClientAccessUrlOptions

Opsi mulai

GroupDataMessage

Pesan data grup

GroupStateItem

Entri status koneksi tunggal dalam grup

GroupStateSnapshotMessage

Pesan rekam jepret status grup, dikirim setelah subscribeGroupState berhasil

GroupStateUpdateMessage

Pesan pembaruan status grup, didorong saat status koneksi berubah

GroupStream

Satu aliran grup masuk.

GroupStreamMessage

Satu fragmen masuk dari aliran grup.

GroupStreamSubscription

Langganan dikembalikan oleh client.onGroupStream(...).

GroupStreamWriteOptions

Opsi penulisan aliran grup.

GroupStreamWriter

Abstraksi penulis aliran grup untuk mengirim satu aliran logis ke grup.

InvocationErrorOptions
InvokeEventOptions

Memanggil opsi operasi peristiwa

InvokeEventResult

Hasil invokeEvent

InvokeMessage

Memanggil pesan

InvokeResponseError

Memanggil detail kesalahan respons

InvokeResponseMessage

Memanggil pesan respons

JoinGroupMessage

Bergabung dengan pesan grup

JoinGroupOptions

Opsi operasi grup gabungan

LeaveGroupMessage

Tinggalkan pesan grup

LeaveGroupOptions

Biarkan opsi operasi grup

OnConnectedArgs

Parameter panggilan balik OnConnected

OnDisconnectedArgs

Parameter panggilan balik OnDisconnected

OnGroupDataMessageArgs

Parameter panggilan balik OnGroupDataMessage

OnGroupStreamOptions

Opsi yang mengontrol bagaimana aliran grup masuk dilacak dan dikirim untuk satu panggilan balik yang didaftarkan melalui client.onGroupStream(callback, options).

Granularitas adalah dua tingkat:

  • Nilai opsi dicakup ke pendaftaran (yaitu per handler): setiap onGroupStream panggilan membawa nilainya sendiri, dan penangan yang berbeda mungkin menggunakan nilai yang berbeda.
  • Efek opsi diterapkan secara independen ke setiap aliran, diidentifikasi oleh pasangannya(group, streamId). Aliran bersamaan — bahkan dua aliran dalam grup yang sama yang diamati oleh penangan yang sama — masing-masing mendapatkan pengatur waktu menganggur dan gerbangnya sendiri handleFromStart . Tidak ada yang dibagikan atau digabungkan di seluruh aliran atau di seluruh grup.
OnRejoinGroupFailedArgs

Parameter panggilan balik RejoinGroupFailed

OnServerDataMessageArgs

Parameter panggilan balik OnDataMessage

OnStoppedArgs

Parameter panggilan balik OnStopped

OpenGroupStreamOptions

opsi operasi openGroupStream.

PingMessage

Pesan ping

PongMessage

Pesan pong

SendEventMessage

Mengirim pesan peristiwa kustom

SendEventOptions

Mengirim opsi operasi peristiwa

SendMessageErrorOptions
SendToGroupMessage

Kirim ke pesan grup

SendToGroupOptions

Opsi operasi Kirim ke grup

SequenceAckMessage

Pesan ack urutan

ServerDataMessage

Pesan data server

SetGroupStateMessage

Atur pesan status grup

StartOptions

Opsi mulai

StartStreamOptions

Deskriptor aliran yang dilampirkan ke bingkai kontrol sendToGroup yang membuka aliran.

StreamAckMessage

Pesan ack streaming.

StreamClosedMessage

Streaming pesan tertutup.

StreamDataError

Detail kesalahan streaming.

StreamDataMessage

Pesan data streaming. Muatan dengan hanya streamId mewakili keepalive.

StreamEndError

Kesalahan akhir aliran yang dapat dikirim oleh aliran keluar ke layanan. Layanan menentukan klasifikasi nama kesalahan tingkat tinggi.

StreamEndMessage

Pesan akhir streaming.

StreamInfo

Metadata streaming yang dilampirkan ke pesan data hilir.

StreamNackMessage

Pesan streaming nack.

SubscribeGroupStateMessage

Pesan status grup berlangganan

UnsubscribeGroupStateMessage

Pesan status grup berhenti berlangganan

WebPubSubClientCredential

Kredensial WebPubSubClient

WebPubSubClientOptions

Opsi klien

WebPubSubClientProtocol

Antarmuka yang akan diimplementasikan untuk subprotokola pubsub web

WebPubSubMessageBase

Pesan umum pubsub web

WebPubSubResult

Hasil ack

WebPubSubRetryOptions

Opsi coba lagi

Alias Jenis

DownstreamMessageType

Jenis untuk pesan hilir

JSONTypes

Jenis yang dapat diserialisasikan dan dikirim sebagai JSON.

RetryMode

Menjelaskan jenis Mode Coba Lagi

UpstreamMessageType

Jenis untuk pesan upstram

WebPubSubDataType

Jenis data

WebPubSubMessage

Pesan pubsub web

Fungsi

WebPubSubJsonProtocol()

Mengembalikan protokol "json.webpubsub.azure.v1"

WebPubSubJsonReliableProtocol()

Mengembalikan protokol "json.reliable.webpubsub.azure.v1"

Detail Fungsi

WebPubSubJsonProtocol()

Mengembalikan protokol "json.webpubsub.azure.v1"

function WebPubSubJsonProtocol(): WebPubSubClientProtocol

Mengembalikan

WebPubSubJsonReliableProtocol()

Mengembalikan protokol "json.reliable.webpubsub.azure.v1"

function WebPubSubJsonReliableProtocol(): WebPubSubClientProtocol

Mengembalikan