GlideList (Now Experience) – Cliente

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 8 min. de leitura

    • A API GlideList fornece métodos para personalizar listas no Estrutura de IU do Next Experience.

    Esta API permite adicionar a funcionalidade GlideList a um botão na IU Experiência com o espaço. Use a variável g_list para chamar cada método.

    Para adicionar um botão, crie uma ação de lista e adicione chamadas de método GlideList ao método onClick{} do campo Client script. Para obter instruções, consulte Como usar a API GlideList do cliente na IU de experiência do espaço.

    Chamadas do método GlideList no campo Client script.
    Nota:
    Cada método deve ser usado com o método refresh(), com as exceções dos métodos " sort()" e " sortDescending()".
    Os métodos nesta API são baseados em GlideList2. Os seguintes métodos GlideList2 não são compatíveis com a estrutura Next Experience e causam um erro no log do console:
    • éListaDeUsuários()
    • definirPrimeiraLinha()
    • mostrarGruposOcultar()
    • mostrarOcultarLista()
    • toggleList ()
    • alternarListaNoPref()

    GlideList (Next Experience) - addFilter(Filtro de cadeia de caracteres)

    Adiciona um único termo ao filtro de consulta de lista.

    Consulte também setFilter().

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    filtros Cadeia de caracteres Cadeia de caracteres de consulta codificada no formato Glide padrão. Consulte Cadeias de caracteres de consulta codificadas.
    Tabela 2. Retorna
    Tipo Descrição
    Nenhum(a)

    O exemplo a seguir mostra como recuperar uma lista de registros ativos e atualizar a página.

    g_list.addFilter("active=true");
g_list.refresh();

    GlideList (Next Experience) - getChecked()

    Retorna uma lista separada por vírgulas dos sys_ids dos itens verificados na lista associada.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 4. Retorna
    Tipo Descrição
    Cadeia de caracteres Lista separada por vírgulas dos sys_ids dos itens verificados na lista. Não verifica para determinar se os itens retornados podem ser executados.

    O exemplo a seguir mostra como obter os sys_ids de cada registro selecionado em uma lista.

    var myChecked = g_list.getChecked();
alert(myChecked);
g_list.refresh();

    Saída em uma caixa de alerta (vazia se nenhum registro estiver selecionado):

    079893e6b733330059128ac7ee11a967, 4fca6d45b7131010f03e9b7ade11a9d3, 5c460fbf1bd0011079e52131604bcbd9

    GlideList (Next Experience) - getFixedQuery()

    Retorna a consulta fixa.

    Uma consulta fixa é a parte da consulta que não pode ser removida da trilha (ou seja, ela é fixa para o usuário).

    Aplique este método em Ações da lista relacionada na IU Experiência com o espaço. Para obter instruções, consulte Como usar a API GlideList do cliente na IU de experiência do espaço.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 6. Retorna
    Tipo Descrição
    Cadeia de caracteres A cadeia de caracteres de consulta fixa da lista.

    O exemplo a seguir mostra como exibir uma consulta fixa com uma mensagem de depuração no log do console do navegador.

    console.log(g_list.getFixedQuery() + " debug message");

    A saída após clicar no botão na guia Incidentes secundários em um registro de Incidente.

    parent_incident=46f1784ba9fe19810018aa27fbb23482 debug message

    GlideList (Next Experience) - getGroupBy()

    Retorna o campo ou a lista separada por vírgulas de campos que são usados para agrupar a lista.

    Consulte também:
    Tabela 7. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 8. Retorna
    Tipo Descrição
    Cadeia de caracteres O campo ou a lista separada por vírgulas de campos que são usados para agrupar a lista.

    O exemplo a seguir mostra como obter valores de campo groupBy da exibição de lista atual.

    var grpdBy = g_list.getGroupBy();
alert("The list is grouped by " + grpdBy);
g_list.refresh();

    Saída em uma caixa de alerta para uma lista agrupada por prioridade:

    The list is grouped by ^GROUPBYpriority

    GlideList (Next Experience) - getListName()

    Retorna o nome da lista, que geralmente é o nome da tabela.

    Tabela 9. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 10. Retorna
    Tipo Descrição
    Cadeia de caracteres O nome da lista (geralmente o nome da tabela).

    O exemplo a seguir mostra como chamar o método.

    g_list.getListName();

    GlideList (Next Experience) - getOrderBy()

    Retorna o primeiro campo usado para ordenar a lista.

    Consulte também:
    Tabela 11. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 12. Retorna
    Tipo Descrição
    Cadeia de caracteres O campo pelo qual a lista será ordenada. Vazio se a lista não estiver ordenada.

    O exemplo a seguir mostra como obter valores de campo orderBy da exibição de lista atual.

    var orderBy = g_list.getOrderBy();
	
