Class CardTypeAsync

Объект, описывающий тип карточки и, который может грузиться по частям.

Hierarchy (View Summary)

CardType
- CardTypeAsync

Implements

ICloneable<CardTypeAsync>

Constructors

constructor

new CardTypeAsync(dataLoader: ICardTypeDataLoader): CardTypeAsync
Parameters
- dataLoader: ICardTypeDataLoader
Returns CardTypeAsync
Overrides CardType.constructor
- Defined in @tessa/platform/src/cards/types/cardTypeAsync.ts:15

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[]
Inherited from CardType.cardTypeSections
- Defined in @tessa/platform/src/cards/types/cardType.ts:117
set cardTypeSections(value: CardTypeSection[]): void
Parameters
- value: CardTypeSection[]
Returns void
Inherited from CardType.cardTypeSections
- Defined in @tessa/platform/src/cards/types/cardType.ts:120

completionOptions

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

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

extensions

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

Returns CardTypeExtension[]
Overrides CardType.extensions
- Defined in @tessa/platform/src/cards/types/cardTypeAsync.ts:57
set extensions(value: CardTypeExtension[]): void
Список расширений для типов карточек.
Parameters
- value: CardTypeExtension[]
Returns void
Overrides CardType.extensions
- Defined in @tessa/platform/src/cards/types/cardTypeAsync.ts:66

forms

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

Returns CardTypeNamedForm[]
Overrides CardType.forms
- Defined in @tessa/platform/src/cards/types/cardTypeAsync.ts:44
set forms(value: CardTypeNamedForm[]): void
Альтернативные варианты пользовательского интерфейса для редактирования карточки.
Parameters
- value: CardTypeNamedForm[]
Returns void
Overrides CardType.forms
- Defined in @tessa/platform/src/cards/types/cardTypeAsync.ts:53

schemeItems

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

Returns CardTypeSchemeItem[]
Overrides CardType.schemeItems
- Defined in @tessa/platform/src/cards/types/cardTypeAsync.ts:31
set schemeItems(value: CardTypeSchemeItem[]): void
Метаданные всех секций, входящих в состав типа карточки.
Parameters
- value: CardTypeSchemeItem[]
Returns void
Overrides CardType.schemeItems
- Defined in @tessa/platform/src/cards/types/cardTypeAsync.ts:40

validators

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

Returns CardTypeValidator[]
Overrides CardType.validators
- Defined in @tessa/platform/src/cards/types/cardTypeAsync.ts:70
set validators(value: CardTypeValidator[]): void
Список валидаторов, используемых при сохранении карточки.
Parameters
- value: CardTypeValidator[]
Returns void
Overrides CardType.validators
- Defined in @tessa/platform/src/cards/types/cardTypeAsync.ts:79

Methods

clone

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

Returns CardTypeAsync
Implementation of ICloneable.clone
Overrides CardType.clone
- Defined in @tessa/platform/src/cards/types/cardTypeAsync.ts:128

deserializeFromStorage

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

ensureDataLoaded

ensureDataLoaded(): Promise<void>
Загружает все лениво-загружаемые данные если необходимо.

Returns Promise<void>
Overrides CardType.ensureDataLoaded
- Defined in @tessa/platform/src/cards/types/cardTypeAsync.ts:96

equals

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

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

isDataLoaded

isDataLoaded(): boolean
Возвращает true если есть ленивые данные, которые нужно загрузить.

Returns boolean
Overrides CardType.isDataLoaded
- Defined in @tessa/platform/src/cards/types/cardTypeAsync.ts:115

isSealed

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

seal

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

tryGetCompletionOptionValidators

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

tryGetMainFormForTask

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

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

visit

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

`Static`isCardTypeStoragePartial

isCardTypeStoragePartial(storage: IStorage): boolean
Проверяет storage объект на наличие лениво загружаемых данных.
Parameters
- storage: IStorage
  storage объект, который нужно проверить.
Returns boolean
true, если есть данные, которые нужно будет загружать.
- Defined in @tessa/platform/src/cards/types/cardTypeAsync.ts:92

Class CardTypeAsync

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CardTypeAsync

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 CardTypeAsync

deserializeFromStorage

Parameters

Returns this

ensureDataLoaded

Returns Promise<void>

equals

Parameters

Returns boolean

Remarks

isDataLoaded

Returns boolean

isSealed

Returns boolean

seal

Returns this

serializeToStorage

Parameters

Returns IStorage

tryGetCompletionOptionValidators

Parameters

Returns null | CardTypeValidator[]

tryGetMainFormForTask

Returns undefined | CardTypeNamedForm

visit

Parameters

Returns Promise<void>

StaticisCardTypeStoragePartial

Parameters

Returns boolean

`Readonly`formatVersion

`Static` `Readonly`currentFormatVersion

`Static`isCardTypeStoragePartial