Class CardRequest

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

Hierarchy (View Summary, Expand)

Implements

Constructors

constructor

Properties - Other

cachedMemberChanged fieldChanged

Properties - Static Keys

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

Accessors

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

Methods

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

Constructors

constructor

  • new CardRequest(requestType: string): CardRequest

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

    Parameters

    • requestType: string

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

    Returns CardRequest

  • new CardRequest(storage?: IStorage): CardRequest

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

    Parameters

    • Optionalstorage: IStorage

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

    Returns CardRequest

Properties - Other

ReadonlycachedMemberChanged

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

ReadonlyfieldChanged

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

Properties - Static Keys

Static ReadonlycardIdKey

cardIdKey: "CardID" = 'CardID'

Static ReadonlycardTypeIdKey

cardTypeIdKey: "CardTypeID" = 'CardTypeID'

Static ReadonlycardTypeNameKey

cardTypeNameKey: "CardTypeName" = 'CardTypeName'

Static ReadonlyfileIdKey

fileIdKey: "FileID" = 'FileID'

Static ReadonlyfileTypeIdKey

fileTypeIdKey: "FileTypeID" = 'FileTypeID'

Static ReadonlyfileTypeNameKey

fileTypeNameKey: "FileTypeName" = 'FileTypeName'

Static ReadonlyfileVersionIdKey

fileVersionIdKey: "FileVersionID" = 'FileVersionID'

Static ReadonlyinfoKey

infoKey: "Info" = 'Info'

Static ReadonlyrequestTypeKey

requestTypeKey: "RequestType" = 'RequestType'

Static ReadonlytaskIdKey

taskIdKey: "TaskID" = 'TaskID'

Static ReadonlytaskTypeIdKey

taskTypeIdKey: "TaskTypeID" = 'TaskTypeID'

Static ReadonlytaskTypeNameKey

taskTypeNameKey: "TaskTypeName" = 'TaskTypeName'

Accessors

cachedMembers

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

    Returns ReadonlyMap<string, unknown>

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

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

    Returns IStorage

  • set info(value: IStorage): void

    Parameters

    Returns void

isObservable

  • get isObservable(): boolean

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

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

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

    Returns boolean

  • set isObservable(value: boolean): void

    Parameters

    • value: boolean

    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

  • clean(): void

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

    Returns void

clone

  • clone(): CardRequest

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

    Returns CardRequest

ensureCacheResolved

  • ensureCacheResolved(): void

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

    Returns void

getStorage

  • getStorage(): IStorage

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

    Returns IStorage

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

getStorageSettings

isValid

  • isValid(): boolean

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

    Returns boolean

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

notifyStorageUpdated

  • notifyStorageUpdated(): void

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

    Returns void

removeSystemInfo

  • removeSystemInfo(): void

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

    Returns void

removeUserInfo

  • removeUserInfo(): void

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

    Returns void

setCardInfo

  • setCardInfo(card: Card): void

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

    Parameters

    • card: Card

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

    Returns void

setFileInfo

  • setFileInfo(file: CardFile): void

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

    Parameters

    • file: CardFile

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

    Returns void

setTaskInfo

  • setTaskInfo(task: CardTask): void

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

    Parameters

    • task: CardTask

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

    Returns void

setTypedRequest

  • setTypedRequest(
        request:
            | null
            | IStorageProvider<IStorage<unknown> | IStorageArray<unknown>>,
    ): void

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

    Parameters

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

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

    Returns void

tryGetInfo

  • tryGetInfo(): null | IStorage

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

    Returns null | IStorage

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

tryGetTypedRequest

  • tryGetTypedRequest(): null | IStorage

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

    Returns null | IStorage

validate

  • validate(): ValidationResult

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

    Returns ValidationResult

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

Settings

Member Visibility

On This Page

Constructors
Properties - Other
Properties - Static Keys
Accessors
Methods
MMNEPVFCICPMFPCPTTAAATR