Freigeben über

JavaScript-API-Referenz für den App-Profilmanager

Die JavaScript-API-Referenz für den App-Profilmanager enthält Methoden und Eigenschaften zum Verwalten von Registerkarten und Sitzungen im Copilot-Dienstarbeitsbereich.

Voraussetzung

Sie müssen über die Sicherheitsrollen "App-Profilbenutzer" oder "Benutzer der Produktivitätstools" verfügen, um die App-Profil-Manager-APIs verwenden zu können. Weitere Informationen: Sicherheitsrollen

Sitzungsverwaltung

Mit den folgenden Methoden und Eigenschaften können Sie Sitzungen im Copilot-Dienstarbeitsbereich verwalten.

Methode Description
getFocusedSession Gibt das Sitzungsobjekt der Sitzung zurück, die sich im Fokus befindet.
getAllSessions Gibt die eindeutige Kennung aller Sitzungen zurück.
getSession Gibt das Sitzungsobjekt für die angegebene Sitzungs-ID zurück.
createSession Erstellt eine Sitzung basierend auf einer Sitzungsvorlage und gibt die eindeutige Kennung der Sitzung zurück.
canCreateSession Gibt einen booleschen Wert zurück, der angibt, ob eine neue Sitzung erstellt werden kann.
schließen Schließt eine Sitzung.
Brennpunkt Legt den Fokus auf eine Sitzung fest.
requestFocus Zeigt eine Benachrichtigungsanzeige für eine bestimmte Sitzung an, wenn die Sitzung nicht im Fokus ist.
Eigentum Description
session-ID Die ID einer bestimmten Sitzung.
isDefault (Default) Boolescher Wert, der angibt, ob es sich bei einer Sitzung um die Startsitzung handelt.
canClose Boolescher Wert, der angibt, ob eine Sitzung geschlossen werden kann.
title Die Textbeschriftung einer Sitzung.

Registerkartenverwaltung

Mit den folgenden Methoden und Eigenschaften können Sie Registerkarten im Arbeitsbereich von Copilot Service verwalten.

Methode Description
getFocusedTab Gibt das Registerkartenobjekt der Registerkarte zurück, die sich im Fokus befindet.
getAllTabs Gibt die eindeutige Kennung 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 die eindeutige Kennung der Registerkarte zurück.
canCreateTab Gibt einen 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 Legt den Fokus auf das Registerkartenobjekt für eine Registerkarten-ID fest.
refreshTab Aktualisiert das Registerkartenobjekt für eine Registerkarten-ID.
Eigentum Description
tabId Die ID einer Registerkarte.
canClose Boolescher Wert, der angibt, ob ein Tab geschlossen werden kann.
title Die Textbeschriftung einer Registerkarte.

Kontextverwaltung

Mit der folgenden Methode können Sie den Sitzungskontext im Copilot-Dienstarbeitsbereich verwalten.

Methode Description
updateContext Legt das Automatisierungswörterbuch fest und ermöglicht Anbietern das Hinzufügen, Ändern und Entfernen von Werten von Slugs. Die aktualisierten Werte stehen dann für den zukünftigen Aufruf von Makros zur Verfügung.

Clientseitige Ereignisse

Event Description
ON_SESSION_SWITCH Wird aufgerufen, wenn die Sitzung gewchselt wird.
ON_SESSION_CLOSED Wird aufgerufen, wenn eine Sitzung geschlossen wird.
  • Last updated on