Class CardGetFileVersionsResponse

Ответ на запрос по получению информации по версиям файла, прикреплённого к карточке, от сервиса карточек.

Hierarchy

CardResponseBase
- CardGetFileVersionsResponse

Implements

ICloneable<CardGetFileVersionsResponse>

Index

Constructors

constructor

new CardGetFileVersionsResponse(storage?: IStorage<unknown>): CardGetFileVersionsResponse
Создаёт экземпляр класса с указанием хранилища (или пустое хранилище по умолчанию), декоратором для которого является создаваемый объект.
Parameters
- storage: IStorage<unknown> = {}
  
  Хранилище, декоратором для которого является создаваемый объект.
Returns CardGetFileVersionsResponse
Overrides CardResponseBase.constructor
- Defined in @tessa/platform/src/cards/service/cardGetFileVersionsResponse.ts:23

Static Keys Properties

`Static` `Readonly` compressedSystemKey

compressedSystemKey: string = ...

`Static` `Readonly` disallowCachingSystemKey

disallowCachingSystemKey: string = ...

`Static` `Readonly` fileVersionsKey

fileVersionsKey: "FileVersions" = 'FileVersions'

`Static` `Readonly` infoKey

infoKey: "Info" = 'Info'

`Static` `Readonly` validationResultKey

validationResultKey: "ValidationResult" = 'ValidationResult'

Accessors

compressed

get compressed(): boolean
Признак того, что список версий fileVersions был сжат.

Returns boolean
- Defined in @tessa/platform/src/cards/service/cardGetFileVersionsResponse.ts:63
set compressed(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in @tessa/platform/src/cards/service/cardGetFileVersionsResponse.ts:66

disallowCaching

get disallowCaching(): boolean
Признак того, что не следует выполнять кэширование результата.

Returns boolean
- Defined in @tessa/platform/src/cards/service/cardGetFileVersionsResponse.ts:71
set disallowCaching(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in @tessa/platform/src/cards/service/cardGetFileVersionsResponse.ts:74

fileVersions

get fileVersions(): StorageArray<CardFileVersion>
Список версий для заданного файла.

Returns StorageArray<CardFileVersion>
- Defined in @tessa/platform/src/cards/service/cardGetFileVersionsResponse.ts:47
set fileVersions(value: CardFileVersion[]): void
Parameters
- value: CardFileVersion[]
Returns void
- Defined in @tessa/platform/src/cards/service/cardGetFileVersionsResponse.ts:58

info

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

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

validationResult

get validationResult(): ValidationStorageResultBuilder
Объект, используемый для построения результата валидации.

Returns ValidationStorageResultBuilder
Inherited from CardResponseBase.validationResult
- Defined in @tessa/platform/src/cards/service/cardResponseBase.ts:34
set validationResult(value: ValidationStorageResultBuilder): void
Parameters
- value: ValidationStorageResultBuilder
Returns void
Inherited from CardResponseBase.validationResult
- Defined in @tessa/platform/src/cards/service/cardResponseBase.ts:40

Methods

clean

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

Returns void
Inherited from CardResponseBase.clean
- Defined in @tessa/platform/src/cards/service/cardResponseBase.ts:65

clone

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

Returns CardGetFileVersionsResponse
Implementation of ICloneable.clone
- Defined in @tessa/platform/src/cards/service/cardGetFileVersionsResponse.ts:102

ensureCacheResolved

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

Returns void
Overrides CardResponseBase.ensureCacheResolved
- Defined in @tessa/platform/src/cards/service/cardGetFileVersionsResponse.ts:110

getStorage

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

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

Returns IStorage<unknown>
Inherited from CardResponseBase.getStorage
- Defined in @tessa/core/src/storage/storageObject.ts:434

getStorageSettings

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

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

isValid

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

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

Returns boolean
Inherited from CardResponseBase.isValid
- Defined in @tessa/core/src/validation/validationStorageObject.ts:19

notifyStorageUpdated

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

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

removeSystemInfo

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

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

removeUserInfo

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

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

tryGetInfo

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

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

Returns null | IStorage<unknown>
Inherited from CardResponseBase.tryGetInfo
- Defined in @tessa/platform/src/cards/cardInfoStorageObject.ts:42

tryGetValidationResult

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

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

Returns null | ValidationStorageResultBuilder
Inherited from CardResponseBase.tryGetValidationResult
- Defined in @tessa/platform/src/cards/service/cardResponseBase.ts:54

tryGetVersions

tryGetVersions(): null | StorageArray<CardFileVersion>
Возвращает список версий для заданного файла или null, если список версий не был задан.

Returns
Список версий для заданного файла или null, если список версий не был задан.

Returns null | StorageArray<CardFileVersion>
- Defined in @tessa/platform/src/cards/service/cardGetFileVersionsResponse.ts:86

validate

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

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

Returns ValidationResult
Inherited from CardResponseBase.validate
- Defined in @tessa/core/src/validation/validationStorageObject.ts:13

Class CardGetFileVersionsResponse

Hierarchy

Implements

Index

Constructors

Properties - Static Keys

Accessors

Methods

Constructors

constructor

Parameters

storage: IStorage<unknown> = {}

Returns CardGetFileVersionsResponse

Static Keys Properties

Static Readonly compressedSystemKey

Static Readonly disallowCachingSystemKey

Static Readonly fileVersionsKey

Static Readonly infoKey

Static Readonly validationResultKey

Accessors

compressed

Returns boolean

Parameters

value: boolean

Returns void

disallowCaching

Returns boolean

Parameters

value: boolean

Returns void

fileVersions

Returns StorageArray<CardFileVersion>

Parameters

value: CardFileVersion[]

Returns void

info

Returns IStorage<unknown>

Parameters

value: IStorage<unknown>

Returns void

validationResult

Returns ValidationStorageResultBuilder

Parameters

value: ValidationStorageResultBuilder

Returns void

Methods

clean

Returns void

clone

Returns CardGetFileVersionsResponse

ensureCacheResolved

Returns void

getStorage

Returns

Returns IStorage<unknown>

getStorageSettings

Returns Readonly<StorageSettings>

isValid

Returns

Returns boolean

notifyStorageUpdated

Returns void

removeSystemInfo

Returns void

removeUserInfo

Returns void

tryGetInfo

Returns

Returns null | IStorage<unknown>

tryGetValidationResult

Returns

Returns null | ValidationStorageResultBuilder

tryGetVersions

Returns

Returns null | StorageArray<CardFileVersion>

validate

Returns

Returns ValidationResult

`Static` `Readonly` compressedSystemKey

`Static` `Readonly` disallowCachingSystemKey

`Static` `Readonly` fileVersionsKey

`Static` `Readonly` infoKey

`Static` `Readonly` validationResultKey