- Overview
- Custom activities
- Migrating Activities to .NET 6
- Release Notes
- Building Workflow Analyzer Rules
- Building Activities Project Settings
- Creating Custom Wizards
- Prioritize Activities by Scope
- UiPath.Activities.Api.Base
- UiPath.Studio.Activities.Api
- UiPath.Studio.Activities.Api.Activities
- UiPath.Studio.Activities.Api.BusyService
- UiPath.Studio.Activities.Api.ExpressionEditor
- UiPath.Studio.Activities.Api.Expressions
- UiPath.Studio.Activities.Api.Licensing
- UiPath.Studio.Activities.Api.Mocking
- UiPath.Studio.Activities.Api.ObjectLibrary
- UiPath.Studio.Activities.Api.PackageBindings
- UiPath.Studio.Activities.Api.ProjectProperties
- UiPath.Studio.Activities.Api.ScopedActivities
- UiPath.Studio.Activities.Api.Settings
- UiPath.Studio.Activities.Api.Wizards
- UiPath.Studio.Activities.Api.Workflow
- UiPath.Studio.Api.Controls
- UiPath.Studio.Api.Telemetry
- UiPath.Studio.Api.Theme
- Robot JavaScript SDK
- Triggers SDK
UiPath.Studio.Activities.Api
In this section you can find more information on how to build activities using UiPath.Studio.Activities.Api.
Structure used to query the IAssetApiService in order to retrieve Orchestrator assets.
List of feature keys to check if a feature is available.
Type |
Name |
Value |
Introduced in |
---|---|---|---|
string |
Settings |
SettingsV1 |
Studio 2019.10 |
string |
SettingsV2 |
SettingsV2 |
Studio 2020.4 |
string |
SettingsV3 |
SettingsV3 |
Studio 2021.10 |
string |
Theme |
ThemeV1 |
Studio 2019.10 |
string |
Wizards |
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 |
WorkflowAnalyzer |
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 |
ActivityTriggers |
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 |
ObjectRepository |
ObjectRepositoryV1 |
Studio 2020.10 |
string |
SimpleObjectRepository |
SimpleObjectRepositoryV1 |
Studio 2021.10 |
string |
OrganizationalSettings |
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 |
OrchestratorApi |
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 |
Exposes the API for performing asset-related operations.
Task<IEnumerable<string>> GetAssets(int top, string folder = null)
Returns a list of strings representing the asset names in the specified folder. If a folder is not specified, the default folder is used.
Parameter Type |
Parameter Name |
Remarks |
---|---|---|
int |
top |
The number of assets to retrieve. |
string |
folder |
The folder in which the assets are defined. If
null , all the assets visible to the current users will be retrieved.
|
Task<IEnumerable<string>> GetAssets(AssetRequestParameters requestParameters, string folder = null)
Returns a list of strings representing the asset names in the specified folder. If a folder is not specified, the default folder is used.
Parameter Type |
Parameter Name |
Remarks |
---|---|---|
AssetRequestParameters |
requestParameters |
Advanced query parameters. See AssetRequestParameters. |
string |
folder |
The folder in which the assets are defined. If
null , all the assets visible to the current users will be retrieved.
|
Task<IEnumerable<string\>\> GetAssetFolders(int top)
Returns the list of accessible folders.
Parameter Type |
Parameter Name |
Remarks |
---|---|---|
int |
top |
The number of folders to retrieve. |
A way to install extensions from an activities package.
void InstallExtension(string extensionName)
Exposes installed extensions to activities.
Parameter Type |
Parameter Name |
Remarks |
---|---|---|
string |
extensionName |
The name of the extension. |
void InstallExcelAddIn()
Triggers the installation process for the UiPath Excel Add-in for StudioX.
Top-level wrapper for Orchestrator-related operations. Exposed in IWorkflowDesignApi.
Type |
Name |
Description |
---|---|---|
AssetApiService |
A reference to an asset-related Orchestrator API. |
Interface that describes how to read organizational settings.
Task<Dictionary<string, object>> GetSettingsAsync(IEnumerable<string\> keys, CancellationToken ct = default(CancellationToken))
Retrieves multiple organizational settings from a data source and returns a map of the keys found and their values.
Parameter Type |
Parameter Name |
Remarks |
---|---|---|
IEnumerable<string> |
keys |
An enumeration of organizational setting keys. |
CancellationToken |
ct |
A dictionary which maps each of the found keys and its value. |
Component called by the analyzer application in each rule assembly, in order to configure the host analyzer.
void Initialize(IAnalyzerConfigurationService workflowAnalyzerConfigService)
Offers an injection point to the implementing assembly in order to access IAnalyzerConfigurationService capabilities.
Parameter Type |
Parameter Name |
Remarks |
---|---|---|
IAnalyzerConfigurationService |
workflowAnalyzerConfigService |
A reference to IAnalyzerConfigurationService to use in order to register rules. |
Workflow designer API registration. It follows the same pattern as IRegisterMetadata. Studio will scan the types in your assembly for implementations of this interface. If an implementation is found, an instance is created by Studio and the API instance is handed through IRegisterWorkflowDesignApi.Initialize(IWorkflowDesignApi.
Initialize(object)
method on the implementation of IRegisterMetadata that Studio will discover through reflection. Cast the object parameter
to IWorkflowDesignApi on your side. The same IWorkflowDesignApi instance may be retrieved from the designer context through
GetService.
void Initialize(IWorkflowDesignApi api)
Register the API instance.
Parameter Type |
Parameter Name |
Remarks |
---|---|---|
IWorkflowDesignApi |
api |
A reference to IWorkflowDesignApi to use in order to access Studio features. |
Interface for functionality related to the Studio Designer panel.
Type |
Name |
Remarks |
---|---|---|
bool |
ModernBehavior |
If set to
true , the Modern Design Experience is enabled.
|
bool |
UseConnectionService |
If set to
true , Integration Service connections are enabled by default. Requires Studio 2021.10 or later.
|
The entry point for window-related operations.
IntPtr GetMainWindowHandle()
Returns a handle to the main Studio window.
void MinimizeMainWindow()
Minimizes the main Studio window.
void MaximizeMainWindow()
Maximizes the main Studio window.
void RestoreMainWindow()
Restores the main Studio window.
void DisableMainWindow()
Disables the main Studio window.
void EnableMainWindow()
Enables the main Studio window.
void Initialize(object)
in your implementation of IRegisterMetadata interface.
Type |
Name |
Accessors |
---|---|---|
OrganizationalSettings |
get | |
Settings |
get | |
Telemetry |
get | |
Theme |
get | |
Wizards |
get | |
AccessProvider |
get | |
ProjectPropertiesService |
get | |
ScopedActivitiesService |
get | |
ActivitySynonymService |
get | |
AttendedActivityService |
get | |
DesignTimeExpressionExpanderService |
get | |
ActivityFactory |
get | |
ObjectLibrary |
get | |
ExtensionsInstallerService |
get | |
StudioDesignSettings |
get | |
ExpressionService |
get | |
ExclusiveScopedActivitiesService |
get | |
MockActivityService |
get | |
WindowOperations |
get | |
PackageBindings |
get | |
LicenseApiService |
get | |
BusyService |
get | |
ActivityTriggerService |
get |
- AssetRequestParameters
- Properties
- DesignFeatureKeys
- Properties
- Remarks
- IAssetApiService
- Methods
- IExtensionsInstallerService
- Methods
- IOrchestratorApiService
- Properties
- IOrganizationalSettingsService
- Methods
- IRegisterAnalyzerConfiguration
- Methods
- IRegisterWorkflowDesignApi
- Methods
- IStudioDesignSettingsService
- Properties
- IWindowOperationsService
- Methods
- IWorkflowDesignApi
- Inheritance
- Properties
- Remarks