Es la interfaz de la instancia del SDK web de ccaas.
Propiedades
En esta sección, se incluyen algunas de las propiedades que puedes usar.
version
Es la versión del SDK web.
console.log(ccaas.VERSION)
cliente
Esta es una instancia del cliente sin interfaz gráfica y contiene todo lo que está disponible en un cliente sin interfaz gráfica.
A continuación, se muestra un ejemplo:
const client = ccaas.client
const chat = await client.loadOngoingChat()
Métodos
Son los métodos disponibles en la instancia del widget.
.config
Actualiza la configuración del widget.
ccaas.config({
accent: 'green'
})
Para obtener más información, consulta la sección Configuración.
.mount
Monta el widget en el elemento determinado. Por ejemplo, en tu página web:
<div id="my-ccaas"></div>
Luego, puedes activar el widget del SDK web con el siguiente código:
ccaas.mount('#my-ccaas')
.unmount
Quita el widget del SDK web de tu página web.
ccaas.unmount()
.destroy
Desmonta y destruye todo.
ccaas.destroy()
.show
Muestra la IU del widget.
ccaas.show()
.hide
Oculta la IU del widget.
ccaas.hide()
.start
Muestra y comienza el widget con las opciones proporcionadas.
interface StartOption {
menuKey?: string;
ticketId?: string;
preferredChannel?: string;
}
Ejemplo:
ccaas.start({ menuKey: 'vip' })
Eventos
En esta sección, se describen los eventos disponibles en el SDK web. Para obtener una lista completa de los eventos disponibles en el SDK web sin encabezado, consulta Eventos del SDK web sin encabezado.
Usa el método .on para agregar un objeto de escucha de eventos. Consulta el siguiente ejemplo:
const trackChat = (chat) => {
console.log(chat)
}
ccaas.on('chat.updated', trackChat)
Usa el método .off para quitar un objeto de escucha de eventos. Consulta el siguiente ejemplo:
ccaas.off('chat.updated', trackChat)
Los métodos .on y .off son alias de los métodos .on y .off del SDK web sin interfaz gráfica. Para obtener más información, consulta la guía del SDK web sin encabezado.
visible
El evento visible se emite cuando el widget está listo para la comunicación.
En el siguiente ejemplo, se muestra el evento visible:
ccaas.on('visible', (visible) => {
console.log(visible) // true or false
})
chat.unread
El evento chat.unread se emite cuando cambia el recuento de mensajes no leídos.
En el siguiente ejemplo, se muestra el evento chat.unread:
ccaas.on('chat.unread', (count) => {
console.log(count)
})
Salió
El evento exited se emite cuando el usuario final cierra el widget.
En el siguiente ejemplo, se muestra el evento exited:
ccaas.on('exited', () => {
// widget was exited
})