API UI Automation

Les API vous permettent d'accéder aux services proposés dans le menu Gérer les packages et d'interagir avec ceux-ci. Vous pouvez utiliser ces API lorsque vous créez des automatisations codées. Rendez-vous sur la page Automatisations codées pour en savoir plus sur les automatisations codées et sur leur conception via API.

Remarque : l'utilisation de l'option Aller à Définition (Go to Definition) (F12) permet d'accéder à la définition des API UiPath pour un certain service. Nous vous recommandons de vous fier uniquement aux API directement exposées lorsque vous implémentez des automatisations codées. Les autres API qui ne sont pas directement exposées avec un service sont susceptibles d'être modifiées sans notification préalable.

Surcharges

Les API ont souvent des surcharges, ce qui signifie qu'elles fournissent plusieurs versions de la même méthode avec différentes options de paramètres. Les surcharges vous permettent de personnaliser le comportement de l'API en fonction de vos besoins. Par exemple, une API UI Automation peut avoir une surcharge qui accepte un paramètre de délai d'attente pour préciser le temps d'attente maximal d'un élément d'IU avant de terminer l'exécution.

En utilisant les API avec leurs surcharges respectives, vous pouvez facilement obtenir la logique et le comportement d'automatisation souhaités.

API UI Automation

Cette section inclut les API dans le service UiPath.UIAutomationNext.API.Contracts.

API	Description
Joindre	Se concentre sur une application de bureau ou une page de navigateur Web déjà ouverte, à utiliser dans UI Automation.
Vérifier (Check)	Coche ou décoche une case ou un bouton radio.
Cliquer (Click)	Clique sur un élément d’IU indiqué, par exemple un bouton ou un lien. Vous pouvez configurer davantage l'action de clic, en fonction de votre cas d'utilisation.
ClosePopup	Ferme toutes les fenêtres contextuelles qui se trouvent au-dessus de l'application.
Glisser et déposer	Exécute une opération de glisser-déposer de l’élément d’interface utilisateur source vers l’élément d’interface utilisateur de destination.
Extraire des données	Extrait les données sous la forme d'une table de données.
Obtenir l'attribut (Get Attribute)	Récupère la valeur d’un attribut spécifié de l’élément d’IU indiqué.
ObtenirEnfants	Récupère les enfants d'une cible spécifiée.
ObtenirCibleRuntime	Récupère la cible runtime d’une cible spécifiée.
GetText	Extrait et copie le texte d'un élément d'IU.
Get URL	Récupère l'URL de la page Web actuelle.
GoToUrl	Accède à l'URL spécifiée dans le navigateur Web indiqué.
Mettre en surbrillance (Highlight)	Met en surbrillance visuellement un élément d'IU spécifié en l'entourant dans une boîte.
Pointer (Hover)	Récupère l'URL de la page Web actuelle.
IsEnabled	Vérifie si un élément d'IU est activé.
Raccourci clavier	Envoie un ou plusieurs raccourcis clavier à un élément d'IU.
Mouse scroll	Permet de faire défiler les applications en envoyant des événements de défilement de la souris à l’élément d’IU spécifié.
Ouvrir	Ouvre une application de bureau ou une page de navigateur Web à utiliser dans UI Automation.
Sélectionner l'élément (Select Item)	Sélectionne un élément dans une zone de liste déroulante ou une zone de liste.
SetRuntimeBrowser	Définit le navigateur de runtime actif actuellement.
SetValue	Définit une valeur sur n'importe quel champ d'entrée : zone d'entrée, liste déroulante, case à cocher, bouton radio.
Prendre une capture d'écran (Take Screenshot)	Prend une capture d'écran d'un élément d'IU ou d'une application spécifié et l'enregistre dans un fichier.
Saisir dans (Type Into)	Entre du texte dans un élément d'IU spécifié, par exemple une zone de texte. Vous pouvez également envoyer des touches spéciales telles que Tab ou Entrée à l'élément d'IU.
ÉtatAttente	Vérifie l'état d'une application ou d'un navigateur Web en vérifiant si un élément apparaît ou disparaît de l'interface utilisateur.

Utilisation des API UI Automation

Vous pouvez utiliser les API UIAutomation en combinaison avec des éléments d'IU. Le processus d'automatisation de l'interface utilisateur consiste à ouvrir l'application souhaitée ou à se concentrer sur celle-ci, puis à automatiser ses éléments d'interface utilisateur. Effectuer les étapes suivantes pour automatiser une application à l'aide des API UI Automation :

1. Appelez le service UIAutomation lorsque vous utilisez Attacher et ouvrir des API. Ces API s'utilisent seules pour ouvrir ou cibler une application ou un navigateur Web.
   1. Lorsque vous travaillez avec des éléments d'IU capturés dans le Référentiel d'objets en tant que descripteurs, utilisez l'API Ouvrir (Open) ou Joindre (Attach) avec la surcharge IScreenDescriptor :

      uiAutomation.Open(ObjectRepository.Decriptors.<ApplicationName>.<ScreenName>)

   2. Pour les sélecteurs natifs, copiez la balise <app/> de l'application à l'aide d'UI Explorer et utilisez l'API Ouvrir (Open) avec la surcharge TargetAppModel :

      var applicationScreen = uiAutomation.Open(Target.FromSelector("<html app = 'chrome.exe'/>"))

2. Appelez les API UI Automation directement sur un élément d'IU.
   1. Lorsque vous travaillez avec des éléments d'IU capturés dans le Référentiel d’objets en tant que descripteurs, utilisez le reste des API avec la surcharge IElementDescriptor :

      var applicationScreen = uiAutomation.Open(ObjectRepository.Decriptors.<ApplicationName>.<ScreenName>)
      applicationScreen.TypeInto(ObjectRepository.Descriptors.<ApplicationName>.<ScreenName>.<ElementName>, "Hello")

   2. Pour les sélecteurs natifs, copiez la balise <webctrl/> de l'élément à l'aide d' UI Explorer et utilisez le reste des API avec les surcharges TargetAnchorableModel :

      var applicationScreen = uiAutomation.Open(Target.FromSelector("<html app = 'chrome.exe'/>"));
      applicationScreen.TypeInto(Target.FromSelector("<webctrl id='generalClick' tag='BUTTON'/>"), "Hello")