UiPath.Studio.Activities.Api

En esta sección puedes encontrar más información sobre cómo crear actividades usando UiPath.Studio.Activities.Api.

AssetRequestParameters

Nota: esta característica se introdujo en UiPath.Studio.Activities.Api v21.10.

Estructura utilizada para consultar el IAssetApiService con el fin de recuperar activos de Orchestrator.

Propiedades

Tipo	Nombre
String	Expandir
String	Filtro
String	Seleccionar
String	Ordenar por
int?	Arriba
int?	Omitir
bool?	Recuento

DesignFeatureKeys

Lista de teclas de función para comprobar si una función está disponible.

Propiedades

Tipo	Nombre	Valor	Introducido en
String	Configuración	SettingsV1	Studio 2019.10
String	SettingsV2	SettingsV2	Studio 2020.4
String	SettingsV3	SettingsV3	Studio 2021.10
String	Tema	ThemeV1	Studio 2019.10
String	Asistentes	WizardsV1	Studio 2019.10
String	WizardsV2	WizardsV2	Studio 2020.4
String	WizardsV3	WizardsV3	Studio 2020.4
String	WizardsV4	WizardsV4	Studio 2020.10
String	AccessProvider	AccessProviderV1	Studio 2019.10
String	AccessProviderV2	AccessProviderV2	Studio 2020.10
String	AccessProviderV3	AccessProviderV3	Studio 2020.10
String	Telemetry	TelemetryV1	Studio 2019.10
String	Analizador de flujo de trabajo	WorkflowAnalyzerV1	Studio 2019.10
String	WorkflowAnalyzerV2	WorkflowAnalyzerV2	Studio 2019.10.2
String	WorkflowAnalyzerV3	WorkflowAnalyzerV3	Studio 2019.10.3
String	ProjectProperties	ProjectPropertiesV1	Studio 2020.4
String	ProjectPropertiesV2	ProjectPropertiesV2	Studio 2021.10
String	ProjectPropertiesV3	ProjectPropertiesV3	Studio 2022.4
String	WorkflowAnalyzerV4	WorkflowAnalyzerV4	Studio 2020.4
String	WorkflowAnalyzerV5	WorkflowAnalyzerV5	Studio 2020.4.2
String	WorkflowAnalyzerV6	WorkflowAnalyzerV6	Studio 2020.10
String	WorkflowAnalyzerV7	WorkflowAnalyzerV7	Studio 2020.10
String	WorkflowAnalyzerV8	WorkflowAnalyzerV8	Studio 2020.10.3
String	WorkflowAnalyzerV9	WorkflowAnalyzerV9	Studio 2021.4
String	WorkflowAnalyzerV10	WorkflowAnalyzerV10	Studio 2021.10
String	WorkflowAnalyzerV11	WorkflowAnalyzerV11	Studio 2022.4
String	WorkflowAnalyzerV12	WorkflowAnalyzerV12	Studio 2022.4
String	WorkflowAnalyzerV13	WorkflowAnalyzerV13	Studio 2022.4
String	ScopedActivities	ScopedActivitiesV1	Studio 2020.4
String	ActivitySynonyms	ActivitySynonymsV1	Studio 2021.10
String	Desencadenadores de actividad	ActivityTriggersV1	Studio 2022.4
String	AttendedActivities	AttendedActivitiesV1	Studio 2021.10
String	InstallExtensions	InstallExtensionsV1	Studio 2020.4
String	InstallExcelAddIn	InstallExcelAddInV1	Studio 2020.10
String	ActivityFactory	ActivityFactoryV1	Studio 2020.10
String	ActivityFactoryV2	ActivityFactoryV2	Studio 2020.10
String	ActivityFactoryV3	ActivityFactoryV3	Studio 2021.4
String	ActivityFactoryV4	ActivityFactoryV4	Studio 2022.4
String	StudioDesignSettings	StudioDesignSettingsV1	Studio 2020.10
String	StudioDesignSettingsV2	StudioDesignSettingsV2	Studio 2021.10
String	ExpressionService	ExpressionServiceV1	Studio 2020.10
String	DesignTimeExpressionExpanderService	DesignTimeExpressionExpanderServiceV1	Studio 2021.10
String	ExclusiveScopedActivities	ExclusiveScopedActivitiesV1	Studio 2020.10
String	MockingCapabilities	MockingCapabilitiesV1	Studio 2020.10
String	MockingCapabilitiesV2	MockingCapabilitiesV2	Studio 2020.10
String	ObjectRecorderHighlight	ObjectRecorderHighlight	Studio 2021.10
String	ObjectRecorderCurrentElements	ObjectRecorderCurrentElements	Studio 2021.10
String	Repo. de objetos	ObjectRepositoryV1	Studio 2020.10
String	SimpleObjectRepository	SimpleObjectRepositoryV1	Studio 2021.10
String	ConfiguraciónOrganizativa	OrganizationalSettingsV1	Studio 2020.10.3
String	WindowOperations	WindowOperationsV1	Studio 2021.4
String	WindowOperationsV2	WindowOperationsV2	Studio 2021.4
String	PackageBindings	PackageBindingsV1	Studio 2021.4
String	PackageBindingsV2	PackageBindingsV2	Studio 2021.10
String	PackageBindingsV3	PackageBindingsV3	Studio 2022.4
String	API de Orchestrator	OrchestratorApiV1	Studio 2021.10
String	LicenseApi	LicenseApiV1	Studio 2021.10
String	BusyService	BusyServiceV1	Studio 2021.10
String	ModernClassicSetting	ModernClassicSettingV1	Studio 2021.10
String	AutoCaptureElements	AutoCaptureElements	Studio 2021.10

