Class CardRequest

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

Hierarchy (View Summary)

CardInfoStorageObject
- CardRequest

Implements

ICloneable<CardRequest>

Constructors

constructor

new CardRequest(requestType: string): CardRequest
Создает универсальный запрос на выполнение действий через сервис карточек.
Parameters
- requestType: string
  Идентификатор типа запроса.
Returns CardRequest
Overrides CardInfoStorageObject.constructor
- Defined in @tessa/platform/src/cards/service/cardRequest.ts:14
new CardRequest(storage?: IStorage): CardRequest
Создаёт экземпляр класса с указанием хранилища (или пустое хранилище по умолчанию), декоратором для которого является создаваемый объект.
Parameters
- Optionalstorage: IStorage
  Хранилище, декоратором для которого является создаваемый объект.
Returns CardRequest
Overrides CardInfoStorageObject.constructor
- Defined in @tessa/platform/src/cards/service/cardRequest.ts:20

Properties - Other

`Readonly`cachedMemberChanged

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

`Readonly`fieldChanged

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

Properties - Static Keys

`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

cachedMembers

get cachedMembers(): ReadonlyMap<string, unknown>
Returns ReadonlyMap<string, unknown>
Inherited from CardInfoStorageObject.cachedMembers
- Defined in @tessa/core/src/storage/storageObject.ts:90

cardId

get cardId(): null | string
Идентификатор карточки. Значение необязательно для заполнения.

Returns null | string
- Defined in @tessa/platform/src/cards/service/cardRequest.ts:82
set cardId(value: null | string): void
Parameters
- value: null | string
Returns void
- Defined in @tessa/platform/src/cards/service/cardRequest.ts:85

cardTypeId

get cardTypeId(): null | string
Идентификатор типа карточки. Значение необязательно для заполнения.

Returns null | string
- Defined in @tessa/platform/src/cards/service/cardRequest.ts:90
set cardTypeId(value: null | string): void
Parameters
- value: null | string
Returns void
- Defined in @tessa/platform/src/cards/service/cardRequest.ts:93

cardTypeName

get cardTypeName(): null | string
Имя типа карточки. Значение необязательно для заполнения.

Returns null | string
- Defined in @tessa/platform/src/cards/service/cardRequest.ts:98
set cardTypeName(value: null | string): void
Parameters
- value: null | string
Returns void
- Defined in @tessa/platform/src/cards/service/cardRequest.ts:101

fileId

get fileId(): null | string
Идентификатор файла. Значение необязательно для заполнения.

Returns null | string
- Defined in @tessa/platform/src/cards/service/cardRequest.ts:106
set fileId(value: null | string): void
Parameters
- value: null | string
Returns void
- Defined in @tessa/platform/src/cards/service/cardRequest.ts:109

fileTypeId

get fileTypeId(): null | string
Идентификатор типа файла. Значение необязательно для заполнения.

Returns null | string
- Defined in @tessa/platform/src/cards/service/cardRequest.ts:114
set fileTypeId(value: null | string): void
Parameters
- value: null | string
Returns void
- Defined in @tessa/platform/src/cards/service/cardRequest.ts:117

fileTypeName

get fileTypeName(): null | string
Имя типа файла. Значение необязательно для заполнения.

Returns null | string
- Defined in @tessa/platform/src/cards/service/cardRequest.ts:122
set fileTypeName(value: null | string): void
Parameters
- value: null | string
Returns void
- Defined in @tessa/platform/src/cards/service/cardRequest.ts:125

fileVersionId

get fileVersionId(): null | string
Идентификатор версии файла. Значение необязательно для заполнения.

Returns null | string
- Defined in @tessa/platform/src/cards/service/cardRequest.ts:130
set fileVersionId(value: null | string): void
Parameters
- value: null | string
Returns void
- Defined in @tessa/platform/src/cards/service/cardRequest.ts:133

info

get info(): IStorage
Дополнительная пользовательская информация.

Returns IStorage
Inherited from CardTaskHistoryItem.info
- Defined in @tessa/platform/src/cards/cardInfoStorageObject.ts:25
set info(value: IStorage): void
Parameters
- value: IStorage
Returns void
Inherited from CardTaskHistoryItem.info
- Defined in @tessa/platform/src/cards/cardInfoStorageObject.ts:28

isObservable

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

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

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

Returns boolean
Inherited from CardInfoStorageObject.isObservable
- Defined in @tessa/core/src/storage/storageObject.ts:83
set isObservable(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from CardInfoStorageObject.isObservable
- Defined in @tessa/core/src/storage/storageObject.ts:86

requestType

get requestType(): string
Идентификатор типа запроса.

Returns string
- Defined in @tessa/platform/src/cards/service/cardRequest.ts:74
set requestType(value: string): void
Parameters
- value: string
Returns void
- Defined in @tessa/platform/src/cards/service/cardRequest.ts:77

taskId

get taskId(): null | string
Идентификатор задания. Значение необязательно для заполнения.

Returns null | string
- Defined in @tessa/platform/src/cards/service/cardRequest.ts:138
set taskId(value: null | string): void
Parameters
- value: null | string
Returns void
- Defined in @tessa/platform/src/cards/service/cardRequest.ts:141

taskTypeId

get taskTypeId(): null | string
Идентификатор типа задания. Значение необязательно для заполнения.

Returns null | string
- Defined in @tessa/platform/src/cards/service/cardRequest.ts:146
set taskTypeId(value: null | string): void
Parameters
- value: null | string
Returns void
- Defined in @tessa/platform/src/cards/service/cardRequest.ts:149

taskTypeName

get taskTypeName(): null | string
Имя типа задания. Значение необязательно для заполнения.

Returns null | string
- Defined in @tessa/platform/src/cards/service/cardRequest.ts:154
set taskTypeName(value: null | string): void
Parameters
- value: null | string
Returns void
- Defined in @tessa/platform/src/cards/service/cardRequest.ts:157

Methods

clean

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

Returns void
Overrides CardInfoStorageObject.clean
- Defined in @tessa/platform/src/cards/service/cardRequest.ts:165

clone

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

Returns CardRequest
Implementation of ICloneable.clone
- Defined in @tessa/platform/src/cards/service/cardRequest.ts:204

ensureCacheResolved

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

Returns void
Inherited from CardInfoStorageObject.ensureCacheResolved
- Defined in @tessa/core/src/storage/storageObject.ts:500

getStorage

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

Returns IStorage
Хранилище IStorage, декоратором для которого является текущий объект.
Inherited from CardInfoStorageObject.getStorage
- Defined in @tessa/core/src/storage/storageObject.ts:486

getStorageSettings

getStorageSettings(): Readonly<StorageSettings>
Возвращает настройки объекта-хранилища.

Returns Readonly<StorageSettings>
Inherited from CardInfoStorageObject.getStorageSettings
- Defined in @tessa/core/src/storage/storageObject.ts:520

isValid

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

Returns boolean
true, если объект прошёл проверку на валидность; false в противном случае.
Inherited from CardInfoStorageObject.isValid
- Defined in @tessa/core/src/validation/validationStorageObject.ts:19

notifyStorageUpdated

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

Returns void
Inherited from CardInfoStorageObject.notifyStorageUpdated
- Defined in @tessa/core/src/storage/storageObject.ts:506

removeSystemInfo

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

Returns void
Inherited from CardInfoStorageObject.removeSystemInfo
- Defined in @tessa/platform/src/cards/cardInfoStorageObject.ts:67

removeUserInfo

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

Returns void
Inherited from CardInfoStorageObject.removeUserInfo
- Defined in @tessa/platform/src/cards/cardInfoStorageObject.ts:50

setCardInfo

setCardInfo(card: Card): void
Заполняет данные текущего объекта из заданной карточки.
Parameters
- card: Card
  Карточка, информацию о которой требуется заполнить для текущего объекта.
Returns void
- Defined in @tessa/platform/src/cards/_extensionsCard.ts:313

setFileInfo

setFileInfo(file: CardFile): void
Заполняет данные текущего объекта из заданного файла.
Parameters
- file: CardFile
  Файл, информацию о котором требуется заполнить для текущего объекта.
Returns void
- Defined in @tessa/platform/src/cards/_extensionsCard.ts:319

setTaskInfo

setTaskInfo(task: CardTask): void
Заполняет данные текущего объекта из заданного задания.
Parameters
- task: CardTask
  Задание, информацию о котором требуется заполнить для текущего объекта.
Returns void
- Defined in @tessa/platform/src/cards/_extensionsCard.ts:325

setTypedRequest

setTypedRequest(
    request:
        | null
        | IStorageProvider<IStorage<unknown> | IStorageArray<unknown>>,
): void
Устанавливает строготипизированный запрос для универсальных расширений.
Parameters
- request: null | IStorageProvider<IStorage<unknown> | IStorageArray<unknown>>
  Строготипизированный запрос или null, если существующий запрос требуется удалить.
Returns void
- Defined in @tessa/platform/src/cards/_extensionsCard.ts:331

tryGetInfo

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

Returns null | IStorage
Дополнительная пользовательская информацию по текущему объекту или null, если информация ещё не была задана.
Inherited from CardInfoStorageObject.tryGetInfo
- Defined in @tessa/platform/src/cards/cardInfoStorageObject.ts:42

tryGetTypedRequest

tryGetTypedRequest(): null | IStorage
Возвращает хранилище для строготипизированного запроса для универсальных расширений.

Returns null | IStorage
- Defined in @tessa/platform/src/cards/_extensionsCard.ts:336

validate

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

Returns ValidationResult
Объект, выполняющий построение результата валидации.
Inherited from CardInfoStorageObject.validate
- Defined in @tessa/core/src/validation/validationStorageObject.ts:13

Class CardRequest

Hierarchy (View Summary)

Implements

Index

Constructors

Properties - Other

Properties - Static Keys

Accessors

Methods

Constructors

constructor

Parameters

Returns CardRequest

Parameters

Returns CardRequest

Properties - Other

ReadonlycachedMemberChanged

ReadonlyfieldChanged

Properties - Static Keys

Static ReadonlycardIdKey

Static ReadonlycardTypeIdKey

Static ReadonlycardTypeNameKey

Static ReadonlyfileIdKey

Static ReadonlyfileTypeIdKey

Static ReadonlyfileTypeNameKey

Static ReadonlyfileVersionIdKey

Static ReadonlyinfoKey

Static ReadonlyrequestTypeKey

Static ReadonlytaskIdKey

Static ReadonlytaskTypeIdKey

Static ReadonlytaskTypeNameKey

Accessors

cachedMembers

Returns ReadonlyMap<string, unknown>

cardId

Returns null | string

Parameters

Returns void

cardTypeId

Returns null | string

Parameters

Returns void

cardTypeName

Returns null | string

Parameters

Returns void

fileId

Returns null | string

Parameters

Returns void

fileTypeId

Returns null | string

Parameters

Returns void

fileTypeName

Returns null | string

Parameters

Returns void

fileVersionId

Returns null | string

Parameters

Returns void

info

Returns IStorage

Parameters

Returns void

isObservable

Returns boolean

Parameters

Returns void

requestType

Returns string

Parameters

Returns void

taskId

Returns null | string

Parameters

Returns void

taskTypeId

Returns null | string

`Readonly`cachedMemberChanged

`Readonly`fieldChanged

`Static` `Readonly`cardIdKey

`Static` `Readonly`cardTypeIdKey

`Static` `Readonly`cardTypeNameKey

`Static` `Readonly`fileIdKey

`Static` `Readonly`fileTypeIdKey

`Static` `Readonly`fileTypeNameKey

`Static` `Readonly`fileVersionIdKey

`Static` `Readonly`infoKey

`Static` `Readonly`requestTypeKey

`Static` `Readonly`taskIdKey

`Static` `Readonly`taskTypeIdKey

`Static` `Readonly`taskTypeNameKey