---
sourceDocument: Référence de l’API Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - fr-FR

ft:publication_title :

    - Référence de l’API Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# CatalogJS : inclus dans le champ d'application

# CatalogJS : inclus dans le champ d'application {#ariaid-title1}

* Rversion finale: Xanadu
* 
* Mis à jour 1 août 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 5 minutes de lecture

L'API CatalogJS fournit des méthodes pour vérifier et récupérer des propriétés spécifiques au 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) {#ariaid-title2}

Crée une instance de la classe de catalogue pour l'objet d'enregistrement Glide spécifié.
{#CJS-Catalog_G__table_og2_g1c_5bb__entry__3}

| Nom | Type | Description |
|-|-|-|
| now_GR | Objet | Enregistrement Glide pointant vers la table sc_catalog. |
[Tableau 1. Paramètres]

{#CJS-Catalog_G__table_og2_g1c_5bb}  
Cet exemple montre comment créer une nouvelle instance de la classe catalog.

    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) {#ariaid-title3}

Crée une instance de la classe Catalog avec le sys_id spécifié.
{#CJS-Catalog_S__table_tf1_gbc_5bb__entry__3}

| Nom | Type | Description |
|-|-|-|
| sys_id | Chaîne | Sys_id du catalogue. |
[Tableau 2. Paramètres]

{#CJS-Catalog_S__table_tf1_gbc_5bb}  
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) {#ariaid-title4}

Détermine si un utilisateur peut afficher la catégorie actuelle sur un appareil mobile ou un ordinateur de bureau.
{#CJS-canView_B__table_mnl_2lz_sbb__entry__3}

| 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 de bureau. Valeurs valides : * true : vue mobile * false : vue poste de travail {#CJS-canView_B__ul_qfp_cb4_kpb} |
| userId | Chaîne | Facultatif. Sys_id de l'utilisateur pour vérifier s'il peut afficher le catalogue. Par défaut : Utilisateur actuel |
[Tableau 3. Paramètres]

{#CJS-canView_B__table_mnl_2lz_sbb} {#CJS-canView_B__table_nnl_2lz_sbb__entry__2}

| Type | Description |
|-|-|
| Booléen | Marqueur indiquant si le catalogue est visible par l'utilisateur. Valeurs valides : * vrai : le catalogue est visible par l'utilisateur. * faux : le catalogue n'est pas visible par l'utilisateur. {#CJS-canView_B__ul_wbn_mb4_kpb} |
[Tableau 4. Renvoie]

{#CJS-canView_B__table_nnl_2lz_sbb}  
Exemple :

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

Sortie :

    true

## CatalogJS : getAvailableCatalog() {#ariaid-title5}

Renvoie le catalogue actif disponible.
S'il n'existe qu'un seul catalogue actif, la méthode renvoie ce catalogue. Dans le cas contraire, il renvoie le premier catalogue créé à partir de la liste des catalogues que l'utilisateur peut afficher. Si aucun catalogue n'est disponible, la méthode retourne null.
{#CJS-getAvailableCatalog__table_m31_rmz_sbb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 5. Paramètres]

{#CJS-getAvailableCatalog__table_m31_rmz_sbb} {#CJS-getAvailableCatalog__table_n31_rmz_sbb__entry__2}

| Type | Description |
|-|-|
| Objet | Objet pointant vers le catalogue le plus ancien que l'utilisateur peut afficher ou nul si aucun catalogue n'est disponible. |
[Tableau 6. Renvoie]

{#CJS-getAvailableCatalog__table_n31_rmz_sbb}  
Cet exemple renvoie le catalogue disponible pour l'utilisateur actuel.

    var catalog = sn_sc.Catalog.getAvailableCatalog()

## CatalogJS : getBackgroundColor() {#ariaid-title6}

Renvoie la couleur d'arrière-plan du catalogue.
{#CJS-getBackgroundColor__table_etj_mrz_sbb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 7. Paramètres]

{#CJS-getBackgroundColor__table_etj_mrz_sbb} {#CJS-getBackgroundColor__table_ftj_mrz_sbb__entry__2}

| Type | Description |
|-|-|
| Chaîne | Couleur d'arrière-plan du catalogue. |
[Tableau 8. Renvoie]

{#CJS-getBackgroundColor__table_ftj_mrz_sbb}  
Cet exemple renvoie la couleur d'arrière-plan du catalogue associé.

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

Sortie :

    Catalog background: white

## CatalogJS : getCatalogCount() {#ariaid-title7}

Renvoie le nombre de catalogues actifs dans la table de catalogue.
{#CJS-getCatalogCount__table_ez1_znz_sbb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 9. Paramètres]

{#CJS-getCatalogCount__table_ez1_znz_sbb} {#CJS-getCatalogCount__table_fz1_znz_sbb__entry__2}

| Type | Description |
|-|-|
| Entier | Nombre de catalogues disponibles dans la table de catalogue. |
[Tableau 10. Renvoie]

{#CJS-getCatalogCount__table_fz1_znz_sbb}  
Exemple :

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

Sortie :

    3

## CatalogJS : getCategories() {#ariaid-title8}

Renvoie les catégories du catalogue actuel.
{#CJS-getCategories__table_nwt_l4z_sbb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 11. Paramètres]

{#CJS-getCategories__table_nwt_l4z_sbb} {#CJS-getCategories__table_owt_l4z_sbb__entry__2}

| Type | Description |
|-|-|
| TableauListe | Renvoie les catégories du catalogue actuel. |
[Tableau 12. Renvoie]

{#CJS-getCategories__table_owt_l4z_sbb}  
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() {#ariaid-title9}

Spécifie l'sys_ids des catégories dans le catalogue actuel.
{#CJS-getCategoryIds__table_ivv_3pz_sbb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 13. Paramètres]

{#CJS-getCategoryIds__table_ivv_3pz_sbb} {#CJS-getCategoryIds__table_jvv_3pz_sbb__entry__2}

| Type | Description |
|-|-|
| TableauListe | Renvoie la sys_ids des catégories dans le catalogue actuel. |
[Tableau 14. Renvoie]

{#CJS-getCategoryIds__table_jvv_3pz_sbb}  
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() {#ariaid-title10}

Renvoie la description du catalogue actuel.
{#CJS-getDescription__table_g5q_3qz_sbb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 15. Paramètres]

{#CJS-getDescription__table_g5q_3qz_sbb} {#CJS-getDescription__table_h5q_3qz_sbb__entry__2}

| Type | Description |
|-|-|
| Chaîne | Description du catalogue. |
[Tableau 16. Renvoie]

{#CJS-getDescription__table_h5q_3qz_sbb}  
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() {#ariaid-title11}

Renvoie le nom du fichier d'image de poste de travail de catalogue.
{#CJS-getDesktopImageSRC__table_zdf_csz_sbb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 17. Paramètres]

{#CJS-getDesktopImageSRC__table_zdf_csz_sbb} {#CJS-getDesktopImageSRC__table_a2f_csz_sbb__entry__2}

| Type | Description |
|-|-|
| Chaîne | Nom de fichier d'image de poste de travail du catalogue. |
[Tableau 18. Renvoie]

{#CJS-getDesktopImageSRC__table_a2f_csz_sbb}  
Cet exemple renvoie le nom de fichier d'image de poste de travail du catalogue actuel.

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

Sortie :

    adbcc271475211002ee987e8dee49001.iix

## CatalogJS : getGr() {#ariaid-title12}

Renvoie le GlideRecord du catalogue actuel.
{#CJS-getGr__table_vdd_rqz_sbb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 19. Paramètres]

{#CJS-getGr__table_vdd_rqz_sbb} {#CJS-getGr__table_wdd_rqz_sbb__entry__2}

| Type | Description |
|-|-|
| GlideRecord | GlideRecord du catalogue actuel. |
[Tableau 20. Renvoie]

{#CJS-getGr__table_wdd_rqz_sbb}  
Cet exemple renvoie le GlideRecord pour le catalogue spécifié.

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

## CatalogJS : getHeaderIconSRC() {#ariaid-title13}

Renvoie l'icône d'en-tête du catalogue actuel.
{#CJS-getHeaderIconSRC__table_xsg_5rz_sbb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 21. Paramètres]

{#CJS-getHeaderIconSRC__table_xsg_5rz_sbb} {#CJS-getHeaderIconSRC__table_ysg_5rz_sbb__entry__2}

| Type | Description |
|-|-|
| Chaîne | Icône d'en-tête de catalogue. |
[Tableau 22. Renvoie]

{#CJS-getHeaderIconSRC__table_ysg_5rz_sbb}  
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() {#ariaid-title14}

Renvoie les sys_id du catalogue actuel.
{#CJS-getID__table_xqx_xpz_sbb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 23. Paramètres]

{#CJS-getID__table_xqx_xpz_sbb} {#CJS-getID__table_yqx_xpz_sbb__entry__2}

| Type | Description |
|-|-|
| Chaîne | Sys_id du catalogue actuel. |
[Tableau 24. Renvoie]

{#CJS-getID__table_yqx_xpz_sbb}  
Cet exemple renvoie les sys_id du catalogue actuel.

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

Sortie :

    e0d08b13c3330100c8b837659bba8fb4

## CatalogJS : getTitle() {#ariaid-title15}

Renvoie le titre du catalogue actuel.
{#CJS-getTitle__table_fxp_mxz_sbb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 25. Paramètres]

{#CJS-getTitle__table_fxp_mxz_sbb} {#CJS-getTitle__table_gxp_mxz_sbb__entry__2}

| Type | Description |
|-|-|
| Chaîne | Titre du catalogue actuel. |
[Tableau 26. Renvoie]

{#CJS-getTitle__table_gxp_mxz_sbb}  
Cet exemple renvoie le titre du catalogue actuel.

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

Sortie :

    Service Catalog

## CatalogJS : hasCategories() {#ariaid-title16}

Spécifie si le catalogue actuel comporte des catégories.
{#CJS-hasCategories__table_kwh_lsz_sbb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 27. Paramètres]

{#CJS-hasCategories__table_kwh_lsz_sbb} {#CJS-hasCategories__table_lwh_lsz_sbb__entry__2}

| Type | Description |
|-|-|
| Booléen | Marqueur qui indique si le catalogue actuel comporte des catégories. Valeurs valides : * true : le catalogue comporte des catégories. * faux : le catalogue n'a pas de catégories. {#CJS-hasCategories__ul_l1q_qn4_kpb} |
[Tableau 28. Renvoie]

{#CJS-hasCategories__table_lwh_lsz_sbb}  
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() {#ariaid-title17}

Spécifie si le catalogue actuel comporte des éléments de catalogue.
{#CJS-hasItems__table_abg_5wz_sbb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 29. Paramètres]

{#CJS-hasItems__table_abg_5wz_sbb} {#CJS-hasItems__table_bbg_5wz_sbb__entry__2}

| Type | Description |
|-|-|
| Booléen | Marqueur indiquant si le catalogue actuel comporte des éléments de catalogue. Valeurs valides : * true : le catalogue contient des éléments de catalogue. * faux : le catalogue n'a pas d'éléments de catalogue. {#CJS-hasItems__ul_l1q_qn4_kpb} |
[Tableau 30. Renvoie]

{#CJS-hasItems__table_bbg_5wz_sbb}  
Exemple :

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

Sortie :

    true

## CatalogJS : isWishlistEnabled() {#ariaid-title18}

Spécifie si la liste de souhaits est activée pour le catalogue actuel.
{#CJS-isWishlistEnabled__table_emb_xk2_sbb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 31. Paramètres]

{#CJS-isWishlistEnabled__table_emb_xk2_sbb} {#CJS-isWishlistEnabled__table_fmb_xk2_sbb__entry__2}

| 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. {#CJS-isWishlistEnabled__ul_l1q_qn4_kpb} |
[Tableau 32. Renvoie]

{#CJS-isWishlistEnabled__table_fmb_xk2_sbb}  
Cet exemple montre comment vérifier si une liste de souhaits est activée pour le catalogue actuel.

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

Sortie :

    true