Observaciones

Puede comprobar si una característica está disponible invocando el método IHasFeature.HasFeature utilizando la clave.

IAssetApiService

Nota: esta característica se introdujo en UiPath.Studio.Activities.Api v21.10.

Expone la API para realizar operaciones relacionadas con activos.

Métodos

Task<IEnumerable<string>> GetAssets(int top, string folder = null)

Devuelve una lista de cadenas que representan los nombres de activos en la carpeta especificada. Si no se especifica una carpeta, se utiliza la carpeta predeterminada.

Tipo de parámetro	Nombre del parámetro	Observaciones
int	Arriba	El número de activos que se van a recuperar.
String	folder	La carpeta en la que están definidos los activos. Si es null, se recuperarán todos los activos visibles para los usuarios actuales.

Task<IEnumerable<string>> GetAssets(AssetRequestParameters requestParameters, string folder = null)

Devuelve una lista de cadenas que representan los nombres de activos en la carpeta especificada. Si no se especifica una carpeta, se utiliza la carpeta predeterminada.

Tipo de parámetro	Nombre del parámetro	Observaciones
AssetRequestParameters	Parámetros de la solicitud	Parámetros de consulta avanzados. Consulta Parámetros de solicitud de activo.
String	folder	La carpeta en la que están definidos los activos. Si es null, se recuperarán todos los activos visibles para los usuarios actuales.

Task<IEnumerable<string\>\> GetAssetFolders(int top)

Devuelve la lista de carpetas accesibles.

Tipo de parámetro	Nombre del parámetro	Observaciones
int	Arriba	El número de carpetas por recuperar.

IExtensionsInstallerService

Una forma de instalar extensiones desde un paquete de actividades.

Métodos

void InstallExtension(string extensionName)

Expone las extensiones instaladas a las actividades.

Tipo de parámetro	Nombre del parámetro	Observaciones
String	extensionName	El nombre de la extensión.

void InstallExcelAddIn()

Desencadena el proceso de instalación del complemento de Excel de UiPath para StudioX.

IOrchestratorApiService

Nota: esta característica se introdujo en UiPath.Studio.Activities.Api v21.10.

Contenedor de nivel superior para operaciones relacionadas con Orchestrator. Expuesto en IWorkflowDesignApi.

Propiedades

Tipo	Nombre	Descripción
IAssetApiService	AssetApiService	Una referencia a una API de Orchestrator relacionada con activos.

IOrganizationalSettingsService

Nota: Esta característica se introdujo en UiPath.Studio.Activities.Api v21.4.

Interfaz que describe cómo leer la configuración de la organización.

Métodos

Task<Dictionary<string, object>> GetSettingsAsync(IEnumerable<string\> keys, CancellationToken ct = default(CancellationToken))

Recupera varias configuraciones organizativas de un origen de datos y devuelve un mapa de las claves encontradas y sus valores.

Tipo de parámetro	Nombre del parámetro	Observaciones
IEnumerable<string>	Claves	Una enumeración de las claves del entorno organizativo.
CancellationToken	ct	Un diccionario que asigna cada una de las claves encontradas y su valor.

IRegisterAnalyzerConfiguration

Componente llamado por la aplicación del analizador en cada conjunto de reglas para configurar el analizador del host.

