CatalogJS - Dans le champ d’application

L’API CatalogJS fournit des méthodes pour vérifier et récupérer les propriétés spécifiques du catalogue.

Pour utiliser cette classe dans une application incluse dans le périmètre, utilisez l’identificateur d’espace de noms sn_sc. Le module d’extension Service Catalog Scoped API (com.glideapp.servicecatalog.scoped.api) qui est activé par défaut est requis pour accéder à l’API CatalogJS .

CatalogJS : catalogue (GlideRecord now_GR)

Crée une instance de la classe de catalogue pour l’objet d’enregistrement Glide spécifié.

Tableau 1. Paramètres

Nom	Type	Description
now_GR	Objet	Enregistrement Glide pointant vers la table sc_catalog.

Cet exemple montre comment créer une nouvelle instance de la classe de catalogue.

var now_GR = new GlideRecord('sc_catalog');
 now_GR.addQuery('sys_id','e0d08b13c3330100c8b837659bba8fb4');
 now_GR.query();
 var catalog = new sn_sc.Catalog(now_GR);

CatalogJS : catalogue (chaîne sys_id)

Crée une instance de la classe de catalogue avec le sys_id spécifié.

Tableau 2. Paramètres

Nom	Type	Description
sys_id	Chaîne	Sys_id du catalogue.

Cet exemple montre comment créer une instance de la classe Catalog avec le syst_id spécifié.

new sn_sc.Catalog(catalog_sys_id);
var catalog = new sn_sc.Catalog("31bea3d53790200044e0bfc8bcbe5dec");

CatalogJS : canView(booléen mobile, chaîne userId)

Détermine si un utilisateur peut afficher la catégorie actuelle sur un appareil mobile ou un ordinateur de bureau.

Tableau 3. Paramètres

Nom	Type	Description
mobile	Booléen	Marqueur indiquant s’il faut vérifier si l’utilisateur peut afficher le catalogue actuel sur une vue mobile ou une vue de bureau. Valeurs valides : vrai : vue mobile false : vue poste de travail
userId	Chaîne	Facultatif. Sys_id de l’utilisateur pour vérifier s’il peut afficher le catalogue. Par défaut : utilisateur actuel

Tableau 4. Renvoie

Type	Description
Booléen	Marqueur indiquant si le catalogue est visible par l’utilisateur. Valeurs valides : vrai : le catalogue est visible par l’utilisateur. false : le catalogue n’est pas visible par l’utilisateur.

Exemple :

var catalog = new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
gs.info(catalog.canView(true));

Sortie :

true

CatalogJS : getAvailableCatalog()

Renvoie le catalogue actif disponible.

S’il n’existe qu’un seul catalogue actif, la méthode renvoie ce catalogue. Sinon, elle renvoie le catalogue le plus ancien créé à partir de la liste des catalogues que l’utilisateur peut afficher. Si aucun catalogue n’est disponible, la méthode renvoie null.

Tableau 5. Paramètres

Nom	Type	Description
Aucun

Tableau 6. Renvoie

Type	Description
Objet	Objet pointant vers le catalogue le plus ancien que l’utilisateur peut afficher ou nul si aucun catalogue n’est disponible.

Cet exemple renvoie le catalogue disponible à l’utilisateur actuel.

var catalog = sn_sc.Catalog.getAvailableCatalog()

CatalogJS : getBackgroundColor()

Renvoie la couleur d’arrière-plan du catalogue.

Tableau 7. Paramètres

Nom	Type	Description
Aucun

Tableau 8. Renvoie

Type	Description
Chaîne	Couleur d’arrière-plan du catalogue.

Cet exemple renvoie la couleur d’arrière-plan pour le catalogue associé.

var catalog = new sn_sc.Catalog("0f910a2ac3112200b12d9f2974d3ae3c");
gs.info("Catalog background: " + catalog.getBackgroundColor());

Sortie :

Catalog background: white

CatalogJS : getCatalogCount()

Renvoie le nombre de catalogues actifs dans la table Catalogue.

Tableau 9. Paramètres

Nom	Type	Description
Aucun

Tableau 10. Renvoie

Type	Description
Entier	Nombre de catalogues disponibles dans la table Catalogue.

Exemple :

console.log(sn_sc.Catalog.getCatalogCount());

Sortie :

3

CatalogJS : getCategories()

Renvoie les catégories du catalogue actuel.

Tableau 11. Paramètres

Nom	Type	Description
Aucun

Tableau 12. Renvoie

Type	Description
Tableau de liste	Renvoie les catégories du catalogue actuel.

Cet exemple renvoie les catégories disponibles dans l’objet de catalogue actuel.

var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
console.log(catalog.getCategories());

Sortie :

0 : {header_image: "", sys_id: "e15706fc0a0a0aa7007fc21e1ab70c2f", description: "Your IT gateway. Report issues and submit requests.", title: "Can We Help You?"} 
1 : {header_image: "", sys_id: "95fc11615f1211001c9b2572f2b477c6", description: "Services offered by different departments in the organization", title: "Departmental Services"} 
2 : {header_image: "", sys_id: "900682363731300054b6a3549dbe5d5f", description: "Desktop computers for your work area.", title: "Desktops"} 
3 : {header_image: "", sys_id: "d2f716fcc611227a015a142fa0b262c1", description: "Order new furniture, and fixtures, or request for cubicle modifications can also be ordered here.", title: "Furniture and Decor"} 
4 : {header_image: "", sys_id: "d258b953c611227a0146101fb1be7c31", description: "Order from a variety of hardware to meet your business needs, including phones, tablets and laptops.", title: "Hardware"} 

