Diagnostic
Set of classes to categorize and manage ECSchema validation results.
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 |
| SuppressionDiagnosticReporter | An abstract base class for IDiagnosticReporter implementation that used the | 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 |
Interfaces
| Name | Description | |
|---|---|---|
| IDiagnostic | The interface implemented by all diagnostics used during schema validation. | Beta |
| IDiagnosticReporter | Interface used to report IDiagnostic objects created during schema validation. | Beta |
Type Aliases
| Name | Description | |
|---|---|---|
| AnyDiagnostic | Type which encapsulates all possible diagnostics. | Beta |
Last Updated: 20 June, 2023