CatalogJS: Bereichsbezogen

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 5 Minuten Lesedauer

    • Die CatalogJS -API bietet Methoden zum Überprüfen und Abrufen katalogspezifischer Eigenschaften.

    Um diese Klasse in einer bereichsbezogenen Anwendung zu verwenden, verwenden Sie den Namespace-Bezeichner sn_sc. Für den Zugriff auf die CatalogJS-API ist das standardmäßig aktivierte Service Catalog Scoped API-Plugin (com.glideapp.servicecatalog.scoped.api) erforderlich.

    CatalogJS: Katalog (GlideRecord now_GR)

    Erstellt eine Instanz der Katalogklasse für das angegebene Glide-Datensatzobjekt.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    now_GR Objekt Glide-Datensatz, der auf die Tabelle „sc_catalog“ verweist.

    In diesem Beispiel wird gezeigt, wie eine neue Instanz der Katalogklasse erstellt wird.

    var now_GR = new GlideRecord('sc_catalog');
 now_GR.addQuery('sys_id','e0d08b13c3330100c8b837659bba8fb4');
 now_GR.query();
 var catalog = new sn_sc.Catalog(now_GR);

    CatalogJS – Catalog(String sys_id)

    Erstellt eine Instanz der Catalog-Klasse mit der angegebenen sys_id.

    Tabelle : 2. Parameter
    Name Typ Beschreibung
    sys_id Zeichenfolge Sys_id des Katalogs

    In diesem Beispiel wird gezeigt, wie eine Instanz der Katalogklasse mit der angegebenen syst_id erstellt wird.

    new sn_sc.Catalog(catalog_sys_id);
var catalog = new sn_sc.Catalog("31bea3d53790200044e0bfc8bcbe5dec");

    CatalogJS - canView(Boolean mobile, Zeichenfolge userId)

    Bestimmt, ob ein Benutzer die aktuelle Kategorie auf einem Mobilgerät oder auf dem Desktop-Computer anzeigen kann.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    mobile Boolean

    Kennzeichnung, die angibt, ob überprüft werden soll, ob der Anwender den aktuellen Katalog in einer mobilen Ansicht oder in einer Desktopansicht anzeigen kann.

    Gültige Werte:
    • true: Mobile Ansicht
    • false: Desktop-Ansicht
    userId Zeichenfolge Optional. Sys_id des Anwenders, um zu überprüfen, ob er den Katalog anzeigen kann.

    Standard: Aktueller Anwender
    Tabelle : 4. Ergebnisse
    Typ Beschreibung
    Boolean

    Kennzeichnung, die angibt, ob der Katalog vom Anwender angezeigt werden kann.

    Gültige Werte:
    • wahr: Der Katalog ist für den Anwender sichtbar.
    • „falsch“: Der Katalog kann vom Anwender nicht angezeigt werden.

    Beispiel:

    var catalog = new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
gs.info(catalog.canView(true));

    Ausgabe:

    true

    CatalogJS – getAvailableCatalog()

    Gibt den verfügbaren aktiven Katalog zurück.

    Wenn nur ein aktiver Katalog vorhanden ist, gibt die Methode diesen Katalog zurück. Andernfalls wird der früheste erstellte Katalog aus der Liste der Kataloge zurückgegeben, die der Benutzer anzeigen kann. Wenn kein Katalog verfügbar ist, gibt die Methode NULL zurück.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 6. Ergebnisse
    Typ Beschreibung
    Objekt Objekt, das auf den frühesten Katalog verweist, den der Anwender anzeigen kann, oder NULL, wenn kein Katalog verfügbar ist.

    In diesem Beispiel wird der Katalog zurückgegeben, der dem aktuellen Benutzer zur Verfügung steht.

    var catalog = sn_sc.Catalog.getAvailableCatalog()

    CatalogJS – getBackgroundColor()

    Gibt die Kataloghintergrundfarbe zurück.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 8. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Hintergrundfarbe des Katalogs.

    In diesem Beispiel wird die Hintergrundfarbe für den zugehörigen Katalog zurückgegeben.

    var catalog = new sn_sc.Catalog("0f910a2ac3112200b12d9f2974d3ae3c");
gs.info("Catalog background: " + catalog.getBackgroundColor());

    Ausgabe:

    Catalog background: white

    CatalogJS – getCatalogCount()

    Gibt die Anzahl der aktiven Kataloge in der Katalogtabelle zurück.

    Tabelle : 9. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 10. Ergebnisse
    Typ Beschreibung
    Ganzzahl Anzahl der in der Katalogtabelle verfügbaren Kataloge.

    Beispiel:

    console.log(sn_sc.Catalog.getCatalogCount());

    Ausgabe:

    3

    CatalogJS – getCategories()

    Gibt die Kategorien für den aktuellen Katalog zurück.

    Tabelle : 11. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 12. Ergebnisse
    Typ Beschreibung
    ArrayList Gibt die Kategorien für den aktuellen Katalog zurück.

    In diesem Beispiel werden die im aktuellen Katalogobjekt verfügbaren Kategorien zurückgegeben.

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
console.log(catalog.getCategories());

    Ausgabe:

    0 : {header_image: "", sys_id: "e15706fc0a0a0aa7007fc21e1ab70c2f", description: "Your IT gateway. Report issues and submit requests.", title: "Can We Help You?"} 