Métodos

void Initialize(IAnalyzerConfigurationService workflowAnalyzerConfigService)

Ofrece un punto de inyección al ensamblado de implementación para acceder a las capacidades de IAnalyzerConfigurationService .

Tipo de parámetro	Nombre del parámetro	Observaciones
IAnalyzerConfigurationService	workflowAnalyzerConfigService	Una referencia a IAnalyzerConfigurationService que se usará para registrar reglas.

IRegisterWorkflowDesignApi

Registro de la API del diseñador de flujo de trabajo. Sigue el mismo patrón que IRegisterMetadata. Studio escaneará los tipos en su ensamblado en busca de implementaciones de esta interfaz. Si se encuentra una implementación, Studio crea una y la instancia de la API se entrega a través de IRegisterWorkflowDesignApi.Initialize (IWorkflowDesignApi.

Nota:

Las versiones anteriores de Studio que no se envían con la API no podrán cargar tu ensamblado. Si quieres mantener la compatibilidad con las versiones anteriores de Studio, en lugar de implementar esta interfaz, añade un método Initialize(object) en la implementación de IRegisterMetadata que Studio descubrirá mediante la reflexión. Transmita el parámetro del objeto a IWorkflowDesignApi. La misma instancia de IWorkflowDesignApi se puede recuperar del contexto del diseñador a través de GetService.

Métodos

void Initialize(IWorkflowDesignApi api)

Registra la instancia de API.

Tipo de parámetro	Nombre del parámetro	Observaciones
IWorkflowDesignApi	API	Una referencia a IWorkflowDesignApi para usar para acceder a las características de Studio.

IStudioDesignSettingsService

Nota: Esta característica se introdujo en UiPath.Studio.Activities.Api v21.4.

Interfaz para funcionalidades relacionadas con el panel de Studio Designer .

Propiedades

Tipo	Nombre	Observaciones
Booleano	Comportamiento moderno	Si se establece en true, se habilita la experiencia de diseño moderno .
Booleano	UseConnectionService	Si se establece en true, las conexiones Integration Service están habilitadas de forma predeterminada. Requiere Studio 2021.10 o posterior.

IWindowOperationsService

Nota: Esta característica se introdujo en UiPath.Studio.Activities.Api v21.4.

El punto de entrada para operaciones relacionadas con las ventanas.

Métodos

IntPtr GetMainWindowHandle()

Devuelve un identificador a la ventana principal de Studio.

void MinimizeMainWindow()

Minimiza la ventana principal de Studio.

void MaximizeMainWindow()

Maximiza la ventana principal de Studio.

void RestoreMainWindow()

Restaura la ventana principal de Studio.

void DisableMainWindow()

Deshabilita la ventana principal de Studio.

void EnableMainWindow()

Habilita la ventana principal de Studio.

IWorkflowDesignApi

Punto de entrada a la API. Puedes obtener una instancia de esta interfaz implementando IRegisterWorkflowDesignApi o añadiendo un void Initialize(object) en tu implementación de la interfaz IRegisterMetadata.

Herencia

IHasFeature > IWorkflowDesignApi

Propiedades

Tipo	Nombre	Accesorios
IOrganizationalSettingsService	ConfiguraciónOrganizativa	get
IActivitiesSettingsService	Configuración	get
ITelemetryService	Telemetry	get
IThemeService	Tema	get
IWizardsService	Asistentes	get
IAccessProvider	AccessProvider	get
IProjectPropertiesService	ProjectPropertiesService	get
IScopedActivitiesService	ScopedActivitiesService	get
IActivitySynonymService	ActivitySynonymService	get
IAttendedActivityService	AttendedActivityService	get
IDesignTimeExpressionExpanderService	DesignTimeExpressionExpanderService	get
IActivityFactoryRepository	ActivityFactory	get
ILibraryService	ObjectLibrary	get
IExtensionsInstallerService	ExtensionsInstallerService	get
IStudioDesignSettingsService	StudioDesignSettings	get
IExpressionService	ExpressionService	get
IExclusiveScopedActivitiesService	ExclusiveScopedActivitiesService	get
IMockActivityService	MockActivityService	get
IWindowOperationsService	WindowOperations	get
IPackageBindingsService	PackageBindings	get
ILicenseApiService	LicenseApiService	get
IStudioBusyService	BusyService	get
IActivityTriggerService	ActivityTriggerService	get

Observaciones

Esta API está disponible en los procesos de Studio y Workflow Analyzer.