Class CardStoreResponse

Ответ на запрос на сохранение информации по карточке посредством сервиса карточек. Содержит объект, осуществляющий валидацию результата сохранения.

Hierarchy

Implements

Constructors

constructor

Properties - Static Keys

cardIdKey cardTypeIdKey cardVersionKey infoKey storeDateTimeKey validationResultKey

Accessors

cardId cardTypeId cardVersion info storeDateTime validationResult

Methods

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

Constructors

constructor

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

    Parameters

    • storage: IStorage<unknown> = {}

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

    Returns CardStoreResponse

Static Keys Properties

Static Readonly cardIdKey

cardIdKey: "CardID" = 'CardID'

Static Readonly cardTypeIdKey

cardTypeIdKey: "CardTypeID" = 'CardTypeID'

Static Readonly cardVersionKey

cardVersionKey: "CardVersion" = 'CardVersion'

Static Readonly infoKey

infoKey: "Info" = 'Info'

Static Readonly storeDateTimeKey

storeDateTimeKey: "StoreDateTime" = 'StoreDateTime'

Static Readonly validationResultKey

validationResultKey: "ValidationResult" = 'ValidationResult'

Accessors

cardId

  • get cardId(): string

  • Идентификатор сохранённой карточки. Свойство обязательно для заполнения при формировании ответа на запрос для виртуальной карточки.

    Returns string

  • set cardId(value: string): void

  • Parameters

    • value: string

    Returns void

cardTypeId

  • get cardTypeId(): string

  • Идентификатор типа сохранённой карточки. Свойство обязательно для заполнения при формировании ответа на запрос для виртуальной карточки.

    Returns string

  • set cardTypeId(value: string): void

  • Parameters

    • value: string

    Returns void

cardVersion

  • get cardVersion(): number

  • Версия карточки после сохранения. Свойство обязательно для заполнения при формировании ответа на запрос для виртуальной карточки.

    Returns number

  • set cardVersion(value: number): void

  • Parameters

    • value: number

    Returns void

info

  • get info(): IStorage<unknown>

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

    Returns IStorage<unknown>

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

  • Parameters

    Returns void

storeDateTime

  • get storeDateTime(): null | string

  • Дата сохранения карточки (которая записана как дата изменения карточки), или null, если карточка не была изменена, сохранение не было выполнено успешно или сохранена виртуальная карточка, для которой это свойство не заполнено.

    Returns null | string

  • set storeDateTime(value: null | string): void

  • Parameters

    • value: null | string

    Returns void

validationResult

Methods

clean

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

    Returns void

clone

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

    Returns CardStoreResponse

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

tryGetInfo

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

    Returns

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

    Returns null | IStorage<unknown>

tryGetValidationResult

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

    Returns

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

    Returns null | ValidationStorageResultBuilder

validate

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

    Returns

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

    Returns ValidationResult

Generated using TypeDoc