sdk

latest

false

重要 :

请注意此内容已使用机器翻译进行了部分本地化。

开发者指南

Last updated 2024年10月25日

UiPath.Studio.Activities.Api

在本节中，您可以找到有关如何使用 UiPath.Studio.Activities.Api构建活动的更多信息。

AssetRequestParameters

注意：此功能是在 UiPath.Studio.Activities.Api v21.10 中引入的。

用于查询 IAssetApiService 以检索 Orchestrator 资产的结构。

属性

类型	名称
字符串	展开
字符串	筛选
字符串	选择
字符串	排序依据
int?	顶部
int?	跳过
bool?	计数

DesignFeatureKeys

用于检查功能是否可用的功能键列表。

属性

类型	名称	值	引入时间
字符串	设置	SettingsV1	Studio 2019.10
字符串	SettingsV2	SettingsV2	Studio 2020.4
字符串	SettingsV3	SettingsV3	Studio 2021.10
字符串	主题	ThemeV1	Studio 2019.10
字符串	向导	WizardsV1	Studio 2019.10
字符串	WizardsV2	WizardsV2	Studio 2020.4
字符串	WizardsV3	WizardsV3	Studio 2020.4
字符串	WizardsV4	WizardsV4	Studio 2020.10
字符串	AccessProvider	AccessProviderV1	Studio 2019.10
字符串	AccessProviderV2	AccessProviderV2	Studio 2020.10
字符串	AccessProviderV3	AccessProviderV3	Studio 2020.10
字符串	Telemetry	TelemetryV1	Studio 2019.10
字符串	工作流分析器	WorkflowAnalyzerV1	Studio 2019.10
字符串	WorkflowAnalyzerV2	WorkflowAnalyzerV2	Studio 2019.10.2
字符串	WorkflowAnalyzerV3	WorkflowAnalyzerV3	Studio 2019.10.3
字符串	ProjectProperties	ProjectPropertiesV1	Studio 2020.4
字符串	ProjectPropertiesV2	ProjectPropertiesV2	Studio 2021.10
字符串	ProjectPropertiesV3	ProjectPropertiesV3	Studio 2022.4
字符串	WorkflowAnalyzerV4	WorkflowAnalyzerV4	Studio 2020.4
字符串	WorkflowAnalyzerV5	WorkflowAnalyzerV5	Studio 2020.4.2
字符串	WorkflowAnalyzerV6	WorkflowAnalyzerV6	Studio 2020.10
字符串	WorkflowAnalyzerV7	WorkflowAnalyzerV7	Studio 2020.10
字符串	WorkflowAnalyzerV8	WorkflowAnalyzerV8	Studio 2020.10.3
字符串	WorkflowAnalyzerV9	WorkflowAnalyzerV9	Studio 2021.4
字符串	WorkflowAnalyzerV10	WorkflowAnalyzerV10	Studio 2021.10
字符串	WorkflowAnalyzerV11	WorkflowAnalyzerV11	Studio 2022.4
字符串	WorkflowAnalyzerV12	WorkflowAnalyzerV12	Studio 2022.4
字符串	WorkflowAnalyzerV13	WorkflowAnalyzerV13	Studio 2022.4
字符串	ScopedActivities	ScopedActivitiesV1	Studio 2020.4
字符串	ActivitySynonyms	ActivitySynonymsV1	Studio 2021.10
字符串	活动触发器	ActivityTriggersV1	Studio 2022.4
字符串	AttendedActivities	AttendedActivitiesV1	Studio 2021.10
字符串	InstallExtensions	InstallExtensionsV1	Studio 2020.4
字符串	InstallExcelAddIn	InstallExcelAddInV1	Studio 2020.10
字符串	ActivityFactory	ActivityFactoryV1	Studio 2020.10
字符串	ActivityFactoryV2	ActivityFactoryV2	Studio 2020.10
字符串	ActivityFactoryV3	ActivityFactoryV3	Studio 2021.4
字符串	ActivityFactoryV4	ActivityFactoryV4	Studio 2022.4
字符串	StudioDesignSettings	StudioDesignSettingsV1	Studio 2020.10
字符串	StudioDesignSettingsV2	StudioDesignSettingsV2	Studio 2021.10
字符串	ExpressionService	ExpressionServiceV1	Studio 2020.10
字符串	DesignTimeExpressionExpanderService	DesignTimeExpressionExpanderServiceV1	Studio 2021.10
字符串	ExclusiveScopedActivities	ExclusiveScopedActivitiesV1	Studio 2020.10
字符串	MockingCapabilities	MockingCapabilitiesV1	Studio 2020.10
字符串	MockingCapabilitiesV2	MockingCapabilitiesV2	Studio 2020.10
字符串	ObjectRecorderHighlight	ObjectRecorderHighlight	Studio 2021.10
字符串	ObjectRecorderCurrentElements	ObjectRecorderCurrentElements	Studio 2021.10
字符串	对象存储库	ObjectRepositoryV1	Studio 2020.10
字符串	SimpleObjectRepository	SimpleObjectRepositoryV1	Studio 2021.10
字符串	组织设置	OrganizationalSettingsV1	Studio 2020.10.3
字符串	WindowOperations	WindowOperationsV1	Studio 2021.4
字符串	WindowOperationsV2	WindowOperationsV2	Studio 2021.4
字符串	PackageBindings	PackageBindingsV1	Studio 2021.4
字符串	PackageBindingsV2	PackageBindingsV2	Studio 2021.10
字符串	PackageBindingsV3	PackageBindingsV3	Studio 2022.4
字符串	Orchestrator API	OrchestratorApiV1	Studio 2021.10
字符串	LicenseApi	LicenseApiV1	Studio 2021.10
字符串	BusyService	BusyServiceV1	Studio 2021.10
字符串	ModernClassicSetting	ModernClassicSettingV1	Studio 2021.10
字符串	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	顶部	要检索的资产数量。
字符串	folder	定义资产的文件夹。如果 `null`，则将检索当前用户可见的所有资产。

