Présentation de l’exécution d’opérations globales avec l’objet Xrm de l’API client

8 minutes

L’API client fournit l’objet Xrm disponible globalement dans votre code, afin d’effectuer diverses activités sans avoir à utiliser le contexte d’exécution. Le schéma général suivant illustre chacune des propriétés et méthodes disponibles. Pour une présentation détaillée de cet objet, consultez Objet Xrm de l’API client.

Objet App

Grâce à la méthode addGlobalNotification de l’objet App, vous pouvez afficher une notification d’erreur, d’information, d’avertissement ou de succès pour une application et spécifier les actions à exécuter en fonction de la notification. Cette notification est similaire aux notifications de formulaire, mais vous pouvez l’utiliser en dehors du contexte d’un formulaire. Par exemple, un script de barre de commandes peut informer un utilisateur d’une action terminée. Effacez une notification de l’application à l’aide de la méthode clearGlobalNotification.

Objet Device

L’objet Xrm.Device expose les capacités des appareils natifs liées aux interactions avec les appareils mobiles, sauf la méthode pickFile, également accessible au moyen des clients web. Les applications canevas fournissent aussi une infrastructure extensible pour le développement mobile et doivent être prises en compte dans ces scénarios. Le tableau suivant présente les méthodes disponibles dans l’objet Xrm.Device :

Méthode	Description
captureAudio	Appelle le microphone de l’appareil pour enregistrer de l’audio.
captureImage	Appelle la caméra de l’appareil pour capturer une image.
captureVideo	Appelle la caméra de l’appareil pour enregistrer une vidéo.
getBarcodeValue	Appelle la caméra de l’appareil pour analyser les informations du code-barres, comme un numéro de produit.
getCurrentPosition	Renvoie l’emplacement actuel à l’aide de la fonction de géolocalisation de l’appareil.
pickFile	Ouvre une boîte de dialogue pour sélectionner des fichiers sur votre ordinateur (client web) ou appareil mobile (clients mobiles).

Selon la configuration de l’appareil, certaines fonctionnalités ne sont pas disponibles. Le consentement de l’utilisateur peut également être requis afin que l’application accède à des fonctionnalités spécifiques de l’appareil. Par exemple, l’utilisateur peut avoir désactivé globalement les fonctionnalités de localisation de l’appareil ou refusé que l’application accède à la caméra. Lors du développement d’une application, gardez à l’esprit que ces méthodes peuvent échouer en raison des fonctionnalités de l’appareil, de sa configuration, du manque d’autorisations ou du consentement de l’utilisateur.

Objet Encoding

L’objet Xrm.Encoding vous permet d’encoder et de décoder des chaînes XML et HTML. Cet encodage et ce décodage peuvent être utiles lorsque vous :

interagissez avec des ressources web HTML ;
encodez et décodez des paramètres de chaîne de requête ;
interagissez avec du code FetchXML qui comporte des caractères spéciaux comme « & » ou « < » dans une chaîne de recherche.

L’objet Navigation fournit des méthodes liées à la navigation que vous pouvez utiliser dans une application pilotée par modèle. En raison de leur nature bloquante, des activités telles que l’affichage de boîtes de dialogue d’alerte, de confirmation et d’erreur ne sont pas considérées comme une expérience utilisateur optimale, mais sont malgré tout disponibles. Dans ces scénarios, nous vous recommandons d’envisager des notifications de formulaire ou d’autres mécanismes non bloquants pour avertir les utilisateurs d’un problème. Voici un résumé des méthodes disponibles dans l’objet Xrm.Navigation :

Méthode	Description
openAlertDialog	Affiche une boîte de dialogue d’alerte contenant un message et un bouton.
openConfirmDialog	Affiche une boîte de dialogue de confirmation contenant un message et deux boutons.
openErrorDialog	Affiche une boîte de dialogue d’erreur.
openFile	Ouvre un fichier.
openForm	Ouvre un formulaire de table ou un formulaire de création rapide.
openUrl	Ouvre une URL, y compris les URL de fichiers.
openWebResource	Ouvre une ressource web HTML.

Objet Panel

