---
sourceDocument: Interface do usuário da Now Platform Yokohama
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/yokohama/platform-user-interface

 Release :

    - yokohama

ft:locale :

    - pt-BR

ft:publication_title :

    - Interface do usuário da Now Platform Yokohama

ft:clusterId :

    - platux

bundleId :

    - platux

workflow :

    - Platform


---

# Referência da API do widget

# Referência da API do widget {#ariaid-title1}

* Versão de lançamento: Yokohama
* 
* Atualizado 30 de jan. de 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 min. de leitura

Portal de serviços Inclui APIs do lado do cliente e do servidor para usar nos scripts do cliente e do servidor do widget.

## Portal de serviços APIs do lado do cliente {#widget-api-reference__section_vcg_qkh_j1b}

Estes são Portal de serviçosAPIs que você pode usar em um controlador de cliente de widget.

Consulte a referência da API para obter informações detalhadas de classe e método.  
{#widget-api-reference__table_skq_rjp_h1b__entry__2}

| Classe | Descrição |
|-|-|
| [spAriaUtil](https://www.servicenow.com/docs/access?context=spAriaUtil-API&version=yokohama&pubname=yokohama-api-reference&ft:locale=en-US) | Mostra mensagens em um leitor de tela. |
| [SpContextManager](https://www.servicenow.com/docs/access?context=spContextManagerAPI&version=yokohama&pubname=yokohama-api-reference&ft:locale=en-US) | Cria dados de um Portal de serviçoswidget disponível para outras aplicações e serviços em um Portal de serviçospágina. Por exemplo, passe dados do widget para Bate-papo do agentequando ele abre em um Portal de serviçospágina. |
| [spUtil](https://www.servicenow.com/docs/access?context=spUtilAPI&version=yokohama&pubname=yokohama-api-reference&ft:locale=en-US) | Métodos de utilitário para executar funções comuns em um Portal de serviçosscript do cliente do widget. |
| [SpModal](https://www.servicenow.com/docs/access?context=SPModal-API&version=yokohama&pubname=yokohama-api-reference&ft:locale=en-US) | Mostra alertas, prompts e caixas de diálogo de confirmação em Portal de serviçoswidgets. . SpModal a classe está disponível em Portal de serviçosscripts do cliente. |
[ ]

{#widget-api-reference__table_skq_rjp_h1b}  
Nota:  
G_form como um objeto global não pode ser usado em um controlador de cliente de widget ou em um script de IU.

## Portal de serviços APIs do lado do servidor {#widget-api-reference__section_nhs_rkh_j1b}

Estes são Portal de serviçosAPIs que você pode usar em um script de servidor de widget.  
{#widget-api-reference__table_sfm_vjp_h1b__entry__2}

| Classe | Descrição |
|-|-|
| [GlideSPScriptable](https://www.servicenow.com/docs/access?context=c_GlideSPScriptableScopedAPI&version=yokohama&pubname=yokohama-api-reference&ft:locale=en-US) | . GlideSPScriptable A API fornece métodos para interagir com dados e executar operações de registro no Portal de serviçoswidgets. |
| [Pesquisa GlideSPSearchAnalytics](https://www.servicenow.com/docs/access?context=GlideSPSearchAnalyticsAPI&version=yokohama&pubname=yokohama-api-reference&ft:locale=en-US) | . Pesquisa GlideSPSearchAnalytics A API fornece métodos para gerar análise de pesquisa personalizada ServiceNowwidgets de pesquisa. |
| [SPScriptedFacet - Scoped](https://www.servicenow.com/docs/access?context=SPScriptedFacetScopedAPI&version=yokohama&pubname=yokohama-api-reference&ft:locale=en-US) | Define itens de aspecto, filtros ou consultas mapeadas para um objeto de facetas. |
| [SPScriptedFacetService - Scoped](https://www.servicenow.com/docs/access?context=SPScriptedFacetServiceScopedAPI&version=yokohama&pubname=yokohama-api-reference&ft:locale=en-US) | Gera um objeto de facetas de múltipla escolha ou de escolha única para uma origem de pesquisa avançada. |
| [SPSEOUtilsSNC - Global](https://www.servicenow.com/docs/access?context=SPSEOUtilsSNCAPI&version=yokohama&pubname=yokohama-api-reference&ft:locale=en-US) | Retorne URLs legíveis para uma página específica ou para a página atual, com base na solicitação de transação. |
| [SPWidgetAccessControl - Global](https://www.servicenow.com/docs/access?context=SPWidgetAccessControlGlobalAPI&version=yokohama&pubname=yokohama-api-reference&ft:locale=en-US) | Verifique se uma tabela fornecida tem acesso a um widget para garantir que um widget seja acessado com segurança por um público-alvo. |
[ ]

{#widget-api-reference__table_sfm_vjp_h1b}

## Propriedades do widget {#ariaid-title2}

Variáveis globais e funções disponíveis em scripts de cliente e servidor de widget.

### Objetos globais de script do servidor {#widget-script-reference__section_p2w_p5h_j1b}

{#widget-script-reference__table_kjh_2ff_dy__entry__2}

| Propriedade | Descrição |
|-|-|
| `entrada` | Um objeto que contém propriedades do lado do cliente definidas em `c.dados `. O valor é `indefinido `até que o controlador do cliente chame `c.server.update() `. |
| `dados` | Um objeto que contém propriedades definidas durante a execução no lado do servidor. |
| `opções` | Um objeto que contém as propriedades da opção de esquema. |
[ ]

{#widget-script-reference__table_kjh_2ff_dy}

### Funções globais de script do cliente {#widget-script-reference__section_mkf_dgs_f1b}

{#widget-script-reference__table_hdm_g3x_hw__entry__2}

| Propriedade | Descrição |
|-|-|
| `this.server.get([Object])` | Chama o servidor e envia personalizado `entrada `. Retorna `Promessa `. |
| `this.server.update()` | Chama o servidor e publica `estes.dados `para o script do servidor. Retorna `Promessa `. |
| `this.server.refresh()` | Chama o servidor e substitui automaticamente as opções atuais e os dados da resposta do servidor. Retorna `Promessa `. |
[ ]

{#widget-script-reference__table_hdm_g3x_hw}

R `promessa `representa o resultado eventual de uma operação assíncrona. Para obter mais informações sobre promessas, consulte <https://promisesaplus.com/>ou [AngularJS](https://docs.angularjs.org/api/ng/service/$q).

