GlideList (Now Experience) – Client

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 7 Minuten Lesedauer
  • Verwenden Sie die GlideList- API, um Listen in der Next Experience UI Frameworkanzupassen.

    Diese API ermöglicht das Hinzufügen der GlideList-Funktionalität zu einer Schaltfläche in der Benutzeroberfläche Arbeitsbereich-Experience. Verwenden Sie die Variable g_list, um jede Methode aufzurufen.

    Um die Schaltfläche hinzuzufügen, erstellen Sie eine Listenaktion und fügen GlideList- Methodenaufrufe im Client -Skriptfeld der onClick{}- Methode hinzu. Anweisungen finden Sie unter Client-API GlideList in der Arbeitsbereich-Experience-UI verwenden.

    Aufrufe der GlideList-Methode im Feld „Client-Skript“.
    Hinweis:
    Jede Methode muss mit der refresh()- Methode verwendet werden, mit Ausnahme von sort() und sortDescending().
    Die Methoden in dieser API basieren auf GlideList2. Die folgenden GlideList2- Methoden werden im Framework Next Experience nicht unterstützt und verursachen einen Fehler im Konsolenprotokoll:
    • isUserList()
    • setFirstRow()
    • showHideGroups()
    • showHideList()
    • toggleList()
    • toggleListNoPref ()

    GlideList (Next Experience) – addFilter(String filter)

    Fügt dem Listenabfragefilter einen einzelnen Begriff hinzu.

    Siehe auch setFilter().

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    filter Zeichenfolge Codierte Abfragezeichenfolge im Standard-Glide-Format. Weitere Informationen finden Sie unter Codierte Abfragezeichenfolgen.
    Tabelle : 2. Ausgabe
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie eine Liste aktiver Datensätze abgerufen und die Seite aktualisiert wird.

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

    GlideList (Next Experience) – getChecked()

    Gibt eine durch Kommas getrennte Liste der sys_ids für die Elemente zurück, die in der zugehörigen Liste überprüft werden.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 4. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Kommagetrennte Liste mit sys_ids für die Elemente, die in der Liste geprüft werden. Überprüft nicht, ob die zurückgegebenen Elemente ausgeführt werden dürfen.

    Das folgende Beispiel zeigt, wie die sys_ids aller in einer Liste ausgewählten Datensätze abgerufen werden.

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

    Ausgabe in ein Warnungsfeld (leer, wenn keine Datensätze ausgewählt sind):

    079893e6b733330059128ac7ee11a967, 4fca6d45b7131010f03e9b7ade11a9d3, 5c460fbf1bd0011079e52131604bcbd9

    GlideList (Next Experience) – getFixedQuery()

    Gibt die feste Abfrage zurück.

    Eine feste Abfrage ist der Teil der Abfrage, der nicht aus dem Breadcrumb entfernt werden kann (d. h. für den Benutzer festgelegt).

    Wenden Sie diese Methode unter Zugehörige Listenaktionen in der Arbeitsbereich-Experience -UI an. Anweisungen finden Sie unter Client-API GlideList in der Arbeitsbereich-Experience-UI verwenden.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 6. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Feste Abfragezeichenfolge für die Liste.

    Das folgende Beispiel zeigt, wie eine feste Abfrage mit einer Debug-Meldung im Protokoll der Browserkonsole angezeigt wird.

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

    Die Ausgabe nach Klicken auf die Schaltfläche auf der Registerkarte „Nachfolge-Incidents“ in einem Incident-Datensatz.

    parent_incident=46f1784ba9fe19810018aa27fbb23482 debug message

    GlideList (Next Experience) – getGroupBy()

    Gibt das Feld oder die kommagetrennte Liste mit Feldern zurück, die zum Gruppieren der Liste verwendet werden.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 8. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Feld oder kommagetrennte Liste mit Feldern, die zum Gruppieren der Liste verwendet werden.

    Das folgende Beispiel zeigt, wie Feldwerte groupBy der aktuellen Listenansicht abgerufen werden.

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

    Ausgabe in einem Warnungsfeld für eine nach Priorität gruppierte Liste:

    The list is grouped by ^GROUPBYpriority

    GlideList (Next Experience) – getListName()

    Gibt den Namen der Liste zurück, normalerweise den Tabellennamen.

    Tabelle : 9. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 10. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Listenname (normalerweise der Tabellenname).

    Das folgende Beispiel zeigt, wie die Methode aufgerufen wird.

    g_list.getListName();

    GlideList (Next Experience) – getOrderBy()

    Gibt das erste Feld zurück, das zum Sortieren der Liste verwendet wird.

    Tabelle : 11. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 12. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Das Feld, nach dem die Liste sortiert werden soll. Leer, wenn die Liste nicht geordnet ist.

    Das folgende Beispiel zeigt, wie Feld orderBy-Werte der aktuellen Listenansicht abgerufen werden.

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

    Ausgabe in einem Warnungsfeld für eine nach Priorität geordnete Liste:

    The list is ordered by ^ORDERBYDESCpriority

    GlideList (Next Experience) – getParentTable()

    Gibt den Namen der übergeordneten Tabelle für eine verknüpfte Liste zurück (die dem Formular zugeordnete Tabelle).

    Tabelle : 13. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 14. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Name der übergeordneten Tabelle.

    Das folgende Beispiel zeigt, wie die Methode aufgerufen wird.

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

    GlideList (Next Experience) – getQuery(Object)

    Gibt die codierte Abfragezeichenfolge für die Liste zurück.

    Tabelle : 15. Parameter
    Name Typ Beschreibung
    <object> Objekt Optional. Standardmäßig enthält diese Methode „orderBy“, „groupBy“ und „fixed query“ in den Ergebnissen. Sie können Objekteigenschaften festlegen, um die Ergebnisse auf eine oder mehrere der drei verfügbaren Optionen zu beschränken.
    <object>.orderBy Boolean Optional. Kennzeichnung, die angibt, ob orderBy in die Ergebnisse aufgenommen werden soll.
    Gültige Werte:
    • true: orderBy in Ergebnisse einbeziehen.
    • false: orderBy nicht in die Ergebnisse einbeziehen.

    Standardwert: false

    <object>.groupBy Boolean Optional. Kennzeichnung, die angibt, ob groupBy in die Ergebnisse aufgenommen werden soll.
    Gültige Werte:
    • true: groupBy in Ergebnisse einbeziehen.
    • false: groupBy nicht in die Ergebnisse einbeziehen.

    Standardwert: false

    <object>.behoben Boolean Optional. Kennzeichnung, die angibt, ob die feste Abfrage in die Ergebnisse aufgenommen werden soll.
    Gültige Werte:
    • true: Feste Abfrage in Ergebnisse einbeziehen.
    • false: Feste Abfrage nicht in die Ergebnisse einbeziehen.

    Standardwert: false

    Tabelle : 16. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Codierte Abfragezeichenfolge für die Liste.

    Das folgende Beispiel zeigt, wie die listencodierte Abfrage mit einer Debug-Meldung im Protokoll der Browserkonsole angezeigt wird.

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

    Ausgabe:

    active=false^EQ message

    GlideList (Next Experience) – getRelated()

    Gibt das verknüpfte Listenfeld zurück, das die verknüpfte Liste dem übergeordneten Formular zuordnet.

    Tabelle : 17. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 18. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Feld, das die Liste mit dem übergeordneten Formular verbindet.

    Das folgende Beispiel zeigt, wie die Methode aufgerufen wird.

    g_list.getRelated();

    GlideList (Next Experience) – getTableName()

    Gibt den Tabellennamen für die Liste zurück.

    Tabelle : 19. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 20. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Gibt den Tabellennamen für die Liste zurück.

    Das folgende Beispiel zeigt, wie der Listenname für die aktuelle Ansicht angezeigt wird.

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

    Ausgabe in ein Warnungsfeld:

    The current list name is incident

    GlideList (Next Experience) – getTitle()

    Gibt den Listentitel zurück.

    Tabelle : 21. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 22. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Listentitel.

    Das folgende Beispiel zeigt, wie die Methode aufgerufen wird.

    g_list.getTitle();

    GlideList (Next Experience) – getView()

    Gibt die Ansicht zurück, mit der die Liste angezeigt wurde.

    Tabelle : 23. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 24. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Name der Ansicht.

    Das folgende Beispiel zeigt, wie die Methode aufgerufen wird.

    g_list.getView();

    GlideList (Next Experience) – refresh(Number firstRow)

    Aktualisiert die Liste. Der Teil orderBy des Listenfilters wird ignoriert, sodass die Liste ihre natürliche Reihenfolge verwendet, wenn sie aktualisiert wird.

    Tabelle : 25. Parameter
    Name Typ Beschreibung
    firstRow Nummer Die erste Zeile, die in der Liste angezeigt wird.

    Standard: Erste Zeile der aktuellen Ansicht.

    Tabelle : 26. Ausgabe
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie die Methode aufgerufen wird.

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

    GlideList (Next Experience) – refreshWithOrderBy(Number firstRow)

    Aktualisiert die Liste. Der Teil orderBy des Listenfilters ist enthalten, wenn er für die Liste angegeben ist.

    Tabelle : 27. Parameter
    Name Typ Beschreibung
    firstRow Nummer Die erste Zeile, die in der Liste angezeigt wird.

    Standard: Erste Zeile der aktuellen Ansicht.

    Tabelle : 28. Ausgabe
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie die Methode aufgerufen wird.

    g_list.refreshWithOrderBy();

    GlideList (Next Experience) – setFilter(String filter)

    Legt die codierte Abfragezeichenfolge für die Liste fest und ignoriert die Teile orderBy und groupBy der Abfragezeichenfolge.

    Siehe auch addFilter().

    Tabelle : 29. Parameter
    Name Typ Beschreibung
    filter Zeichenfolge Codierte Abfragezeichenfolge im Standard-Glide-Format. Weitere Informationen finden Sie unter Codierte Abfragezeichenfolgen.
    Tabelle : 30. Ausgabe
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie Listenergebnisse auf aktive Datensätze beschränkt werden.

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

    GlideList (Next Experience) – setGroupBy(String groupBy)

    Legt die Kriterien der Liste groupBy für ein einzelnes Feld fest.

    Tabelle : 31. Parameter
    Name Typ Beschreibung
    groupBy Zeichenfolge Die groupBy -Kriterien für die Liste.
    Tabelle : 32. Ausgabe
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie aufgelistete Datensätze nach Anrufer-ID gruppiert werden.

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

    GlideList (Next Experience) – setOrderBy(String orderBy)

    Legt die Kriterien orderBy für die Liste fest.

    Verwenden Sie für ein einzelnes Feld „Sortieren nach“ das Feld orderBy oder das Feld orderByDesc. Verwenden Sie für mehrere Felder orderByField1^orderByField2^orderByField3. orderBy gibt die aufsteigende Reihenfolge an, orderByDesc die absteigende. Diese Präfixzeichenfolgen sind optional. Wenn nicht angegeben, ist orderBy die Standardreihenfolge.

    Tabelle : 33. Parameter
    Name Typ Beschreibung
    orderBy Zeichenfolge Einzelne oder mehrere orderBy-Felder.
    Tabelle : 34. Ausgabe
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie die Liste nach dem Wert des Felds Priorität sortiert wird.

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

    GlideList (Next Experience) – setRowsPerPage(Number rows)

    Legt die Anzahl der anzuzeigenden Zeilen pro Seite fest.

    Tabelle : 35. Parameter
    Name Typ Beschreibung
    rows Nummer Die Anzahl der anzuzeigenden Zeilen.
    Tabelle : 36. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie die Ergebnisse auf 50 Zeilen pro Seite beschränkt werden.

    g_list.setRowsPerPage(50);
    refresh();

    GlideList (Next Experience) – sort(String field)

    Sortiert die Liste in aufsteigender Reihenfolge und legt das Feld als Spalte orderBy fest.

    Hinweis:
    Diese Methode erfordert nicht die refresh()- Methode.
    Tabelle : 37. Parameter
    Name Typ Beschreibung
    field Zeichenfolge Feld zum Sortieren der Liste.
    Tabelle : 38. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie Ergebnisse nach dem Feld Nummer sortiert werden.

    g_list.sort("number");

    GlideList (Next Experience) – sortDescending(String field, Number amount)

    Sortiert ein einzelnes Feld in der Liste in absteigender Reihenfolge und legt das Feld als Spalte orderByDescField fest.

    Hinweis:
    Diese Methode erfordert nicht die refresh()- Methode.
    Tabelle : 39. Parameter
    Name Typ Beschreibung
    field Zeichenfolge Feld zum Sortieren der Liste.
    Tabelle : 40. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie Ergebnisse nach dem Feld Nummer in absteigender Reihenfolge sortiert werden.

    g_list.sortDescending("number");