WebPubSubClient class

Creación de una instancia de WebPubSubClient

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

Parámetros

Creación de una instancia de WebPubSubClient

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

Parámetros

Invoca un evento aguas arriba y espera la respuesta correlacionada.

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

Parámetros

Devoluciones

Unión del cliente al grupo

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

Parámetros

Devoluciones

Dejar el cliente del grupo

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

Parámetros

Devoluciones

Eliminación del controlador para el evento conectado

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

Parámetros

Quitar controlador para el evento desconectado

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

Parámetros

Quitar controlador para el mensaje de grupo

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

Parámetros

Error al quitar el controlador para volver a unir el grupo

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

Parámetros

Quitar controlador para el mensaje del servidor

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

Parámetros

Quitar controlador para el evento detenido

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

Parámetros

Adición de un controlador para el evento conectado

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

Parámetros

Agregar controlador para el evento desconectado

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

Parámetros

Agregar controlador para grupos messags

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

Parámetros

Error al agregar el controlador para volver a unir el grupo

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

Parámetros

Agregar controlador para mensajes de servidor

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

Parámetros

Agregar controlador para el evento detenido

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

Parámetros

Suscríbete a los streams de grupos entrantes. La callback se invoca una vez por cada flujo nuevo observado.

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

Parámetros

Devoluciones

Abre un flujo saliente a un grupo.

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

Parámetros

Devoluciones

Enviar eventos personalizados al servidor.

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

Parámetros

Devoluciones

Enviar mensaje al grupo.

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

Parámetros

Devoluciones

Empiece a iniciarse en el servicio.

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

Parámetros

Devoluciones

Detenga el cliente.

function stop()