---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# CatalogJS - com escopo

# CatalogJS - com escopo {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 5 min. de leitura

A API CatalogJS fornece métodos para verificar e recuperar propriedades específicas do catálogo.

Para usar esta classe em uma aplicação com escopo, use o identificador de namespace `sn_sc`. O plug-in API com escopo do Catálogo de serviços (com.glideapp.servicecatalog.scoped.api) habilitado por padrão é necessário para acessar a API CatalogJS.

## CatalogJS -- Catálogo (GlideRecord now_GR) {#ariaid-title2}

Cria uma instância da classe de catálogo para o objeto de registro do Glide especificado.
{#CJS-Catalog_G__table_og2_g1c_5bb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| now_GR | Objeto | Registro do Glide que aponta para a tabela sc_catalog. |
[Tabela 1. Parâmetros]

{#CJS-Catalog_G__table_og2_g1c_5bb}  
Este exemplo mostra como criar uma nova instância da classe de catálogo.

    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 - Catálogo (cadeia de caracteres sys_id) {#ariaid-title3}

Cria uma instância da classe Catálogo com o sys_id especificado.
{#CJS-Catalog_S__table_tf1_gbc_5bb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| sys_id | Cadeia de caracteres | Sys_id do catálogo. |
[Tabela 2. Parâmetros]

{#CJS-Catalog_S__table_tf1_gbc_5bb}  
Este exemplo mostra como criar uma instância da classe Catálogo com o syst_id especificado.

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

## CatalogJS - canView (booliano móvel, cadeia de caracteres userId) {#ariaid-title4}

Determina se um usuário pode exibir a categoria atual em um dispositivo móvel ou desktop.
{#CJS-canView_B__table_mnl_2lz_sbb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| para celular | Booliano | Sinalizador que indica se deve ser verificado se o usuário pode exibir o catálogo atual em uma exibição móvel ou de desktop. Valores válidos: * verdadeiro: exibição móvel * falso: exibição da área de trabalho {#CJS-canView_B__ul_qfp_cb4_kpb} |
| userId | Cadeia de caracteres | Opcional. Sys_id do usuário para verificar se ele pode exibir o catálogo. Padrão: usuário atual |
[Tabela 3. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Booliano | Sinalizador que indica se o catálogo pode ser visualizado pelo usuário. Valores válidos: * verdadeiro: o catálogo pode ser visualizado pelo usuário. * falso: o catálogo não pode ser visualizado pelo usuário. {#CJS-canView_B__ul_wbn_mb4_kpb} |
[Tabela 4. Retorna]

{#CJS-canView_B__table_nnl_2lz_sbb}  
Exemplo:

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

Saída:

    true

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

Retorna o catálogo ativo disponível.
Se houver apenas um catálogo ativo, o método retornará esse catálogo. Caso contrário, ele retornará o catálogo mais antigo criado a partir da lista de catálogos que o usuário pode exibir. Se nenhum catálogo estiver disponível, o método retornará nulo.
{#CJS-getAvailableCatalog__table_m31_rmz_sbb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 5. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Objeto | Objeto que aponta para o catálogo mais antigo que o usuário pode exibir ou nulo se nenhum catálogo estiver disponível. |
[Tabela 6. Retorna]

{#CJS-getAvailableCatalog__table_n31_rmz_sbb}  
Este exemplo retorna o catálogo que está disponível para o usuário atual.

    var catalog = sn_sc.Catalog.getAvailableCatalog()

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

Retorna a cor de fundo do catálogo.
{#CJS-getBackgroundColor__table_etj_mrz_sbb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 7. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Cor de fundo do catálogo. |
[Tabela 8. Retorna]

{#CJS-getBackgroundColor__table_ftj_mrz_sbb}  
Este exemplo retorna a cor de fundo do catálogo associado.

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

Saída:

    Catalog background: white

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

Retorna o número de catálogos ativos na tabela de catálogos.
{#CJS-getCatalogCount__table_ez1_znz_sbb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 9. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Inteiro | Número de catálogos disponíveis na tabela de catálogos. |
[Tabela 10. Retorna]

{#CJS-getCatalogCount__table_fz1_znz_sbb}  
Exemplo:

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

Saída:

    3

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

Retorna as categorias do catálogo atual.
{#CJS-getCategories__table_nwt_l4z_sbb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 11. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| ArrayList | Retorna as categorias do catálogo atual. |
[Tabela 12. Retorna]

{#CJS-getCategories__table_owt_l4z_sbb}  
Este exemplo retorna as categorias disponíveis no objeto de catálogo atual.

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

Saída:

    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}

Especifica os sys_ids das categorias no catálogo atual.
{#CJS-getCategoryIds__table_ivv_3pz_sbb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 13. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| ArrayList | Retorna os sys_ids das categorias no catálogo atual. |
[Tabela 14. Retorna]

{#CJS-getCategoryIds__table_jvv_3pz_sbb}  
Este exemplo retorna os sys_ids das categorias disponíveis no catálogo atual.

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

Saída:

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

## CatalogJS - getDescription() {#ariaid-title10}

Retorna a descrição do catálogo atual.
{#CJS-getDescription__table_g5q_3qz_sbb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 15. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Descrição do catálogo. |
[Tabela 16. Retorna]

{#CJS-getDescription__table_h5q_3qz_sbb}  
Este exemplo retorna o nome do catálogo atual.

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

Saída:

    Service Catalog - IT Now

## CatalogJS - getDesktopImageSRC() {#ariaid-title11}

Retorna o nome do arquivo de imagem da área de trabalho do catálogo.
{#CJS-getDesktopImageSRC__table_zdf_csz_sbb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 17. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Nome do arquivo de imagem da área de trabalho do catálogo. |
[Tabela 18. Retorna]

{#CJS-getDesktopImageSRC__table_a2f_csz_sbb}  
Este exemplo retorna o nome do arquivo de imagem da área de trabalho do catálogo atual.

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

Saída:

    adbcc271475211002ee987e8dee49001.iix

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

Retorna o GlideRecord do catálogo atual.
{#CJS-getGr__table_vdd_rqz_sbb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 19. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| GlideRecord | GlideRecord do catálogo atual. |
[Tabela 20. Retorna]

{#CJS-getGr__table_wdd_rqz_sbb}  
Este exemplo retorna o GlideRecord do catálogo especificado.

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

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

Retorna o ícone de cabeçalho do catálogo atual.
{#CJS-getHeaderIconSRC__table_xsg_5rz_sbb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 21. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Ícone do cabeçalho do catálogo. |
[Tabela 22. Retorna]

{#CJS-getHeaderIconSRC__table_ysg_5rz_sbb}  
Este exemplo mostra como obter o nome do ícone do cabeçalho do catálogo.

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

Saída:

    service_catalog_header.png

## CatalogJS - getID() {#ariaid-title14}

Retorna o sys_id do catálogo atual.
{#CJS-getID__table_xqx_xpz_sbb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 23. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Sys_id do catálogo atual. |
[Tabela 24. Retorna]

{#CJS-getID__table_yqx_xpz_sbb}  
Este exemplo retorna o sys_id do catálogo atual.

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

Saída:

    e0d08b13c3330100c8b837659bba8fb4

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

Retorna o título do catálogo atual.
{#CJS-getTitle__table_fxp_mxz_sbb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 25. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Título do catálogo atual. |
[Tabela 26. Retorna]

{#CJS-getTitle__table_gxp_mxz_sbb}  
Este exemplo retorna o título do catálogo atual.

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

Saída:

    Service Catalog

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

Especifica se o catálogo atual tem categorias.
{#CJS-hasCategories__table_kwh_lsz_sbb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 27. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Booliano | Sinalizador que indica se o catálogo atual tem categorias. Valores válidos: * verdadeiro: o catálogo tem categorias. * falso: o catálogo não tem categorias. {#CJS-hasCategories__ul_l1q_qn4_kpb} |
[Tabela 28. Retorna]

{#CJS-hasCategories__table_lwh_lsz_sbb}  
Este exemplo mostra como determinar se o catálogo atual contém categorias.

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

Saída:

    false

## CatalogJS - hasItems() {#ariaid-title17}

Especifica se o catálogo atual tem itens do catálogo.
{#CJS-hasItems__table_abg_5wz_sbb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 29. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Booliano | Sinalizador que indica se o catálogo atual tem itens do catálogo. Valores válidos: * verdadeiro: o catálogo tem itens do catálogo. * falso: o catálogo não tem itens do catálogo. {#CJS-hasItems__ul_l1q_qn4_kpb} |
[Tabela 30. Retorna]

{#CJS-hasItems__table_bbg_5wz_sbb}  
Exemplo:

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

Saída:

    true

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

Especifica se a lista de desejos está habilitada para o catálogo atual.
{#CJS-isWishlistEnabled__table_emb_xk2_sbb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 31. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Booliano | Sinalizador que indica se o catálogo atual oferece suporte a listas de desejos. Valores válidos: * verdadeiro: o catálogo oferece suporte a listas de desejos. * falso: o catálogo não é compatível com listas de desejos. {#CJS-isWishlistEnabled__ul_l1q_qn4_kpb} |
[Tabela 32. Retorna]

{#CJS-isWishlistEnabled__table_fmb_xk2_sbb}  
Este exemplo mostra como verificar se uma lista de desejos está habilitada para o catálogo atual.

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

Saída:

    true