Class CardType

Объект, описывающий тип карточки.

Hierarchy (View Summary, Expand)

CardSerializableObject
- CardType

Implements

ICloneable<CardType>

Constructors

constructor

new CardType(): CardType
Returns CardType
Overrides CardSerializableObject.constructor
- Defined in @tessa/platform/src/cards/types/cardType.ts:30

Properties

caption

caption: string = ''

Отображаемое имя типа карточки.

digestFormat

digestFormat: null | string = null

Формат функции Digest для карточки. Актуально только для типов CardInstanceType.Card.

flags

flags: CardTypeFlags = 0

Флаги типа карточки.

`Readonly`formatVersion

formatVersion: 3 = CardType.currentFormatVersion

Версия формата JSON.

group

group: null | string = null

Название группы для типа карточки. Может быть равно null, если группа не задана.

id

id: string = Guid.empty

ID объекта.

instanceType

instanceType: CardInstanceType = CardInstanceType.Card

Тип экземпляра карточки.

mainFormName

mainFormName: string = ''

Имя формы, которая является основной для задания, или 'null' если это пустая форма.

name

name: string = ''

Наименование объекта.

`Static` `Readonly`currentFormatVersion

currentFormatVersion: 3

Accessors

cardTypeSections

get cardTypeSections(): CardTypeSection[]
Виртуальные секции, которые доступны в пределах данного типа карточки.

Returns CardTypeSection[]
- Defined in @tessa/platform/src/cards/types/cardType.ts:117
set cardTypeSections(value: CardTypeSection[]): void
Parameters
- value: CardTypeSection[]
Returns void
- Defined in @tessa/platform/src/cards/types/cardType.ts:120

completionOptions

get completionOptions(): CardTypeCompletionOption[]
Варианты завершения типа карточки задания.

Returns CardTypeCompletionOption[]
- Defined in @tessa/platform/src/cards/types/cardType.ts:107
set completionOptions(value: CardTypeCompletionOption[]): void
Parameters
- value: CardTypeCompletionOption[]
Returns void
- Defined in @tessa/platform/src/cards/types/cardType.ts:110

extensions

get extensions(): CardTypeExtension[]
Список расширений для типов карточек.

Returns CardTypeExtension[]
- Defined in @tessa/platform/src/cards/types/cardType.ts:137
set extensions(value: CardTypeExtension[]): void
Parameters
- value: CardTypeExtension[]
Returns void
- Defined in @tessa/platform/src/cards/types/cardType.ts:140

forms

get forms(): CardTypeNamedForm[]
Альтернативные варианты пользовательского интерфейса для редактирования карточки.

Returns CardTypeNamedForm[]
- Defined in @tessa/platform/src/cards/types/cardType.ts:127
set forms(value: CardTypeNamedForm[]): void
Parameters
- value: CardTypeNamedForm[]
Returns void
- Defined in @tessa/platform/src/cards/types/cardType.ts:130

schemeItems

get schemeItems(): CardTypeSchemeItem[]
Метаданные всех секций, входящих в состав типа карточки.

Returns CardTypeSchemeItem[]
- Defined in @tessa/platform/src/cards/types/cardType.ts:97
set schemeItems(value: CardTypeSchemeItem[]): void
Parameters
- value: CardTypeSchemeItem[]
Returns void
- Defined in @tessa/platform/src/cards/types/cardType.ts:100

validators

get validators(): CardTypeValidator[]
Список валидаторов, используемых при сохранении карточки.

Returns CardTypeValidator[]
- Defined in @tessa/platform/src/cards/types/cardType.ts:147
set validators(value: CardTypeValidator[]): void
Parameters
- value: CardTypeValidator[]
Returns void
- Defined in @tessa/platform/src/cards/types/cardType.ts:150

Methods

clone

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

Returns CardType
Implementation of ICloneable.clone
- Defined in @tessa/platform/src/cards/types/cardType.ts:455

deserializeFromStorage

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

equals

equals(other: CardType): boolean
Сравнивает два объекта.
Parameters
- other: CardType
  Другой объект сравнения.
Returns boolean
true если объекты равны; false в противном случае.

Remarks
Объекты считаются равными, если их идентификаторы равны.
- Defined in @tessa/platform/src/cards/types/cardType.ts:181

isSealed

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

seal

seal(): this
Returns this
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
Inherited from CardSerializableObject.serializeToStorage
- Defined in @tessa/core/src/serialization/storageSerializableObject.ts:28

tryGetCompletionOptionValidators

tryGetCompletionOptionValidators(form: CardTypeForm): null | CardTypeValidator[]
Возвращает список валидаторов, связанных с вариантом завершения, подходящего для заданной, формы задания, или null, если текущий тип не является типом задания, или с формой не связано ни одного или связано более одного варианта завершения.
Parameters
- form: CardTypeForm
  Форма задания, для которой требуется получить валидаторы.
Returns null | CardTypeValidator[]
Список валидаторов, связанных с вариантом завершения, подходящего для заданной формы задания, или null, если текущий тип не является типом задания, или с формой не связано ни одного или связано более одного варианта завершения.
- Defined in @tessa/platform/src/cards/types/cardType.ts:194

tryGetMainFormForTask

tryGetMainFormForTask(): undefined | CardTypeNamedForm
Возвращает основную форму для задания, или undefined, если не удалось найти форму с именем CardType.MainFormName в CardType.Forms.

Returns undefined | CardTypeNamedForm
Основная форма.
- Defined in @tessa/platform/src/cards/types/cardType.ts:167

visit

visit(visitor: ICardTypeVisitor): Promise<void>
Parameters
- visitor: ICardTypeVisitor
Returns Promise<void>
- Defined in @tessa/platform/src/cards/types/cardType.ts:232

Class CardType

Hierarchy (View Summary, Expand)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns CardType

Properties

caption

digestFormat

flags

ReadonlyformatVersion

group

id

instanceType

mainFormName

name

Static ReadonlycurrentFormatVersion

Accessors

cardTypeSections

Returns CardTypeSection[]

Parameters

Returns void

completionOptions

Returns CardTypeCompletionOption[]

Parameters

Returns void

extensions

Returns CardTypeExtension[]

Parameters

Returns void

forms

Returns CardTypeNamedForm[]

Parameters

Returns void

schemeItems

Returns CardTypeSchemeItem[]

Parameters

Returns void

validators

Returns CardTypeValidator[]

Parameters

Returns void

Methods

clone

Returns CardType

deserializeFromStorage

Parameters

Returns this

equals

Parameters

Returns boolean

Remarks

isSealed

Returns boolean

seal

Returns this

serializeToStorage

Parameters

Returns IStorage

tryGetCompletionOptionValidators

Parameters

Returns null | CardTypeValidator[]

tryGetMainFormForTask

Returns undefined | CardTypeNamedForm

visit

Parameters

Returns Promise<void>

Settings

On This Page

`Readonly`formatVersion

`Static` `Readonly`currentFormatVersion