Class InitializationResponse

Строго типизированный декоратор для хранилища IStorage, поддерживающий валидацию свойств и расширение произвольными данными через свойство ValidationInfoStorageObject.info.

Hierarchy

ValidationInfoStorageObject
- InitializationResponse

Index

Constructors

constructor

new InitializationResponse(storage?: IStorage<unknown>): InitializationResponse
Parameters
- storage: IStorage<unknown> = {}
Returns InitializationResponse
Overrides ValidationInfoStorageObject.constructor
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:23

Static Keys Properties

`Static` `Readonly` additionalMetaKey

additionalMetaKey: "AdditionalMeta" = 'AdditionalMeta'

`Static` `Readonly` configurationCacheIsActualKey

configurationCacheIsActualKey: "ConfigurationIsCached" = 'ConfigurationIsCached'

`Static` `Readonly` configurationMetadataKey

configurationMetadataKey: ".configuration" = '.configuration'

`Static` `Readonly` configurationVersionKey

configurationVersionKey: "ConfigurationVersion" = 'ConfigurationVersion'

`Static` `Readonly` dbmsKey

dbmsKey: "Dbms" = 'Dbms'

`Static` `Readonly` defaultColors

defaultColors: "DefaultColors" = 'DefaultColors'

`Static` `Readonly` deskiCipherInfoKey

deskiCipherInfoKey: "CipherInfo" = 'CipherInfo'

`Static` `Readonly` formattingSettingsListKey

formattingSettingsListKey: "FormattingSettingsList" = 'FormattingSettingsList'

`Static` `Readonly` infoKey

infoKey: "Info" = 'Info'

`Static` `Readonly` personalRoleSatelliteKey

personalRoleSatelliteKey: "PersonalRoleSatellite" = 'PersonalRoleSatellite'

`Static` `Readonly` supportedPdfFormatsKey

supportedPdfFormatsKey: "SupportedPdfFormats" = 'SupportedPdfFormats'

`Static` `Readonly` userSettingsLastUpdateKey

userSettingsLastUpdateKey: "UserSettingsLastUpdate" = 'UserSettingsLastUpdate'

`Static` `Readonly` validationResultKey

validationResultKey: "ValidationResult" = 'ValidationResult'

`Static` `Readonly` webSettingsKey

webSettingsKey: "WebSettings" = 'WebSettings'

Accessors

additionalMeta

get additionalMeta(): IStorage<unknown>
Returns IStorage<unknown>
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:181
set additionalMeta(value: IStorage<unknown>): void
Parameters
- value: IStorage<unknown>
Returns void
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:184

configurationIsCached

