Widget-API-Referenz

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 1 Minute Lesedauer
  • Serviceportal enthält client- und serverseitige APIs zur Verwendung in Widget-Client- und -Serverskripts.

    Serviceportal clientseitige APIs

    Dies sind Serviceportal APIs, die Sie in einem Widget-Client-Controller verwenden können.

    Ausführliche Informationen zu Klassen und Methoden finden Sie in der API-Referenz.

    Klasse Beschreibung
    spAriaUtil

    Zeigen Sie Nachrichten in einem Screen Reader an.

    spContextManager

    Machen Sie Daten aus einem Serviceportal -Widget für andere Anwendungen und Services auf einer Serviceportal -Seite verfügbar. Übergeben Sie beispielsweise Widget-Daten an Mitarbeiterchat, wenn sie auf einer Serviceportal -Seite geöffnet werden.

    spUtil

    Utility-Methoden zum Ausführen allgemeiner Funktionen in einem Serviceportal -Widget-Client-Skript.

    spModal

    Zeigen Sie Warnungen, Eingabeaufforderungen und Bestätigungsdialoge in Serviceportal -Widgets an. Die Klasse „spModal“ ist in Service Portal-Client-Skripts verfügbar.

    Hinweis:
    g_form als globales Objekt kann nicht in einem Widget-Client-Controller oder in einem UI-Skript verwendet werden.

    Serviceportal serverseitige APIs

    Dies sind Serviceportal APIs, die Sie in einem Widget-Serverskript verwenden können.

    Klasse Beschreibung
    GlideSPScriptable

    Interagieren Sie mit Daten und führen Sie Datensatzvorgänge in Serviceportal -Widgets aus.

    GlideSPSearchAnalytics

    Generiert Suchanalysen aus benutzerdefinierten ServiceNow Such-Widgets.

    SPScriptedFacet - Scoped

    Definieren Sie Aspektelemente, Filter oder zugeordnete Abfragen für ein Aspekte-Objekt.

    SPScriptedFacetService - Scoped

    Generieren Sie ein Aspekte-Objekt mit mehreren oder nur einer Auswahl für eine erweiterte Suchquelle.

    SPSEOUtilsSNC - Global

    Geben Sie basierend auf der Transaktionsanforderung visuell lesbare URLs für eine bestimmte Seite oder für die aktuelle Seite zurück.

    SPWidgetAccessControl - Global

    Überprüfen Sie, ob einer bereitgestellten Tabelle Zugriff auf ein Widget gewährt wird, um sicherzustellen, dass eine vorgesehene Zielgruppe sicher auf ein Widget zugreifen kann.

    Widget-Eigenschaften

    Verfügbare globale Variable und Funktionen in Widget-Client- und -Serverskripts.

    Globale Objekte des Serverskripts

    Eigenschaft Beschreibung
    Eingabe Ein Objekt, das clientseitige Eigenschaften enthält, die unter c.data festgelegt sind. Der Wert ist nicht definiert, bis der Client-Controller c.server.update() aufruft.
    Daten Ein Objekt, das Eigenschaften enthält, die während der serverseitigen Ausführung festgelegt wurden.
    Optionen Ein Objekt, das die Schemaoption-Eigenschaften enthält.

    Globale Funktionen des Clientskripts

    Eigenschaft Beschreibung
    this.server.get([Object]) Ruft den Server auf und sendet benutzerdefinierte Eingaben. Gibt Versprechen aus.
    this.server.update() Ruft den Server auf und postet this.data zum Serverskript. Gibt Versprechen aus.
    this.server.refresh() Ruft den Server auf und ersetzt automatisch die aktuellen Optionen und Daten aus der Serverantwort. Gibt Versprechen aus.

    Ein Versprechen repräsentiert das eventuelle Ergebnis einer asynchronen Operation. Weitere Informationen zu Versprechen finden Sie unter https://promisesaplus.com/ oder in der AngularJS-Dokumentation.