alert("The list is ordered by " + orderBy);
g_list.refresh();

    Saída em uma caixa de alerta para uma lista ordenada por prioridade:

    The list is ordered by ^ORDERBYDESCpriority

    GlideList (Next Experience) - getParentTable()

    Retorna o nome da tabela primária para uma lista relacionada (a tabela associada ao formulário).

    Tabela 13. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 14. Retorna
    Tipo Descrição
    Cadeia de caracteres O nome da tabela primária.

    O exemplo a seguir mostra como chamar o método.

    g_list.getParentTable();
g_list.refresh();

    GlideList (Next Experience) - getQuery(Object)

    Retorna a cadeia de caracteres de consulta codificada da lista.

    Consulte também:
    Tabela 15. Parâmetros
    Nome Tipo Descrição
    <object> Objeto Opcional. Por padrão, este método inclui orderBy, groupBy e consulta fixa nos resultados. Você pode definir propriedades de objeto para restringir os resultados a uma ou mais das três opções disponíveis.
    <object>.orderBy Booliano Opcional. Sinalizador que indica se orderBy deve ser incluído nos resultados.
    Valores válidos:
    • verdadeiro: incluir orderBy nos resultados.
    • falso: não inclui orderBy nos resultados.

    Padrão: falso
    <object>.groupBy Booliano Opcional. Sinalizador que indica se groupBy deve ser incluído nos resultados.
    Valores válidos:
    • verdadeiro: incluir groupBy nos resultados.
    • falso: não inclui groupBy nos resultados.

    Padrão: falso
    <object>.fixo Booliano Opcional. Sinalizador que indica se a consulta fixa deve ser incluída nos resultados.
    Valores válidos:
    • verdadeiro: inclui consulta fixa nos resultados.
    • falso: não inclui consulta fixa nos resultados.

    Padrão: falso
    Tabela 16. Retorna
    Tipo Descrição
    Cadeia de caracteres Cadeia de caracteres de consulta codificada para a lista.

    O exemplo a seguir mostra como exibir a consulta codificada de lista com uma mensagem de depuração no log do console do navegador.

    var myQuery = g_list.getQuery();
console.log(myQuery + " message");

    Saída:

    active=false^EQ message

    GlideList (Next Experience) - getRelated()

    Retorna o campo de lista relacionada que associa a lista relacionada ao formulário primário.

    Tabela 17. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 18. Retorna
    Tipo Descrição
    Cadeia de caracteres Campo que conecta a lista ao formulário primário.

    O exemplo a seguir mostra como chamar o método.

    g_list.getRelated();

    GlideList (Next Experience) - getTableName()

    Retorna o nome da tabela para a lista.

    Tabela 19. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 20. Retorna
    Tipo Descrição
    Cadeia de caracteres Retorna o nome da tabela para a lista.

    O exemplo a seguir mostra como exibir o nome da lista para a exibição atual.

    var listName = g_list.getListName();
alert("The current list name is " + listName);
g_list.refresh();

    Saída em uma caixa de alerta:

    The current list name is incident

    GlideList (Next Experience) - getTitle()

    Retorna o título da lista.

    Tabela 21. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 22. Retorna
    Tipo Descrição
    Cadeia de caracteres O título da lista.

    O exemplo a seguir mostra como chamar o método.

    g_list.getTitle();

    GlideList (Next Experience) - getView()

    Retorna a exibição usada para exibir a lista.

    Tabela 23. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 24. Retorna
    Tipo Descrição
    Cadeia de caracteres O nome da exibição.

    O exemplo a seguir mostra como chamar o método.

    g_list.getView();

    GlideList (Next Experience) - atualizar (Number firstRow)

    Atualiza a lista. A parte orderBy do filtro de lista é ignorada para que a lista use sua ordem natural quando for atualizada.

    Tabela 25. Parâmetros
    Nome Tipo Descrição
    firstRow Número A primeira linha a aparecer na lista.

    Padrão: primeira linha da exibição atual.
    Tabela 26. Retorna
    Tipo Descrição
    Nenhum(a)

    O exemplo a seguir mostra como chamar o método.

    g_list.addFilter("active=true");
