Class CardNewResponse

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

Hierarchy

Implements

Constructors

constructor

Properties - Static Keys

cancelOpeningSystemKey cardKey infoKey sectionRowsKey validationResultKey

Accessors

cancelOpening card info sectionRows validationResult

Methods

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

Constructors

constructor

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

    Parameters

    • storage: IStorage<unknown> = {}

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

    Returns CardNewResponse

Static Keys Properties

Static Readonly cancelOpeningSystemKey

cancelOpeningSystemKey: string = ...

Static Readonly cardKey

cardKey: "Card" = 'Card'

Static Readonly infoKey

infoKey: "Info" = 'Info'

Static Readonly sectionRowsKey

sectionRowsKey: "SectionRows" = 'SectionRows'

Static Readonly validationResultKey

validationResultKey: "ValidationResult" = 'ValidationResult'

Accessors

cancelOpening

  • get cancelOpening(): boolean

  • Признак того, что созданную карточку не следует открывать стандартными средствами, как будто бы при её создании произошла ошибка.

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

    Актуально только для запросов на создание карточек, но не других объектов (файлов, заданий, диалогов).

    Returns boolean

  • set cancelOpening(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

card

  • get card(): Card

  • Карточка.

    Returns Card

  • set card(value: Card): void

  • Parameters

    Returns void

info

  • get info(): IStorage<unknown>

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

    Returns IStorage<unknown>

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

  • Parameters

    Returns void

sectionRows

  • get sectionRows(): StorageMap<CardRow, IStorage<unknown>>

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

    Returns StorageMap<CardRow, IStorage<unknown>>

  • set sectionRows(value: StorageMap<CardRow, IStorage<unknown>>): void

  • Parameters

    Returns void

validationResult

Methods

clean

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

    Returns void

clone

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

    Returns CardNewResponse

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

tryGetInfo

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

    Returns

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

    Returns null | IStorage<unknown>

tryGetSectionRows

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

    Returns

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

    Returns null | StorageMap<CardRow, IStorage<unknown>>

tryGetValidationResult

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

    Returns

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

    Returns null | ValidationStorageResultBuilder

validate

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

    Returns

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

    Returns ValidationResult

Generated using TypeDoc