Freigeben über

Referenz zur JavaScript-API des App-Profil-Managers

  • Artikel

Die Referenz zur JavaScript-API des App-Profil-Managers enthält Methoden und Eigenschaften zum Verwalten von Registerkarten und Sitzungen im Customer Service workspace.

Voraussetzung

Sie müssen über die Sicherheitsrolle „App-Profilbenutzer“ oder „Produktivitättoolsbenutzer“ verfügen, um die App-Profil-Managers-APIs verwenden zu können. Weitere Informationen zu Sicherheitsrollen

Sitzungsverwaltung

Mit den folgenden Methoden und Eigenschaften können Sie Sitzungen im Customer Service workspace verwalten.

Methode Beschreibung des Dataflows
getFocusedSession Gibt das Sitzungsobjekt der Sitzung zurück, die im Fokus ist.
getAllSessions Gibt den eindeutigen Bezeichner aller Sitzungen zurück.
getSession Gibt das Sitzungsobjekt für die angegebene Session-ID zurück.
createSession Erstellt eine Sitzung basierend auf einer Sitzungsvorlage und gibt den eindeutigen Bezeichner der Sitzung zurück.
canCreateSession Gibt einen booleschen Wert zurück, der angibt, ob eine neue Sitzung erstellt werden kann.
close Schließt eine Sitzung.
focus Setzt den Fokus auf die Sitzung.
requestFocus Zeigt eine Benachrichtigungsanzeige für eine bestimmte Sitzung an, wenn die Sitzung nicht im Fokus ist.
Eigenschaften Beschreibung des Dataflows
sessionId Die ID einer bestimmten Sitzung.
isDefault Boolescher Wert, der angibt, ob es sich bei einer Sitzung um die Home-Sitzung handelt.
canClose Boolescher Wert, der angibt, ob eine Sitzung geschlossen werden kann.
title Die Textbeschriftung einer Sitzung.

Registerkarten-Verwaltung

Mit den folgenden Methoden und Eigenschaften können Sie Registerkarten im Customer Service workspace verwalten.

Methode Beschreibung des Dataflows
getFocusedTab Gibt das Registerkartenobjekt der Registerkarte zurück, die im Fokus ist.
getAllTabs Gibt den eindeutigen Bezeichner aller Registerkarten für eine Sitzung zurück.
getTab Gibt das Registerkartenobjekt der angegebenen Registerkarten-ID zurück.
createTab Erstellt eine Registerkarte in einer fokussierten Sitzung und gibt den eindeutigen Bezeichner der Registerkarte zurück.
canCreateTab Gibt einem booleschen Wert zurück, der angibt, ob eine neue Registerkarte für eine Sitzung erstellt werden kann.
Tab schließen Schließt das Registerkartenobjekt für eine Registerkarten-ID.
focusTab Setzt den Fokus auf das Registerkartenobjekt für eine Registerkarten-ID.
refreshTab Aktualisiert das Registerkartenobjekt für eine Registerkarten-ID.
Eigenschaften Beschreibung des Dataflows
tabId Die ID einer Registerkarte.
canClose Boolescher Wert, der angibt, ob eine Registerkarte geschlossen werden kann.
title Die Textbeschriftung einer Registerkarte.

Context-Management

Mit der folgenden Methode können Sie den Sitzungskontext im Customer Service workspace verwalten.

Methode Beschreibung des Dataflows
updateContext Legt das Automatisierungswörterbuch fest und ermöglicht es Anbietern, Werte von Platzhalterfeldern hinzuzufügen, zu ändern und zu entfernen. Die aktualisierten Werte stehen dann in Zukunft für den Aufruf von Makros zur Verfügung.

Clientseitige Ereignisse

Event Eigenschaft
ON_SESSION_SWITCH Wird aufgerufen, wenn die Sitzung gewchselt wird.
ON_SESSION_CLOSED Wird aufgerufen, wenn eine Sitzung geschlossen wird.

Siehe auch