TESSA Web API
    Preparing search index...

    Class CardStoreRequest

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

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties - Other

    cachedMemberChanged fieldChanged

    Properties - Static Keys

    affectVersionKey cardKey doesNotAffectVersionKey fileMappingKey forceTransactionKey infoKey systemMethodKey

    Accessors

    affectVersion cachedMembers card doesNotAffectVersion fileMapping forceTransaction info isObservable method

    Methods

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

    Constructors

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

      Parameters

      • storage: IStorage = {}

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

      Returns CardStoreRequest

    Properties - Other

    cachedMemberChanged: EventHandler<
        { fieldName: string; newValue: unknown; oldValue: unknown },
    >
    fieldChanged: EventHandler<
        { fieldName: string; newValue: unknown; oldValue: unknown },
    >

    Properties - Static Keys

    affectVersionKey: "AffectVersion" = 'AffectVersion'
    cardKey: "Card" = 'Card'
    doesNotAffectVersionKey: "DoesNotAffectVersionKey" = 'DoesNotAffectVersionKey'
    fileMappingKey: "FileMapping" = 'FileMapping'
    forceTransactionKey: "ForceTransaction" = 'ForceTransaction'
    infoKey: "Info" = 'Info'
    systemMethodKey: string = ...

    Accessors

    • get affectVersion(): boolean

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

      Returns boolean

    • set affectVersion(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get cachedMembers(): ReadonlyMap<string, unknown>

      Returns ReadonlyMap<string, unknown>

    • get card(): Card

      Карточка.

      Returns Card

    • set card(value: Card): void

      Parameters

      Returns void

    • get doesNotAffectVersion(): boolean

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

      Returns boolean

    • set doesNotAffectVersion(value: boolean): void

      Parameters

      • value: boolean

      Returns void

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

      Returns StorageArray<CardFileContentMapping>

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

      Parameters

      Returns void

    • get forceTransaction(): boolean

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

      Returns boolean

    • set forceTransaction(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get info(): IStorage

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

      Returns IStorage

    • set info(value: IStorage): void

      Parameters

      Returns void

    • get isObservable(): boolean

      Определяет, является ли хранилище наблюдаемым, то есть поддерживает механизм автоматического оповещения о своих изменениях.

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

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

      Returns boolean

    • set isObservable(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get method(): CardStoreMethod

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

      Returns CardStoreMethod

    • set method(value: CardStoreMethod): void

      Parameters

      Returns void

    Methods

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

      Returns void

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

      Returns CardStoreRequest

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

      Returns void

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

      Returns IStorage

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

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

      Returns boolean

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

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

      Returns void

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

      Returns void

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

      Returns void

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

      Returns null | Card

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

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

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

      Returns null | StorageArray<CardFileContentMapping>

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

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

      Returns null | IStorage

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

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

      Returns ValidationResult

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties - Other
    Properties - Static Keys
    Accessors
    Methods