APIs

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 móvel

Esta seção inclui as APIs encontradas no serviço UiPath.MobileAutomation.API.Models.

API	Description
Dispose	Libera recursos usados durante a automação, limpa a memória tomada por essas ações e retorna o Connection de volta ao seu estado original. Isso disponibiliza esses recursos para outras tarefas em um Connection.
DrawPattern	Desenha um caminho marcado por vários pontos na tela do dispositivo. Os pontos que criam o caminho são gravados a partir do caminho do dedo na tela do dispositivo. É possível adicionar vários caminhos de dedos para simular interações de tela que envolvam vários dedos.
ElementExists	Retorna uma variável de booleano que declara se um elemento de interface gráfica especificado existe.
ExecuteCommand	Execute comandos móveis nativos que não estão associados a um ponto de extremidade específico.
Finalize	Permite que um objeto execute operações de limpeza e libere recursos antes que ele seja recuperado pelo coleta de lixo. Implementa o método Object.Finalize .
Get Attribute	Recupera um atributo de um elemento de interface gráfica especificado.
GetDeviceOrientation	Recupera a orientação atual do dispositivo móvel especificado.
GetLogTypes	Recupera os tipos de log de um dispositivo conectado por meio do dispositivo móvel Connection.
GetPageSource	Recupera a origem da página de um dispositivo móvel conectado por meio da classe Connection .
GetSelectedItem	Recupera o item selecionado de um elemento de interface gráfica de destino.
GetSessionIdentifier	Recupere o ID da sessão da conexão atual do Mobile Device Manager para encaminhar comandos HTTP para pontos de extremidade do Appium, para que você possa executar Actionspersonalizadas.
GetSystemTime	Recupera a hora atual do dispositivo.
GetText	Extracts the text from a specified UI element and returns it as a String variable.
InstallApp	Instala um aplicativo especificado em um dispositivo móvel conectado por meio de Connection.
ManageCurrentApplication	Redefine ou inicia o aplicativo atual para esta sessão.
ManageOtherApplication	Gerencia outros aplicativos usando comandos.
OpenDeepLink	Abre um link profundo dentro de um aplicativo.
OpenUrl	Abre um URL no Chrome. O aplicativo atualmente ativo deve ser o Chrome, com pelo menos uma guia aberta, antes de chamar este método.
PositionalSwipe	Desliza para um local predefinido na tela com pontos inicial e final.
PressHardwareButton	Pressiona um botão do hardware no dispositivo conectado.
SaveLogs	Salvar logs de um tipo específico em um arquivo.
SetDeviceGeoLocation	Define a localização geográfica atual do dispositivo.
SetDeviceOrientation	Muda e depois recupera a orientação do dispositivo conectado.
SetSelectedItem	Define o item selecionado em um elemento de interface gráfica de destino.
SetText	Digita o texto especificado em um elemento de interface gráfica de destino, reconhecido pelo Mobile Automation.
Deslizar	A operação de deslizar itera através de várias ações de deslizar na lista (até atingir o valor MaxNumberOfSwipes) até localizar o elemento especificado.
Take Screenshot	Faz uma captura de tela do dispositivo móvel que você está usando com dimensões personalizadas especificadas nos parâmetros Altura e Largura .
Tap	Retorna uma variável de booleano que declara se um elemento de interface gráfica especificado existe. A API não tem um valor de retorno, mas se o elemento de interface gráfica especificado existir (valor booleano), então ele executará operações de toque nele.
TypeText	Leva o conteúdo digitado pelo teclado e cola-o no elemento de interface gráfica atualmente ativo. Para colar o texto dentro do elemento desejado, você precisa focar onde deseja colar o texto. Você pode usar essa API ao automatizar aplicativos para os quais você precisa digitar texto através do teclado, mas sem um elemento de destino que seja reconhecido pelo Mobile Automation.

Uso de APIs

Use o seguinte formato para chamar uma API a partir do serviço correspondente: service.API Por exemplo, system.GetAsset

Uso de APIs de Automação Móvel

Para usar APIs de Automação Móvel, você primeiro estabelece uma conexão com seu dispositivo e aplicativo (consulte Conexão para saber mais) e, em seguida, chame os métodos de automação desejados nesta conexão, como connection.Tap(<selector>); ou var orientation = connection.GetDeviceOrientation();.