Class ForumResponse

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

Hierarchy

InfoStorageObject
- ForumResponse

Implements

ICloneable<ForumResponse>

Index

Constructors

constructor

new ForumResponse(storage?: IStorage<unknown>): ForumResponse
Parameters
- storage: IStorage<unknown> = {}
Returns ForumResponse
Overrides InfoStorageObject.constructor
- Defined in @tessa/platform/src/forums/forumResponse.ts:22

Static Keys Properties

`Static` `Readonly` forumSettingsKey

forumSettingsKey: "ForumSettings" = 'ForumSettings'

`Static` `Readonly` infoKey

infoKey: "Info" = 'Info'

`Static` `Readonly` messageKey

messageKey: "Message" = 'Message'

`Static` `Readonly` messagesKey

messagesKey: "Messages" = 'Messages'

`Static` `Readonly` satelliteIdKey

satelliteIdKey: "SatelliteID" = 'SatelliteID'

`Static` `Readonly` topicsKey

topicsKey: "Topics" = 'Topics'

Accessors

forumSettings

get forumSettings(): IStorage<unknown>
Returns IStorage<unknown>
- Defined in @tessa/platform/src/forums/forumResponse.ts:55
set forumSettings(value: IStorage<unknown>): void
Parameters
- value: IStorage<unknown>
Returns void
- Defined in @tessa/platform/src/forums/forumResponse.ts:58

info

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

Returns IStorage<unknown>
Inherited from InfoStorageObject.info
- Defined in @tessa/core/src/storage/infoStorageObject.ts:25
set info(value: IStorage<unknown>): void
Parameters
- value: IStorage<unknown>
Returns void
Inherited from InfoStorageObject.info
- Defined in @tessa/core/src/storage/infoStorageObject.ts:28

message

get message(): ForumMessageModel
Returns ForumMessageModel
- Defined in @tessa/platform/src/forums/forumResponse.ts:99
set message(value: ForumMessageModel): void
Parameters
- value: ForumMessageModel
Returns void
- Defined in @tessa/platform/src/forums/forumResponse.ts:102

messages

get messages(): StorageArray<ForumMessageModel>
Returns StorageArray<ForumMessageModel>
- Defined in @tessa/platform/src/forums/forumResponse.ts:84
set messages(value: ForumMessageModel[]): void
Parameters
- value: ForumMessageModel[]
Returns void
- Defined in @tessa/platform/src/forums/forumResponse.ts:95

satelliteId

get satelliteId(): null | string
Returns null | string
- Defined in @tessa/platform/src/forums/forumResponse.ts:62
set satelliteId(value: null | string): void
Parameters
- value: null | string
Returns void
- Defined in @tessa/platform/src/forums/forumResponse.ts:65

topics

get topics(): StorageArray<ForumTopicModel>
Returns StorageArray<ForumTopicModel>
- Defined in @tessa/platform/src/forums/forumResponse.ts:69
set topics(value: ForumTopicModel[]): void
Parameters
- value: ForumTopicModel[]
Returns void
- Defined in @tessa/platform/src/forums/forumResponse.ts:80

Methods

clean

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

Returns void
Overrides InfoStorageObject.clean
- Defined in @tessa/platform/src/forums/forumResponse.ts:223

clone

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

Returns ForumResponse
Implementation of ICloneable.clone
- Defined in @tessa/platform/src/forums/forumResponse.ts:232

ensureCacheResolved

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

Returns void
Overrides InfoStorageObject.ensureCacheResolved
- Defined in @tessa/platform/src/forums/forumResponse.ts:212

getStorage

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

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

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

getStorageSettings

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

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

getTopics

getTopics(type: ForumTopicTypes): ReadonlyStorageArray<ForumTopicModel>
Parameters
- type: ForumTopicTypes
Returns ReadonlyStorageArray<ForumTopicModel>
- Defined in @tessa/platform/src/forums/forumResponse.ts:142

isEmpty

isEmpty(): boolean
Returns boolean
- Defined in @tessa/platform/src/forums/forumResponse.ts:178

notifyStorageUpdated

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

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

tryGetForumSettings

tryGetForumSettings(): null | IStorage<unknown>
Returns null | IStorage<unknown>
- Defined in @tessa/platform/src/forums/forumResponse.ts:110

tryGetInfo

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

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

Returns null | IStorage<unknown>
Inherited from InfoStorageObject.tryGetInfo
- Defined in @tessa/core/src/storage/infoStorageObject.ts:42

tryGetMessages

tryGetMessages(): null | StorageArray<ForumMessageModel>
Returns null | StorageArray<ForumMessageModel>
- Defined in @tessa/platform/src/forums/forumResponse.ts:126

tryGetTopics

tryGetTopics(): null | StorageArray<ForumTopicModel>
Returns null | StorageArray<ForumTopicModel>
- Defined in @tessa/platform/src/forums/forumResponse.ts:114

Class ForumResponse

Hierarchy

Implements

Index

Constructors

Properties - Static Keys

Accessors

Methods

Constructors

constructor

Parameters

storage: IStorage<unknown> = {}

Returns ForumResponse

Static Keys Properties

Static Readonly forumSettingsKey

Static Readonly infoKey

Static Readonly messageKey

Static Readonly messagesKey

Static Readonly satelliteIdKey

Static Readonly topicsKey

Accessors

forumSettings

Returns IStorage<unknown>

Parameters

value: IStorage<unknown>

Returns void

info

Returns IStorage<unknown>

Parameters

value: IStorage<unknown>

Returns void

message

Returns ForumMessageModel

Parameters

value: ForumMessageModel

Returns void

messages

Returns StorageArray<ForumMessageModel>

Parameters

value: ForumMessageModel[]

Returns void

satelliteId

Returns null | string

Parameters

value: null | string

Returns void

topics

Returns StorageArray<ForumTopicModel>

Parameters

value: ForumTopicModel[]

Returns void

Methods

clean

Returns void

clone

Returns ForumResponse

ensureCacheResolved

Returns void

getStorage

Returns

Returns IStorage<unknown>

getStorageSettings

Returns Readonly<StorageSettings>

getTopics

Parameters

type: ForumTopicTypes

Returns ReadonlyStorageArray<ForumTopicModel>

isEmpty

Returns boolean

notifyStorageUpdated

Returns void

tryGetForumSettings

Returns null | IStorage<unknown>

tryGetInfo

Returns

Returns null | IStorage<unknown>

tryGetMessages

Returns null | StorageArray<ForumMessageModel>

tryGetTopics

Returns null | StorageArray<ForumTopicModel>

`Static` `Readonly` forumSettingsKey

`Static` `Readonly` infoKey

`Static` `Readonly` messageKey

`Static` `Readonly` messagesKey

`Static` `Readonly` satelliteIdKey

`Static` `Readonly` topicsKey