Class CardStoreRequest

Запрос на сохранение информации по карточке посредством сервиса карточек. Содержит только изменённую информацию о карточке.

Hierarchy

Implements

Constructors

constructor

Properties - Static Keys

affectVersionKey cardKey doesNotAffectVersionKey fileMappingKey forceReleaseLockKey forceTransactionKey infoKey systemMethodKey

Accessors

affectVersion card doesNotAffectVersion fileMapping forceReleaseLock forceTransaction info method

Methods

clean clone ensureCacheResolved getStorage getStorageSettings isValid notifyStorageUpdated removeSystemInfo removeUserInfo tryGetCard tryGetFileMapping tryGetInfo validate

Constructors

constructor

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

    Parameters

    • storage: IStorage<unknown> = {}

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

    Returns CardStoreRequest

Static Keys Properties

Static Readonly affectVersionKey

affectVersionKey: "AffectVersion" = 'AffectVersion'

Static Readonly cardKey

cardKey: "Card" = 'Card'

Static Readonly doesNotAffectVersionKey

doesNotAffectVersionKey: "DoesNotAffectVersionKey" = 'DoesNotAffectVersionKey'

Static Readonly fileMappingKey

fileMappingKey: "FileMapping" = 'FileMapping'

Static Readonly forceReleaseLockKey

forceReleaseLockKey: "ForceReleaseLock" = 'ForceReleaseLock'

Static Readonly forceTransactionKey

forceTransactionKey: "ForceTransaction" = 'ForceTransaction'

Static Readonly infoKey

infoKey: "Info" = 'Info'

Static Readonly systemMethodKey

systemMethodKey: string = ...

Accessors

affectVersion

  • get affectVersion(): boolean

  • Признак того, что изменение карточки будет принудительно выполняться с проверкой её версии и приведёт к увеличению номера версии, даже если отсутствуют изменяемые значения в основной карточке или её файлах. Изменение заданий не приводит к проверке и увеличению версии, только если этот флаг установлен в false. Этот флаг менее приоритетный, чем doesNotAffectVersion.

    Returns boolean

  • set affectVersion(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

card

  • get card(): Card

  • Карточка.

    Returns Card

  • set card(value: Card): void

  • Parameters

    Returns void

doesNotAffectVersion

  • get doesNotAffectVersion(): boolean

  • Признак того, что изменение карточки не приведёт к проверке версии и к увеличению номера версии, даже если присутствуют изменяемые значения в основной карточке или её файлах. При первом сохранении карточки версия всё равно увеличивается до 1. Этот флаг более приоритетный, чем affectVersion.

    Returns boolean

  • set doesNotAffectVersion(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

fileMapping

  • get fileMapping(): StorageArray<CardFileContentMapping>

  • Маппинг для контента сохраняемых файлов. Значение актуально задавать при сохранении карточки с контентом файлов, которые являются виртуальными, т.е. принадлежат другой карточке.

    Returns StorageArray<CardFileContentMapping>

  • set fileMapping(value: CardFileContentMapping[]): void

  • Parameters

    Returns void

forceReleaseLock

  • get forceReleaseLock(): boolean

  • Признак того, что для карточки будет принудительно закрыта блокировка на запись даже в том случае, если она не должна быть закрыта. Этот флаг имеет смысл только в том случае, когда method равен CardStoreMethod.Restore. Актуально, например, при восстановлении карточки-сателлита.

    Returns boolean

  • set forceReleaseLock(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

forceTransaction

  • get forceTransaction(): boolean

  • Признак того, что для карточки будет принудительно открыта транзакция даже в том случае, если изменения карточки отсутствуют. Это позволит гарантировать, что расширения внутри транзакции будут выполнены. При отсутствии других изменений в карточке транзакция будет открыта без блокировки.

    Returns boolean

  • set forceTransaction(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

info

  • get info(): IStorage<unknown>

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

    Returns IStorage<unknown>

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

  • Parameters

    Returns void

method

  • get method(): CardStoreMethod

  • Способ сохранения карточки.

    Returns CardStoreMethod

  • set method(value: CardStoreMethod): void

  • Parameters

    Returns void

Methods

clean

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

    Returns void

clone

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

    Returns CardStoreRequest

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

tryGetCard

  • Возвращает карточку или null, если карточка не была задана.

    Returns

    Карточка или null, если карточка не была задана.

    Returns null | Card

tryGetFileMapping

  • Возвращает маппинг для контента сохраняемых файлов или null, если маппинг ещё не был задан.

    Значение актуально задавать при сохранении карточки с контентом файлов, которые являются виртуальными, т.е. принадлежат другой карточке.

    Returns

    Возвращает маппинг для контента сохраняемых файлов или null, если маппинг ещё не был задан.

    Returns null | StorageArray<CardFileContentMapping>

tryGetInfo

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

    Returns

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

    Returns null | IStorage<unknown>

validate

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

    Returns

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

    Returns ValidationResult

Generated using TypeDoc