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


---

# CatalogClientScript - com escopo

# CatalogClientScript - 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) 3 min. de leitura

A API CatalogClientScript fornece métodos que permitem criar, modificar ou excluir registros de client script de 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 (ID: com.glideapp.servicecatalog.scoped.api) habilitado por padrão é necessário para acessar a API CatalogClientScript.

## CatalogClientScript - CatalogClientScript() {#ariaid-title2}

Cria uma instância da classe CatalogClientScript.
{#r_CCSS-CatalogClientScript__table_hlv_q2c_1z__entry__3}

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

{#r_CCSS-CatalogClientScript__table_hlv_q2c_1z}  

    var catalogClientScript = new sn_sc.CatalogClientScript();

## CatalogClientScript - addScript(cadeia de caracteres script) {#ariaid-title3}

Adiciona um script ao client script do catálogo.
{#r_CCSS-addScript_S__table_m1v_1ds_sy__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| script | Cadeia de caracteres | Script a ser adicionado ao client script do catálogo. |
[Tabela 2. Parâmetros]

{#r_CCSS-addScript_S__table_m1v_1ds_sy} {#r_CCSS-addScript_S__table_n1v_1ds_sy__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 3. Retorna]

{#r_CCSS-addScript_S__table_n1v_1ds_sy}  
Este exemplo mostra como chamar este método.

    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.addScript("function onLoad(){Enter the script}");

## CatalogClientScript - applyToCatalogItem(sinalizador booliano) {#ariaid-title4}

Especifica se o client script do catálogo é executado em um item do catálogo.
{#r_CCSS-appliesToCatalogItem_B__table_zsm_rzr_sy__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| sinalizador | Booliano | Se verdadeiro, o client script do catálogo será executado no item do catálogo. Se falso, o client script do catálogo não será executado no item do catálogo. |
[Tabela 4. Parâmetros]

{#r_CCSS-appliesToCatalogItem_B__table_zsm_rzr_sy} {#r_CCSS-appliesToCatalogItem_B__table_atm_rzr_sy__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 5. Retorna]

{#r_CCSS-appliesToCatalogItem_B__table_atm_rzr_sy}  

    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.appliesToCatalogItem(true);

## CatalogClientScript - applyToCatalogTask (sinalizador booliano) {#ariaid-title5}

Especifica se o client script do catálogo é executado em uma tarefa de catálogo.
{#r_CCSS-appliesToCatalogTask_B__table_tqp_n2s_sy__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| sinalizador | Booliano | Se verdadeiro, o script do cliente do catálogo será executado na tarefa do catálogo. Se falso, o script do cliente do catálogo não será executado na tarefa do catálogo. |
[Tabela 6. Parâmetros]

{#r_CCSS-appliesToCatalogTask_B__table_tqp_n2s_sy} {#r_CCSS-appliesToCatalogTask_B__table_uqp_n2s_sy__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 7. Retorna]

{#r_CCSS-appliesToCatalogTask_B__table_uqp_n2s_sy}  
Este exemplo mostra como chamar este método.

    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.appliesToCatalogTask(true);

## CatalogClientScript - applyToRequestedItem(sinalizador booliano) {#ariaid-title6}

Especifica se o client script do catálogo é executado em um item solicitado.
{#r_CCSS-appliesToRequestedItem_B__table_rsq_p1s_sy__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| sinalizador | Booliano | Se verdadeiro, o client script do catálogo será executado no item solicitado. Se falso, o client script do catálogo não será executado no item solicitado. |
[Tabela 8. Parâmetros]

{#r_CCSS-appliesToRequestedItem_B__table_rsq_p1s_sy} {#r_CCSS-appliesToRequestedItem_B__table_ssq_p1s_sy__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 9. Retorna]

{#r_CCSS-appliesToRequestedItem_B__table_ssq_p1s_sy}  
Este exemplo mostra como chamar o método.

    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.appliesToRequestedItem(true);

## CatalogClientScript - applyToTargetRecord (sinalizador booliano) {#ariaid-title7}

Especifica se o client script do catálogo é executado em um item solicitado.
{#r_CCSS-appliesToTargetRecord_B__table_hwy_44l_5z__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| sinalizador | Booliano | Se verdadeiro, o client script do catálogo será executado no registro de destino. Se falso, o client script do catálogo não será executado no registro de destino. |
[Tabela 10. Parâmetros]

{#r_CCSS-appliesToTargetRecord_B__table_hwy_44l_5z} {#r_CCSS-appliesToTargetRecord_B__table_iwy_44l_5z__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 11. Retorna]

{#r_CCSS-appliesToTargetRecord_B__table_iwy_44l_5z}  
Este exemplo mostra como chamar o método.

    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.appliesToTargetRecord(true);

## CatalogClientScript - create(Boolean StandardUpdate) {#ariaid-title8}

Insere o script do cliente de catálogo definido na tabela catalog_script_client.
{#r_CCSS-create_B__table_kj1_xbs_kx__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| padrãoAtualizar | Booliano | Sinalizador que indica se a execução de mecanismos e fluxos de trabalho deve ser habilitada. Valores válidos: * verdadeiro: habilitar mecanismos e fluxo de trabalho. * falso: não habilite mecanismos e fluxo de trabalho. {#r_CCSS-create_B__ul_nnx_xwn_kpb} |
[Tabela 12. Parâmetros]

{#r_CCSS-create_B__table_kj1_xbs_kx} {#r_CCSS-create_B__table_lj1_xbs_kx__entry__2}

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

{#r_CCSS-create_B__table_lj1_xbs_kx}  
Este exemplo mostra como chamar o método.

    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.setAttributes({"name": "My Catalog Item", "applies_to": "item", "ui_type": "desktop", "type": "onLoad"});
    catalogClientScript.appliesToCatalogItem(true);
    catalogClientScript.appliesToRequestedItem(true);
    catalogClientScript.appliesToCatalogTask(true);
    catalogClientScript.appliesToTargetRecord(true);
    var catalogClientScriptId = catalogClientScript.create();
    gs.info(catalogClientScriptId);

Saída:

    039c516237b1300054b6a3549dbe5dfc

## CatalogClientScript - deleteRecord(cadeia de caracteres sys_id, Booliano StandardUpdate) {#ariaid-title9}

Exclui o client script do catálogo definido.
{#r_CCSS-deleteRecord_S_B__table_jdv_hsz_qy__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| sys_id | Cadeia de caracteres | Sys_id do client script do catálogo. |
| padrãoAtualizar | Booliano | Sinalizador que indica se a execução de mecanismos e fluxos de trabalho deve ser habilitada. Valores válidos: * verdadeiro: habilitar mecanismos e fluxo de trabalho. * falso: não habilite mecanismos e fluxo de trabalho. {#r_CCSS-deleteRecord_S_B__ul_nnx_xwn_kpb} |
[Tabela 14. Parâmetros]

{#r_CCSS-deleteRecord_S_B__table_jdv_hsz_qy} {#r_CCSS-deleteRecord_S_B__table_kdv_hsz_qy__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 15. Retorna]

{#r_CCSS-deleteRecord_S_B__table_kdv_hsz_qy}  
O exemplo a seguir mostra como excluir um client script de catálogo.

    var sys_id = "039c516237b1300054b6a3549dbe5dfc"; 
    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.deleteRecord("039c516237b1300054b6a3549dbe5dfc");

## CatalogClientScript - setAttributes(Mapear atributos) {#ariaid-title10}

Define valores de atributo para o client script do catálogo.
{#r_CCSS-setAttributes_M__table_fyy_tyr_sy__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| atributos | Mapa | Um objeto JSON que tem mapeamento para os pares de campo e valor. |
[Tabela 16. Parâmetros]

{#r_CCSS-setAttributes_M__table_fyy_tyr_sy} {#r_CCSS-setAttributes_M__table_gyy_tyr_sy__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 17. Retorna]

{#r_CCSS-setAttributes_M__table_gyy_tyr_sy}  
Este exemplo mostra como chamar o método.

    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.setAttributes({"name": "My Catalog Item", "applies_to": "catalog_item", "ui_type": "desktop", "type": "onLoad"});

## CatalogClientScript -- setCatalogItem(cadeia de caracteres sys_id) {#ariaid-title11}

Associa um item do catálogo ao client script do catálogo.
{#r_CCSS-setCatalogItem_S__table_v3g_zds_sy__entry__3}

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

{#r_CCSS-setCatalogItem_S__table_v3g_zds_sy} {#r_CCSS-setCatalogItem_S__table_w3g_zds_sy__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 19. Retorna]

{#r_CCSS-setCatalogItem_S__table_w3g_zds_sy}  
Este exemplo mostra como associar um item do catálogo ao client script do catálogo atual.

    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.setCatalogItem("039c516237b1300054b6a3549dbe5dfc");

## CatalogClientScript -- setOnChangeVariable(cadeia de caracteres sys_id) {#ariaid-title12}

Executa o client script do catálogo quando um valor de variável é atualizado.
{#r_CCSS-setOnChangeVariable_S__table_m3r_3cs_sy__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| sys_id | Cadeia de caracteres | Sys_id da variável. |
[Tabela 20. Parâmetros]

{#r_CCSS-setOnChangeVariable_S__table_m3r_3cs_sy} {#r_CCSS-setOnChangeVariable_S__table_n3r_3cs_sy__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 21. Retorna]

{#r_CCSS-setOnChangeVariable_S__table_n3r_3cs_sy}  
Este exemplo mostra como chamar o método.

    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.setOnChangeVariable("039c516237b1300054b6a3549dbe5dfc");

## CatalogClientScript - setVariableSet(cadeia de caracteres sys_id) {#ariaid-title13}

Associa um conjunto de variáveis ao client script do catálogo.
{#r_CCSS-setVariableSet_S__table_cvz_tbs_sy__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| sys_id | Cadeia de caracteres | Sys_id do conjunto de variáveis. |
[Tabela 22. Parâmetros]

{#r_CCSS-setVariableSet_S__table_cvz_tbs_sy} {#r_CCSS-setVariableSet_S__table_dvz_tbs_sy__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 23. Retorna]

{#r_CCSS-setVariableSet_S__table_dvz_tbs_sy}  
Este exemplo mostra como chamar o método.

    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.setVariableSet("039c516237b1300054b6a3549dbe5dfc");