Class CardRequest

Универсальный запрос на выполнение действий через сервис карточек.

Hierarchy

Implements

Constructors

constructor

Properties - Static Keys

cardIdKey cardTypeIdKey cardTypeNameKey fileIdKey fileTypeIdKey fileTypeNameKey fileVersionIdKey infoKey requestTypeKey taskIdKey taskTypeIdKey taskTypeNameKey

Accessors

cardId cardTypeId cardTypeName fileId fileTypeId fileTypeName fileVersionId info requestType taskId taskTypeId taskTypeName

Methods

clean clone ensureCacheResolved getStorage getStorageSettings isValid notifyStorageUpdated removeSystemInfo removeUserInfo setCardInfo setFileInfo setTaskInfo setTypedRequest tryGetInfo tryGetTypedRequest validate

Constructors

constructor

  • Создает универсальный запрос на выполнение действий через сервис карточек.

    Parameters

    • requestType: string

      Идентификатор типа запроса.

    Returns CardRequest

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

    Parameters

    • Optional storage: IStorage<unknown>

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

    Returns CardRequest

Static Keys Properties

Static Readonly cardIdKey

cardIdKey: "CardID" = 'CardID'

Static Readonly cardTypeIdKey

cardTypeIdKey: "CardTypeID" = 'CardTypeID'

Static Readonly cardTypeNameKey

cardTypeNameKey: "CardTypeName" = 'CardTypeName'

Static Readonly fileIdKey

fileIdKey: "FileID" = 'FileID'

Static Readonly fileTypeIdKey

fileTypeIdKey: "FileTypeID" = 'FileTypeID'

Static Readonly fileTypeNameKey

fileTypeNameKey: "FileTypeName" = 'FileTypeName'

Static Readonly fileVersionIdKey

fileVersionIdKey: "FileVersionID" = 'FileVersionID'

Static Readonly infoKey

infoKey: "Info" = 'Info'

Static Readonly requestTypeKey

requestTypeKey: "RequestType" = 'RequestType'

Static Readonly taskIdKey

taskIdKey: "TaskID" = 'TaskID'

Static Readonly taskTypeIdKey

taskTypeIdKey: "TaskTypeID" = 'TaskTypeID'

Static Readonly taskTypeNameKey

taskTypeNameKey: "TaskTypeName" = 'TaskTypeName'

Accessors

cardId

  • get cardId(): null | string

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

    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

fileId

  • get fileId(): null | string

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

    Returns null | string

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

  • Parameters

    • value: null | string

    Returns void

fileTypeId

  • get fileTypeId(): null | string

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

    Returns null | string

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

  • Parameters

    • value: null | string

    Returns void

fileTypeName

  • get fileTypeName(): null | string

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

    Returns null | string

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

  • Parameters

    • value: null | string

    Returns void

fileVersionId

  • get fileVersionId(): null | string

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

    Returns null | string

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

  • Parameters

    • value: null | string

    Returns void

info

  • get info(): IStorage<unknown>

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

    Returns IStorage<unknown>

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

  • Parameters

    Returns void

requestType

  • get requestType(): string

  • Идентификатор типа запроса.

    Returns string

  • set requestType(value: string): void

  • Parameters

    • value: string

    Returns void

taskId

  • get taskId(): null | string

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

    Returns null | string

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

  • Parameters

    • value: null | string

    Returns void

taskTypeId

  • get taskTypeId(): null | string

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

    Returns null | string

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

  • Parameters

    • value: null | string

    Returns void

taskTypeName

  • get taskTypeName(): null | string

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

    Returns null | string

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

  • Parameters

    • value: null | string

    Returns void

Methods

clean

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

    Returns void

clone

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

    Returns CardRequest

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

setCardInfo

  • Заполняет данные текущего объекта из заданной карточки.

    Parameters

    • card: Card

      Карточка, информацию о которой требуется заполнить для текущего объекта.

    Returns void

setFileInfo

  • Заполняет данные текущего объекта из заданного файла.

    Parameters

    • file: CardFile

      Файл, информацию о котором требуется заполнить для текущего объекта.

    Returns void

setTaskInfo

  • Заполняет данные текущего объекта из заданного задания.

    Parameters

    • task: CardTask

      Задание, информацию о котором требуется заполнить для текущего объекта.

    Returns void

setTypedRequest

  • Устанавливает строготипизированный запрос для универсальных расширений.

    Parameters

    • request: null | IStorageProvider<IStorage<unknown> | IStorageArray<unknown>>

      Строготипизированный запрос или null, если существующий запрос требуется удалить.

    Returns void

tryGetInfo

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

    Returns

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

    Returns null | IStorage<unknown>

tryGetTypedRequest

  • Возвращает хранилище для строготипизированного запроса для универсальных расширений.

    Returns null | IStorage<unknown>

validate

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

    Returns

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

    Returns ValidationResult

Generated using TypeDoc