L’objet Xrm.Panel fournit une méthode pour afficher une page web sur le volet latéral d’un formulaire d’application pilotée par modèle. Cette fonctionnalité est actuellement en version préliminaire et ne sera pas traitée en détail ici. Pour en savoir plus, consultez Xrm.Panel.

Objet Utility

L’objet Xrm.Utility est un conteneur pour diverses méthodes utiles. Le tableau suivant présente les méthodes disponibles dans l’objet Xrm.Utility. Pour en savoir plus, consultez Xrm.Utility (référence de l’API client)

Méthode	Description
closeProgressIndicator	Ferme une boîte de dialogue de progression ouverte à l’aide de showProgressIndicator.
getAllowedStatusTransitions	Renvoie les transitions d’état valides pour le type de table et le code d’état spécifiés.
getEntityMetadata	Renvoie les métadonnées pour l’entité spécifiée.
getGlobalContext	Obtient le contexte global pouvant vous fournir des informations d’exécution, notamment des paramètres d’organisation, des paramètres utilisateur et des informations sur l’application et le client.
getLearningPathAttributeName	Renvoie le nom de l’attribut DOM prévu par le concepteur de contenu du parcours d’apprentissage (aide guidée) pour identifier les contrôles d’IU dans les formulaires d’applications pilotées par modèle.
getResourceString	Renvoie la chaîne localisée pour une clé donnée associée à la ressource web spécifiée.
invokeProcessAction	Appelle une action sur la base des paramètres spécifiés. Cette méthode permet également d’appeler des API personnalisées créées par vos développeurs.
lookupObjects	Ouvre un contrôle de recherche pour sélectionner un ou plusieurs éléments.
refreshParentGrid	Actualise la grille parente contenant l’enregistrement spécifié.
showProgressIndicator	Affiche une boîte de dialogue de progression avec le message spécifié.

Vous pouvez également rencontrer de nombreuses méthodes non répertoriées ici dans un code plus ancien désormais déconseillé, car elles ont été déplacées dans l’espace de noms Xrm.Navigation. Si vous les rencontrez, vous devez mettre à jour le code pour utiliser les nouvelles méthodes Xrm.Navigation.

Objet Xrm.WebAPI

L’objet Xrm.WebAPI fournit des propriétés et des méthodes permettant d’utiliser l’API web pour les opérations CRUD traditionnelles dans un script client. Lorsque vous utilisez l’objet Xrm.WebAPI, dans la logique de votre script, les opérations que vous effectuez le sont automatiquement dans le contexte de l’utilisateur actuel de l’application. Vous pouvez utiliser l’API web lorsque l’application est en ligne et hors connexion (si vous configurez l’environnement pour le mode hors connexion). L’espace de noms comprend un ensemble spécifique de méthodes en ligne et hors connexion. Cependant, leur utilisation nécessite que vous gardiez une trace de l’état du client. Si vous utilisez la méthode Xrm.WebAPI.createRecord de l’objet Xrm.WebAPI, l’API détermine si elle doit utiliser les méthodes d’espace de noms en ligne ou hors connexion pour vous.

Le tableau suivant présente les méthodes disponibles dans l’objet Xrm.WebAPI. Pour en savoir plus, consultez Xrm.WebAPI (référence de l’API client).

Méthode	Description
createRecord	Crée une ligne de table.
deleteRecord	Supprime une ligne de table à l’aide de l’ID de la ligne.
retrieveRecord	Récupère une ligne de table à l’aide de l’ID de la ligne.
retrieveMultipleRecords	Récupère un ensemble de lignes de table correspondant aux options de requête ou au FetchXML fourni(es).
updateRecord	Met à jour une ligne de table.
isAvailableOffline	Renvoie une valeur booléenne qui indique si une table est présente dans le profil d’un utilisateur et disponible en mode hors connexion.
execute	Exécutez une seule action, fonction ou opération CRUD.
executeMultiple	Exécutez un ensemble d’actions, de fonctions ou d’opérations CRUD.

Grâce aux propriétés et méthodes de l’objet Xrm, vous pouvez automatiser les processus métier et améliorer l’expérience utilisateur globale.

Continuer