WebPubSubClient class

WebPubSubClient örneği oluşturma

new WebPubSubClient(clientAccessUrl: string, options?: WebPubSubClientOptions)

Parametreler

WebPubSubClient örneği oluşturma

new WebPubSubClient(credential: WebPubSubClientCredential, options?: WebPubSubClientOptions)

Parametreler

Bir yukarı akış etkinliğini çağırın ve ilişkili yanıtı bekleyin.

function invokeEvent(eventName: string, content: JSONTypes | ArrayBuffer, dataType: WebPubSubDataType, options?: InvokeEventOptions): Promise<InvokeEventResult>

Parametreler

Döndürülenler

İstemciyi gruplandırmak için birleştirme

function joinGroup(groupName: string, options?: JoinGroupOptions): Promise<WebPubSubResult>

Parametreler

Döndürülenler

İstemciyi gruptan bırakın

function leaveGroup(groupName: string, options?: LeaveGroupOptions): Promise<WebPubSubResult>

Parametreler

Döndürülenler

Bağlı olay için işleyiciyi kaldırma

function off(event: "connected", listener: (e: OnConnectedArgs) => void)

Parametreler

Bağlantısı kesilmiş olay için işleyiciyi kaldırma

function off(event: "disconnected", listener: (e: OnDisconnectedArgs) => void)

Parametreler

Grup iletisi için işleyiciyi kaldırma

function off(event: "group-message", listener: (e: OnGroupDataMessageArgs) => void)

Parametreler

Gruba yeniden katılma işleyicisi kaldırılamadı

function off(event: "rejoin-group-failed", listener: (e: OnRejoinGroupFailedArgs) => void)

Parametreler

Sunucu iletisi için işleyiciyi kaldırma

function off(event: "server-message", listener: (e: OnServerDataMessageArgs) => void)

Parametreler

Durdurulan olay için işleyiciyi kaldırma

function off(event: "stopped", listener: (e: OnStoppedArgs) => void)

Parametreler

Bağlı olay için işleyici ekleme

function on(event: "connected", listener: (e: OnConnectedArgs) => void)

Parametreler

Bağlantısı kesilmiş olay için işleyici ekleme

function on(event: "disconnected", listener: (e: OnDisconnectedArgs) => void)

Parametreler

Grup messag'ları için işleyici ekleme

function on(event: "group-message", listener: (e: OnGroupDataMessageArgs) => void)

Parametreler

Gruba yeniden katılma işleyicisi eklenemedi

function on(event: "rejoin-group-failed", listener: (e: OnRejoinGroupFailedArgs) => void)

Parametreler

Sunucu iletileri için işleyici ekleme

function on(event: "server-message", listener: (e: OnServerDataMessageArgs) => void)

Parametreler

Durdurulan olay için işleyici ekleme

function on(event: "stopped", listener: (e: OnStoppedArgs) => void)

Parametreler

Gelen grup akışlarına abone olun. Her yeni gözlemlenen akış için geri çağrı bir kez çağrılır.

function onGroupStream(callback: (stream: GroupStream) => void | Promise<void>, options?: OnGroupStreamOptions): GroupStreamSubscription

Parametreler

Döndürülenler

Bir gruba çıkış akışı açın.

function openGroupStream(groupName: string, options?: OpenGroupStreamOptions): Promise<GroupStreamWriter>

Parametreler

Döndürülenler

Sunucuya özel olay gönderin.

function sendEvent(eventName: string, content: JSONTypes | ArrayBuffer, dataType: WebPubSubDataType, options?: SendEventOptions): Promise<WebPubSubResult>

Parametreler

Döndürülenler

Gruba ileti gönder.

function sendToGroup(groupName: string, content: JSONTypes | ArrayBuffer, dataType: WebPubSubDataType, options?: SendToGroupOptions): Promise<WebPubSubResult>

Parametreler

Döndürülenler

Hizmete başlamaya başlayın.

function start(options?: StartOptions): Promise<void>

Parametreler

Döndürülenler

İstemciyi durdurun.

function stop()