APIs para formulários HTML e chamadas

A tabela abaixo descreve as APIs específicas da UiPath que podem ser usadas ao criar formulários HTML personalizados e textos explicativos. Essas APIs podem ser usadas como autônomas dentro de formulários HTML, gerando o redimensionamento de um formulário, ou podem ser usadas como mensagens para enviar de volta ao Studio, para que seus fluxos de trabalho de gatilho possam continuar a execução. Essas APIs são escritas como JavaScript.

Formulários e textos explicativos

A tabela abaixo mostra as APIs que você pode usar ao criar formulários e textos explicativos em HTML. As APIs podem atuar como ouvintes de eventos e disparar uma função de retorno de chamada e, que você pode usar posteriormente para acessar outras propriedades do formulário ou texto explicativo, como altura, largura ou parte superior. Além disso, é possível testar outras propriedades pressionando inspecionar no formulário e, em seguida, gravando as propriedades diretamente no console.

Você também pode usar APIs para obter e definir valores de formulário, além de disparar eventos de formulário.

API	Description	Exemplo de JavaScript
uiPath.form.isVisible	Verifique se o formulário está visível na tela no momento. Ele retorna um valor booleano que indica se o formulário está visível ou oculto.	if (uiPath.form.isVisible === true){ console.log("The form is visible"); } else { console.log("The form is not visible"); }
uiPathApi.form.addEventListener("visibilityChanged", (e) => {})	Configure um ouvinte de eventos para detectar alterações no status de visibilidade de um formulário. Quando a visibilidade do formulário muda, a função de retorno de chamada especificada é executada. Isso oferece uma oportunidade para realizar ações ou atualizações em resposta a o formulário se tornar visível ou oculto. O parâmetro e na função de retorno de chamada representa o evento, e você pode acessar suas propriedades para determinar o novo status de visibilidade, como e.detail.	uiPathApi.form.addEventListener("visibilityChanged", (e) => { console.log("form visibility changed triggered: " + e.detail); });
uiPathApi.form.addEventListener("locationChanged", (e) => {})	Configure um ouvinte de evento que responda a alterações na posição de um formulário. Quando o local do formulário muda, a função de retorno de chamada fornecida é executada. Dentro da função de retorno de chamada, você tem acesso ao parâmetro e , que representa o evento. Esse objeto de evento contém informações sobre a alteração no local, como as novas coordenadas à esquerda (e.detail.left) e superior (e.detail.top) do formulário.	uiPathApi.form.addEventListener("locationChanged", (e) => { window.formLocationChangedArg = e.detail.left + " " + e.detail.top; window.formLocationChangedCount++; console.log("form location changed triggered: " + window.formLocationChangedArg); });
getValue: function (elementId)	Permite que você recupere valores do formulário.	getValue: function (elementId) { if (elementId == 'getArray') { return [1, 2, 3]; }
setValue: function (elementId, value)	Permite que você defina os valores do formulário.	setValue: function (elementId, value) { // execute this to throw in case the form element does not exist $("#" + elementId).val().toString(); $("#" + elementId).val(value); },
sendMessage: function (id, value)	Permite que você dispare um evento de formulário, como Encerrado. Dentro da atividade Form Trigger, qualquer evento de formulário que você criar usando essa API poderá ser acessado apenas como um Evento de mensagem de formulário .	sendMessage: function (id, value) { }

Textos Explicativos

A tabela abaixo mostra as APIs que você pode usar ao criar textos explicativos em HTML. Essas APIs permitem que você extraia detalhes sobre o elemento de destino ao qual o texto explicativo está associado. As APIs atuam como ouvintes de eventos e disparam uma função de retorno de chamada e, que você pode usar posteriormente para acessar outras propriedades do destino, como altura, largura e parte superior. Além disso, é possível testar outras propriedades pressionando Inspecionar no texto explicativo e, em seguida, gravando as propriedades diretamente no console.

API	Description	Exemplo de JavaScript
uiPathApi.target.visibile	Verifique se o elemento de destino associado a um texto explicativo está visível na tela no momento. Ele retorna um valor booleano que indica se o elemento está visível ou oculto.	if (uiPath.target.isVisible === true){ console.log("The target is visible"); } else { console.log("The target is not visible"); }
uiPathApi.target.addEventListener("visibilityChanged", (e) => {})	Configure um ouvinte de evento para alterações na visibilidade do elemento de destino. Quando a visibilidade do elemento muda, a função de retorno de chamada especificada é executada. Em seguida, você pode obter os detalhes sobre a visibilidade do destino usando a função de retorno de chamada e configurar um contador para rastrear quantas vezes a visibilidade do destino mudou.	uiPathApi.target.addEventListener("visibilityChanged", (e) => { console.log("target visibility changed triggered: " + e.detail); window.targetVisibilityChangedArg = e.detail; window.targetVisibilityChangedCount++; });
uiPathApi.target.addEventListener("locationChanged", (e) => {})	Configure um ouvinte de evento que responda a alterações na posição (esquerda ou superior) do elemento de destino. Quando a posição do elemento muda, a função de retorno de chamada fornecida é executada. Em seguida, você pode obter os detalhes sobre o local atual do destino usando a função de retorno de chamada e configurar um contador para ele, para que você saiba quantas vezes o local foi alterado.	uiPathApi.target.addEventListener("locationChanged", (e) => { window.targetLocationChangedArg = e.detail.left + " " + e.detail.top; window.targetLocationChangedCount++; console.log("target location changed triggered: " + window.targetLocationChangedArg); });
uiPathApi.target.addEventListener("sizeChanged", (e) => {})	Configure um ouvinte de evento para detectar alterações no tamanho (largura ou altura) do elemento de destino. Quando o tamanho do elemento muda, a função de retorno de chamada especificada é executada. Em seguida, será possível obter a largura e a altura do elemento de destino e configurar um contador para rastrear quantas vezes o tamanho do destino mudou.	uiPathApi.target.addEventListener("sizeChanged", (e) => { window.targetSizeChangedArg = e.detail.width + " " + e.detail.height; window.targetSizeChangedCount++; console.log("target size changed triggered: " + window.targetSizeChangedArg);