GlideList (Now Experience) : client

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 le champ de script clientonClick{} méthode. Pour obtenir des instructions, consultez Utiliser l’API client GlideList dans l’interface utilisateur de l’expérience d’espace de travail.

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 l’infrastructure Next Experience 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. Voir Chaînes de requête codées.

Tableau 2. Renvoie

Type	Description
Néant

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 pour les éléments qui sont enregistré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 vérifiés dans la liste. Ne vérifie pas que les éléments retournés peuvent être exécutés.

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

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

Sortie dans une zone 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 est la partie de la requête qui ne peut pas être supprimée du fil d’Ariane (c’est-à-dire qu’elle est fixe pour l’utilisateur).

Appliquez cette méthode sous Actions sur la liste connexe dans l’interface Expérience d'espace de travail utilisateur. Pour obtenir des instructions, consultez Utiliser l’API client GlideList dans l’interface utilisateur de l’expérience d’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 la liste des champs ou des champs séparés par des virgules utilisés pour regrouper la liste.

Voir aussi :

• getQuery()
• setGroupBy()

Tableau 7. Paramètres

Nom	Type	Description
Aucun

Tableau 8. Renvoie

Type	Description
Chaîne	Liste des champs séparés par des champs ou séparés par des virgules utilisés pour regrouper la liste.

L’exemple suivant montre comment obtenir les valeurs de champ groupBy 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	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 organiser la liste.

Voir aussi :

• getQuery()
• setOrderBy()

Tableau 11. Paramètres

Nom	Type	Description
Aucun

Tableau 12. Renvoie

Type	Description
Chaîne	Champ selon lequel trier la liste. Vide si la liste n’est pas ordonnée.

L’exemple suivant montre comment obtenir les valeurs orderBy de 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 zone 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(Objet)

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

Voir aussi :

• getFixedQuery()
• getGroupBy()
• getOrderBy()
• setGroupBy()
• setOrderBy()

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 des propriétés d’objet pour limiter 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. false : n’incluez pas 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 : true : inclure groupBy dans les résultats. false : n’incluez pas 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 : n’incluez pas de 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 liste pour la vue actuelle.

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

Sortie dans une zone 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	Le titre de la 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(Numéro 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
Néant

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
Néant

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. Voir Chaînes de requête codées.

Tableau 30. Renvoie

Type	Description
Néant

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 :

• getGroupBy()
• getQuery()

Tableau 31. Paramètres

Nom	Type	Description
groupBy	Chaîne	Les groupBy critères de la liste.

Tableau 32. Renvoie

Type	Description
Néant

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 champ d’ordre unique 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. S’il n’est pas spécifié, orderBy il s’agit de l’ordre par défaut.

Voir aussi :

• getOrderBy()
• getQuery()
• trier()
• triDescending()

Tableau 33. Paramètres

Nom	Type	Description
orderBy	Chaîne	Champs orderBy uniques ou multiples.

Tableau 34. Renvoie

Type	Description
Néant

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
Néant

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 :

• getOrderBy()
• getQuery()
• setOrderBy()
• triDescending()

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
Néant

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 du nombre)

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

Voir aussi :

• getOrderBy()
• getQuery()
• setOrderBy()
• triDescending()

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
Néant

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

g_list.sortDescending("number");