Class CardDeleteRequest

Запрос на удаление карточки посредством сервиса карточек.

Hierarchy

Implements

Constructors

constructor

Properties - Static Keys

cardIdKey cardTypeIdKey cardTypeNameKey infoKey keepFileContentKey systemDeletionModeKey systemMethodKey

Accessors

cardId cardTypeId cardTypeName deletionMode info keepFileContent method

Methods

clean clone ensureCacheResolved getStorage getStorageSettings isValid notifyStorageUpdated removeSystemInfo removeUserInfo tryGetInfo validate

Constructors

constructor

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

    Parameters

    • storage: IStorage<unknown> = {}

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

    Returns CardDeleteRequest

Static Keys Properties

Static Readonly cardIdKey

cardIdKey: "CardID" = 'CardID'

Static Readonly cardTypeIdKey

cardTypeIdKey: "CardTypeID" = 'CardTypeID'

Static Readonly cardTypeNameKey

cardTypeNameKey: "CardTypeName" = 'CardTypeName'

Static Readonly infoKey

infoKey: "Info" = 'Info'

Static Readonly keepFileContentKey

keepFileContentKey: "KeepFileContent" = 'KeepFileContent'

Static Readonly systemDeletionModeKey

systemDeletionModeKey: string = ...

Static Readonly systemMethodKey

systemMethodKey: string = ...

Accessors

cardId

  • get cardId(): null | string

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

    Returns null | string

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

  • Parameters

    • value: null | string

    Returns void

cardTypeId

  • get cardTypeId(): null | string

  • Идентификатор типа карточки. Значение необязательно для заполнения.

    Returns null | string

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

  • Parameters

    • value: null | string

    Returns void

cardTypeName

  • get cardTypeName(): null | string

  • Имя типа карточки. Значение необязательно для заполнения.

    Returns null | string

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

  • Parameters

    • value: null | string

    Returns void

deletionMode

  • get deletionMode(): CardDeletionMode

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

    Returns CardDeletionMode

  • set deletionMode(value: CardDeletionMode): void

  • Parameters

    Returns void

info

  • get info(): IStorage<unknown>

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

    Returns IStorage<unknown>

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

  • Parameters

    Returns void

keepFileContent

  • get keepFileContent(): boolean

  • Признак того, что контент файлов не должен быть удалён при удалении карточки. Значение следует устанавливать только при вызове серверного API.

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

    Returns boolean

  • set keepFileContent(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

method

  • get method(): Default

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

    Returns Default

  • set method(value: Default): void

  • Parameters

    Returns void

Methods

clean

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

    Returns void

clone

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

    Returns CardDeleteRequest

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>

validate

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

    Returns

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

    Returns ValidationResult

Generated using TypeDoc