Class Card

Содержит информацию о карточке.

Hierarchy

Implements

Constructors

constructor

Properties - Static Keys

createdByIdKey createdByNameKey createdKey filesKey flagsKey idKey infoKey modifiedByIdKey modifiedByNameKey modifiedKey permissionsKey sectionsKey taskHistoryGroupsKey taskHistoryKey tasksKey topicsKey typeCaptionKey typeIdKey typeNameKey versionKey

Accessors

created createdById createdByName files flags id info instanceType modified modifiedById modifiedByName permissions sections storeMode taskHistory taskHistoryGroups tasks topics typeCaption typeId typeName version

Methods

clean clone convertToInserted ensureCacheResolved getStorage getStorageSettings hasChanges isEmpty isValid notifyStorageUpdated removeAllButChanged removeChanges removeSystemInfo removeUserInfo tryGetFiles tryGetInfo tryGetPermissions tryGetSections tryGetTaskHistory tryGetTaskHistoryGroups tryGetTasks tryGetTopics updateStates validate

Constructors

constructor

  • Создаёт экземпляр класса с указанием хранилища (или пустое хранилище по умолчанию), декоратором для которого является создаваемый объект.

    Parameters

    • storage: IStorage<unknown> = {}

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

    Returns Card

Static Keys Properties

Static Readonly createdByIdKey

createdByIdKey: "CreatedByID" = 'CreatedByID'

Static Readonly createdByNameKey

createdByNameKey: "CreatedByName" = 'CreatedByName'

Static Readonly createdKey

createdKey: "Created" = 'Created'

Static Readonly filesKey

filesKey: "Files" = 'Files'

Static Readonly flagsKey

flagsKey: "Flags" = 'Flags'

Static Readonly idKey

idKey: "ID" = 'ID'

Static Readonly infoKey

infoKey: "Info" = 'Info'

Static Readonly modifiedByIdKey

modifiedByIdKey: "ModifiedByID" = 'ModifiedByID'

Static Readonly modifiedByNameKey

modifiedByNameKey: "ModifiedByName" = 'ModifiedByName'

Static Readonly modifiedKey

modifiedKey: "Modified" = 'Modified'

Static Readonly permissionsKey

permissionsKey: "Permissions" = 'Permissions'

Static Readonly sectionsKey

sectionsKey: "Sections" = 'Sections'

Static Readonly taskHistoryGroupsKey

taskHistoryGroupsKey: "TaskHistoryGroups" = 'TaskHistoryGroups'

Static Readonly taskHistoryKey

taskHistoryKey: "TaskHistory" = 'TaskHistory'

Static Readonly tasksKey

tasksKey: "Tasks" = 'Tasks'

Static Readonly topicsKey

topicsKey: "Topics" = 'Topics'

Static Readonly typeCaptionKey

typeCaptionKey: "TypeCaption" = 'TypeCaption'

Static Readonly typeIdKey

typeIdKey: "TypeID" = 'TypeID'

Static Readonly typeNameKey

typeNameKey: "TypeName" = 'TypeName'

Static Readonly versionKey

versionKey: "Version" = 'Version'

Accessors

created

  • get created(): null | string

  • Дата создания карточки или null, если дата неизвестна или карточка ещё не была создана.

    Returns null | string

  • set created(value: null | string): void

  • Parameters

    • value: null | string

    Returns void

createdById

  • get createdById(): string

  • Идентификатор пользователя, который создал карточку.

    Returns string

  • set createdById(value: string): void

  • Parameters

    • value: string

    Returns void

createdByName

  • get createdByName(): string

  • Имя пользователя, который создал карточку.

    Returns string

  • set createdByName(value: string): void

  • Parameters

    • value: string

    Returns void

files

  • get files(): StorageArray<CardFile>

  • Список прикреплённых к карточке файлов.

    Remarks

    Для того, чтобы обратиться к значению этого свойства, свойство карточки instanceType должно быть равным Card или Task.

    Returns StorageArray<CardFile>

  • set files(value: CardFile[]): void

  • Parameters

    Returns void

flags

  • get flags(): number

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

    Returns number

  • set flags(value: number): void

  • Parameters

    • value: number

    Returns void

id

  • get id(): string

  • Идентификатор карточки.

    Returns string

  • set id(value: string): void

  • Parameters

    • value: string

    Returns void

info

  • get info(): IStorage<unknown>

  • Дополнительная пользовательская информация.

    Returns IStorage<unknown>

  • set info(value: IStorage<unknown>): void

  • Parameters

    Returns void

