WebPubSubClient class

Creare un'istanza di WebPubSubClient

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

Parametri

Creare un'istanza di WebPubSubClient

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

Parametri

Invoca un evento a monte e attendi la risposta correlata.

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

Parametri

Valori restituiti

Aggiungere il client a un gruppo

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

Parametri

Valori restituiti

Lasciare il client dal gruppo

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

Parametri

Valori restituiti

Rimuovere il gestore per l'evento connesso

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

Parametri

Rimuovere il gestore per l'evento disconnesso

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

Parametri

Rimuovere il gestore per il messaggio di gruppo

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

Parametri

Rimozione del gestore per la ricongiuzione del gruppo non riuscita

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

Parametri

Rimuovere il gestore per il messaggio del server

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

Parametri

Rimuovere il gestore per l'evento arrestato

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

Parametri

Aggiungere un gestore per l'evento connesso

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

Parametri

Aggiungere un gestore per l'evento disconnesso

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

Parametri

Aggiungere il gestore per i gruppi messags

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

Parametri

Impossibile aggiungere il gestore per la ricongiuzione del gruppo

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

Parametri

Aggiungere un gestore per i messaggi del server

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

Parametri

Aggiungere un gestore per l'evento arrestato

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

Parametri

Iscriviti agli stream di gruppo in entrata. Il callback viene invocato una volta per ogni flusso appena osservato.

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

Parametri

Valori restituiti

Apri un flusso in uscita verso un gruppo.

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

Parametri

Valori restituiti

Inviare un evento personalizzato al server.

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

Parametri

Valori restituiti

Invia messaggio al gruppo.

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

Parametri

Valori restituiti

Iniziare a avviare il servizio.

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

Parametri

Valori restituiti

Arrestare il client.

function stop()