A interface da instância do SDK da Web ccaas.
Propriedades
Esta seção contém algumas das propriedades que você pode usar.
version
A versão do SDK da Web.
console.log(ccaas.VERSION)
cliente
Esta é uma instância do cliente sem comando, que contém tudo o que está disponível em um cliente sem comando.
Veja um exemplo:
const client = ccaas.client
const chat = await client.loadOngoingChat()
Métodos
Métodos disponíveis na instância do widget.
.config
Atualize a configuração do widget.
ccaas.config({
accent: 'green'
})
Para mais informações, consulte a seção Configuração.
.mount
Monta o widget no elemento especificado. Por exemplo, na sua página da Web:
<div id="my-ccaas"></div>
Em seguida, você pode montar o widget do SDK da Web com:
ccaas.mount('#my-ccaas')
.unmount
Remova o widget do SDK da Web da sua página da Web.
ccaas.unmount()
.destroy
Desmonte e destrua tudo.
ccaas.destroy()
.show
Mostre a UI do widget.
ccaas.show()
.hide
Ocultar a UI do widget.
ccaas.hide()
.start
Mostra e inicia o widget com as opções especificadas.
interface StartOption {
menuKey?: string;
ticketId?: string;
preferredChannel?: string;
}
Exemplo:
ccaas.start({ menuKey: 'vip' })
Eventos
Esta seção descreve os eventos disponíveis no SDK da Web. Para conferir uma lista completa de eventos disponíveis no SDK headless para Web, consulte Eventos do SDK headless para Web.
Use o método .on para adicionar um listener de eventos. Veja o exemplo a seguir:
const trackChat = (chat) => {
console.log(chat)
}
ccaas.on('chat.updated', trackChat)
Use o método .off para remover um listener de eventos. Veja o exemplo a seguir:
ccaas.off('chat.updated', trackChat)
Os métodos .on e .off são aliases dos métodos .on e .off do SDK da Web sem interface gráfica. Para mais informações, consulte o guia do SDK da Web sem interface gráfica.
visível
O evento visible é emitido quando o widget está pronto para comunicação.
O exemplo a seguir mostra o evento visible:
ccaas.on('visible', (visible) => {
console.log(visible) // true or false
})
chat.unread
O evento chat.unread é emitido quando a contagem de mensagens não lidas muda.
O exemplo a seguir mostra o evento chat.unread:
ccaas.on('chat.unread', (count) => {
console.log(count)
})
saiu
O evento exited é emitido quando o usuário final fecha o widget.
O exemplo a seguir mostra o evento exited:
ccaas.on('exited', () => {
// widget was exited
})