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

# GlideSession - Global {#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 GlideSession fornece métodos para encontrar informações sobre a sessão atual.

## GlideSession -- clearClientData(cadeia de caracteres paramName) {#ariaid-title2}

Limpa um valor de cliente de sessão definido anteriormente com putClientData().
Este método é usado em um client script para limpar valores de dados que foram definidos por um script de servidor usando o método putClientData().
{#r_GlideSessionClearClientData_String__table_aw2_rsq_ks__entry__3}

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

{#r_GlideSessionClearClientData_String__table_aw2_rsq_ks} {#r_GlideSessionClearClientData_String__table_bw2_rsq_ks__entry__2}

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

{#r_GlideSessionClearClientData_String__table_bw2_rsq_ks}  

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

Saída:

    Harry
     
    null

## GlideSession -- getClientData(cadeia de caracteres paramName) {#ariaid-title3}

Retorna um valor de cliente de sessão definido anteriormente com putClientData().
Este método é usado em um client script para recuperar valores de dados que foram definidos por um script de servidor que usou o método putClientData() .
{#r_GlideSessionGetClientData_String__table_s1s_k5q_ks__entry__3}

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

{#r_GlideSessionGetClientData_String__table_s1s_k5q_ks} {#r_GlideSessionGetClientData_String__table_t1s_k5q_ks__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Os dados do cliente como uma cadeia de caracteres. |
[Tabela 4. Retorna]

{#r_GlideSessionGetClientData_String__table_t1s_k5q_ks}  

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

Saída:

    Harry

### Equivalente com escopo {#r_GlideSessionGetClientData_String__section_q2n_wgs_mcb}

Para usar o método getClientData() em uma aplicação com escopo, use o método com escopo correspondente: [getClientData()](https://servicenow-prod.fluidtopics.net/JkKoVjDBfUlhjdBuhYOkZw#r_ScopedGlideSessionGetClientData_String "Recupera um valor de cliente de sessão definido anteriormente com putClientData().").

## GlideSession -- getLanguage() {#ariaid-title4}

Obtém o código de idioma da sessão.
{#r_GlideSessionGetLanguage__table_mc5_dvq_ks__entry__3}

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

{#r_GlideSessionGetLanguage__table_mc5_dvq_ks} {#r_GlideSessionGetLanguage__table_nc5_dvq_ks__entry__2}

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

{#r_GlideSessionGetLanguage__table_nc5_dvq_ks}  

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

Saída:

    en

### Equivalente com escopo {#r_GlideSessionGetLanguage__section_arv_zgs_mcb}

Para usar o método getLanguage() em uma aplicação com escopo, use o método com escopo correspondente: [getLanguage()](https://servicenow-prod.fluidtopics.net/JkKoVjDBfUlhjdBuhYOkZw#r_ScopedGlideSessionGetLanguage "Retorna o código de idioma da sessão.").

## GlideSession -- getRoles() {#ariaid-title5}

Obtém uma lista de funções para o usuário atual.
A lista de funções não reflete as mudanças feitas durante a sessão do usuário atual. Para obter a lista atualizada de funções, o usuário deve fazer logout e login novamente.
{#r_GlideSessionGetRoles__table_bk4_qvq_ks__entry__3}

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

{#r_GlideSessionGetRoles__table_bk4_qvq_ks} {#r_GlideSessionGetRoles__table_ck4_qvq_ks__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Uma lista separada por vírgulas de funções. |
[Tabela 8. Retorna]

{#r_GlideSessionGetRoles__table_ck4_qvq_ks}  

    gs.info(gs.getSession().getRoles());

Saída:

    admin,hr_fulfiller,itsa_fulfiller,security_admin

## GlideSession -- getTimeZoneName() {#ariaid-title6}

Obtém o nome do fuso horário da sessão.
{#r_GlideSessionGetTimeZoneName__table_jzq_bwq_ks__entry__3}

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

{#r_GlideSessionGetTimeZoneName__table_jzq_bwq_ks} {#r_GlideSessionGetTimeZoneName__table_kzq_bwq_ks__entry__2}

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

{#r_GlideSessionGetTimeZoneName__table_kzq_bwq_ks}  

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

Saída:

    US/Pacific

### Equivalente com escopo {#r_GlideSessionGetTimeZoneName__section_gcb_chs_mcb}

Para usar o método getTimeZoneName() em uma aplicação com escopo, use o método com escopo correspondente: [getTimeZoneName()](https://servicenow-prod.fluidtopics.net/JkKoVjDBfUlhjdBuhYOkZw#r_ScopedGlideSessionGetTimeZoneName "Retorna o nome do fuso horário da sessão.").

## GlideSession -- isInteractive() {#ariaid-title7}

Determina se a sessão atual é 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_GlideSessionIsInteractive__table_j3c_mtq_ks__entry__3}

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

{#r_GlideSessionIsInteractive__table_j3c_mtq_ks} {#r_GlideSessionIsInteractive__table_k3c_mtq_ks__entry__2}

| Tipo | Descrição |
|-|-|
| Booliano | Verdadeiro se a sessão for interativa. |
[Tabela 12. Retorna]

{#r_GlideSessionIsInteractive__table_k3c_mtq_ks}  
Nota:  
O método isInteractive() sempre retornará um valor falso para todas as sessões de usuário que usam os aplicativos para celular clássicos ou atuais.  

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

Saída:

    false

### Equivalente com escopo {#r_GlideSessionIsInteractive__section_vl5_fhs_mcb}

Para usar o método isInteractive() em uma aplicação com escopo, use o método com escopo correspondente: [isInteractive()](https://servicenow-prod.fluidtopics.net/JkKoVjDBfUlhjdBuhYOkZw#r_ScopedGlideSessionIsInteractive "Retorna verdadeiro se a sessão for interativa.").

## GlideSession -- isLoggedIn() {#ariaid-title8}

Determina se o usuário atual está conectado no momento.
{#r_GlideSessionIsLoggedIn__table_kgj_ztq_ks__entry__3}

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

{#r_GlideSessionIsLoggedIn__table_kgj_ztq_ks} {#r_GlideSessionIsLoggedIn__table_lgj_ztq_ks__entry__2}

| Tipo | Descrição |
|-|-|
| Booliano | Verdadeiro se o usuário atual estiver conectado. |
[Tabela 14. Retorna]

{#r_GlideSessionIsLoggedIn__table_lgj_ztq_ks}  

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

Saída:

    true

### Equivalente com escopo {#r_GlideSessionIsLoggedIn__section_ey1_3hs_mcb}

Para usar o método isLoggedIn() em uma aplicação com escopo, use o método com escopo correspondente: [isLoggedIn()](https://servicenow-prod.fluidtopics.net/JkKoVjDBfUlhjdBuhYOkZw#r_ScopedGlideSessionIsLoggedIn "Retorna verdadeiro se o usuário estiver conectado.").

## GlideSession -- putClientData(cadeia de caracteres paramName, cadeia de caracteres paramValue) {#ariaid-title9}

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_GSSN-PutClientData_S_S__table_rms_lwq_ks__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| paramName | Cadeia de caracteres | Nome do parâmetro do cliente a ser definido. |
| paramValue | Cadeia de caracteres | Valor do parâmetro. |
[Tabela 15. Parâmetros]

{#r_GSSN-PutClientData_S_S__table_rms_lwq_ks} {#r_GSSN-PutClientData_S_S__table_sms_lwq_ks__entry__2}

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

{#r_GSSN-PutClientData_S_S__table_sms_lwq_ks}  

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

Saída:

    Harry

### Equivalente com escopo {#r_GSSN-PutClientData_S_S__section_bkp_5gs_mcb}

Para usar o método putClientData() em uma aplicação com escopo, use o método com escopo correspondente: [putClientData()](https://servicenow-prod.fluidtopics.net/JkKoVjDBfUlhjdBuhYOkZw#r_ScopedGlideSessionPutClientData_String_String "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.").