The UiPath.Activities.API SDK package is hosted on the Official activities feed (https://www.myget.org/F/workflow).

Among others, the package is used for:

• Building Custom Workflow Analyzer rules by adding descriptions, parameters, and integrating them in Studio's Workflow Analyzer Settings window.

• Building your own Activities Project Settings by adding categories, sections, numeric input fields, combo boxes, and integrating them in the Activity Project Settings window in Studio, much like activities from UiPath packages.

• Creating custom wizards and integrating them in the Studio ribbon.

📘

Important!

UiPath.Activities.API SDK 包必须用作自定义项目中的开发依赖项。阅读有关开发依赖项的更多信息。

如何使用 API

将活动加载到 Studio 后，系统将通过以下几种方式提供对 IWorkflowDesignApi 的引用：

1. 在 IRegisterMetadata 实施内部，添加 public void Initialize(object api) 方法。在活动加载过程中，系统将调用此方法，并且活动可以存储 api 参数供以后使用。
2. 定义实施 IRegisterWorkflowDesignApi 的类别。在活动加载过程中，系统将调用方法 IRegisterWorkflowDesignApi.Initialize(IWorkflowDesignApi api)，并且活动可以存储 api 参数供以后使用。使用此方法时，只有 2019.6 以上版本的 Studio 才能加载您的包。
3. 通过调用 context.Services.GetService<IWorkflowDesignApi>() 引用 api 对象，其中 context 为 System.Activities.Presentation.EditingContext，通常供活动设计人员使用。

Design Feature Keys

重要的是，对 DesignFeatureKeys 执行初步检查以查看是否支持所需的功能键。

In order to check for a feature, you need to call the HasFeature method on the IWorkflowDesignApi reference, otherwise calls to the relevant api methods might fail with MissingMemberException or MissingMethodException on older Studio versions.

IWorkflowDesignApi studioActivitiesApi;
            // How to check for a feature.
            if (studioActivitiesApi.HasFeature(UiPath.Studio.Activities.Api.DesignFeatureKeys.Settings))
            {
                // Call Method or lambda that is using specific feature
                // This ensures that the code is JIT compiled only after the feature check
           }

List of Feature Keys

Interfaces

IExtensionsInstallerService Interface

IRegisterAnalyzerConfiguration Interface

Component called by the analyzer application in each rule assembly, in order to configure the host analyzer.

IRegisterWorkflowDesignApi Interface

Workflow designer API registration. It follows the same pattern as IRegisterMetadata. Studio scans 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 UiPath.Studio.Activities.Api.IRegisterWorkflowDesignApi.Initialize(UiPath.Studio.Activities.Api.IWorkflowDesignApi).

Note that older Studio versions that do not ship with the API are not able to load your assembly. If you want to keep the compatibility with the older Studio versions, instead of implementing this interface, add an Initialize(object) method on the implementation of IRegisterMetadata, that Studio will discover through reflection. Cast the object parameter to UiPath.Studio.Activities.Api.IWorkflowDesignApi on your side. The same UiPath.Studio.Activities.Api.IWorkflowDesignApi instance may be retrieved from the designer context through GetService.

IWorkflowDesignApi Interface

Offers capabilities to query runtime support of a feature.