APIs de Automação de interface gráfica

As APIs permitem acessar e interagir com os serviços oferecidos no menu Gerenciar pacotes. Você pode usar essas APIs ao projetar automações codificadas. Visite Automações codificadas para saber mais sobre automações codificadas e como projetá-las usando APIs.

Observação: usar Ir para a definição (F12) permite que você acesse a definição de APIs da UiPath para um determinado serviço. Recomendamos confiar apenas nas APIs expostas diretamente ao implementar automações codificadas. Outras APIs não diretamente expostas com um serviço estão sujeitas a alterações sem notificação prévia.

Sobrecarregas

As APIs frequentemente têm sobrecargas, o que significa que fornecem várias versões do mesmo método com diferentes opções de parâmetros. As sobrecargas permitem que você personalize o comportamento da API com base em seus requisitos específicos. Por exemplo, uma API de Automação de interface gráfica pode ter uma sobrecarga que aceita um parâmetro de tempo limite para especificar o tempo máximo para esperar pela exibição de um elemento de interface gráfica antes de terminar a execução.

Ao usar as APIs com suas respectivas cargas de trabalho, você pode facilmente atingir a lógica e o comportamento de automação desejados.

APIs de Automação de interface gráfica

Esta seção inclui as APIs encontradas no serviço UiPath.UIAutomationNext.API.Contracts.

API	Description
Anexar	Concentra-se em um aplicativo de área de trabalho ou página do navegador da Web que já está aberto, para usar em Automação de interface gráfica.
Marcar	Marca ou desmarca uma caixa de seleção ou um botão de opção.
Click	Clica em um elemento de IU especificado, por exemplo, um botão ou link. Você pode configurar ainda mais a ação de clique, de acordo com seu caso de uso.
ClosePopup	Ignora todos os pop-ups que estão na parte superior do aplicativo.
Drag and Drop	Executa uma operação de arrastar e soltar do elemento de interface gráfica de origem para o de destino.
Extrair dados	Extrai dados como tabela de dados.
Get Attribute	Recupera o valor de um atributo especificado de um elemento de interface gráfica indicado.
GetChildren	Recupera os filhos de um destino especificado.
GetRuntimeTarget	Recupera o destino do runtime de um destino especificado.
GetText	Extrai e copia o texto de um elemento de IU.
Get URL	Recupera o URL da página web atual.
GoToUrl	Navega para a URL especificada no navegador da Web indicado.
Highlight	Realça visualmente um elemento de interface gráfica especificado delimitando-o em uma caixa.
Hover	Recupera o URL da página web atual.
IsEnabled	Verifica se um elemento de interface gráfica está habilitado.
Atalho do Teclado	Envia um ou mais atalhos de teclado a um elemento de interface gráfica.
Mouse Scroll	Habilita a rolagem em aplicativos enviando eventos de rolagem do mouse para o elemento de interface gráfica especificado.
Abrir	Abre um aplicativo da área de trabalho ou uma página do navegador da Web para serem usados na automação de interface gráfica.
Select Item	Seleciona um item de uma caixa de combinação suspensa ou caixa de listagem.
SetRuntimeBrowser	Define o navegador de runtime ativo no momento.
SetValue	Define um valor em qualquer campo de entrada: caixa de entrada, menu suspenso, caixa de seleção, botão de rádio.
Take Screenshot	Obtém uma captura de tela de um elemento de interface gráfica ou aplicativo especificado e a salva em um arquivo.
Type Into	Insere texto em um elemento de interface do usuário especificado, por exemplo, uma caixa de texto. Também é possível enviar teclas especiais como Tab ou Enter para o elemento de interface gráfica.
Aguardar Estado	Verifica o estado de um aplicativo ou navegador da web verificando se um elemento aparece ou desaparece da interface do usuário.

Uso de APIs de Automação de interface gráfica

Você pode usar APIs de automação de interface gráfica em combinação com elementos de interface gráfica. O processo de automatização de aplicativos de interface gráfica envolve abrir o aplicativo desejado ou concentrar-se nele e, em seguida, automatizar seus elementos de interface gráfica. Execute as seguintes etapas para automatizar um aplicativo usando APIs de automação de interface gráfica:

1. Chame o serviço de Automação de Interface Gráfica ao usar as APIs Attach e Open . Essas APIs são usadas por conta própria para abrir ou se concentrar em um aplicativo ou navegador web.
   1. Ao trabalhar com elementos de interface gráfica coletados no Repositório de objetos como descritores, empregue a API Abrir ou Anexar com a sobrecarga IScreenDescriptor:

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

   2. Para seletores nativos, copie a tag <app/> do aplicativo usando o UI Explorer e utilize a Open API com a sobrecarga TargetAppModel:

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

2. Chamar as APIs de Automação de Interface Gráfica diretamente em um elemento de interface gráfica.
   1. Ao trabalhar com elementos de interface gráfica coletados no Repositório de objetos como descritores, empregue o restante das APIs com a sobrecarga IElementDescriptor:

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

   2. Para seletores nativos, copie a tag <webctrl/> do elemento usando o UI Explorer e empregue o resto das APIs com as sobrecargas TargetAnchorableModel:

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