g_list.refresh();

    GlideList (Next Experience) - refreshWithOrderBy(Number firstRow)

    Atualiza a lista. A parte orderBy do filtro de lista será incluída se for especificada para a lista.

    Tabela 27. Parâmetros
    Nome Tipo Descrição
    firstRow Número A primeira linha a aparecer na lista.

    Padrão: primeira linha da exibição atual.
    Tabela 28. Retorna
    Tipo Descrição
    Nenhum(a)

    O exemplo a seguir mostra como chamar o método.

    g_list.refreshWithOrderBy();

    GlideList (Next Experience) - setFilter(Filtro de cadeia de caracteres)

    Define a cadeia de caracteres de consulta codificada para a lista, ignorando as partes orderBy e groupBy da cadeia de caracteres de consulta.

    Consulte também addFilter().

    Tabela 29. Parâmetros
    Nome Tipo Descrição
    filtros Cadeia de caracteres Cadeia de caracteres de consulta codificada no formato Glide padrão. Consulte Cadeias de caracteres de consulta codificadas.
    Tabela 30. Retorna
    Tipo Descrição
    Nenhum(a)

    O exemplo a seguir mostra como restringir os resultados da lista a registros ativos.

    g_list.setFilter("active=true");
g_list.refresh();

    GlideList (Next Experience) - setGroupBy(cadeia de caracteres groupBy)

    Define os critérios groupBy de lista para um único campo.

    Consulte também:
    Tabela 31. Parâmetros
    Nome Tipo Descrição
    groupBy Cadeia de caracteres Os critérios groupBy para a lista.
    Tabela 32. Retorna
    Tipo Descrição
    Nenhum(a)

    O exemplo a seguir mostra como agrupar registros listados por ID de chamador.

    g_list.setGroupBy("caller_id");
g_list.refresh();

    GlideList (Next Experience) - setOrderBy(cadeia de caracteres orderBy)

    Define os critérios orderBy para a lista.

    Para uma única ordem por campo, use o campo orderBy ou o campo orderByDesc. Para vários campos, use orderByField1^orderByField2^orderByField3. orderBy especifica a ordem crescente e orderByDesc especifica decrescente. Essas cadeias de caracteres de prefixo são opcionais. Se não for especificado, orderBy será a ordem padrão.

    Consulte também:
    Tabela 33. Parâmetros
    Nome Tipo Descrição
    orderBy Cadeia de caracteres Campos orderBy únicos ou múltiplos.
    Tabela 34. Retorna
    Tipo Descrição
    Nenhum(a)

    O exemplo a seguir mostra como ordenar a lista pelo valor do campo Prioridade.

    g_list.setOrderBy("priority");
g_list.refresh();

    GlideList (Next Experience) - setRowsPerPage(Número de linhas)

    Define o número de linhas por página a serem exibidas.

    Tabela 35. Parâmetros
    Nome Tipo Descrição
    linhas Número O número de linhas a serem exibidas.
    Tabela 36. Retorna
    Tipo Descrição
    Nenhum(a)

    O exemplo a seguir mostra como limitar os resultados a 50 linhas por página.

    g_list.setRowsPerPage(50);
refresh();

    GlideList (Next Experience) - classificar(campo de cadeia de caracteres)

    Classifica a lista em ordem crescente e define o campo como uma coluna orderBy.

    Consulte também:
    Nota:
    Este método não requer o método refresh().
    Tabela 37. Parâmetros
    Nome Tipo Descrição
    Assunto: Cadeia de caracteres Campo a ser usado para classificar a lista.
    Tabela 38. Retorna
    Tipo Descrição
    Nenhum(a)

    O exemplo a seguir mostra como classificar os resultados pelo campo Número.

    g_list.sort("number");

    GlideList (Next Experience) - ordenarDescending(cadeia de caracteres do campo, valor do número)

    Classifica um único campo na lista em ordem decrescente e define o campo como uma coluna orderByDescField.

    Consulte também:
    Nota:
    Este método não requer o método refresh().
    Tabela 39. Parâmetros
    Nome Tipo Descrição
    Assunto: Cadeia de caracteres Campo a ser usado para classificar a lista.
    Tabela 40. Retorna
    Tipo Descrição
    Nenhum(a)

    O exemplo a seguir mostra como classificar os resultados pelo campo Número em ordem decrescente.

    g_list.sortDescending("number");