TESSA Web API
    Preparing search index...

    Interface ICardValidationManager

    Объект, управляющий валидацией карточки.

    interface ICardValidationManager {
        validateCard(
            validators: readonly CardTypeValidator[],
            mainCardTypeId: string,
            mainCard: Card,
            storeMode: CardStoreMode,
            externalContextInfo?: null | IStorage,
            modifyContextAction?:
                | null
                | ((context: ICardValidationContext) => Promise<void>),
            validationMode?: CardValidationMode,
        ): Promise<ICardValidationResult>;
        validateTask(
            validators: readonly CardTypeValidator[],
            mainCardTypeId: string,
            mainCard: Card,
            storeMode: CardStoreMode,
            taskCardTypeId: string,
            taskCard: Card,
            externalContextInfo?: null | IStorage,
            modifyContextAction?:
                | null
                | ((context: ICardValidationContext) => Promise<void>),
            validationMode?: CardValidationMode,
        ): Promise<ICardValidationResult>;
    }

    Implemented by

    Index

    Methods

    validateCard validateTask

    Methods

    • Выполняет валидацию основной карточки для заданного списка валидаторов.

      Parameters

      • validators: readonly CardTypeValidator[]

        Список валидаторов, посредством которых будет выполняться валидация.

      • mainCardTypeId: string

        Идентификатор типа основной карточки, валидация которой выполняется.

      • mainCard: Card

        Основная карточка, валидация которой выполняется.

      • storeMode: CardStoreMode

        Способ сохранения проверяемого объекта - карточки или файла.

      • OptionalexternalContextInfo: null | IStorage

        Произвольно структурированная информация из внешнего контекста (например, контекста сохранения карточки), которая может быть заполнена валидатором и использована либо другими валидаторами, либо внешними расширениями. Значение null определяет, что внешний контекст неизвестен и для свойства будет создан пустой объект.

      • OptionalmodifyContextAction: null | ((context: ICardValidationContext) => Promise<void>)

        Действие, выполняющее изменение контекста валидации перед его использованием, или null, если такое действие не требуется. Действие может использоваться, например, для указания ограничений по секциям валидации.

      • OptionalvalidationMode: CardValidationMode

        Способ выполнения валидации. По умолчанию рекомендуется использовать CardValidationMode.Card.

      Returns Promise<ICardValidationResult>

      Результат валидации основной карточки для заданного списка валидаторов.

    • Выполняет валидацию основной карточки и её карточки задания для заданного списка валидаторов.

      Parameters

      • validators: readonly CardTypeValidator[]

        Список валидаторов, посредством которых будет выполняться валидация.

      • mainCardTypeId: string

        Идентификатор типа основной карточки, валидация которой выполняется.

      • mainCard: Card

        Основная карточка, валидация которой выполняется.

      • storeMode: CardStoreMode

        Способ сохранения проверяемого объекта - карточки или файла.

      • taskCardTypeId: string

        Идентификатор типа карточки задания, валидация которой выполняется.

      • taskCard: Card

        Карточка задания, валидация которой выполняется.

      • OptionalexternalContextInfo: null | IStorage

        Произвольно структурированная информация из внешнего контекста (например, контекста сохранения карточки), которая может быть заполнена валидатором и использована либо другими валидаторами, либо внешними расширениями. Значение null определяет, что внешний контекст неизвестен и для свойства будет создан пустой объект.

      • OptionalmodifyContextAction: null | ((context: ICardValidationContext) => Promise<void>)

        Действие, выполняющее изменение контекста валидации перед его использованием, или null, если такое действие не требуется. Действие может использоваться, например, для указания ограничений по секциям валидации.

      • OptionalvalidationMode: CardValidationMode

        Способ выполнения валидации. По умолчанию рекомендуется использовать CardValidationMode.Task.

      Returns Promise<ICardValidationResult>

      Результат валидации основной карточки для заданного списка валидаторов.

    Settings

    Member Visibility

    On This Page

    Methods