API de automatización de IU

Las API te permiten acceder e interactuar con los servicios ofrecidos en el menú Gestionar paquetes. Puedes utilizar estas API al diseñar automatizaciones. Visita Automatizaciones codificadas para obtener más información sobre las automatizaciones codificadas y cómo diseñarlas utilizando API.

Nota: Al utilizar Ir a definición (F12), puedes acceder a la definición de las API de UiPath para un determinado servicio. Recomendamos confiar solo en las API expuestas directamente al implementar automatizaciones codificadas. Otras API que no estén expuestas directamente a un servicio serán sujeto de cambios sin notificación previa.

Sobrecargas

Las API tienen sobrecargas con frecuencia, lo que significa que proporcionan varias versiones del mismo método con diferentes opciones de parámetros. Las sobrecargas te permiten personalizar el comportamiento de la API en función de tus requisitos específicos. Por ejemplo, una API de automatización de IU puede tener una sobrecarga que acepte un parámetro de tiempo de espera para especificar el tiempo máximo de espera para que aparezca un elemento de IU antes de finalizar la ejecución.

Al utilizar las API con sus respectivas sobrecargas, puedes lograr fácilmente la lógica y el comportamiento de automatización deseados.

API de automatización de IU

Esta sección incluye las API que en el servicio UiPath.UIAutomationNext.API.Contracts.

API	Descripción
Adjuntar	Se centra en una aplicación de escritorio o en una página de navegador web que ya está abierta para su uso en la automatización de IU.
Comprobar	Selecciona o borra una casilla de verificación o un botón de opción.
Clic	Haz clic en un elemento de la interfaz de usuario especificado, por ejemplo, un botón o un enlace. Puedes configurar aún más la acción de clic en función de tu caso de uso.
ClosePopup	Descarta todas las ventanas emergentes que se encuentran en la parte superior de la aplicación.
Arrastrar y soltar	Ejecuta una operación de arrastrar y soltar desde el elemento de la interfaz de usuario de origen al elemento de la interfaz de usuario de destino.
Extraer datos	Extrae datos como tabla de datos.
Obtener atributo	Recupera el valor de un atributo especificado del elemento de IU indicado.
ObtenerSecundarios	Recupera los elementos secundarios de un destino especificado.
ObtenerRuntimeDestino	Recupera el destino de runtime de un destino especificado.
GetText	Extrae y copia el texto de un elemento de la interfaz de usuario.
Obtener URL	Recupera la URL de la página web actual.
GoToUrl	Navega a la URL especificada en el navegador web indicado.
Resaltar	Resalta de forma visual un elemento de la IU especificado rodeándolo en un cuadro.
Mantener el puntero	Recupera la URL de la página web actual.
IsEnabled	Comprueba si un elemento de IU está habilitado.
Atajo del teclado	Envía uno o más atajos de teclado a un elemento de la IU.
Desplazamiento del ratón	Habilita el desplazamiento en las aplicaciones enviando eventos de desplazamiento del ratón al elemento de la IU especificado.
Abrir	Abre una aplicación de escritorio o una página del navegador web para usar en la automatización de IU.
Seleccionar elemento	Selecciona un elemento de un cuadro combinado desplegable o cuadro de lista.
SetRuntimeBrowser	Establece el navegador de runtime actualmente activo.
SetValue	Establece un valor en cualquier campo de entrada: cuadro de entrada, menú desplegable, casilla de verificación, botón de opción.
Realizar captura	Toma una captura de pantalla de un elemento de IU o una aplicación especificados y lo guarda en un archivo.
Escribir en	Introduce texto en un elemento de la IU especificado, por ejemplo, un cuadro de texto. También puede enviar teclas especiales como Tab o Intro al elemento de la interfaz de usuario.
EsperarEstado	Comprueba el estado de una aplicación o navegador web verificando si un elemento aparece o desaparece de la interfaz de usuario.

Utilizar API de automatización de IU

Puedes utilizar las API de automatización de IU en combinación con los elementos de la IU. El proceso de automatización de las aplicaciones de IU implica abrir la aplicación deseada o centrarse en ella y, a continuación, automatizar sus elementos de la IU. Realiza los siguientes pasos para automatizar una aplicación utilizando las API de automatización de IU:

1. Llame al servicio de automatización de IU cuando use las API Adjuntar y Abrir . Estas API se utilizan solas para abrir o centrarse en una aplicación o navegador web.
   1. Al trabajar con elementos de IU capturados en el repositorio de objetos como descriptores, emplea la API Abrir o Adjuntar con la sobrecarga IScreenDescriptor:

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

   2. Para los selectores nativos, copia la etiqueta <app/> de la aplicación utilizando el UI Explorer y utiliza la API Abrir con la sobrecarga TargetAppModel:

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

2. Llamar a las API de automatización de la interfaz de usuario directamente en un elemento de la interfaz de usuario.
   1. Al trabajar con elementos de IU capturados en el repositorio de objetos como descriptores, emplea el resto de las API con la sobrecarga IElementDescriptor:

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

   2. Para los selectores nativos, copia la etiqueta <webctrl/> del elemento utilizando el UI Explorer y emplea el resto de las API con las sobrecargas TargetAnchorableModel:

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