L'interfaccia dell'istanza dell'SDK web ccaas.
Proprietà
Questa sezione contiene alcune delle proprietà che potresti utilizzare.
versione
La versione dell'SDK web.
console.log(ccaas.VERSION)
client
Si tratta di un'istanza del client headless, che contiene tutto ciò che è disponibile in un client headless.
Ecco un esempio:
const client = ccaas.client
const chat = await client.loadOngoingChat()
Metodi
Metodi disponibili nell'istanza del widget.
.config
Aggiorna la configurazione del widget.
ccaas.config({
accent: 'green'
})
Per saperne di più, consulta la sezione Configurazione.
.mount
Monta il widget sull'elemento specificato. Ad esempio, nella tua pagina web:
<div id="my-ccaas"></div>
A questo punto, puoi montare il widget SDK web con:
ccaas.mount('#my-ccaas')
.unmount
Rimuovi il widget dell'SDK web dalla tua pagina web.
ccaas.unmount()
.destroy
Smonta e distruggi tutto.
ccaas.destroy()
.show
Visualizza la UI del widget.
ccaas.show()
.hide
Nascondi l'interfaccia utente del widget.
ccaas.hide()
.start
Mostra e avvia il widget con le opzioni specificate.
interface StartOption {
menuKey?: string;
ticketId?: string;
preferredChannel?: string;
}
Esempio:
ccaas.start({ menuKey: 'vip' })
Eventi
Questa sezione descrive gli eventi disponibili nell'SDK web. Per un elenco completo degli eventi disponibili nell'SDK web headless, consulta Eventi dell'SDK web headless.
Utilizza il metodo .on per aggiungere un listener di eventi. Vedi il seguente esempio:
const trackChat = (chat) => {
console.log(chat)
}
ccaas.on('chat.updated', trackChat)
Utilizza il metodo .off per rimuovere un listener di eventi. Vedi il seguente esempio:
ccaas.off('chat.updated', trackChat)
I metodi .on e .off sono alias dei metodi .on e .off dell'SDK web headless. Per saperne di più, consulta la guida all'SDK web headless.
visibile
Emesso quando la visibilità del widget cambia (si apre o si chiude).
L'esempio seguente mostra l'evento visible:
ccaas.on('visible', (visible) => {
console.log(visible) // true or false
})
chat.unread
Emesso quando cambia il conteggio dei messaggi non letti.
L'esempio seguente mostra l'evento chat.unread:
ccaas.on('chat.unread', (count) => {
console.log(count)
})
uscito
Emesso quando l'utente finale chiude il widget e la sessione termina.
L'esempio seguente mostra l'evento exited:
ccaas.on('exited', () => {
// widget was exited
})