get configurationIsCached(): boolean
Returns boolean
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:86
set configurationIsCached(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:89

configurationMetadata

get configurationMetadata(): ConfigurationMetadata
Returns ConfigurationMetadata
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:100
set configurationMetadata(value: ConfigurationMetadata): void
Parameters
- value: ConfigurationMetadata
Returns void
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:106

configurationVersion

get configurationVersion(): number
Returns number
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:93
set configurationVersion(value: number): void
Parameters
- value: number
Returns void
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:96

dbms

get dbms(): number
Returns number
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:146
set dbms(value: number): void
Parameters
- value: number
Returns void
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:149

defaultColors

get defaultColors(): IStorage<unknown>
Returns IStorage<unknown>
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:167
set defaultColors(value: IStorage<unknown>): void
Parameters
- value: IStorage<unknown>
Returns void
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:170

deskiCipherInfo

get deskiCipherInfo(): IStorage<unknown>
Returns IStorage<unknown>
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:174
set deskiCipherInfo(value: IStorage<unknown>): void
Parameters
- value: IStorage<unknown>
Returns void
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:177

formattingSettingsList

get formattingSettingsList(): StorageArray<FormattingSettingsStorageObject>
Returns StorageArray<FormattingSettingsStorageObject>
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:132
set formattingSettingsList(value: StorageArray<FormattingSettingsStorageObject>): void
Parameters
- value: StorageArray<FormattingSettingsStorageObject>
Returns void
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:142

info

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

Returns IStorage<unknown>
Inherited from ValidationInfoStorageObject.info
- Defined in @tessa/core/src/validation/validationInfoStorageObject.ts:31
set info(value: IStorage<unknown>): void
Parameters
- value: IStorage<unknown>
Returns void
Inherited from ValidationInfoStorageObject.info
- Defined in @tessa/core/src/validation/validationInfoStorageObject.ts:34

personalRoleSatellite

get personalRoleSatellite(): Card
Returns Card
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:119
set personalRoleSatellite(value: Card): void
Parameters
- value: Card
Returns void
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:128

supportedPdfFormats

get supportedPdfFormats(): string[]
Returns string[]
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:153
set supportedPdfFormats(value: string[]): void
Parameters
- value: string[]
Returns void
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:156

userSettingsLastUpdate

get userSettingsLastUpdate(): null | string
Returns null | string
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:110
set userSettingsLastUpdate(value: null | string): void
Parameters
- value: null | string
Returns void
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:115

validationResult

get validationResult(): ValidationStorageResultBuilder
Returns ValidationStorageResultBuilder
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:188
set validationResult(value: ValidationStorageResultBuilder): void
Parameters
- value: ValidationStorageResultBuilder
Returns void
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:194

webSettings

get webSettings(): IStorage<unknown>
Returns IStorage<unknown>
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:160
set webSettings(value: IStorage<unknown>): void
Parameters
- value: IStorage<unknown>
Returns void
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:163

Methods

clean

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

Returns void
Inherited from ValidationInfoStorageObject.clean
- Defined in @tessa/core/src/validation/validationInfoStorageObject.ts:98

clone

clone(): InitializationResponse
Returns InitializationResponse
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:252

ensureCacheResolved

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

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

getStorage

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

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

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

getStorageSettings

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

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

isValid

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

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

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

notifyStorageUpdated

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

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

removeSystemInfo

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

Returns void
Inherited from ValidationInfoStorageObject.removeSystemInfo
- Defined in @tessa/core/src/validation/validationInfoStorageObject.ts:81

removeUserInfo

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

Returns void
Inherited from ValidationInfoStorageObject.removeUserInfo
- Defined in @tessa/core/src/validation/validationInfoStorageObject.ts:64

tryGetAdditionalMeta

tryGetAdditionalMeta(): null | IStorage<unknown>
Returns null | IStorage<unknown>
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:237

tryGetDefaultColors

tryGetDefaultColors(): null | IStorage<unknown>
Returns null | IStorage<unknown>
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:229

tryGetDeskiCipherInfo

tryGetDeskiCipherInfo(): null | IStorage<unknown>
Returns null | IStorage<unknown>
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:233

tryGetFormattingSettingsList

tryGetFormattingSettingsList(): null | StorageArray<FormattingSettingsStorageObject>
Returns null | StorageArray<FormattingSettingsStorageObject>
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:210

tryGetInfo

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

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

Returns null | IStorage<unknown>
Inherited from ValidationInfoStorageObject.tryGetInfo
- Defined in @tessa/core/src/validation/validationInfoStorageObject.ts:56

tryGetPersonalRoleSatellite

tryGetPersonalRoleSatellite(): null | Card
Returns null | Card
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:202

tryGetSupportedPdfFormats

tryGetSupportedPdfFormats(): null | string[]
Returns null | string[]
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:221

tryGetValidationResult

tryGetValidationResult(): null | ValidationStorageResultBuilder
Returns null | ValidationStorageResultBuilder
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:241

tryGetWebSettings

tryGetWebSettings(): null | IStorage<unknown>
Returns null | IStorage<unknown>
- Defined in @tessa/platform/src/initialization/initializationResponse.ts:225

validate

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

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

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

Class InitializationResponse

Hierarchy

Index

Constructors

Properties - Static Keys

Accessors

Methods

Constructors

constructor

Parameters

storage: IStorage<unknown> = {}

Returns InitializationResponse

Static Keys Properties

Static Readonly additionalMetaKey

Static Readonly configurationCacheIsActualKey

Static Readonly configurationMetadataKey

Static Readonly configurationVersionKey

Static Readonly dbmsKey

Static Readonly defaultColors

Static Readonly deskiCipherInfoKey

Static Readonly formattingSettingsListKey

Static Readonly infoKey

Static Readonly personalRoleSatelliteKey

Static Readonly supportedPdfFormatsKey

Static Readonly userSettingsLastUpdateKey

Static Readonly validationResultKey

Static Readonly webSettingsKey

Accessors

additionalMeta

Returns IStorage<unknown>

Parameters

value: IStorage<unknown>

Returns void

configurationIsCached

Returns boolean

Parameters

value: boolean

Returns void

configurationMetadata

Returns ConfigurationMetadata

Parameters

value: ConfigurationMetadata

Returns void

configurationVersion

Returns number

Parameters

value: number

Returns void

dbms

Returns number

Parameters

value: number

Returns void

defaultColors

Returns IStorage<unknown>

Parameters

value: IStorage<unknown>

Returns void

deskiCipherInfo

Returns IStorage<unknown>

Parameters

value: IStorage<unknown>

Returns void

formattingSettingsList

Returns StorageArray<FormattingSettingsStorageObject>

Parameters

value: StorageArray<FormattingSettingsStorageObject>

Returns void

info

Returns IStorage<unknown>

Parameters

value: IStorage<unknown>

Returns void

personalRoleSatellite

Returns Card

Parameters

value: Card

Returns void

supportedPdfFormats

Returns string[]

`Static` `Readonly` additionalMetaKey

`Static` `Readonly` configurationCacheIsActualKey

`Static` `Readonly` configurationMetadataKey

`Static` `Readonly` configurationVersionKey

`Static` `Readonly` dbmsKey

`Static` `Readonly` defaultColors

`Static` `Readonly` deskiCipherInfoKey

`Static` `Readonly` formattingSettingsListKey

`Static` `Readonly` infoKey

`Static` `Readonly` personalRoleSatelliteKey

`Static` `Readonly` supportedPdfFormatsKey

`Static` `Readonly` userSettingsLastUpdateKey

`Static` `Readonly` validationResultKey

`Static` `Readonly` webSettingsKey