@azure/web-pubsub-client package

Sınıflar

InvocationError

Bir çağrı başarısız olduğunda veya iptal edildiğinde yapılan hata.

SendMessageError

İleti gönderilemediğinde hata oluştu

WebPubSubClient

WebPubSub istemcisi

Arabirimler

AbortGroupStreamOptions

Grup yayın seçeneklerini iptal edin.

AckMessage

Ack iletisi

AckMessageError

AckMessage'da hata ayrıntıları

CancelInvocationMessage

İptal Etme Mesajı

ConnectedMessage

Bağlı ileti

DisconnectedMessage

Bağlantısı kesilmiş ileti

EndGroupStreamOptions

Grup akışı seçeneklerini sonlandırın.

GetClientAccessUrlOptions

Başlangıç seçenekleri

GroupDataMessage

Grup verisi iletisi

GroupStateItem

Tek bir bağlantının bir grup içindeki durum girişi

GroupStateSnapshotMessage

Başarılı abone olma sonrası gönderilen grup durumu anlık mesajıGroupState

GroupStateUpdateMessage

Bağlantının durumu değiştiğinde gönderilen grup durumu güncelleme mesajı

GroupStream

Tek bir gelen grup akışı.

GroupStreamMessage

Bir grup akışının bir gelen parçası.

GroupStreamSubscription

Abonelik tarafından geri gönderildi client.onGroupStream(...).

GroupStreamWriteOptions

Grup akışı yazma seçenekleri.

GroupStreamWriter

Bir mantıksal akışı bir gruba göndermek için grup akışı yazarı soyutlaması.

InvocationErrorOptions
InvokeEventOptions

Olay işlem seçeneklerini çağır

InvokeEventResult

invokeEvent'in sonucu

InvokeMessage

Mesajı çağır

InvokeResponseError

Yanıt hata detaylarını çağır

InvokeResponseMessage

Yanıt mesajını çağırma

JoinGroupMessage

Gruba katıl iletisi

JoinGroupOptions

Gruba katılma işlemi seçenekleri

LeaveGroupMessage

Grup iletisi bırakma

LeaveGroupOptions

Grup işlemi seçeneklerini bırakma

OnConnectedArgs

OnConnected geri çağırma parametresi

OnDisconnectedArgs

OnDisconnected geri çağırma parametresi

OnGroupDataMessageArgs

OnGroupDataMessage geri çağırma parametresi

OnGroupStreamOptions

Gelen grup akışlarının nasıl takip edildiğini ve tek bir geri dönüş için client.onGroupStream(callback, options)gönderildiğini kontrol eden seçenekler.

Granülarlık iki seviyelidir:

  • Opsiyon değerleri kayıt kapsamına (yani her bir işleyici başı) bağlıdır: her onGroupStream çağrı kendi değerlerini taşır ve farklı yöneticiler farklı değerler kullanabilir.
  • Seçenek etkileri her akışa bağımsız olarak uygulanır ve çiftiyle (group, streamId) tanımlanır. Eşzamanlı akışlar — aynı grupta aynı yönetici tarafından gözlemlenen iki akış bile — her biri kendi boşta zamanlayıcısına ve kendi handleFromStart kapısına sahip. Hiçbir şey akışlar veya gruplar arasında paylaşılmaz veya toplanmaz.
OnRejoinGroupFailedArgs

RejoinGroupFailed geri çağırma parametresi

OnServerDataMessageArgs

OnDataMessage geri çağırma parametresi

OnStoppedArgs

OnStopped geri çağırma parametresi

OpenGroupStreamOptions

openGroupStream işlem seçenekleri.

PingMessage

Ping mesajı

PongMessage

Pong mesajı

SendEventMessage

Özel olay iletisi gönderme

SendEventOptions

Olay işlemi seçeneklerini gönderme

SendMessageErrorOptions
SendToGroupMessage

Grup iletisine gönder

SendToGroupOptions

Gruba gönder işlemi seçenekleri

SequenceAckMessage

Sıralı hata iletisi

ServerDataMessage

Sunucu veri iletisi

SetGroupStateMessage

Grup durumu mesajını ayar

StartOptions

Başlangıç seçenekleri

StartStreamOptions

Akışı açan sendToGroup kontrol çerçevesine bağlı akış tanımlayıcısı.

StreamAckMessage

Yayın mesajı.

StreamClosedMessage

Yayın kapandı.

StreamDataError

Akış hata detayı.

StreamDataMessage

Veri mesajını yayınla. Sadece streamId bir yük olan bir yük bir keepalive'ı temsil eder.

StreamEndError

Giden bir akışın servise gönderebileceği akış sonu hatası. Hizmet, yüksek seviyeli hata isim sınıflandırmasına karar verir.

StreamEndMessage

Yayın sonu mesajı.

StreamInfo

Akış meta verisi, bir aşağı akış veri mesajına eklenir.

StreamNackMessage

Nack mesajını yayınlayın.

SubscribeGroupStateMessage

Abone grup durumu mesajı

UnsubscribeGroupStateMessage

Grup durumu mesajını geri çek

WebPubSubClientCredential

WebPubSubClient kimlik bilgisi

WebPubSubClientOptions

İstemci seçenekleri

WebPubSubClientProtocol

Web pubsub altprotocol için uygulanacak arabirim

WebPubSubMessageBase

Web pubsub iletisinin yaygın olanı

WebPubSubResult

Ack sonucu

WebPubSubRetryOptions

Yeniden deneme seçenekleri

Tür Diğer Adları

DownstreamMessageType

Aşağı akış iletileri türleri

JSONTypes

Seri hale getirilebilen ve JSON olarak gönderilebilen türler.

RetryMode

Yeniden Deneme Modu türünü açıklar

UpstreamMessageType

Yukarı akış iletileri türleri

WebPubSubDataType

Veri türü

WebPubSubMessage

Web pubsub iletisi

İşlevler

WebPubSubJsonProtocol()

"json.webpubsub.azure.v1" protokolünü döndürme

WebPubSubJsonReliableProtocol()

"json.reliable.webpubsub.azure.v1" protokolünü döndürme

İşlev Ayrıntıları

WebPubSubJsonProtocol()

"json.webpubsub.azure.v1" protokolünü döndürme

function WebPubSubJsonProtocol(): WebPubSubClientProtocol

Döndürülenler

WebPubSubJsonReliableProtocol()

"json.reliable.webpubsub.azure.v1" protokolünü döndürme

function WebPubSubJsonReliableProtocol(): WebPubSubClientProtocol

Döndürülenler