instanceType

  • get instanceType(): CardInstanceType

  • Тип экземпляра карточки. По умолчанию равен Card при создании карточки через конструктор без параметров.

    Returns CardInstanceType

  • set instanceType(value: CardInstanceType): void

  • Parameters

    Returns void

modified

  • get modified(): null | string

  • Дата последнего изменения карточки или null, если дата неизвестна или карточка ещё не была создана.

    Returns null | string

  • set modified(value: null | string): void

  • Parameters

    • value: null | string

    Returns void

modifiedById

  • get modifiedById(): string

  • Идентификатор пользователя, который последним изменил карточку.

    Returns string

  • set modifiedById(value: string): void

  • Parameters

    • value: string

    Returns void

modifiedByName

  • get modifiedByName(): string

  • Имя пользователя, который последним изменил карточку.

    Returns string

  • set modifiedByName(value: string): void

  • Parameters

    • value: string

    Returns void

permissions

sections

storeMode

  • get storeMode(): CardStoreMode

  • Способ сохранения карточки.

    Returns CardStoreMode

taskHistory

  • get taskHistory(): StorageArray<CardTaskHistoryItem>

  • Список с информацией по завершённым заданиям, которые были выданы на карточку.

    Remarks

    Для того, чтобы обратиться к значению этого свойства, свойство карточки instanceType должно быть равным Card.

    Returns StorageArray<CardTaskHistoryItem>

  • set taskHistory(value: CardTaskHistoryItem[]): void

  • Parameters

    Returns void

taskHistoryGroups

  • get taskHistoryGroups(): StorageArray<CardTaskHistoryGroup>

  • Список с информацией по группам заданий, которые были выданы на карточку.

    Remarks

    Для того, чтобы обратиться к значению этого свойства, свойство карточки instanceType должно быть равным Card.

    Returns StorageArray<CardTaskHistoryGroup>

  • set taskHistoryGroups(value: CardTaskHistoryGroup[]): void

  • Parameters

    Returns void

tasks

  • get tasks(): StorageArray<CardTask>

  • Список заданий, которые были выданы на карточку и ещё не были завершены.

    Remarks

    Для того, чтобы обратиться к значению этого свойства, свойство карточки instanceType должно быть равным Card.

    Returns StorageArray<CardTask>

  • set tasks(value: CardTask[]): void

  • Parameters

    Returns void

topics

typeCaption

  • get typeCaption(): string

  • Отображаемое в пользовательском интерфейсе имя типа карточки.

    Returns string

  • set typeCaption(value: string): void

  • Parameters

    • value: string

    Returns void

typeId

  • get typeId(): string

  • Идентификатор типа карточки.

    Returns string

  • set typeId(value: string): void

  • Parameters

    • value: string

    Returns void

typeName

  • get typeName(): string

  • Имя типа карточки.

    Returns string

  • set typeName(value: string): void

  • Parameters

    • value: string

    Returns void

version

  • get version(): number

  • Версия карточки.

    • 0, если карточка ещё не была создана.
    • 1 или больше, если карточка был создана и теперь редактируется.

    Returns number

  • set version(value: number): void

  • Parameters

    • value: number

    Returns void

Methods

clean

  • Выполняет очистку хранилища от избыточных данных.

    Returns void

clone

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

    Returns Card

convertToInserted

  • Изменяет карточку таким образом, что все её строки, файлы и задания считаются добавленными, т.е. имеют состояние Inserted или Inserted, а также для карточки указан storeMode как Insert. Возвращает признак того, что в карточке были сделаны изменения.

    Returns

    true, если в карточке были сделаны изменения; false, если карточка осталась неизменной.

    Returns boolean

ensureCacheResolved

  • Выполняет резолв кеша декораторов для данных объекта-хранилища.

    Returns void

getStorage

  • Возвращает хранилище IStorage, декоратором для которого является текущий объект.

    Returns

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

    Returns IStorage<unknown>

getStorageSettings

hasChanges

  • Возвращает признак того, что хотя бы одна секция карточки или одна из вложенных карточек файлов или заданий содержит изменения.

    Returns

    true, если карточка содержит изменения; false в противном случае.

    Parameters

    • checkStates: boolean = true

      Признак того, что требуется проверить состояние всех вложенных заданий и файлов, а не только данные их карточек.

    Returns boolean

isEmpty

  • Returns boolean

