---
sourceDocument: Interface utilisateur de la Now Platform Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/platform-user-interface

 Release :

    - xanadu

ft:locale :

    - fr-FR

ft:publication_title :

    - Interface utilisateur de la Now Platform Xanadu

ft:clusterId :

    - platux

bundleId :

    - platux

workflow :

    - Platform


---

# Référence de l'API de widget

# Référence de l'API de widget {#ariaid-title1}

* Rversion finale: Xanadu
* 
* Mis à jour 1 août 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 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 {#widget-api-reference__section_vcg_qkh_j1b}

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.  
{#widget-api-reference__table_skq_rjp_h1b__entry__2}

| Classe | Description |
|-|-|
| [spAriaUtil](https://www.servicenow.com/docs/access?context=spAriaUtil-API&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US) | Affiche les messages sur un lecteur d'écran. |
| [spContextManager (en anglais seulement)](https://www.servicenow.com/docs/access?context=spContextManagerAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US) | 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](https://www.servicenow.com/docs/access?context=spUtilAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US) | Méthodes utilitaires pour exécuter des fonctions courantes dans un Portail de services script client de widget. |
| [spModal](https://www.servicenow.com/docs/access?context=SPModal-API&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US) | 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. |
[ ]

{#widget-api-reference__table_skq_rjp_h1b}  
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 {#widget-api-reference__section_nhs_rkh_j1b}

Il s'agit Portail de services d'API que vous pouvez utiliser dans un script de serveur de widgets.  
{#widget-api-reference__table_sfm_vjp_h1b__entry__2}

| Classe | Description |
|-|-|
| [GlideSPScriptable](https://www.servicenow.com/docs/access?context=c_GlideSPScriptableScopedAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US) | 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](https://www.servicenow.com/docs/access?context=GlideSPSearchAnalyticsAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US) | 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](https://www.servicenow.com/docs/access?context=SPScriptedFacetScopedAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US) | Définit des éléments de facette, des filtres ou des requêtes mappées pour un objet à facettes. |
| [SPScriptedFacetService - Scoped](https://www.servicenow.com/docs/access?context=SPScriptedFacetServiceScopedAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US) | Génère un objet de facettes à choix multiple ou à choix unique pour une source de recherche avancée. |
| [SPSEOUtilsSNC - Global](https://www.servicenow.com/docs/access?context=SPSEOUtilsSNCAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US) | Renvoyer des URL explicites pour une page spécifique ou pour la page actuelle, en fonction de la demande de transaction. |
| [SPWidgetAccessControl - Global](https://www.servicenow.com/docs/access?context=SPWidgetAccessControlGlobalAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US) | 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. |
[ ]

{#widget-api-reference__table_sfm_vjp_h1b}

## Propriétés du widget {#ariaid-title2}

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

### Objets globaux du script serveur {#widget-script-reference__section_p2w_p5h_j1b}

{#widget-script-reference__table_kjh_2ff_dy__entry__2}

| 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. |
[ ]

{#widget-script-reference__table_kjh_2ff_dy}

### Fonctions globales du script client {#widget-script-reference__section_mkf_dgs_f1b}

{#widget-script-reference__table_hdm_g3x_hw__entry__2}

| 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`. |
[ ]

{#widget-script-reference__table_hdm_g3x_hw}

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](https://docs.angularjs.org/api/ng/service/$q).

