WebPubSubClient class

Erstellen einer Instanz von WebPubSubClient

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

Parameter

Erstellen einer Instanz von WebPubSubClient

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

Parameter

Rufen Sie ein Upstream-Ereignis aus und warten Sie auf die korrelierte Antwort.

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

Parameter

Gibt zurück

Beitreten zum Client zur Gruppe

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

Parameter

Gibt zurück

Verlassen des Clients aus der Gruppe

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

Parameter

Gibt zurück

Entfernen des Handlers für verbundene Ereignisse

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

Parameter

Entfernen des Handlers für das getrennte Ereignis

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

Parameter

Entfernen des Handlers für Gruppennachrichten

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

Parameter

Fehler beim Entfernen des Handlers für die erneute Teilnahme an der Gruppe.

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

Parameter

Entfernen des Handlers für Servernachrichten

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

Parameter

Entfernen des Handlers für das beendete Ereignis

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

Parameter

Hinzufügen eines Handlers für verbundene Ereignisse

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

Parameter

Hinzufügen eines Handlers für getrenntes Ereignis

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

Parameter

Hinzufügen eines Handlers für Gruppen-Messags

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

Parameter

Fehler beim Hinzufügen des Handlers für die erneute Teilnahme an der Gruppe.

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

Parameter

Hinzufügen eines Handlers für Servernachrichten

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

Parameter

Hinzufügen eines Handlers für das beendete Ereignis

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

Parameter

Abonnieren Sie eingehende Gruppenstreams. Der Rückruf wird einmal für jeden neu beobachteten Stream aufgerufen.

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

Parameter

Gibt zurück

Öffne einen ausgehenden Stream für eine Gruppe.

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

Parameter

Gibt zurück

Benutzerdefiniertes Ereignis an den Server senden.

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

Parameter

Gibt zurück

Nachricht an Gruppe senden.

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

Parameter

Gibt zurück

Beginnen Sie, um mit dem Dienst zu beginnen.

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

Parameter

Gibt zurück

Beenden Sie den Client.

function stop()