Class CardMetadata

Содержит метаинформацию, необходимую для использования типов карточек совместно с пакетом карточек.

Hierarchy

CardSerializableObject
- CardMetadata

Implements

ICardMetadata

Index

Constructors

constructor

new CardMetadata(sections: ICardMetadataSection[], cardType: CardType): CardMetadata
Создаёт экземпляр класса с указанием списка секций и типа карточки.
Parameters
- sections: ICardMetadataSection[]
  
  Список секций, ссылка на который даётся в создаваемом объекте.
- cardType: CardType
  
  Тип карточки, добавляемый в создаваемый объект.
Returns CardMetadata
Overrides CardSerializableObject.constructor
- Defined in @tessa/platform/src/cards/metadata/cardMetadata.ts:46
new CardMetadata(sections: ICardMetadataSection[], enumerations: ICardMetadataEnumeration[], cardTypes: CardType[], damagedCardTypeIdList: string[]): CardMetadata
Создаёт экземпляр класса с указанием списка секций, перечислений и типов карточек.
Parameters
- sections: ICardMetadataSection[]
  
  Список секций, ссылка на который даётся в создаваемом объекте.
- enumerations: ICardMetadataEnumeration[]
  
  Список перечислений, ссылка на который даётся в создаваемом объекте.
- cardTypes: CardType[]
  
  Список типов карточек, ссылка на который даётся в создаваемом объекте.
- damagedCardTypeIdList: string[]
  
  Идентификаторы повреждённых типов карточек.
Returns CardMetadata
Overrides CardSerializableObject.constructor
- Defined in @tessa/platform/src/cards/metadata/cardMetadata.ts:54
new CardMetadata(metadata: ICardMetadata): CardMetadata
Создаёт экземпляр класса с указанием копируемого объекта.
Parameters
- metadata: ICardMetadata
  
  Объект, для которого создаётся копия.
Returns CardMetadata
Overrides CardSerializableObject.constructor
- Defined in @tessa/platform/src/cards/metadata/cardMetadata.ts:64
new CardMetadata(): CardMetadata
Конструктор по умолчанию.

Returns CardMetadata
Overrides CardSerializableObject.constructor
- Defined in @tessa/platform/src/cards/metadata/cardMetadata.ts:68

Accessors

cardTypes

get cardTypes(): CardTypeArray
Список типов карточек карточек.

Returns CardTypeArray
Implementation of ICardMetadata.cardTypes
- Defined in @tessa/platform/src/cards/metadata/cardMetadata.ts:137
set cardTypes(value: CardTypeArray): void
Список типов карточек карточек.
Parameters
- value: CardTypeArray
Returns void
Implementation of ICardMetadata.cardTypes
- Defined in @tessa/platform/src/cards/metadata/cardMetadata.ts:140

damagedCardTypeIdList

get damagedCardTypeIdList(): string[]
Список идентификаторов повреждённых типов карточек.

Returns string[]
Implementation of ICardMetadata.damagedCardTypeIdList
- Defined in @tessa/platform/src/cards/metadata/cardMetadata.ts:151
set damagedCardTypeIdList(value: string[]): void
Список идентификаторов повреждённых типов карточек.
Parameters
- value: string[]
Returns void
Implementation of ICardMetadata.damagedCardTypeIdList
- Defined in @tessa/platform/src/cards/metadata/cardMetadata.ts:154

enumerations

get enumerations(): ICardMetadataEnumerationArray<ICardMetadataEnumeration, ICardMetadataCompletionOption, ICardMetadataFunctionRole>
Список перечислений.

Returns ICardMetadataEnumerationArray<ICardMetadataEnumeration, ICardMetadataCompletionOption, ICardMetadataFunctionRole>
Implementation of ICardMetadata.enumerations
- Defined in @tessa/platform/src/cards/metadata/cardMetadata.ts:144
set enumerations(value: ICardMetadataEnumerationArray<ICardMetadataEnumeration, ICardMetadataCompletionOption, ICardMetadataFunctionRole>): void
Список перечислений.
Parameters
- value: ICardMetadataEnumerationArray<ICardMetadataEnumeration, ICardMetadataCompletionOption, ICardMetadataFunctionRole>
Returns void
Implementation of ICardMetadata.enumerations
- Defined in @tessa/platform/src/cards/metadata/cardMetadata.ts:147

sections

get sections(): ICardMetadataSectionArray<ICardMetadataSection>
Метаинформация по секциям карточек.

Returns ICardMetadataSectionArray<ICardMetadataSection>
Implementation of ICardMetadata.sections
- Defined in @tessa/platform/src/cards/metadata/cardMetadata.ts:130
set sections(value: ICardMetadataSectionArray<ICardMetadataSection>): void
Метаинформация по секциям карточек.
Parameters
- value: ICardMetadataSectionArray<ICardMetadataSection>
Returns void
Implementation of ICardMetadata.sections
- Defined in @tessa/platform/src/cards/metadata/cardMetadata.ts:133

