GlideList (Now Experience) : client

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 8 minutes de lecture

    • L’API GlideList fournit des méthodes pour personnaliser les listes dans le Cadre de travail de l'interface utilisateur Next Experiencefichier .

    Cette API permet d’ajouter la fonctionnalité GlideList à un bouton dans l’interface Expérience d'espace de travail utilisateur. Utilisez la variable g_list pour appeler chaque méthode.

    Pour ajouter un bouton, créez une action de liste et ajoutez des appels de méthode GlideList dans la méthode onClick{}du champ de script client. Pour obtenir des instructions, consultez Utiliser l’API GlideList du client dans l’interface utilisateur de l’expérience de l’espace de travail.

    Appels de méthode GlideList dans le champ Script client.
    Remarque :
    Chaque méthode doit être utilisée avec la méthode refresh(), à l’exception des méthodes sort() et sortDescending().
    Les méthodes de cette API sont basées sur GlideList2. Les méthodes GlideList2 suivantes ne sont pas prises en charge dans le cadre de Next Experience travail et provoquent une erreur dans le journal de la console :
    • isUserList()
    • setFirstRow()
    • showHideGroups()
    • showHideList()
    • toggleList()
    • toggleListNoPref()

    GlideList (Next Experience) : addFilter (filtre de chaîne)

    Ajoute un terme unique au filtre de requête de liste.

    Voir aussi setFilter().

    Tableau 1. Paramètres
    Nom Type Description
    filtre Chaîne Chaîne de requête codée au format Glide standard. Reportez-vous à la section Chaînes de requêtes codées.
    Tableau 2. Renvoie
    Type Description
    Aucun

    L’exemple suivant montre comment récupérer une liste d’enregistrements actifs et actualiser la page.

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

    GlideList (Next Experience) : getChecked()

    Renvoie une liste séparée par des virgules des sys_ids des éléments qui sont vérifiés dans la liste associée.

    Tableau 3. Paramètres
    Nom Type Description
    Aucun
    Tableau 4. Renvoie
    Type Description
    Chaîne Liste séparée par des virgules des sys_ids pour les éléments qui sont cochés dans la liste. Ne vérifie pas si les éléments renvoyés peuvent être exécutés.

    L’exemple suivant montre comment obtenir le sys_ids de chaque enregistrement sélectionné dans une liste.

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

    Sortie dans une boîte d’alerte (vide si aucun enregistrement n’est sélectionné) :

    079893e6b733330059128ac7ee11a967, 4fca6d45b7131010f03e9b7ade11a9d3, 5c460fbf1bd0011079e52131604bcbd9

    GlideList (Next Experience) : getFixedQuery()

    Renvoie la requête fixe.

    Une requête fixe correspond à la partie de la requête qui ne peut pas être supprimée du fil d’Ariane (c’est-à-dire qu’elle est corrigée pour l’utilisateur).

    Appliquez cette méthode sous Actions sur la liste connexe de l’interface Expérience d'espace de travail utilisateur. Pour obtenir des instructions, consultez Utiliser l’API GlideList du client dans l’interface utilisateur de l’expérience de l’espace de travail.

    Tableau 5. Paramètres
    Nom Type Description
    Aucun
    Tableau 6. Renvoie
    Type Description
    Chaîne Chaîne de requête fixe pour la liste.

    L’exemple suivant montre comment afficher une requête fixe avec un message de débogage dans le journal de la console du navigateur.

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

    Sortie après avoir cliqué sur le bouton de l’onglet Incidents enfants dans un enregistrement d’incident.

    parent_incident=46f1784ba9fe19810018aa27fbb23482 debug message

    GlideList (Next Experience) : getGroupBy()

    Renvoie le champ ou la liste de champs séparés par des virgules utilisés pour regrouper la liste.

    Voir aussi :
    Tableau 7. Paramètres
    Nom Type Description
    Aucun
    Tableau 8. Renvoie
    Type Description
    Chaîne Champ ou liste de champs séparés par des virgules utilisés pour regrouper la liste.

    L’exemple suivant montre comment obtenir les valeurs groupBy du champ de la vue de liste actuelle.

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

    Sortie dans une zone d’alerte pour une liste regroupée par priorité :

    The list is grouped by ^GROUPBYpriority

    GlideList (Next Experience) : getListName()

    Renvoie le nom de la liste, qui est généralement le nom de la table.

    Tableau 9. Paramètres
    Nom Type Description
    Aucun
    Tableau 10. Renvoie
    Type Description
    Chaîne Le nom de la liste (généralement le nom de la table).

    L’exemple suivant montre comment appeler la méthode.

    g_list.getListName();

    GlideList (Next Experience) : getOrderBy()

    Renvoie le premier champ utilisé pour ordonner la liste.

    Voir aussi :
    Tableau 11. Paramètres
    Nom Type Description
    Aucun
    Tableau 12. Renvoie
    Type Description
    Chaîne Champ utilisé pour trier la liste. Vide si la liste n’est pas ordonnée.

    L’exemple suivant montre comment obtenir les valeurs orderBy du champ de la vue de liste actuelle.

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

    Sortie dans une boîte d’alerte pour une liste classée par priorité :

    The list is ordered by ^ORDERBYDESCpriority

    GlideList (Next Experience) : getParentTable()

    Renvoie le nom de la table parente d’une liste connexe (la table associée au formulaire).

    Tableau 13. Paramètres
    Nom Type Description
    Aucun
    Tableau 14. Renvoie
    Type Description
    Chaîne Nom de la table parente.

    L’exemple suivant montre comment appeler la méthode.

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

    GlideList (Next Experience) : getQuery(Object)

    Renvoie la chaîne de requête codée pour la liste.

    Voir aussi :
    Tableau 15. Paramètres
    Nom Type Description
    <object> Objet Facultatif. Par défaut, cette méthode inclut orderBy, groupBy et une requête fixe dans les résultats. Vous pouvez définir les propriétés d’objet pour restreindre les résultats à une ou plusieurs des trois options disponibles.
    <object>.orderBy Booléen Facultatif. Marqueur indiquant s’il faut inclure orderBy dans les résultats.
    Valeurs valides :
    • vrai : inclure orderBy dans les résultats.
    • faux : ne pas inclure orderBy dans les résultats.

    Valeur par défaut : false
    <object>.groupBy Booléen Facultatif. Marqueur indiquant s’il faut inclure groupBy dans les résultats.
    Valeurs valides :
    • vrai : inclure groupBy dans les résultats.
    • faux : ne pas inclure groupBy dans les résultats.

    Valeur par défaut : false
    <object>.fixe Booléen Facultatif. Marqueur indiquant s’il faut inclure une requête fixe dans les résultats.
    Valeurs valides :
    • vrai : inclure la requête fixe dans les résultats.
    • faux : ne pas inclure la requête fixe dans les résultats.

    Valeur par défaut : false
    Tableau 16. Renvoie
    Type Description
    Chaîne Chaîne de requête codée pour la liste.

    L’exemple suivant montre comment afficher la requête codée de liste avec un message de débogage dans le journal de la console du navigateur.

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

    Sortie :

    active=false^EQ message

    GlideList (Next Experience) : getRelated()

    Renvoie le champ de liste connexe qui associe la liste connexe au formulaire parent.

    Tableau 17. Paramètres
    Nom Type Description
    Aucun
    Tableau 18. Renvoie
    Type Description
    Chaîne Champ qui relie la liste au formulaire parent.

    L’exemple suivant montre comment appeler la méthode.

    g_list.getRelated();

    GlideList (Next Experience) : getTableName()

    Renvoie le nom de table de la liste.

    Tableau 19. Paramètres
    Nom Type Description
    Aucun
    Tableau 20. Renvoie
    Type Description
    Chaîne Renvoie le nom de table de la liste.

    L’exemple suivant montre comment afficher le nom de la liste pour la vue actuelle.

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

    Sortie dans une boîte d’alerte :

    The current list name is incident

    GlideList (Next Experience) : getTitle()

    Renvoie le titre de la liste.

    Tableau 21. Paramètres
    Nom Type Description
    Aucun
    Tableau 22. Renvoie
    Type Description
    Chaîne Titre de liste.

    L’exemple suivant montre comment appeler la méthode.

    g_list.getTitle();

    GlideList (Next Experience) : getView()

    Renvoie la vue utilisée pour afficher la liste.

    Tableau 23. Paramètres
    Nom Type Description
    Aucun
    Tableau 24. Renvoie
    Type Description
    Chaîne Nom de la vue.

    L’exemple suivant montre comment appeler la méthode.

    g_list.getView();

    GlideList (Next Experience) : refresh(Number firstRow)

    Actualise la liste. La orderBy partie du filtre de liste est ignorée afin que la liste utilise son ordre naturel lorsqu’elle est actualisée.

    Tableau 25. Paramètres
    Nom Type Description
    première ligne Numéro Première ligne à apparaître dans la liste.

    Par défaut : première ligne de la vue actuelle.
    Tableau 26. Renvoie
    Type Description
    Aucun

    L’exemple suivant montre comment appeler la méthode.

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

    GlideList (Next Experience) : refreshWithOrderBy(Number firstRow)

    Actualise la liste. La orderBy partie du filtre de liste est incluse si elle est spécifiée pour la liste.

    Tableau 27. Paramètres
    Nom Type Description
    première ligne Numéro Première ligne à apparaître dans la liste.

    Par défaut : première ligne de la vue actuelle.
    Tableau 28. Renvoie
    Type Description
    Aucun

    L’exemple suivant montre comment appeler la méthode.

    g_list.refreshWithOrderBy();

    GlideList (Next Experience) : setFilter(filtre de chaîne)

    Définit la chaîne de requête codée pour la liste, en ignorant les orderBy parties et groupBy de la chaîne de requête.

    Voir aussi addFilter().

    Tableau 29. Paramètres
    Nom Type Description
    filtre Chaîne Chaîne de requête codée au format Glide standard. Reportez-vous à la section Chaînes de requêtes codées.
    Tableau 30. Renvoie
    Type Description
    Aucun

    L’exemple suivant montre comment restreindre les résultats de la liste aux enregistrements actifs.

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

    GlideList (Next Experience) : setGroupBy(String groupBy)

    Définit les critères de liste groupBy pour un seul champ.

    Voir aussi :
    Tableau 31. Paramètres
    Nom Type Description
    groupBy Chaîne Critères groupBy de la liste.
    Tableau 32. Renvoie
    Type Description
    Aucun

    L’exemple suivant montre comment regrouper les enregistrements répertoriés par ID d’appelant.

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

    GlideList (Next Experience) : setOrderBy(String orderBy)

    Définit les orderBy critères de la liste.

    Pour un seul champ de commande par, utilisez orderBy champ ou orderByDesc champ. Pour plusieurs champs, utilisez orderByField1^orderByField2^orderByField3. orderBy spécifie l’ordre croissant et orderByDesc spécifie l’ordre décroissant. Ces chaînes de préfixe sont facultatives. Il s’agit de l’ordre par défaut si cette option n’est pas spécifiée orderBy .

    Voir aussi :
    Tableau 33. Paramètres
    Nom Type Description
    orderBy Chaîne Champs trier par simple ou multiple.
    Tableau 34. Renvoie
    Type Description
    Aucun

    L’exemple suivant montre comment trier la liste en fonction de la valeur du champ Priorité.

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

    GlideList (Next Experience) : setRowsPerPage(Nombre de lignes)

    Définit le nombre de lignes par page à afficher.

    Tableau 35. Paramètres
    Nom Type Description
    lignes Numéro Nombre de lignes à afficher.
    Tableau 36. Renvoie
    Type Description
    Aucun

    L’exemple suivant montre comment limiter les résultats à 50 lignes par page.

    g_list.setRowsPerPage(50);
refresh();

    GlideList (Next Experience) : tri (champ de chaîne)

    Trie la liste par ordre croissant et définit le champ sous forme de orderBy colonne.

    Voir aussi :
    Remarque :
    Cette méthode ne nécessite pas la méthode refresh().
    Tableau 37. Paramètres
    Nom Type Description
    champ Chaîne Champ à utiliser pour trier la liste.
    Tableau 38. Renvoie
    Type Description
    Aucun

    L’exemple suivant montre comment trier les résultats par le champ Nombre .

    g_list.sort("number");

    GlideList (Next Experience) : sortDescending(Champ de chaîne, montant numérique)

    Trie un champ unique de la liste par ordre décroissant et définit le champ en tant que orderByDescField colonne.

    Voir aussi :
    Remarque :
    Cette méthode ne nécessite pas la méthode refresh().
    Tableau 39. Paramètres
    Nom Type Description
    champ Chaîne Champ à utiliser pour trier la liste.
    Tableau 40. Renvoie
    Type Description
    Aucun

    L’exemple suivant montre comment trier les résultats par le champ Nombre dans l’ordre décroissant.

    g_list.sortDescending("number");