Die Schnittstelle der ccaas-Web-SDK-Instanz.
Properties
Dieser Abschnitt enthält einige der Properties, die Sie möglicherweise verwenden.
Version
Die Version des Web-SDK.
console.log(ccaas.VERSION)
Client
Dies ist eine Instanz des monitorlosen Clients. Sie enthält alles, was in einem monitorlosen 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
Binden Sie das Widget in das angegebene Element ein. Beispiel: auf Ihrer Webseite:
<div id="my-ccaas"></div>
Anschließend können Sie das Web-SDK-Widget mit folgendem Code einbinden:
ccaas.mount('#my-ccaas')
.unmount
Entfernen Sie das Web-SDK-Widget von Ihrer Webseite.
ccaas.unmount()
.destroy
Heben Sie die Einbindung auf und zerstören Sie alles.
ccaas.destroy()
.show
Zeigen Sie die Widget-UI an.
ccaas.show()
.hide
Blenden Sie die Widget-UI aus.
ccaas.hide()
.start
Zeigen Sie das Widget mit den angegebenen Optionen an und starten Sie 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 monitorlosen Web-SDK verfügbaren Ereignisse finden Sie unter Ereignisse des monitorlosen Web-SDK.
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-SDK. Weitere Informationen finden Sie im Leitfaden zum monitorlosen Web-SDK.
sichtbar
Wird ausgegeben, wenn sich die Sichtbarkeit des Widgets ändert (es wird geöffnet oder geschlossen).
Im folgenden Beispiel wird das Ereignis visible gezeigt:
ccaas.on('visible', (visible) => {
console.log(visible) // true or false
})
chat.unread
Wird ausgegeben, wenn sich die Anzahl der ungelesenen Nachrichten ändert.
Im folgenden Beispiel wird das Ereignis chat.unread gezeigt:
ccaas.on('chat.unread', (count) => {
console.log(count)
})
beendet
Wird ausgegeben, wenn der Endnutzer das Widget schließt und die Sitzung beendet wird.
Im folgenden Beispiel wird das Ereignis exited gezeigt:
ccaas.on('exited', () => {
// widget was exited
})