開発者ガイド

最終更新日時 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 パラメーターを格納できます。この方法を使用すると、v2019.6 の Studio のみがパッケージを読み込むことができます。
context が System.Activities.Presentation.EditingContextで、通常はアクティビティデザイナーがアクセスできる場所である context.Services.GetService<IWorkflowDesignApi>() を呼び出すことで、 api オブジェクトの参照を取得します。

デザイン機能キー

必要な機能キーがサポートされているかどうかを確認するには、 DesignFeatureKeys に対して予備チェックを実行することが重要です。詳細については、 DesignFeatureKeysをご覧ください。

機能を確認するには、 IWorkflowDesignApi 参照に対して HasFeature メソッドを呼び出す必要があります。そうしないと、古いバージョンの Studio で MissingMemberException または MissingMethodException によって、関連する 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
           }