1 : {header_image: "", sys_id: "95fc11615f1211001c9b2572f2b477c6", description: "Services offered by different departments in the organization", title: "Departmental Services"} 
2 : {header_image: "", sys_id: "900682363731300054b6a3549dbe5d5f", description: "Desktop computers for your work area.", title: "Desktops"} 
3 : {header_image: "", sys_id: "d2f716fcc611227a015a142fa0b262c1", description: "Order new furniture, and fixtures, or request for cubicle modifications can also be ordered here.", title: "Furniture and Decor"} 
4 : {header_image: "", sys_id: "d258b953c611227a0146101fb1be7c31", description: "Order from a variety of hardware to meet your business needs, including phones, tablets and laptops.", title: "Hardware"}

    CatalogJS – getCategoryIds()

    Gibt die sys_ids der Kategorien im aktuellen Katalog an.

    Tabelle : 13. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 14. Ergebnisse
    Typ Beschreibung
    ArrayList Gibt die sys_ids der Kategorien im aktuellen Katalog zurück.

    In diesem Beispiel werden die sys_ids der im aktuellen Katalog verfügbaren Kategorien zurückgegeben.

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
console.log(catalog.getCategoryIds());

    Ausgabe:

    0:"e15706fc0a0a0aa7007fc21e1ab70c2f"
1 : "95fc11615f1211001c9b2572f2b477c6"
2 : "900682363731300054b6a3549dbe5d5f"
3 : "d2f716fcc611227a015a142fa0b262c1"

    CatalogJS – getDescription()

    Gibt die Beschreibung des aktuellen Katalogs zurück.

    Tabelle : 15. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 16. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Katalogbeschreibung.

    In diesem Beispiel wird der Name des aktuellen Katalogs zurückgegeben.

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
console.log(catalog.getDescription());

    Ausgabe:

    Service Catalog - IT Now

    CatalogJS – getDesktopImageSRC()

    Gibt den Namen der Katalog-Desktop-Image-Datei zurück.

    Tabelle : 17. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 18. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Name der Katalog-Desktop-Bilddatei.

    In diesem Beispiel wird der Name der aktuellen Katalog-Desktop-Bilddatei zurückgegeben.

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
console.log(catalog.getDesktopImageSRC());

    Ausgabe:

    adbcc271475211002ee987e8dee49001.iix

    CatalogJS – getGr()

    Gibt den GlideRecord des aktuellen Katalogs zurück.

    Tabelle : 19. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 20. Ergebnisse
    Typ Beschreibung
    GlideRecord GlideRecord des aktuellen Katalogs.

    In diesem Beispiel wird der GlideRecord für den angegebenen Katalog zurückgegeben.

    var catalog = new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
data.history = catalog.getGr();

    CatalogJS – getHeaderIconSRC()

    Gibt das Header-Symbol des aktuellen Katalogs zurück.

    Tabelle : 21. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 22. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Katalog-Kopfzeilensymbol.

    In diesem Beispiel wird gezeigt, wie Sie den Namen des Katalog-Header-Symbols abrufen.

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
gs.info(catalog.getHeaderIconSRC());

    Ausgabe:

    service_catalog_header.png

    CatalogJS – getID()

    Gibt die sys_id des aktuellen Katalogs zurück.

    Tabelle : 23. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 24. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Sys_id des aktuellen Katalogs.

    In diesem Beispiel wird die sys_id des aktuellen Katalogs zurückgegeben.

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
console.log(catalog.getId());

    Ausgabe:

    e0d08b13c3330100c8b837659bba8fb4

    CatalogJS – getTitle()

    Gibt den Titel des aktuellen Katalogs zurück.

    Tabelle : 25. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 26. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Titel des aktuellen Katalogs.

    In diesem Beispiel wird der Titel des aktuellen Katalogs zurückgegeben.

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
gs.info(catalog.getTitle());

    Ausgabe:

    Service Catalog

    CatalogJS – hasCategories()

    Gibt an, ob der aktuelle Katalog Kategorien enthält.

    Tabelle : 27. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 28. Ergebnisse
    Typ Beschreibung
    Boolean

    Kennzeichnung, die angibt, ob der aktuelle Katalog Kategorien enthält.

    Gültige Werte:
    • „wahr“: Katalog hat Kategorien.
    • „falsch“: Katalog enthält keine Kategorien.

    In diesem Beispiel wird gezeigt, wie ermittelt wird, ob der aktuelle Katalog Kategorien enthält.

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
gs.info(catalog.hasCategories());

    Ausgabe:

    false

    CatalogJS – hasItems()

    Gibt an, ob der aktuelle Katalog Katalogelemente enthält.

    Tabelle : 29. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 30. Ergebnisse
    Typ Beschreibung
    Boolean

    Kennzeichnung, die angibt, ob der aktuelle Katalog Katalogelemente enthält.

    Gültige Werte:
    • „wahr“: Katalog enthält Katalogelemente.
    • „falsch“: Katalog enthält keine Katalogelemente.

    Beispiel:

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
gs.info(catalog.hasItems());

    Ausgabe:

    true

    CatalogJS – isWishlistEnabled()

    Gibt an, ob die Wunschliste für den aktuellen Katalog aktiviert ist.

    Tabelle : 31. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 32. Ergebnisse
    Typ Beschreibung
    Boolean

    Kennzeichnung, die angibt, ob der aktuelle Katalog Wunschlisten unterstützt.

    Gültige Werte:
    • „wahr“: Katalog unterstützt Wunschlisten.
    • „falsch“: Katalog unterstützt keine Wunschlisten.

    In diesem Beispiel wird gezeigt, wie überprüft wird, ob Wunschlisten für den aktuellen Katalog aktiviert sind.

    var catalog = new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
gs.info(catalog.isWishlistEnabled());

    Ausgabe:

    true