components/dev.fritz2.components.validation

Package dev.fritz2.components.validation

Types

ComponentValidationMessage

common

data class ComponentValidationMessage(id: String, severity: Severity, message: String, details: String?) : ValidationMessage

Special ValidationMessage for fritz2 components.

ComponentValidator

common

abstract class ComponentValidator<D, T> : Validator<D, ComponentValidationMessage, T>

Special Validator for fritz2 components which uses the ComponentValidationMessage internally.

Severity

common

enum Severity : Enum<Severity>

Enum which specify the Severity of ComponentValidationMessage.

WithValidator

js

interface WithValidator<D, T> : Store<D>

Interface which RootStores can implement to mark them that they have a ComponentValidator.

Functions

errorMessage

common

fun errorMessage(id: String, message: String, details: String? = null): ComponentValidationMessage

Creates ComponentValidationMessage with Severity.Error.

infoMessage

common

fun infoMessage(id: String, message: String, details: String? = null): ComponentValidationMessage

Creates ComponentValidationMessage with Severity.Info.

successMessage

common

fun successMessage(id: String, message: String, details: String? = null): ComponentValidationMessage

Creates ComponentValidationMessage with Severity.Info.

validationMessage

js

fun <D> Store<D>.validationMessage(): Flow<ComponentValidationMessage?>?

Finds the proper ComponentValidationMessage for the given Store.

validationMessages

js

fun <D> Store<D>.validationMessages(): Flow<List<ComponentValidationMessage>>?

Filters all proper ComponentValidationMessages for the given Store.

warningMessage

common

fun warningMessage(id: String, message: String, details: String? = null): ComponentValidationMessage

Creates ComponentValidationMessage with Severity.Warning.