Task<IEnumerable<string>> GetAssets(AssetRequestParameters requestParameters, string folder = null)

返回表示指定文件夹中资产名称的字符串列表。如果未指定文件夹，则使用默认文件夹。

参数类型	参数名称	备注
AssetRequestParameters	请求参数	高级查询参数。请参阅资产请求参数。
字符串	folder	定义资产的文件夹。如果 `null`，则将检索当前用户可见的所有资产。

Task<IEnumerable<string\>\> GetAssetFolders(int top)

返回可访问文件夹的列表。

参数类型	参数名称	备注
int	顶部	要检索的文件夹数。

IExtensionsInstallerService

一种从活动包安装扩展程序的方法。

方法

void InstallExtension(string extensionName)

向活动公开已安装的扩展程序。

参数类型	参数名称	备注
字符串	extensionName	扩展程序的名称。

void InstallExcelAddIn()

触发适用于 StudioX 的 UiPath Excel 加载项的安装流程。

IOrchestratorApiService

注意：此功能是在 UiPath.Studio.Activities.Api v21.10 中引入的。

Orchestrator 相关操作的顶层包装器。在 IWorkflowDesignApi中公开。

属性

类型	名称	描述
IAssetApiService	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 功能。

参数类型	参数名称	备注
IAnalyzer 配置服务	workflowAnalyzerConfigService	对 IAnalyzerConfigurationService 的引用，用于注册规则。

IRegisterWorkflowDesignApi

工作流设计器 API 注册。它遵循与 IRegisterMetadata 相同的模式。 Studio 将扫描程序集中的类型，以查找此接口的实现。如果找到实现，Studio 将创建一个实例，并通过 IRegisterWorkflowDesignApi.Initialize(IWorkflowDesignApi.

备注：

未附带 API 的较旧 Studio 版本将无法加载您的程序集。如果要保持与旧版 Studio 的兼容性，请不要实现此接口，请在 Studio 将通过反射发现的 IRegisterMetadata 实现上添加 Initialize(object) 方法。将对象参数转换为您这边的 IWorkflowDesignApi。可以通过“获取服务”从设计器上下文中检索相同的 IWorkflowDesignApi 实例。

方法

void Initialize(IWorkflowDesignApi api)

参数类型	参数名称	备注
IWorkflowDesignApi	API	对用于访问 Studio 功能的 IWorkflowDesignApi 的引用。

IStudioDesignSettingsService

注意：此功能是在 UiPath.Studio.Activities.Api v21.4 中引入的。

Studio 设计器 面板相关功能的界面。

属性

类型	名称	备注
Bool	新式行为	如果设置为 `true`，则启用新式设计体验。
Bool	UseConnectionService	如果设置为 `true`，则默认启用 Integration Service 连接。需要 Studio 2021.10 或更高版本。

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

属性

类型	名称	访问器
IOrganizationalSettingsService	组织设置	get
IActivitiesSettingsService	设置	get
ITelemetryService	Telemetry	get
IThemeService	主题	get
IWizardsService	向导	get
IAccessProvider	AccessProvider	get
IProjectPropertiesService	ProjectPropertiesService	get
IScopedActivitiesService	ScopedActivitiesService	get
IActivitySynonymService	ActivitySynonymService	get
IAttendedActivityService	AttendedActivityService	get
IDesignTimeExpressionExpanderService	DesignTimeExpressionExpanderService	get
IActivityFactoryRepository	ActivityFactory	get
ILibraryService	ObjectLibrary	get
IExtensionsInstallerService	ExtensionsInstallerService	get
IStudioDesignSettingsService	StudioDesignSettings	get
IExpressionService	ExpressionService	get
IExclusiveScopedActivitiesService	ExclusiveScopedActivitiesService	get
IMockActivityService	MockActivityService	get
IWindowOperationsService	WindowOperations	get
IPackageBindingsService	PackageBindings	get
ILicenseApiService	LicenseApiService	get
IStudioBusyService	BusyService	get
IActivityTriggerService	ActivityTriggerService	get