Référence de l’API de widget

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

    • Portail de services inclut les API côté client et côté serveur à utiliser dans les scripts client widget et serveur.

    Portail de services API côté client

    Il s’agit Portail de services d’API que vous pouvez utiliser dans un contrôleur client de widget.

    Consultez la référence de l’API pour obtenir des informations détaillées sur la classe et la méthode.

    Classe Description
    spAriaUtil

    Affiche les messages sur un lecteur d’écran.
    spContextManager (en anglais seulement)

    Met les données d’un Portail de services widget à la disposition d’autres applications et services d’une Portail de services page. Par exemple, transmettez les données du widget lorsqu’elles Messagerie instantanée d'agent s’ouvrent dans une Portail de services page.
    spUtil

    Méthodes utilitaires pour exécuter des fonctions courantes dans un Portail de services script client de widget.
    spModal

    Affiche les alertes, les invites et les boîtes de dialogue de confirmation dans Portail de services les widgets. La classe spModal est disponible dans Portail de services les scripts clients.
    Remarque :
    g_form en tant qu’objet global ne peut pas être utilisé dans un contrôleur client de widget ou dans un script d’interface utilisateur.

    Portail de services API côté serveur

    Il s’agit Portail de services d’API que vous pouvez utiliser dans un script de serveur de widgets.

    Classe Description
    GlideSPScriptable

    L’API GlideSPScriptable fournit des méthodes pour interagir avec les données et effectuer des opérations d’enregistrement dans Portail de services les widgets.
    GlideSPSearchAnalytics

    L’API GlideSPSearchAnalytics fournit des méthodes pour générer des analyses de recherche à partir de widgets de recherche personnalisés ServiceNow .
    SPScriptedFacet - Scoped

    Définit des éléments de facette, des filtres ou des requêtes mappées pour un objet à facettes.
    SPScriptedFacetService - Scoped

    Génère un objet de facettes à choix multiple ou à choix unique pour une source de recherche avancée.
    SPSEOUtilsSNC - Global

    Renvoyer des URL explicites pour une page spécifique ou pour la page actuelle, en fonction de la demande de transaction.
    SPWidgetAccessControl - Global

    Vérifiez si une table fournie a accès à un widget pour vous assurer que l’accès à un widget est sécurisé pour une audience cible.

    Propriétés du widget

    Variable globale et fonctions disponibles dans les scripts client widget et serveur.

    Objets globaux du script serveur

    Propriété Description
    entrée Un objet contenant les propriétés côté client définies sous c.data. La valeur n’est pas définie jusqu’à ce que le contrôleur client appelle c.server.update().
    données Objet contenant les propriétés définies lors de l’exécution côté serveur.
    options Objet contenant les propriétés de l’option de schéma.

    Fonctions globales du script client

    Propriété Description
    this.server.get([Objet]) Appelle le serveur et envoie une entrée personnalisée. Renvoie la promesse.
    this.server.update() Appelle le serveur et publie this.data sur le script serveur. Renvoie la promesse.
    this.server.refresh() Appelle le serveur et remplace automatiquement les options actuelles et les données de la réponse du serveur. Renvoie la promesse.

    Une promesse représente le résultat final d’une opération asynchrone. Pour plus d’informations sur les promesses, consultez https://promisesaplus.com/ notre documentation AngularJS.