Class CardGetFileContentResponse

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

Hierarchy

CardResponseBase
- CardGetFileContentResponse

Implements

ICloneable<CardGetFileContentResponse>

Index

Constructors

constructor

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

Static Keys Properties

`Static` `Readonly` fileNameKey

fileNameKey: "FileName" = 'FileName'

`Static` `Readonly` infoKey

infoKey: "Info" = 'Info'

`Static` `Readonly` validationResultKey

validationResultKey: "ValidationResult" = 'ValidationResult'

Accessors

content

get content(): null | Blob
Запрошенный контент.

Returns null | Blob
- Defined in @tessa/platform/src/cards/service/cardGetFileContentResponse.ts:62

fileName

get fileName(): null | string
Имя файла.

Returns null | string
- Defined in @tessa/platform/src/cards/service/cardGetFileContentResponse.ts:40
set fileName(value: null | string): void
Parameters
- value: null | string
Returns void
- Defined in @tessa/platform/src/cards/service/cardGetFileContentResponse.ts:43

hasContent

get hasContent(): boolean
Признак того, что запрошенный контент может быть получен.

Returns boolean
- Defined in @tessa/platform/src/cards/service/cardGetFileContentResponse.ts:67

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

size

get size(): number
Длина в байтах для запрошенного контента.

Returns number
- Defined in @tessa/platform/src/cards/service/cardGetFileContentResponse.ts:72

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(): CardGetFileContentResponse
Создает новый объект, который является копией текущего экземпляра.

Returns CardGetFileContentResponse
Implementation of ICloneable.clone
- Defined in @tessa/platform/src/cards/service/cardGetFileContentResponse.ts:124

ensureCacheResolved

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

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

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

setContent

setContent(content: Blob, fileName?: null | string): void
Parameters
- content: Blob
- fileName: null | string = null
Returns void
- Defined in @tessa/platform/src/cards/service/cardGetFileContentResponse.ts:80

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

tryGetSuggestedFileNameFromInfo

tryGetSuggestedFileNameFromInfo(): null | string
Returns null | string
- Defined in @tessa/platform/src/cards/service/cardGetFileContentResponse.ts:116

tryGetValidationResult

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

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

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

validate

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

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

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

`Static` tryGetFileNameFromContentDisposition

tryGetFileNameFromContentDisposition(contentDisposition: null | string): null | string
Parameters
- contentDisposition: null | string
Returns null | string
- Defined in @tessa/platform/src/cards/service/cardGetFileContentResponse.ts:88

Class CardGetFileContentResponse

Hierarchy

Implements

Index

Constructors

Properties - Static Keys

Accessors

Methods

Constructors

constructor

Parameters

storage: IStorage<unknown> = {}

Returns CardGetFileContentResponse

Static Keys Properties

Static Readonly fileNameKey

Static Readonly infoKey

Static Readonly validationResultKey

Accessors

content

Returns null | Blob

fileName

Returns null | string

Parameters

value: null | string

Returns void

hasContent

Returns boolean

info

Returns IStorage<unknown>

Parameters

value: IStorage<unknown>

Returns void

size

Returns number

validationResult

Returns ValidationStorageResultBuilder

Parameters

value: ValidationStorageResultBuilder

Returns void

Methods

clean

Returns void

clone

Returns CardGetFileContentResponse

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

setContent

Parameters

content: Blob

fileName: null | string = null

Returns void

tryGetInfo

Returns

Returns null | IStorage<unknown>

tryGetSuggestedFileNameFromInfo

Returns null | string

tryGetValidationResult

Returns

Returns null | ValidationStorageResultBuilder

validate

Returns

Returns ValidationResult

Static tryGetFileNameFromContentDisposition

Parameters

contentDisposition: null | string

Returns null | string

`Static` `Readonly` fileNameKey

`Static` `Readonly` infoKey

`Static` `Readonly` validationResultKey

`Static` tryGetFileNameFromContentDisposition