sdk
latest
false
重要 :
このコンテンツの一部は機械翻訳によって処理されており、完全な翻訳を保証するものではありません。 新しいコンテンツの翻訳は、およそ 1 ~ 2 週間で公開されます。
UiPath logo, featuring letters U and I in white

開発者ガイド

最終更新日時 2024年10月25日

UiPath.Studio.Activities.Api

このセクションでは、 UiPath.Studio.Activities.APIを使用してアクティビティを構築する方法について詳しく説明します。

AssetRequestParameters

メモ: この機能は UiPath.Studio.Activities.API v21.10 で導入されました。

Orchestrator のアセットを取得するために IAssetApiService にクエリを実行するための構造です。

プロパティ

入力

名前

string

展開

string

フィルター

string

選択

string

order-by

int?

上限数

int?

スキップ

bool?

Count

DesignFeatureKeys

フィーチャーが使用可能かどうかを確認するためのフィーチャー・キーのリスト。

プロパティ

入力

名前

値 (Value)

で導入

string

設定

SettingsV1

Studio v2019.10

string

SettingsV2

SettingsV2

Studio 2020.4

string

SettingsV3

SettingsV3

Studio 2021.10

string

テーマ

ThemeV1

Studio v2019.10

string

ウィザード

WizardsV1

Studio v2019.10

string

WizardsV2

WizardsV2

Studio 2020.4

string

WizardsV3

WizardsV3

Studio 2020.4

string

WizardsV4

WizardsV4

Studio 2020.10

string

AccessProvider

AccessProviderV1

Studio v2019.10

string

AccessProviderV2

AccessProviderV2

Studio 2020.10

string

AccessProviderV3

AccessProviderV3

Studio 2020.10

string

テレメトリ

TelemetryV1

Studio v2019.10

string

ワークフロー アナライザー

WorkflowAnalyzerV1

Studio v2019.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 v2022.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 v2022.4 の

string

WorkflowAnalyzerV12

WorkflowAnalyzerV12

Studio v2022.4 の

string

WorkflowAnalyzerV13

WorkflowAnalyzerV13

Studio v2022.4 の

string

ScopedActivities

ScopedActivitiesV1

Studio 2020.4

string

ActivitySynonyms

ActivitySynonymsV1

Studio 2021.10

string

アクティビティ トリガー

ActivityTriggersV1

Studio v2022.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 v2022.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

オブジェクト リポジトリ

ObjectRepositoryV1

Studio 2020.10

string

SimpleObjectRepository

SimpleObjectRepositoryV1

Studio 2021.10

string

組織レベルの設定

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 v2022.4 の

string

Orchestrator API

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

備考

キーを使用して IHasFeature.HasFeature メソッドを呼び出すことで、機能が利用可能かどうかを確認できます。

IAssetApiService

メモ: この機能は UiPath.Studio.Activities.API v21.10 で導入されました。

アセット関連の操作を実行するための API を公開します。

メソッド

Task<IEnumerable<string>> GetAssets(int top, string folder = null)

指定したフォルダー内のアセット名を表す文字列のリストを返します。 フォルダーを指定しない場合は、既定のフォルダーが使用されます。

パラメーターの種類

パラメーター名

備考

int

top

取得するアセットの数です。

string

folder

アセットが定義されているフォルダーです。 nullすると、現在のユーザーに表示されるすべてのアセットが取得されます。
Task<IEnumerable<string>> GetAssets(AssetRequestParameters requestParameters, string folder = null)

指定したフォルダー内のアセット名を表す文字列のリストを返します。 フォルダーを指定しない場合は、既定のフォルダーが使用されます。

パラメーターの種類

パラメーター名

備考

AssetRequestParameters

要求パラメーター

高度なクエリ パラメーター。 「 アセット要求パラメーター」をご覧ください

string

folder

アセットが定義されているフォルダーです。 nullすると、現在のユーザーに表示されるすべてのアセットが取得されます。
Task<IEnumerable<string\>\> GetAssetFolders(int top)

アクセス可能なフォルダーのリストを返します。

パラメーターの種類

パラメーター名

備考

int

top

取得するフォルダーの数です。

IExtensionsInstallerService

アクティビティ パッケージから拡張機能をインストールする方法。

メソッド

void InstallExtension(string extensionName)

インストール済みの拡張機能をアクティビティに公開します。

パラメーターの種類

パラメーター名

備考

string

extensionName

拡張機能の名前です。

void InstallExcelAddIn()

UiPath Excel アドイン for StudioX のインストール プロセスをトリガーします。

IOrchestratorApiService

