开发者指南

上次更新日期 2024年10月25日

Studio 活动 SDK

UiPath Activities.API SDK 包托管在官方活动订阅源 (https://pkgs.dev.azure.com/uipath/Public.Feeds/_packaging/UiPath-Official/nuget/v3/index.json) 上。

其中，该包用于：

通过添加说明、参数并将其集成到 Studio 的“ 工作流分析器设置” 窗口来构建工作流分析器规则。
通过添加类别、部分、数字输入字段、组合框并将它们集成到 Studio 的“ 活动项目设置” 窗口中来构建活动项目设置，这与 UiPath 包中的活动非常相似。
创建自定义向导并将其集成到 Studio 功能区中。

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

如何使用 API

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

在 IRegisterMetadata 实施内部，添加 public void Initialize(object api) 方法。在活动加载过程中，系统将调用此方法，并且活动可以存储 api 参数供以后使用。
定义一个实现 IRegisterWorkflowDesignApi的类。在活动加载过程中，系统将调用方法 IRegisterWorkflowDesignApi.Initialize(IWorkflowDesignApi api) ，并且活动可以存储 api 参数以供以后使用。使用此方法时，只有 2019.6 及更高版本的 Studio 能够加载您的包。
通过调用 context.Services.GetService<IWorkflowDesignApi>() 获取 api 对象的引用，其中 context 是 System.Activities.Presentation.EditingContext，通常可供活动设计者访问。

设计功能键

务必对 DesignFeatureKeys 执行初步检查，以查看是否支持所需的功能键。有关详细信息，请参阅设计功能键。

为了检查功能，您需要在 IWorkflowDesignApi 引用上调用 HasFeature 方法，否则在较旧的 Studio 版本上，对相关 API 方法的调用可能会失败，并显示“ 缺少成员异常 ”或“ 缺少方法异常”。

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
           }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
           }