Class CardResponse

Ответ на универсальный запрос по выполнению действий через сервис карточек.

Hierarchy

Implements

Constructors

constructor

Properties - Static Keys

infoKey validationResultKey

Accessors

info validationResult

Methods

clean clone ensureCacheResolved getStorage getStorageSettings isValid notifyStorageUpdated removeSystemInfo removeUserInfo setTypedResponse tryGetInfo tryGetTypedResponse tryGetValidationResult validate

Constructors

constructor

  • Создаёт экземпляр класса с указанием хранилища (или пустое хранилище по умолчанию), декоратором для которого является создаваемый объект.

    Parameters

    • storage: IStorage<unknown> = {}

      Хранилище, декоратором для которого является создаваемый объект.

    Returns CardResponse

Static Keys Properties

Static Readonly infoKey

infoKey: "Info" = 'Info'

Static Readonly validationResultKey

validationResultKey: "ValidationResult" = 'ValidationResult'

Accessors

info

  • get info(): IStorage<unknown>

  • Дополнительная пользовательская информация.

    Returns IStorage<unknown>

  • set info(value: IStorage<unknown>): void

  • Parameters

    Returns void

validationResult

Methods

clean

  • Выполняет очистку хранилища от избыточных данных.

    Returns void

clone

  • Создает новый объект, который является копией текущего экземпляра.

    Returns CardResponse

ensureCacheResolved

  • Выполняет резолв кеша декораторов для данных объекта-хранилища.

    Returns void

getStorage

  • Возвращает хранилище IStorage, декоратором для которого является текущий объект.

    Returns

    Хранилище IStorage, декоратором для которого является текущий объект.

    Returns IStorage<unknown>

getStorageSettings

isValid

  • Выполняет проверку объекта на валидность и возвращает признак того, что объект является валидным.

    Returns

    true, если объект прошёл проверку на валидность; false в противном случае.

    Returns boolean

notifyStorageUpdated

  • Метод, уведомляющий объект о наличии изменений в его хранилище.

    Returns void

removeSystemInfo

  • Удаляет системную информацию, которая может располагаться в любом месте в хранилище текущего объекта и может быть найдена по ключам с префиксом StorageHelper.systemKeyPrefix.

    Returns void

removeUserInfo

  • Удаляет пользовательскую информацию, которая может располагаться в любом месте в хранилище текущего объекта и может быть найдена по ключам с префиксом StorageHelper.userKeyPrefix.

    Returns void

setTypedResponse

  • Устанавливает строготипизированный ответ на запрос для универсальных расширений.

    Parameters

    • response: null | IStorageProvider<IStorage<unknown> | IStorageArray<unknown>>

      Строготипизированный ответ на запрос или null, если существующий ответ требуется удалить.

    Returns void

tryGetInfo

  • Возвращает дополнительную пользовательскую информацию по текущему объекту или null, если информация ещё не была задана.

    Returns

    Дополнительная пользовательская информацию по текущему объекту или null, если информация ещё не была задана.

    Returns null | IStorage<unknown>

tryGetTypedResponse

  • Возвращает хранилище для строготипизированного ответа на запрос для универсальных расширений.

    Returns null | IStorage<unknown>

tryGetValidationResult

  • Возвращает объект, используемый для построения результата валидации, или null, если результат не был задан.

    Returns

    Объект, используемый для построения результата валидации, или null, если результат ещё не был задан.

    Returns null | ValidationStorageResultBuilder

validate

  • Выполняет валидацию текущего объекта и всех его дочерних объектов.

    Returns

    Объект, выполняющий построение результата валидации.

    Returns ValidationResult

Generated using TypeDoc