メモ: この機能は UiPath.Studio.Activities.API v21.10 で導入されました。

Orchestrator 関連の操作に対する最上位ラッパーです。 IWorkflowDesignApiで公開されます。

プロパティ

入力

名前

説明

AssetApiService

アセット関連の Orchestrator API への参照です。

IOrganizationalSettingsService

メモ: この機能は UiPath.Studio.Activities.API v21.4 で導入されました。

組織設定の読み方を説明するインターフェイスです。

メソッド

Task<Dictionary<string, object>> GetSettingsAsync(IEnumerable<string\> keys, CancellationToken ct = default(CancellationToken))

データ ソースから複数の組織設定を取得し、見つかったキーとその値のマップを返します。

パラメーターの種類

パラメーター名

備考

IEnumerable<string>

キー

組織設定キーが列挙されます。

CancellationToken

ct

見つかった各キーとその値をマッピングするディクショナリ。

IRegisterAnalyzerConfiguration

ホスト アナライザーを設定するために、各ルール アセンブリ内にアナライザー アプリケーションによって呼び出されるコンポーネントです。

メソッド

void Initialize(IAnalyzerConfigurationService workflowAnalyzerConfigService)

IAnalyzerConfigurationService 機能に アクセスするためにアセンブリを実装するためのインジェクション ポイントを提供します。

パラメーターの種類

パラメーター名

備考

IAnalyzerConfigurationService

workflowAnalyzerConfigService

ルールを登録するために使用する IAnalyzerConfigurationService への参照です。

IRegisterWorkflowDesignApi

ワークフロー デザイナーの API の登録。 [IRegisterMetadata] と同じパターンに従います。 Studio では、アセンブリ内の種類をスキャンして、このインターフェイスの実装を確認します。 実装が見つかった場合、インスタンスは Studio によって作成され、API インスタンスは IRegisterWorkflowDesignApi.Initialize(IWorkflowDesignApi) を通じて渡されます。

注:
API に付属していない旧バージョンの Studio では、アセンブリを読み込めなくなります。 このインターフェイスを実装するのではなく、古いバージョンの Studio との相互運用性を維持するには、リフレクションを通じて検出する IRegisterMetadata の実装に Initialize(object) メソッドを追加します。 ユーザー側でオブジェクト パラメーターを IWorkflowDesignApi にキャストします。 同じ IWorkflowDesignApi インスタンスが、GetService を通じてデザイナー コンテキストから取得される場合があります。

メソッド

void Initialize(IWorkflowDesignApi api)

API インスタンスを登録します。

パラメーターの種類

パラメーター名

備考

IWorkflowDesignApi

API

Studio の機能にアクセスするために使用する IWorkflowDesignApi への参照です。

IStudioDesignSettingsService

メモ: この機能は UiPath.Studio.Activities.API v21.4 で導入されました。

Studio デザイナー パネルに関連する機能のインターフェイスです。

プロパティ

入力

名前

備考

Bool

モダンの挙動

trueに設定すると、 モダン デザイン エクスペリエンス が有効化されます。

Bool

UseConnectionService

[ trueに設定すると、Integration Service のコネクションが既定で有効化されます。 v2021.10 以降の Studio が必要です。

IWindowOperationsService

メモ: この機能は UiPath.Studio.Activities.API v21.4 で導入されました。

ウィンドウ関連の操作のエントリ ポイントです。

メソッド

IntPtr GetMainWindowHandle()

メインの Studio ウィンドウにハンドルを返します。

void MinimizeMainWindow()

メインの Studio ウィンドウを最小化します。

void MaximizeMainWindow()

メインの Studio ウィンドウを最大化します。

void RestoreMainWindow()

Studio のメイン ウィンドウを復元します。

void DisableMainWindow()

メインの Studio ウィンドウを無効化します。

void EnableMainWindow()

メインの Studio ウィンドウを有効化します。

IWorkflowDesignApi

API のエントリ ポイントです。 このインターフェイスのインスタンスを取得するには、IRegisterWorkflowDesignApi を実装するか、IRegisterMetadata インターフェイスの実装に void Initialize(object) を追加します。

継承

IHasFeature > IWorkflowDesignApi

プロパティ

入力

名前

アクセサー

組織レベルの設定

get

設定

get

テレメトリ

get

テーマ

get

ウィザード

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

備考

この API は、Studio とワークフロー アナライザーの両方のプロセスで使用できます。

このページは役に立ちましたか?

サポートを受ける
RPA について学ぶ - オートメーション コース
UiPath コミュニティ フォーラム
Uipath Logo White
信頼とセキュリティ
© 2005-2024 UiPath. All rights reserved.