Methods

clone

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

Returns CardMetadata
Implementation of ICardMetadata.clone
- Defined in @tessa/platform/src/cards/metadata/cardMetadata.ts:274

deserializeFromStorage

deserializeFromStorage(storage: IStorage<unknown>, context?: StorageSerializableContext): CardMetadata
Parameters
- storage: IStorage<unknown>
- Optional context: StorageSerializableContext
Returns CardMetadata
Implementation of ICardMetadata.deserializeFromStorage

Inherited from CardSerializableObject.deserializeFromStorage
- Defined in @tessa/core/src/serialization/storageSerializable.ts:54

getMetadataForType

getMetadataForType(cardTypeId: string): ICardMetadata
Возвращает выборку из метаинформации, которая относится только к заданному типу карточек. В возвращённую выборку не передаются перечисления.

Returns
Выборка метаинформации, которая относится только к заданному типу карточки.

Deprecated
use getMetadataForTypeAsync.
Parameters
- cardTypeId: string
  
  Идентификатор типа карточки, для которого строится выборка из метаинформации.
Returns ICardMetadata
Implementation of ICardMetadata.getMetadataForType
- Defined in @tessa/platform/src/cards/metadata/cardMetadata.ts:163

getMetadataForTypeAsync

getMetadataForTypeAsync(cardTypeId: string): Promise<ICardMetadata>
Возвращает выборку из метаинформации, которая относится только к заданному типу карточек. В возвращённую выборку не передаются перечисления.

Returns
Выборка метаинформации, которая относится только к заданному типу карточки.
Parameters
- cardTypeId: string
  
  Идентификатор типа карточки, для которого строится выборка из метаинформации.
Returns Promise<ICardMetadata>
Implementation of ICardMetadata.getMetadataForTypeAsync
- Defined in @tessa/platform/src/cards/metadata/cardMetadata.ts:203

isSealed

isSealed(): boolean
Returns boolean
Implementation of ICardMetadata.isSealed

Inherited from CardSerializableObject.isSealed
- Defined in @tessa/core/src/serialization/storageSerializable.ts:102

seal

seal(): CardMetadata
Returns CardMetadata
Implementation of ICardMetadata.seal

Inherited from CardSerializableObject.seal
- Defined in @tessa/core/src/serialization/storageSerializable.ts:85

serializeToStorage

serializeToStorage(storage?: IStorage<unknown>, context?: StorageSerializableContext): IStorage<unknown>
Parameters
- storage: IStorage<unknown> = {}
- Optional context: StorageSerializableContext
Returns IStorage<unknown>
Implementation of ICardMetadata.serializeToStorage

Inherited from CardSerializableObject.serializeToStorage
- Defined in @tessa/core/src/serialization/storageSerializable.ts:44

Class CardMetadata

Hierarchy

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

sections: ICardMetadataSection[]

cardType: CardType

Returns CardMetadata

Parameters

sections: ICardMetadataSection[]

enumerations: ICardMetadataEnumeration[]

cardTypes: CardType[]

damagedCardTypeIdList: string[]

Returns CardMetadata

Parameters

metadata: ICardMetadata

Returns CardMetadata

Returns CardMetadata

Accessors

cardTypes

Returns CardTypeArray

Parameters

value: CardTypeArray

Returns void

damagedCardTypeIdList

Returns string[]

Parameters

value: string[]

Returns void

enumerations

Returns ICardMetadataEnumerationArray<ICardMetadataEnumeration, ICardMetadataCompletionOption, ICardMetadataFunctionRole>

Parameters

value: ICardMetadataEnumerationArray<ICardMetadataEnumeration, ICardMetadataCompletionOption, ICardMetadataFunctionRole>

Returns void

sections

Returns ICardMetadataSectionArray<ICardMetadataSection>

Parameters

value: ICardMetadataSectionArray<ICardMetadataSection>

Returns void

Methods

clone

Returns CardMetadata

deserializeFromStorage

Parameters

storage: IStorage<unknown>

Optional context: StorageSerializableContext

Returns CardMetadata

getMetadataForType

Returns

Deprecated

Parameters

cardTypeId: string

Returns ICardMetadata

getMetadataForTypeAsync

Returns

Parameters

cardTypeId: string

Returns Promise<ICardMetadata>

isSealed

Returns boolean

seal

Returns CardMetadata

serializeToStorage

Parameters

storage: IStorage<unknown> = {}

Optional context: StorageSerializableContext

Returns IStorage<unknown>

`Optional` context: StorageSerializableContext

`Optional` context: StorageSerializableContext