isValid

  • Выполняет проверку объекта на валидность и возвращает признак того, что объект является валидным.

    Returns

    true, если объект прошёл проверку на валидность; false в противном случае.

    Returns boolean

notifyStorageUpdated

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

    Returns void

removeAllButChanged

  • Удаляет информацию о всех полях или строках всех секций карточки, которые не были изменены посредством IStorageObjectStateProvider.

    Remarks

    Метод удаляет информацию об изменённых полях, поэтому повторный его вызов приведёт к удалению всех полей. Для коллекционных и древовидных секций метод удаляет строки, у которых state равен None. Если у секций не остаётся строк, то они удаляются. Метод удаляет всю информацию, кроме служебной, о строках, у которых state равен Deleted, и не удаляет информацию у строк Inserted. Рекомендуется вызывать этот метод перед вызовом clean.

    Parameters

    • storeMode: CardStoreMode = CardStoreMode.Update

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

    • storeMethod: CardStoreMethod = CardStoreMethod.Default

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

    Returns void

removeChanges

  • Выполняет удаление информации по состояниям, из которой можно было бы определить, что карточка изменена. Возвращает признак того, что при этом были внесены изменения.

    Returns

    true, если в процессе удаления были внесены изменения; false в противном случае.

    Parameters

    • deletedHandling: CardRemoveChangesDeletedHandling = CardRemoveChangesDeletedHandling.ResetToNone

      Способ обработки удалённых строк, файлов и заданий.

    Returns boolean

removeSystemInfo

  • Удаляет системную информацию, которая может располагаться в любом месте в хранилище текущего объекта и может быть найдена по ключам с префиксом StorageHelper.systemKeyPrefix.

    Returns void

removeUserInfo

  • Удаляет пользовательскую информацию, которая может располагаться в любом месте в хранилище текущего объекта и может быть найдена по ключам с префиксом StorageHelper.userKeyPrefix.

    Returns void

tryGetFiles

  • Возвращает список прикреплённых к карточке файлов или null, если список ещё не был задан.

    Returns

    Список прикреплённых к карточке файлов или null, если список ещё не был задан.

    Returns null | StorageArray<CardFile>

tryGetInfo

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

    Returns

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

    Returns null | IStorage<unknown>

tryGetPermissions

  • Возвращает права доступа на карточку и её секции или null, если права ещё не были заданы.

    Returns

    Права доступа на карточку и её секции или null, если права ещё не были заданы.

    Returns null | CardPermissionInfo

tryGetSections

  • Возвращает данные карточки, включающие содержимое всех строк и полей, или null, если данные ещё не были заданы.

    Returns

    Данные карточки, включающие содержимое всех строк и полей, или null, если данные ещё не были заданы.

    Returns null | StorageMap<CardSection, IStorage<unknown>>

tryGetTaskHistory

  • Возвращает список с информацией по завершённым заданиям, которые были выданы на карточку, или null, если список ещё не был задан.

    Returns

    Список с информацией по завершённым заданиям, которые были выданы на карточку, или null, если список ещё не был задан.

    Returns null | StorageArray<CardTaskHistoryItem>

tryGetTaskHistoryGroups

  • Возвращает список с информацией по группам заданий, которые были выданы на карточку, или null, если список ещё не был задан.

    Returns

    Список с информацией по группам заданий, которые были выданы на карточку, или null, если список ещё не был задан.

    Returns null | StorageArray<CardTaskHistoryGroup>

tryGetTasks

  • Возвращает список заданий, которые были выданы на карточку и ещё не были завершены, или null, если список ещё не был задан.

    Returns

    Список заданий, которые были выданы на карточку и ещё не были завершены, или null, если список ещё не был задан.

    Returns null | StorageArray<CardTask>

tryGetTopics

  • Возвращает список моделей с информацией по сообщениям в обсуждениях или null, если информация ещё не была задана.

    Returns

    Список моделей с информацией по сообщениям в обсуждениях или null, если информация ещё не была задана.

    Returns null | StorageArray<ForumTopicModel>

updateStates

  • Обновляет состояние всех файлов и заданий в зависимости от наличия изменений в данных соответствующих карточек.

    Returns

    true, если состояние хотя бы одного задания или файла было изменено; false в противном случае.

    Returns boolean

validate

  • Выполняет валидацию текущего объекта и всех его дочерних объектов.

    Returns

    Объект, выполняющий построение результата валидации.

    Returns ValidationResult

Generated using TypeDoc