Dela via

JavaScript API-referens för appprofilhanterare

JavaScript API-referensen för appprofilhanteraren innehåller metoder och egenskaper för att hantera flikar och sessioner i Copilot-tjänstens arbetsyta.

Förutsättning

Du måste ha användarsäkerhetsrollerna Appprofil användare eller Produktivitetsverktyg för att kunna använda API:erna för appprofilhanteraren. Mer information: Säkerhetsroller

Sessionshantering

Med följande metoder och egenskaper kan du hantera sessioner i Copilot Service workspace.

Metod Description
getFocusedSession Returnerar sessionsobjektet för den session som är i fokus.
getAllSessions Returnerar den unika identifieraren för alla sessioner.
getSession Returnerar sessionsobjektet för det angivna sessions-ID:t.
createSession Skapar en session baserat på en sessionsmall och returnerar den unika identifieraren för sessionen.
canCreateSession Returnerar ett booleskt värde som anger om en ny session kan skapas.
stänga Stänger en session.
fokus Ställer in fokus på en session.
requestFocus Visar en aviseringsindikator för en viss session om sessionen inte är i fokus.
Fastighet Description
session-ID ID för en viss session.
isDefault Booleskt värde som anger om en session är hemsessionen.
kanStäng Booleskt värde som anger om en session kan stängas.
title Textetiketten för en session.

Hantering av flikar

Med följande metoder och egenskaper kan du hantera flikar i Copilot Service workspace.

Metod Description
getFocusedTab Returnerar tabbobjektet för den flik som är i fokus.
getAllTabs Returnerar den unika identifieraren för alla flikar för en session.
getTab Returnerar flikobjektet för det angivna flik-ID:t.
skapaFlik Skapar en flik i en fokuserad session och returnerar den unika identifieraren för fliken.
canCreateTab (på engelska) Returnerar ett booleskt värde som anger om en ny flik kan skapas för en session.
closeTab (på engelska) Stänger flikobjektet för ett flik-ID.
fokusFlik Ställer in fokus på flikobjektet för ett flik-ID.
refreshTab (på engelska) Uppdaterar flikobjektet för ett flik-ID.
Fastighet Description
tabId ID för en flik.
kanStäng Booleskt värde som anger om en flik kan stängas.
title Textetiketten för en flik.

Hantering av kontext

Med följande metod kan du hantera sessionskontexten i Copilot Service-arbetsytan.

Metod Description
updateContext Ställer in automatiseringsordlistan och gör det möjligt för leverantörer att lägga till, ändra och ta bort värden för sniglar. De uppdaterade värdena är sedan tillgängliga för att anropa makron i framtiden.

Händelser på klientsidan

Event Description
ON_SESSION_SWITCH Anropas när sessionen växlas.
ON_SESSION_CLOSED Anropas när en session stängs.
  • Last updated on