Class CardMetadata

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

Hierarchy (View Summary, Expand)

CardSerializableObject
- CardMetadata

Implements

ICardMetadata

Index

Constructors

constructor

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

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

Accessors

cardTypes

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

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

damagedCardTypeIdList

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

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

enumerations

get enumerations(): ICardMetadataEnumerationArray
Список перечислений.

Returns ICardMetadataEnumerationArray
Implementation of ICardMetadata.enumerations
- Defined in @tessa/platform/src/cards/metadata/cardMetadata.ts:169
set enumerations(value: ICardMetadataEnumerationArray): void
Список перечислений.
Parameters
- value: ICardMetadataEnumerationArray
Returns void
Implementation of ICardMetadata.enumerations
- Defined in @tessa/platform/src/cards/metadata/cardMetadata.ts:172

normalizationInfo

get normalizationInfo(): ICardMetadataNormalizationInfo
Метаинформация по справочникам нормализации, используемых в служебных таблицах.

Returns ICardMetadataNormalizationInfo
Implementation of ICardMetadata.normalizationInfo
- Defined in @tessa/platform/src/cards/metadata/cardMetadata.ts:162
set normalizationInfo(value: ICardMetadataNormalizationInfo): void
Метаинформация по справочникам нормализации, используемых в служебных таблицах.
Parameters
- value: ICardMetadataNormalizationInfo
Returns void
Implementation of ICardMetadata.normalizationInfo
- Defined in @tessa/platform/src/cards/metadata/cardMetadata.ts:165

sections

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

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

Methods

clone

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

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

deserializeFromStorage

deserializeFromStorage(
storage: IStorage,
context?: StorageSerializableContext,
): this
Parameters
- storage: IStorage
- Optionalcontext: StorageSerializableContext
Returns this
Implementation of ICardMetadata.deserializeFromStorage
Inherited from CardSerializableObject.deserializeFromStorage
- Defined in @tessa/core/src/serialization/storageSerializableObject.ts:41

getMetadataForType

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

Deprecated
use getMetadataForTypeAsync.
Implementation of ICardMetadata.getMetadataForType
- Defined in @tessa/platform/src/cards/metadata/cardMetadata.ts:188

getMetadataForTypeAsync

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

isSealed

isSealed(): boolean
Returns boolean
Implementation of ICardMetadata.isSealed
Inherited from CardSerializableObject.isSealed
- Defined in @tessa/core/src/serialization/storageSerializableObject.ts:89

seal

seal(): this
Returns this
Implementation of ICardMetadata.seal
Inherited from CardSerializableObject.seal
- Defined in @tessa/core/src/serialization/storageSerializableObject.ts:72

serializeToStorage

serializeToStorage(
storage?: IStorage,
context?: StorageSerializableContext,
): IStorage
Parameters
- storage: IStorage = {}
- Optionalcontext: StorageSerializableContext
Returns IStorage
Implementation of ICardMetadata.serializeToStorage
Inherited from CardSerializableObject.serializeToStorage
- Defined in @tessa/core/src/serialization/storageSerializableObject.ts:28

Class CardMetadata

Hierarchy (View Summary, Expand)

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns CardMetadata

Parameters

Returns CardMetadata

Parameters

Returns CardMetadata

Returns CardMetadata

Accessors

cardTypes

Returns CardTypeArray

Parameters

Returns void

damagedCardTypeIdList

Returns string[]

Parameters

Returns void

enumerations

Returns ICardMetadataEnumerationArray

Parameters

Returns void

normalizationInfo

Returns ICardMetadataNormalizationInfo

Parameters

Returns void

sections

Returns ICardMetadataSectionArray

Parameters

Returns void

Methods

clone

Returns CardMetadata

deserializeFromStorage

Parameters

Returns this

getMetadataForType

Parameters

Returns ICardMetadata

Deprecated

getMetadataForTypeAsync

Parameters

Returns Promise<ICardMetadata>

isSealed

Returns boolean

seal

Returns this

serializeToStorage

Parameters

Returns IStorage

Settings

On This Page