Die Schnittstelle der ccaas-Web-SDK-Instanz.
Eigenschaften
Dieser Abschnitt enthält einige der Eigenschaften, die Sie möglicherweise verwenden.
Version
Die Version des Web-SDK.
console.log(ccaas.VERSION)
Client
Dies ist eine Instanz des Headless-Clients. Sie enthält alles, was in einem Headless-Client verfügbar ist.
Hier ein Beispiel:
const client = ccaas.client
const chat = await client.loadOngoingChat()
Methoden
Verfügbare Methoden für die Widget-Instanz.
.config
Aktualisieren Sie die Konfiguration des Widgets.
ccaas.config({
accent: 'green'
})
Weitere Informationen finden Sie im Abschnitt Konfiguration.
.mount
Bringen Sie das Widget am angegebenen Element an. Beispiel für Ihre Webseite:
<div id="my-ccaas"></div>
Anschließend können Sie das Web-SDK-Widget mit folgendem Befehl einbinden:
ccaas.mount('#my-ccaas')
.unmount
Entfernen Sie das Web-SDK-Widget von Ihrer Webseite.
ccaas.unmount()
.destroy
Trennen Sie die Verbindung und zerstören Sie alles.
ccaas.destroy()
.show
Die Benutzeroberfläche des Widgets anzeigen
ccaas.show()
.hide
Blenden Sie die Benutzeroberfläche des Widgets aus.
ccaas.hide()
.start
Zeigt das Widget mit den angegebenen Optionen an und startet es.
interface StartOption {
menuKey?: string;
ticketId?: string;
preferredChannel?: string;
}
Beispiel:
ccaas.start({ menuKey: 'vip' })
Ereignisse
In diesem Abschnitt werden die im Web-SDK verfügbaren Ereignisse beschrieben. Eine vollständige Liste der im Headless Web SDK verfügbaren Ereignisse finden Sie unter Headless Web SDK-Ereignisse.
Verwenden Sie die Methode .on, um einen Event-Listener hinzuzufügen. Sehen Sie sich folgendes Beispiel an:
const trackChat = (chat) => {
console.log(chat)
}
ccaas.on('chat.updated', trackChat)
Verwenden Sie die Methode .off, um einen Event-Listener zu entfernen. Sehen Sie sich folgendes Beispiel an:
ccaas.off('chat.updated', trackChat)
Die Methoden .on und .off sind Aliase für die Methoden .on und .off des monitorlosen Web-SDKs. Weitere Informationen finden Sie im Headless Web SDK-Leitfaden.
sichtbar
Das visible-Ereignis wird ausgegeben, wenn das Widget für die Kommunikation bereit ist.
Das folgende Beispiel zeigt das visible-Ereignis:
ccaas.on('visible', (visible) => {
console.log(visible) // true or false
})
chat.unread
Das Ereignis chat.unread wird ausgegeben, wenn sich die Anzahl der ungelesenen Nachrichten ändert.
Das folgende Beispiel zeigt das chat.unread-Ereignis:
ccaas.on('chat.unread', (count) => {
console.log(count)
})
beendet
Das Ereignis exited wird ausgegeben, wenn der Endnutzer das Widget schließt.
Das folgende Beispiel zeigt das exited-Ereignis:
ccaas.on('exited', () => {
// widget was exited
})