Interface IssueFound

Snapshot of the results of validate() when there are errors/warnings ("Issues")

interface IssueFound {
    valueHostName: string;
    errorCode: string;
    severity: ValidationSeverity;
    errorMessage: string;
    summaryMessage?: string;
}

Properties

valueHostName errorCode severity errorMessage summaryMessage?

Properties

valueHostName

valueHostName: string

Containing ValueHostName

errorCode

errorCode: string

Error code is either what was supplied on ValidatorConfig.errorCode or Condition.ConditionType.

severity

severity: ValidationSeverity

Determines how a Validator will behave when a Condition evaluates as NoMatch. It may show error messages, prevent further evaluation of conditions on the same ValueHost, and block saving.

errorMessage

errorMessage: string

The error message nearby the input field/element, ready to display in the UI. With all of the processing for tokens and added formatting (for example, HTML tags around some tokens if the platform supports HTML).

Optional summaryMessage

summaryMessage?: string

The error message shown in a validation summary. It often contains a user friendly name of the ValueHost due to being a distance from the input field/element. With all of the processing for tokens and added formatting (for example, HTML tags around some tokens if the platform supports HTML). If null/undefined, summary viewer should use errorMessage.

Settings

Member Visibility

Theme

On This Page

valueHostNameerrorCodeseverityerrorMessagesummaryMessage

Generated using TypeDoc v0.25.12