ecschema-editing

Classes

Name Description
BaseDiagnostic The abstract base class for all IDiagnostic implementations. Beta
ClassDiagnostic An IDiagnostic implementation used for ECClass diagnostics. Beta
CustomAttributeContainerDiagnostic An IDiagnostic implementation used for CustomAttributeContainerProps diagnostics. Beta
FormatDiagnosticReporter An abstract SuppressionDiagnosticReporter implementation that formats the Beta
LoggingDiagnosticReporter An IDiagnosticReporter for logging IDiagnostic objects. Beta
PropertyDiagnostic An IDiagnostic implementation used for PropertyDiagnostic.Property diagnostics. Beta
RelationshipConstraintDiagnostic An IDiagnostic implementation used for RelationshipConstraintDiagnostic.RelationshipConstraint diagnostics. Beta
SchemaDiagnostic An IDiagnostic implementation used for SchemaDiagnostic.Schema diagnostics. Beta
SchemaItemDiagnostic An IDiagnostic implementation used for SchemaItemDiagnostic.SchemaItem diagnostics. Beta
SchemaValidater Applies EC Rules, see SchemaValidater.ECRuleSet, to a given Schema and reports any violations. Beta
SchemaValidationVisitor A SchemaWalkerVisitor interface implementation that is used to validate ECObjects schemas using Beta
SuppressionDiagnosticReporter An abstract base class for IDiagnosticReporter implementation that used the Beta

Constants

Name Description
DiagnosticCodes The unique diagnostic codes for ECObjects rules. Beta
Diagnostics The list of IDiagnostic implementation classes used by the EC rule implementations. Beta
ECRuleSet All schema validation rules that fall under the category of ECObjects. Beta
SchemaCompareCodes The unique diagnostic codes for Schema comparison. Beta
SchemaCompareDiagnostics The list of IDiagnostic implementation classes used by the Schema comparison framework. Beta

Enumerations

Name Description
DiagnosticCategory Defines the possible diagnostic categories. Beta
DiagnosticType Defines the possible diagnostic types. Beta

Global Functions

Name Description
createClassDiagnosticClass Helper method for creating ClassDiagnostic child classes. Beta
createCustomAttributeContainerDiagnosticClass Helper method for creating CustomAttributeContainerDiagnostic child classes. Beta
createPropertyDiagnosticClass Helper method for creating PropertyDiagnostic child classes. Beta
createRelationshipConstraintDiagnosticClass Helper method for creating RelationshipConstraintDiagnostic child classes. Beta
createSchemaDiagnosticClass Helper method for creating SchemaDiagnostic child classes. Beta
createSchemaItemDiagnosticClass Helper method for creating SchemaItemDiagnostic child classes. Beta
diagnosticCategoryToString Beta
diagnosticTypeToString Beta
validateCustomAttributeInstance Validates a custom attribute instance and yields EC-500, EC-501, and EC-502 rule violations.
validateNavigationProperty Validates Navigation Properties.
validateSchemaReferences Validates schema references against multiple EC rules.
validateSchemaReferencesSync

Interfaces

Name Description
BaseRuleSuppressionMap Interface used to represent elements of a rule suppression Beta
IDiagnostic The interface implemented by all diagnostics used during schema validation. Beta
IDiagnosticReporter Interface used to report IDiagnostic objects created during schema validation. Beta
IRuleSet Interface used to represent logical collection of IRule instances. Beta
IRuleSuppressionMap Interface used to represent elements of a rule suppression Beta
IRuleSuppressionSet Interface used to represent logical collection of ISuppressionRule instances. Beta

Type Aliases

Name Description
AnyDiagnostic Type which encapsulates all possible diagnostics. Beta
AnyRuleSuppressionMap
BaseRule Beta
BaseSuppressionRule Beta
IRule Interface used for all rule implementations used during schema validation. Beta
ISuppressionRule Interface used for all rule suppressions used during schema validation. Beta

Last Updated: 06 October, 2021