WebPubSubClient class

Membuat instans WebPubSubClient

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

Parameter

Membuat instans WebPubSubClient

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

Parameter

Panggil peristiwa hulu dan tunggu respons yang berkorelasi.

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

Parameter

Mengembalikan

Bergabung dengan klien ke grup

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

Parameter

Mengembalikan

Tinggalkan klien dari grup

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

Parameter

Mengembalikan

Menghapus handler untuk peristiwa yang tersambung

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

Parameter

Menghapus handler untuk kejadian terputus

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

Parameter

Menghapus handler untuk pesan grup

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

Parameter

Hapus handler untuk bergabung kembali grup gagal

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

Parameter

Menghapus handler untuk pesan server

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

Parameter

Hapus handler untuk kejadian yang dihentikan

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

Parameter

Menambahkan handler untuk peristiwa yang tersambung

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

Parameter

Menambahkan handler untuk kejadian terputus

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

Parameter

Menambahkan handler untuk messags grup

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

Parameter

Gagal menambahkan handler untuk bergabung kembali dengan grup

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

Parameter

Menambahkan handler untuk pesan server

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

Parameter

Menambahkan handler untuk kejadian yang dihentikan

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

Parameter

Berlangganan aliran grup masuk. Callback dipanggil sekali untuk setiap aliran yang baru diamati.

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

Parameter

Mengembalikan

Buka aliran keluar ke grup.

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

Parameter

Mengembalikan

Kirim peristiwa kustom ke server.

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

Parameter

Mengembalikan

Kirim pesan ke grup.

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

Parameter

Mengembalikan

Mulailah untuk memulai ke layanan.

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

Parameter

Mengembalikan

Hentikan klien.

function stop()