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.

• カスタム ウィザードを作成し、Studio のリボンに組み込みます。

📘

重要

カスタム プロジェクトでは開発依存関係として UiPath.Activities.API SDK パッケージを使用する必要があります。開発依存関係について参照してください。

API の使用法

アクティビティが Studio に読み込まれると、IWorkflowDesignApi は次のようないくつかの方法で参照できます。

1. IRegisterMetadata の実装に public void Initialize(object api) メソッドを追加します。このメソッドはアクティビティの読み込みプロセスで呼び出され、読み込まれたアクティビティは後で使用するため api パラメーターを保存します。
2. IRegisterWorkflowDesignApi を実装するクラスを定義します。IRegisterWorkflowDesignApi.Initialize(IWorkflowDesignApi api) メソッドはアクティビティの読み込みプロセスで呼び出され、読み込まれたアクティビティは後で使用するため api パラメーターを保存します。このメソッドを使用する場合、Studio の 2019.6 以降のバージョンでしかパッケージを読み込むことができません。
3. api オブジェクトへの参照を、context.Services.GetService<IWorkflowDesignApi>() を呼び出すことで取得します。ここで、context は、通常アクティビティの設計者がアクセス可能な System.Activities.Presentation.EditingContext です。

Design Feature Keys

必要な機能キーがサポートされているかどうかを調べるために、DesignFeatureKeys に対して予備チェックを実行することが重要です。

フィーチャーをチェックするには、IWorkflowDesignApi の参照に対して HasFeature メソッドを呼び出す必要があります。これを行わないと、Studio のより古いバージョンでは、関連する API メソッドの呼び出しが MissingMemberException または MissingMethodException で失敗する可能性があります。

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.