Référence d’API JavaScript du Gestionnaire de profils d’application

La référence d’API JavaScript du Gestionnaire de profils d’application inclut des méthodes et des propriétés pour gérer les onglets et les sessions dans Customer Service workspace.

Conditions préalables

Vous devez disposer des rôles de sécurité Utilisateur du profil d’application et Utilisateur des outils de productivité pour utiliser les API du Gestionnaire de profils d’application. Pour plus d’informations : Rôles de sécurité

Gestion de session

Les méthodes et propriétés suivantes permettent de gérer les sessions dans Customer Service workspace.

méthode	Description
getFocusedSession	Renvoie l’objet session de la session mise en focus.
getAllSessions	Renvoie l’identificateur unique de toutes les sessions.
getSession	Renvoie l’objet session d’un ID de session donné.
createSession	Crée une session basée sur un modèle de session et renvoie l’identificateur unique de la session.
canCreateSession	Renvoie une valeur booléenne indiquant si une nouvelle session peut être créée.
close	Ferme une session.
focus	Définit le focus sur une session.
requestFocus	Affiche un indicateur de notification sur une session donnée si la session n’est pas mise en focus.

Property	Description
sessionId	ID d’une session donnée.
isDefault	Valeur booléenne indiquant si une session est la session d’accueil.
canClose	Valeur booléenne indiquant si une session peut être fermée.
title	Étiquette de texte d’une session.

Gestion des onglets

Les méthodes et propriétés suivantes permettent de gérer les onglets dans Customer Service workspace.

méthode	Description
getFocusedTab	Renvoie l’objet onglet de l’onglet mis en focus.
getAllTabs	Renvoie l’identificateur unique de tous les onglets pour une session.
getTab	Retourne l’objet onglet de l’ID d’onglet spécifié.
createTab	Crée un onglet dans une session mise en focus et renvoie l’identificateur unique de l’onglet.
canCreateTab	Renvoie une valeur booléenne indiquant si un nouvel onglet peut être créé pour une session.
closeTab	Ferme l’objet onglet pour un ID d’onglet.
focusTab	Définit le focus sur l’objet onglet pour un ID d’onglet.
refreshTab	Actualise l’objet onglet pour un ID d’onglet.

Property	Description
tabId	ID d’un onglet.
canClose	Valeur booléenne indiquant si un onglet peut être fermé.
title	Étiquette de texte d’un onglet.

Gestion du contexte

La méthode suivante permet de gérer le contexte de la session dans Customer Service workspace.

méthode	Description
updateContext	Définit le dictionnaire d’automatisation et permet aux fournisseurs d’ajouter, de modifier et de supprimer des valeurs de slugs ; les valeurs mises à jour sont ensuite disponibles pour de futurs appels de macros.

Événements côté client

Événement	Description
ON_SESSION_SWITCH	Appelé lorsque la session est commutée.
ON_SESSION_CLOSED	Appelé lorsqu’une session est fermée.

Voir aussi