APIs

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 d'automatisation mobile

Cette section inclut les API dans le service UiPath.MobileAutomation.API.Models.

API	Description
Dispose	Libère les ressources utilisées pendant l’automatisation, efface la mémoire prise par ces actions et renvoie le Connection à son état d’origine. Cela rend ces ressources disponibles pour d'autres tâches sur un Connection.
DrawPattern	Trace un chemin marqué par plusieurs points sur l'écran de l'appareil. Les points qui créent le chemin sont enregistrés à partir du chemin du doigt sur l'écran de l'appareil. Vous pouvez ajouter plusieurs chemins tactiles pour simuler des interactions d'écran impliquant plusieurs doigts.
ElementExists	Renvoie une variable booléenne indiquant si un élément d'IU spécifié existe.
ExecuteCommand	Exécuter des commandes mobiles natives qui ne sont pas associées à un point de terminaison spécifique.
Finalize	Permet à un objet d'effectuer des opérations de nettoyage et de libérer des ressources avant qu'il ne soit récupéré par la collecte indésirable. Implémente la méthode Object.Finalize .
Obtenir l'attribut (Get Attribute)	Récupère un attribut d'un élément d'IU spécifié.
GetDeviceOrientation	Récupère l'orientation actuelle de l'appareil mobile spécifié.
GetLogTypes	Récupère les types de journaux d'un appareil connecté via l'appareil mobile Connection.
GetPageSource	Récupère la source de la page à partir d'un appareil mobile connecté via la classe Connection .
GetSelectedItem	Récupère l'élément sélectionné à partir d'un élément d'IU cible.
GetSessionIdentifier	Récupérez l' ID de session de la connexion actuelle au gestionnaire d'appareils mobiles pour acheminer les commandes HTTP vers les points de terminaison Appium afin de pouvoir effectuer des Actionspersonnalisées .
GetSystemTime	Récupère l'heure actuelle de l'appareil.
GetText	Extracts the text from a specified UI element and returns it as a String variable.
InstallApp	Installe une application spécifiée sur un appareil mobile connecté via Connection.
ManageCurrentApplication	Réinitialise ou lance l'application actuelle pour cette session.
ManageOtherApplication	Gère d'autres applications à l'aide de commandes.
OpenDeepLink	Ouvre un lien profond dans une application.
OpenUrl	Ouvre une URL dans Chrome. Avant d'appeler cette méthode, l'application active actuelle doit être Chrome et avoir au moins un onglet ouvert.
PositionalSwipe	Balaie vers un emplacement prédéfini de l'écran avec des points de début et de fin.
PressHardwareButton	Appuie sur un bouton matériel de l'appareil connecté
SaveLogs	Enregistrez les journaux d'un type spécifique dans un fichier.
SetDeviceGeoLocation	Définit la géolocalisation actuelle de l'appareil.
SetDeviceOrientation	Modifie et récupère l'orientation de l'appareil connecté.
SetSelectedItem	Définissez l'élément sélectionné sur un élément d'IU cible.
SetText	Saisit le texte spécifié dans un élément d'IU cible, reconnu par l'automatisation mobile.
Balayer	L'opération de balayage parcourt plusieurs balayages dans la liste (jusqu'à NombreMaxBalayages) jusqu'à ce qu'il localise l'élément spécifié.
Prendre une capture d'écran (Take Screenshot)	Prend une capture d'écran de l'écran de l'appareil mobile que vous utilisez avec des dimensions personnalisées spécifiées dans les paramètres Hauteur ( Height ) et Largeur (Width).
Tap	Renvoie une variable booléenne indiquant si un élément d'IU spécifié existe. L'API n'a pas de valeur de retour, mais si l'élément d'IU spécifié existe (valeur booléenne), elle effectue des opérations d'appui dessus.
TypeText	Prend le contenu tapé au clavier avec le clavier et le colle dans l’élément d’IU actuellement actif. Pour coller le texte à l'intérieur de l'élément souhaité, vous devez vous concentrer n'importe où sur l'interface utilisateur où vous souhaitez coller le texte. Vous pouvez utiliser cette API lors de l'automatisation d'applications pour lesquelles vous devez saisir du texte via le clavier, mais sans élément cible reconnu par Mobile Automation.

Utilisation des API

Utilisez le format suivant pour appeler une API à partir du service correspondant : service.API. Par exemple, system.GetAsset.

Utilisation des API d'automatisation mobile

Pour utiliser les API d'automatisation mobile, établissez d'abord une connexion à votre appareil et à votre application (visitez Connexion pour en savoir plus), puis appelez les méthodes d'automatisation souhaitées sur cette connexion, telles que connection.Tap(<selector>); ou var orientation = connection.GetDeviceOrientation();.