sdk

latest

false

重要 :

请注意，此内容已使用机器翻译进行了部分本地化。新发布内容的本地化可能需要 1-2 周的时间才能完成。

开发者指南

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

UiPath.Studio.Activities.Api.Analyzer.Rules

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

ActivityMessage

指明活动触发了工作流分析器错误的消息。

继承

InspectionMessage > ActivityMessage

属性

类型	名称	备注
字符串	活动 ID	与消息相关的活动的 ID。
字符串	ActivityDisplayName	活动显示名称。
IMemberModel	SourceMember	可选结果的来源，例如变量或属性。

AnalyzerInspector

表示规则和计数器的基类。

继承

属性

类型	名称	备注
字符串	名称	显示在“ 工作流分析器设置”窗口中的规则/计数器名称。
字符串	ID	规则/计数器的 ID 必须唯一。使用类似于 https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/ Compiler-messages/的表示法
IDictionary<string, IParameter>	参数	可由用户配置的参数集合。
Bool	DefaultIsEnabled	如果为 `true`，则默认情况下启用该规则。需要 Studio 2019.10.3 或更高版本。
字符串	DocumentationLink	可在 WFA 设置窗口中单击的链接。需要 Studio 2019.10.3 或更高版本。
List<string>	ApplicableScopes	应应用此规则的目标配置。有关一些示例，请参见规则常量。需要 Studio 2020.4 或更高版本。

计数器

用于定义计数器的界面。

继承

AnalyzerInspector > Counter

构造函数

public Counter(string counterName, string counterId)

类型	名称	备注
字符串	counterName	显示在“工作流分析器设置”窗口中的名称。
字符串	counterId	计数器的 ID 必须唯一。

Counter <T>

适用于特定检查对象的计数器。

继承

AnalyzerInspector > Counter > Counter<T>

泛型类型 T

定义此计数器适用范围的智能检查对象。

构造函数

public Rule(string ruleName, string ruleId, Func<T, Rule, InspectionResult> inspectionFunction)

类型	名称	备注
字符串	counterName	计数器的名称。
字符串	counterId	计数器的 ID 必须唯一。
Func<IReadOnlyCollection<T>, Counter, InspectionResult>	inspectionFunction	一个函数，用于接收要检查的对象和用户配置的计数器，并且必须返回“ 检查结果”。

InspectionMessage

InspectionResult.InspectionMessages中的消息。

属性

类型	名称	备注
字符串	消息	要显示的消息。需要 Studio 2019.10.3 或更高版本。

InspectionResult

要检查的结果。

继承

IResult > InspectionResult

属性

类型	名称	备注
Bool	HasErrors
ICollection<string>	消息	有关更详细的消息，请使用“ 检查消息”。
ICollection<InspectionMessage>	InspectionMessages	更好、可扩展且更详细的消息。提供专用类型 (ActivityMessage)。需要 Studio 2019.10.3 或更高版本。
字符串	RecommendationMessage	此结果的建议。
追踪级别	ErrorLevel	此结果的错误级别。
字符串	DocumentationLink	此结果的文档链接。

IParameter

定义规则或计数器参数的外观。

继承

属性

类型	名称	备注
字符串	密钥	此规则中此参数的唯一键。
字符串	LocalizedDisplayName	当前本地化的显示名称。
字符串	值	用户为此参数提供的值。
字符串	ConstraintRegex	值的约束正则表达式。需要 Studio 2019.10.2 或更高版本。
Bool	默认值	此参数的默认值。需要 Studio 2019.10.2 或更高版本。

参数

IParameter 的简单实现。

继承

IParameter > Parameter

属性

类型	名称	备注
字符串	密钥	此规则中此参数的唯一键。
字符串	LocalizedDisplayName	当前本地化的显示名称。
字符串	值	用户为此参数提供的值。
字符串	ConstraintRegex	值的约束正则表达式。需要 Studio 2019.10.2 或更高版本。
Bool	默认值	此参数的默认值。需要 Studio 2019.10.2 或更高版本。

ProjectMessage

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

触发工作流分析器错误的包依赖项。

继承

InspectionMessage > ProjectMessage

属性

类型	名称	备注
IDependency	依赖项	可选存在错误的依赖项。

规则

用于定义规则的界面。

继承

AnalyzerInspector > Rule

构造函数

公共规则 (字符串规则名称，字符串规则 ID)

类型	名称	备注
字符串	ruleName	显示在“工作流分析器设置”窗口中的名称。
字符串	规则 ID	规则 ID 必须唯一。

属性

类型	名称	备注
追踪级别	ErrorLevel	此规则的可配置错误级别。仅在 Runtime 使用以读取有效的错误级别。定义规则时请勿设置此选项。请改用 `DefaultErrorLevel` 。
追踪级别	DefaultErrorLevel	此规则的默认错误级别。需要 Studio 2019.10.2 或更高版本。
字符串	RecommendationMessage	可配置的建议消息。

Rule <T>

适用于特定检查对象的规则。

继承

AnalyzerInspector > Rule > Rule<T>

泛型类型 T

定义此规则适用范围的智能检查对象。

构造函数

public Rule(string ruleName, string ruleId, Func<T, Rule, InspectionResult> inspectionFunction)

类型	名称	备注
字符串	ruleName	显示在“工作流分析器设置”窗口中的名称。
字符串	规则 ID	规则 ID 必须唯一。
Func<T, Rule, InspectionResult>	inspectionFunction	一个函数，用于接收要检查的对象和用户配置的规则，并且必须返回“ 检查结果”。

RuleConstants

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

定义要应用规则的 Studio 配置文件。

常量

类型	名称	备注
字符串	DevelopmentRuleConstant	表示适用于 Studio 的规则。
字符串	BusinessRuleConstant	表示适用于 StudioX 的规则。
字符串	TestAutomationRuleConstant	表示适用于 Studio Pro 的规则。