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


---

# GlideSession - com escopo

# GlideSession - 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) 4 min. de leitura

A API GlideSession com escopo fornece métodos para encontrar informações sobre a sessão atual.

Não há construtores para criar uma instância de um objeto GlideSession com escopo. Em vez disso, use o método getSession() da API GlideSystem com escopo.

## GlideSession com escopo - getClientData(String paramName) {#ariaid-title2}

Recupera um valor de cliente de sessão definido anteriormente com putClientData().
Use este método para recuperar valores de dados que foram definidos usando o método putClientData().
{#r_ScopedGlideSessionGetClientData_String__table_j24_fqk_ls__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| paramName | Cadeia de caracteres | Nome dos dados do cliente a serem recuperados. |
[Tabela 1. Parâmetros]

{#r_ScopedGlideSessionGetClientData_String__table_j24_fqk_ls} {#r_ScopedGlideSessionGetClientData_String__table_k24_fqk_ls__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Dados do cliente. |
[Tabela 2. Retorna]

{#r_ScopedGlideSessionGetClientData_String__table_k24_fqk_ls}  

    var session = gs.getSession();
    session.putClientData('test1', 'Harry');
    var clientData = session.getClientData('test1');
    gs.info(clientData);

Saída:

    Harry

## GlideSession com escopo - getClientIP() {#ariaid-title3}

Retorna o endereço IP do cliente.
{#r_ScopedGlideSessionGetClientIP__table_gcx_wqk_ls__entry__3}

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

{#r_ScopedGlideSessionGetClientIP__table_gcx_wqk_ls} {#r_ScopedGlideSessionGetClientIP__table_hcx_wqk_ls__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Endereço IP. |
[Tabela 4. Retorna]

{#r_ScopedGlideSessionGetClientIP__table_hcx_wqk_ls}  

    var session = gs.getSession();
    var addr = session.getClientIP();
    gs.info(addr);

Saída:

    50.59.164.97

## GlideSession com escopo - getCurrentApplicationId() {#ariaid-title4}

Retorna a aplicação selecionada no momento no seletor de aplicações.
Este método requer privilégios de administrador.
{#r_ScopedGlideSessionGetCurrentApplicationId__table_br3_jrk_ls__entry__3}

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

{#r_ScopedGlideSessionGetCurrentApplicationId__table_br3_jrk_ls} {#r_ScopedGlideSessionGetCurrentApplicationId__table_cr3_jrk_ls__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Aplicação selecionada no momento. |
[Tabela 6. Retorna]

{#r_ScopedGlideSessionGetCurrentApplicationId__table_cr3_jrk_ls}  

    var session = gs.getSession();
    var appID = session.getCurrentApplicationId();
    gs.info(appID);

Saída:

    ce05b9f32b840200c5244f74b4da1501

## GlideSession com escopo - getCurrentDomainID() {#ariaid-title5}

Retorna o sys_id do domínio atual da sessão do usuário conectado.
O identificador retornado depende do tipo de domínio e da instanciação desse domínio.

* Se o usuário estiver configurado no domínio global e não usar o seletor de domínio para alternar os domínios, o método retornará nulo.
* Se o usuário usar o seletor de domínio para alternar para o domínio global, o método retornará a cadeia de caracteres "global".
* Para todos os outros domínios, o método retorna o sys_id desse domínio.
{#GSS-getCurrentDomainID__table_jcl_vvq_xnb__entry__3}

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

{#GSS-getCurrentDomainID__table_jcl_vvq_xnb} {#GSS-getCurrentDomainID__table_kcl_vvq_xnb__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Sys_id do domínio da sessão do usuário conectado no momento. Essas são as mesmas informações que aparecem no seletor de domínio. |
[Tabela 8. Retorna]

{#GSS-getCurrentDomainID__table_kcl_vvq_xnb}  
Este exemplo mostra o domínio do registro sys_email atual que está sendo definido para o domínio da sessão do usuário, se o domínio do usuário for global ou nulo.

    // Set domain based on parent record's domain
    setDomain();

    // If the domain is global, set to user's domain
    if (current.sys_domain == 'global' || current.sys_domain.nil())
       current.sys_domain = gs.getSession().getCurrentDomainID();

    function setDomain() {
       if (current.target_table.nil())
          return;

       var d = new GlideRecord(current.target_table);
       if (!d.isValid())
          return;

       if (!d.get('sys_id', current.instance))
          return;

       if (typeof(d.sys_domain) == 'object')
          current.sys_domain = d.sys_domain;

## GlideSession com escopo - getLanguage() {#ariaid-title6}

Retorna o código de idioma da sessão.
{#r_ScopedGlideSessionGetLanguage__table_chb_wrk_ls__entry__3}

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

{#r_ScopedGlideSessionGetLanguage__table_chb_wrk_ls} {#r_ScopedGlideSessionGetLanguage__table_dhb_wrk_ls__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Código de idioma da sessão. |
[Tabela 10. Retorna]

{#r_ScopedGlideSessionGetLanguage__table_dhb_wrk_ls}  

    var session = gs.getSession();
    var language = session.getLanguage();
    gs.info(language);

Saída:

    en

## GlideSession com escopo - getSessionToken() {#ariaid-title7}

Retorna o token da sessão.
{#r_ScopedGlideSessionGetSessionToken__table_g2l_gsk_ls__entry__3}

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

{#r_ScopedGlideSessionGetSessionToken__table_g2l_gsk_ls} {#r_ScopedGlideSessionGetSessionToken__table_h2l_gsk_ls__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Token de sessão. |
[Tabela 12. Retorna]

{#r_ScopedGlideSessionGetSessionToken__table_h2l_gsk_ls}  

    var session = gs.getSession();
    var token = session.getSessionToken();
    gs.info(token);

Saída:

    4284b5372b840200c5244f74b4da15f2c3476cf7fcb6572afa4ef9d5e6d307a5fd9e1da7

## GlideSession com escopo - getTimeZoneName() {#ariaid-title8}

Retorna o nome do fuso horário da sessão.
{#r_ScopedGlideSessionGetTimeZoneName__table_tws_qsk_ls__entry__3}

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

{#r_ScopedGlideSessionGetTimeZoneName__table_tws_qsk_ls} {#r_ScopedGlideSessionGetTimeZoneName__table_uws_qsk_ls__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Nome do fuso horário da sessão. |
[Tabela 14. Retorna]

{#r_ScopedGlideSessionGetTimeZoneName__table_uws_qsk_ls}  

    var session = gs.getSession();
    var zoneName = session.getTimeZoneName();
    gs.info(zoneName);

Saída:

    US/Pacific

## GlideSession com escopo - getUrlOnStack() {#ariaid-title9}

Retorna o URL na pilha. Retorna nulo se a pilha estiver vazia.
{#r_ScopedGlideSessionGetUrlOnStack__table_qhx_ctk_ls__entry__3}

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

{#r_ScopedGlideSessionGetUrlOnStack__table_qhx_ctk_ls} {#r_ScopedGlideSessionGetUrlOnStack__table_rhx_ctk_ls__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | URL na pilha. Retorna nulo se a pilha estiver vazia. |
[Tabela 16. Retorna]

{#r_ScopedGlideSessionGetUrlOnStack__table_rhx_ctk_ls}  

    var session = gs.getSession();
    var URL = session.getUrlOnStack();
    gs.info(URL);

Saída: quebras de linha adicionadas para maior clareza.

    sys_app.do?sys_id=ce05b9f32b840200c5244f74b4da1501&sysparm_goto_url=sys_app.do
    %3Fsys_id%3Dce05b9f32b840200c5244f74b4da1501

## GlideSession com escopo - isImpersonating() {#ariaid-title10}

Retorna verdadeiro se o usuário estiver representando outro usuário.
{#r_SGSSN-isImpersonating__table_rhv_tj5_xw__entry__3}

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

{#r_SGSSN-isImpersonating__table_rhv_tj5_xw} {#r_SGSSN-isImpersonating__table_shv_tj5_xw__entry__2}

| Tipo | Descrição |
|-|-|
| Booliano | Sinalizador que indica que o usuário está representando outro usuário. Valores possíveis: * verdadeiro: o usuário está representando. * falso: o usuário não está representando. |
[Tabela 18. Retorna]

{#r_SGSSN-isImpersonating__table_shv_tj5_xw}  

    var isImpersonator = gs.getSession().isImpersonating();
    gs.info(isImpersonator);

## GlideSession com escopo - isInteractive() {#ariaid-title11}

Retorna verdadeiro se a sessão for interativa.
Uma sessão interativa é aquela que envolve um usuário final interagindo com uma interface do usuário que recupera informações de um servidor. Um exemplo desse tipo de sessão é quando um usuário faz login usando a tela de login ou usa um formulário para consultar um armazenamento de dados. Uma sessão não interativa é aquela que envolve apenas interação programática com um servidor, como uma solicitação SOAP para recuperar dados.
{#r_ScopedGlideSessionIsInteractive__table_fjc_dpk_ls__entry__3}

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

{#r_ScopedGlideSessionIsInteractive__table_fjc_dpk_ls} {#r_ScopedGlideSessionIsInteractive__table_gjc_dpk_ls__entry__2}

| Tipo | Descrição |
|-|-|
| Booliano | Sinalizador que indica se a sessão é interativa. Valores possíveis: * verdadeiro: a sessão é interativa. * falso: a sessão não é interativa. |
[Tabela 20. Retorna]

{#r_ScopedGlideSessionIsInteractive__table_gjc_dpk_ls}  

    var interActive = gs.getSession().isInteractive();
    gs.info(interActive);

## GlideSession com escopo - isLoggedIn() {#ariaid-title12}

Retorna verdadeiro se o usuário estiver conectado.
{#r_ScopedGlideSessionIsLoggedIn__table_phb_qpk_ls__entry__3}

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

{#r_ScopedGlideSessionIsLoggedIn__table_phb_qpk_ls} {#r_ScopedGlideSessionIsLoggedIn__table_qhb_qpk_ls__entry__2}

| Tipo | Descrição |
|-|-|
| Booliano | Sinalizador que indica se o usuário está conectado Valores possíveis: * verdadeiro: o usuário está conectado. * falso: o usuário não está conectado. |
[Tabela 22. Retorna]

{#r_ScopedGlideSessionIsLoggedIn__table_qhb_qpk_ls}  

    var session = gs.getSession();
    var loggedIn = session.isLoggedIn();
    gs.info(loggedIn);

Saída:

    true

## GlideSession com escopo - putClientData(cadeia de caracteres paramName, cadeia de caracteres paramValue) {#ariaid-title13}

Define um valor de cliente de sessão que pode ser recuperado com getClientData(). Este método é usado em um script do lado do servidor que é executado quando um formulário é criado.
{#r_ScopedGlideSessionPutClientData_String_String__table_cgh_ytk_ls__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| paramName | Cadeia de caracteres | Nome dos dados do cliente a serem definidos. |
| paramValue | Cadeia de caracteres | Valor dos dados do cliente. |
[Tabela 23. Parâmetros]

{#r_ScopedGlideSessionPutClientData_String_String__table_cgh_ytk_ls} {#r_ScopedGlideSessionPutClientData_String_String__table_dgh_ytk_ls__entry__2}

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

{#r_ScopedGlideSessionPutClientData_String_String__table_dgh_ytk_ls}  

    var session = gs.getSession();
    session.putClientData('test1', 'Harry');
    var clientData = session.getClientData('test1');
    gs.info(clientData);

Saída:

    Harry