Plugins

Inhaltsverzeichnis

• Installation
  • Globale Konfiguration
  • Entwicklermodus
    • Manuelle Installation
    • Automatische Installation
• Struktur eines Plugins
  • Dateistruktur
  • Manifest
    • Metainformationen
    • Erweiterungstyp Schaltfläche
    • Erweiterungstyp Pane
    • Erweiterungstyp Dialog
    • Erweiterungstyp Einstellungen
• Beispiel Plugin: Hello World
  • Manifest
  • Pane erstellen
  • Plugin bereitstellen
• Beispiel Plugin: Erweitertes Plugin
  • Voraussetzung
  • Schaltfläche erstellen
  • Kommunikation innerhalb und zwischen Plugins
  • Clientseitige UI Events
  • Einstellungen für Ihr Plugin
  • Dialog in der Anwendung

Erweiterungsmöglichkeiten

Über Plugins können Sie die Funktionalität des LiveChats erweitern. Hierfür stehen in der Benutzeroberfläche vier Typen von Erweiterungsmöglichkeiten zur Verfügung.

Einstellungen

Jedes installierte Plugin ist in den Einstellungen unter Plugins sichtbar. Dort können Sie einen eigenen Dialog hinterlegen, um dem Benutzer Einstellungsmöglichkeiten für Ihr Plugin zu geben.

Um Einstellungen auf dem Server zu speichern, können Sie die lcapi.storage API nutzen.

Kontrollleiste

In den Kontrollleisten des Video- und TextChats befindet sich jeweils ein erweitertes Menü welches über geöffnet werden kann. In diesem Menü können Sie weitere Schaltflächen einfügen.

Um die Schaltflächen während der Laufzeit zu verändern, können Sie die lcapi.ui.button API nutzen.

Erweiterungs Pane

Im Video- und TextChat befindet sich an der rechten Seite die sogenannte Erweiterungs Pane. In diese Pane können Sie weitere Einträge hinzufügen und den Bereich frei gestalten.

Um die Erweiterungen während der Laufzeit zu verändern, können Sie die lcapi.ui.pane API nutzen.

Dialoge

Ein Plugin kann außerdem Dialoge definieren, die über die lcapi.ui.dialog API geöffnet werden können.

Extension Points

Neben den vier Erweiterungsmöglichkeiten gibt es unterschiedliche Bereiche, die erweitert werden können (so genannte Extension Points).

Beispiele für Extension Points sind der TextChat im TeamChat oder der VideoChat unter den öffentlichen Anfragen.

Hier finden Sie die Liste aller möglichen Extension Points:

agentclient.teamchat.textchat
agentclient.teamchat.videochat
agentclient.teamchat.contextmenu
agentclient.teamchatGroup.textchat
agentclient.teamchatGroup.contextmenu
agentclient.livechat.private.textchat
agentclient.livechat.private.videochat
agentclient.livechat.public.textchat
agentclient.livechat.public.videochat
agentclient.livechat.overdue.textchat
agentclient.livechat.overdue.videochat
agentclient.livechat.public.contextmenu
agentclient.livechat.private.contextmenu
agentclient.livechat.overdue.contextmenu
multimediaBusinessCard.textchat
multimediaBusinessCard.videochat
portal.textchat
portal.videochat
widget.videochat

Wann immer Sie einen Extension Point angeben, können Sie auch Wildcards benutzen. agentclient.teamchat.* sorgt dafür dass alle Extension Points des TeamChats angesprochen werden, agentclient.* referenziert sämtliche Extension Points im Agentenclient.

Note

Wenn Sie Ihr Plugin für mehr als einen Extension Point konfiguriert haben, bspw. für agentclient.livechat.private.*, existieren zur Laufzeit mehrere Instanzen Ihres Codes. In dem Beispiel eine für agentclient.livechat.private.textchat und eine für agentclient.livechat.private.videochat.