CatalogJS : getCategoryIds()

Spécifie le sys_ids des catégories du catalogue actuel.

Tableau 13. Paramètres

Nom	Type	Description
Aucun

Tableau 14. Renvoie

Type	Description
Tableau de liste	Renvoie le sys_ids des catégories du catalogue actuel.

Cet exemple renvoie la sys_ids des catégories disponibles dans le catalogue actuel.

var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
console.log(catalog.getCategoryIds());

Sortie :

0:"e15706fc0a0a0aa7007fc21e1ab70c2f"
1 : "95fc11615f1211001c9b2572f2b477c6"
2 : "900682363731300054b6a3549dbe5d5f"
3 : "d2f716fcc611227a015a142fa0b262c1"

CatalogJS : getDescription()

Renvoie la description du catalogue actuel.

Tableau 15. Paramètres

Nom	Type	Description
Aucun

Tableau 16. Renvoie

Type	Description
Chaîne	Description du catalogue.

Cet exemple renvoie le nom du catalogue actuel.

var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
console.log(catalog.getDescription());

Sortie :

Service Catalog - IT Now

CatalogJS : getDesktopImageSRC()

Renvoie le nom du fichier image de bureau du catalogue.

Tableau 17. Paramètres

Nom	Type	Description
Aucun

Tableau 18. Renvoie

Type	Description
Chaîne	Nom de fichier d’image de bureau de catalogue.

Cet exemple renvoie le nom du fichier image de poste de travail du catalogue actuel.

var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
console.log(catalog.getDesktopImageSRC());

Sortie :

adbcc271475211002ee987e8dee49001.iix

CatalogJS : getGr()

Retourne le GlideRecord du catalogue actuel.

Tableau 19. Paramètres

Nom	Type	Description
Aucun

Tableau 20. Renvoie

Type	Description
GlideRecord	GlideRecord du catalogue actuel.

Cet exemple retourne le GlideRecord pour le catalogue spécifié.

var catalog = new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
data.history = catalog.getGr();

CatalogJS : getHeaderIconSRC()

Renvoie l’icône d’en-tête du catalogue actuel.

Tableau 21. Paramètres

Nom	Type	Description
Aucun

Tableau 22. Renvoie

Type	Description
Chaîne	Icône En-tête de catalogue.

Cet exemple montre comment obtenir le nom de l’icône d’en-tête de catalogue.

var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
gs.info(catalog.getHeaderIconSRC());

Sortie :

service_catalog_header.png

CatalogJS : getID()

Renvoie le sys_id du catalogue actuel.

Tableau 23. Paramètres

Nom	Type	Description
Aucun

Tableau 24. Renvoie

Type	Description
Chaîne	Sys_id du catalogue actuel.

Cet exemple renvoie la sys_id du catalogue actuel.

var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
console.log(catalog.getId());

Sortie :

e0d08b13c3330100c8b837659bba8fb4

CatalogJS : getTitle()

Renvoie le titre du catalogue actuel.

Tableau 25. Paramètres

Nom	Type	Description
Aucun

Tableau 26. Renvoie

Type	Description
Chaîne	Titre du catalogue actuel.

Cet exemple renvoie le titre du catalogue actuel.

var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
gs.info(catalog.getTitle());

Sortie :

Service Catalog

CatalogJS : hasCategories()

Spécifie si le catalogue actuel comporte des catégories.

Tableau 27. Paramètres

Nom	Type	Description
Aucun

Tableau 28. Renvoie

Type	Description
Booléen	Marqueur indiquant si le catalogue actuel comporte des catégories. Valeurs valides : vrai : le catalogue comporte des catégories. faux : le catalogue n’a pas de catégories.

Cet exemple montre comment déterminer si le catalogue actuel contient des catégories.

var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
gs.info(catalog.hasCategories());

Sortie :

false

CatalogJS : hasItems()

Spécifie si le catalogue actuel contient des éléments de catalogue.

Tableau 29. Paramètres

Nom	Type	Description
Aucun

Tableau 30. Renvoie

Type	Description
Booléen	Marqueur indiquant si le catalogue actuel contient des éléments de catalogue. Valeurs valides : vrai : le catalogue contient des éléments de catalogue. faux : le catalogue ne contient pas d’éléments de catalogue.

Exemple :

var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
gs.info(catalog.hasItems());

Sortie :

true

CatalogJS : isWishlistEnabled()

Spécifie si la liste de souhaits est activée pour le catalogue actuel.

Tableau 31. Paramètres

Nom	Type	Description
Aucun

Tableau 32. Renvoie

Type	Description
Booléen	Marqueur indiquant si le catalogue actuel prend en charge les listes de souhaits. Valeurs valides : true : le catalogue prend en charge les listes de souhaits. faux : le catalogue ne prend pas en charge les listes de souhaits.

Cet exemple montre comment vérifier si des listes de souhaits sont activées pour le catalogue actuel.

var catalog = new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
gs.info(catalog.isWishlistEnabled());

Sortie :

true