CatalogJS - Com escopo

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 5 min. de leitura

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

    Para usar esta classe em uma aplicação com escopo, use sn_sc identificador de namespace. 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 o. CatalogJS API.

    CatalogJS - Catálogo (GlideRecord now_GR)

    Cria uma instância da classe de catálogo para o objeto de registro do Glide especificado.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    Now_GR Objeto Registro do Glide apontando para a tabela sc_catalog.

    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)

    Cria uma instância da classe Catálogo com o sys_id especificado.

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

    Este exemplo mostra como criar uma instância da classe Catálogo com o sys_id especificado.

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

    CatalogJS - canView (booliano para celular, cadeia de caracteres UserId)

    Determina se um usuário pode exibir a categoria atual em um dispositivo móvel ou desktop.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    móvel Booliano

    Sinalizador que indica se o usuário pode exibir o catálogo atual em uma exibição para celular ou desktop.

    Valores válidos:
    • Verdadeiro: Exibição móvel
    • Falso: Exibição da área de trabalho
    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 4. Retornos
    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.

    Exemplo:

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

    Saída:

    true

    CatalogJS - getAvailableCatalog()

    Retorna o catálogo ativo disponível.

    Se houver apenas um catálogo ativo, o método retornará esse catálogo. Caso contrário, retornará o catálogo mais antigo criado na lista de catálogos que o usuário pode exibir. Se nenhum catálogo estiver disponível, o método retornará nulo.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 6. Retorna
    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.

    Este exemplo retorna o catálogo que está disponível para o usuário atual.

    var catalog = sn_sc.Catalog.getAvailableCatalog()

    CatalogJS - getBackgroundColor()

    Retorna a cor de fundo do catálogo.

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 8. Retorna
    Tipo Descrição
    Cadeia de caracteres Cor de fundo do catálogo.

    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()

    Retorna o número de catálogos ativos na tabela de catálogo.

    Tabela 9. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 10. Retorna
    Tipo Descrição
    Inteiro Número de catálogos disponíveis na tabela de catálogo.

    Exemplo:

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

    Saída:

    3

    CatalogJS - getCategories()

    Retorna as categorias do catálogo atual.

    Tabela 11. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 12. Retorna
    Tipo Descrição
    ArrayList Retorna as categorias do catálogo atual.

    Este exemplo retorna as categorias disponíveis no objeto do 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()

    Especifica os sys_ids das categorias no catálogo atual.

    Tabela 13. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 14. Retorna
    Tipo Descrição
    ArrayList Retorna os sys_ids das categorias no catálogo atual.

    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()

    Retorna a descrição do catálogo atual.

    Tabela 15. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 16. Retorna
    Tipo Descrição
    Cadeia de caracteres Descrição do catálogo.

    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 - getDesktoImageSRC()

    Retorna o nome do arquivo de imagem da área de trabalho do catálogo.

    Tabela 17. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 18. Retorna
    Tipo Descrição
    Cadeia de caracteres Nome do arquivo de imagem da área de trabalho do catálogo.

    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()

    Retorna o GlideRecord do catálogo atual.

    Tabela 19. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 20. Retorna
    Tipo Descrição
    GlideRecord GlideRecord do catálogo atual.

    Este exemplo retorna o GlideRecord do catálogo especificado.

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

    CatalogJS - getHeaderIconSRC()

    Retorna o ícone de cabeçalho do catálogo atual.

    Tabela 21. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 22. Retorna
    Tipo Descrição
    Cadeia de caracteres Ícone de cabeçalho do catálogo.

    Este exemplo mostra como obter o nome do ícone de cabeçalho do catálogo.

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

    Saída:

    service_catalog_header.png

    CatalogJS - getID()

    Retorna o sys_id do catálogo atual.

    Tabela 23. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 24. Retorna
    Tipo Descrição
    Cadeia de caracteres Sys_id do catálogo atual.

    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()

    Retorna o título do catálogo atual.

    Tabela 25. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 26. Retorna
    Tipo Descrição
    Cadeia de caracteres Título do catálogo atual.

    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()

    Especifica se o catálogo atual tem categorias.

    Tabela 27. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 28. Retorna
    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.

    Estes exemplos mostram 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()

    Especifica se o catálogo atual tem itens do catálogo.

    Tabela 29. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 30. Retorna
    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.

    Exemplo:

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

    Saída:

    true

    CatalogJS - isWishlistEnabled()

    Especifica se a lista de desejos está habilitada para o catálogo atual.

    Tabela 31. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 32. Retorna
    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.

    Este exemplo mostra como verificar se as listas de desejos estão habilitadas para o catálogo atual.

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

    Saída:

    true