API para formularios HTML y llamadas

La tabla a continuación describe las API específicas de UiPath que se pueden usar al crear formularios y avisos HTML personalizados. Estas API se pueden usar de forma independiente dentro de formularios HTML, lo que genera el cambio de tamaño de un formulario, o se pueden usar como mensajes para enviar de nuevo a Studio, para que los flujos de trabajo desencadenadores puedan continuar ejecutándose. Estas API están escritas como JavaScript.

Formularios y avisos

La tabla a continuación muestra las API que puede usar al crear formularios y avisos en HTML. Las API pueden actuar como oyentes de eventos y activar una función de devolución de llamada e, que luego puedes utilizar para acceder a otras propiedades del formulario o aviso, como la altura, la anchura o la parte superior. También puede probar otras propiedades presionando inspeccionar en el formulario y luego escribiendo las propiedades directamente en la consola.

También puede usar las API para obtener y establecer valores de formulario y desencadenar eventos de formulario.

API	Descripción	Ejemplo de JavaScript
uiPath.form.isVisible	Compruebe si el formulario está actualmente visible en la pantalla. Devuelve un valor booleano que indica si el formulario está visible u 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) => {})	Configurar un receptor de eventos para detectar cambios en el estado de visibilidad de un formulario. Cuando cambia la visibilidad del formulario, se ejecuta la función de devolución de llamada especificada. Esto brinda la oportunidad de realizar acciones o actualizaciones en respuesta a la visibilidad u oculta del formulario. El parámetro e de la función de devolución de llamada representa el evento y puedes acceder a sus propiedades para determinar el nuevo estado de visibilidad, como e.detail.	uiPathApi.form.addEventListener("visibilityChanged", (e) => { console.log("form visibility changed triggered: " + e.detail); });
uiPathApi.form.addEventListener("locationChanged", (e) => {})	Configure un receptor de eventos que responda a los cambios en la posición de un formulario. Cuando cambia la ubicación del formulario, se ejecuta la función de devolución de llamada proporcionada. Dentro de la función de devolución de llamada, tienes acceso al parámetro e , que representa el evento. Este objeto de evento contiene información sobre el cambio de ubicación, como las nuevas coordenadas izquierda (e.detail.left) y superior (e.detail.top) del formulario.	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)	Te permite recuperar valores del formulario.	getValue: function (elementId) { if (elementId == 'getArray') { return [1, 2, 3]; }
setValue: function (elementId, value)	Te permite establecer valores del formulario.	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)	Le permite desencadenar un evento de formulario, como Cerrado. Dentro de la actividad desencadenador del formulario, solo se puede acceder a cualquier evento de formulario que crees con esta API como evento de mensaje del formulario .	sendMessage: function (id, value) { }

Avisos

La tabla a continuación muestra las API que puede usar al crear avisos en HTML. Estas API te permiten extraer detalles sobre el elemento de destino al que se vincula la llamada. Las API actúan como oyentes de eventos y activan una función de devolución de llamada e, que luego puedes utilizar para acceder a otras propiedades del destino, como la altura, la anchura y la parte superior. También puede probar otras propiedades presionando inspeccionar en la llamada y luego escribiendo las propiedades directamente en la consola.

API	Descripción	Ejemplo de JavaScript
uiPathApi.target.visibile	Compruebe si el elemento de destino asociado con una llamada está visible en la pantalla actualmente. Devuelve un valor booleano que indica si el elemento está visible u 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 un receptor de eventos para cambios en la visibilidad del elemento de destino. Cuando cambia la visibilidad del elemento, se ejecuta la función de devolución de llamada especificada. Luego puedes obtener los detalles sobre la visibilidad del destino usando la función de devolución de llamada y configurar un contador para rastrear cuántas veces cambió la visibilidad del destino.	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 un receptor de eventos que responda a los cambios en la posición (izquierda o arriba) del elemento de destino. Cuando cambia la posición del elemento, se ejecuta la función de devolución de llamada proporcionada. Luego puedes obtener los detalles sobre la ubicación actual del destino usando la función de devolución de llamada y configurar un contador para saber cuántas veces ha cambiado la ubicación.	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) => {})	Configura un receptor de eventos para detectar cambios en el tamaño (ancho o alto) del elemento de destino. Cuando cambia el tamaño del elemento, se ejecuta la función de devolución de llamada especificada. A continuación, puedes obtener la anchura y la altura del elemento de destino y configurar un contador para realizar un seguimiento de cuántas veces ha cambiado el tamaño del destino.	uiPathApi.target.addEventListener("sizeChanged", (e) => { window.targetSizeChangedArg = e.detail.width + " " + e.detail.height; window.targetSizeChangedCount++; console.log("target size changed triggered: " + window.targetSizeChangedArg);