TESSA Web API
    Preparing search index...

    Class Card

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

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties - Other

    cachedMemberChanged fieldChanged

    Properties - Static Keys

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

    Accessors

    cachedMembers created createdById createdByName files flags id info instanceType isObservable 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

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

      Parameters

      • storage: IStorage = {}

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

      Returns Card

    Properties - Other

    cachedMemberChanged: EventHandler<
        { fieldName: string; newValue: unknown; oldValue: unknown },
    >
    fieldChanged: EventHandler<
        { fieldName: string; newValue: unknown; oldValue: unknown },
    >

    Properties - Static Keys

    createdByIdKey: "CreatedByID" = 'CreatedByID'
    createdByNameKey: "CreatedByName" = 'CreatedByName'
    createdKey: "Created" = 'Created'
    filesKey: "Files" = 'Files'
    flagsKey: "Flags" = 'Flags'
    idKey: "ID" = 'ID'
    infoKey: "Info" = 'Info'
    modifiedByIdKey: "ModifiedByID" = 'ModifiedByID'
    modifiedByNameKey: "ModifiedByName" = 'ModifiedByName'
    modifiedKey: "Modified" = 'Modified'
    permissionsKey: "Permissions" = 'Permissions'
    sectionsKey: "Sections" = 'Sections'
    taskHistoryGroupsKey: "TaskHistoryGroups" = 'TaskHistoryGroups'
    taskHistoryKey: "TaskHistory" = 'TaskHistory'
    tasksKey: "Tasks" = 'Tasks'
    topicsKey: "Topics" = 'Topics'
    typeCaptionKey: "TypeCaption" = 'TypeCaption'
    typeIdKey: "TypeID" = 'TypeID'
    typeNameKey: "TypeName" = 'TypeName'
    versionKey: "Version" = 'Version'

    Accessors

    • get cachedMembers(): ReadonlyMap<string, unknown>

      Returns ReadonlyMap<string, unknown>

    • get created(): null | string

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

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    • get createdById(): string

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

      Returns string

    • set createdById(value: string): void

      Parameters

      • value: string

      Returns void

    • get createdByName(): string

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

      Returns string

    • set createdByName(value: string): void

      Parameters

      • value: string

      Returns void

    • get flags(): number

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

      Returns number

    • set flags(value: number): void

      Parameters

      • value: number

      Returns void

    • get id(): string

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

      Returns string

    • set id(value: string): void

      Parameters

      • value: string

      Returns void

    • get info(): IStorage

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

      Returns IStorage

    • set info(value: IStorage): void

      Parameters

      Returns void

    • get instanceType(): CardInstanceType

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

      Returns CardInstanceType

    • set instanceType(value: CardInstanceType): void

      Parameters

      Returns void

    • get isObservable(): boolean

      Определяет, является ли хранилище наблюдаемым, то есть поддерживает механизм автоматического оповещения о своих изменениях.

      Если значение этого свойства равно true, то объект класса может быть подписан на изменения, и соответствующие обработчики будут вызываться при каждом изменении состояния объекта.

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

      Returns boolean

    • set isObservable(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get modified(): null | string

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

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    • get modifiedById(): string

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

      Returns string

    • set modifiedById(value: string): void

      Parameters

      • value: string

      Returns void

    • get modifiedByName(): string

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

      Returns string

    • set modifiedByName(value: string): void

      Parameters

      • value: string

      Returns void

    • get storeMode(): CardStoreMode

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

      Returns CardStoreMode

    • get tasks(): StorageArray<CardTask>

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

      Returns StorageArray<CardTask>

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

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

      Parameters

      Returns void

    • get typeCaption(): string

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

      Returns string

    • set typeCaption(value: string): void

      Parameters

      • value: string

      Returns void

    • get typeId(): string

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

      Returns string

    • set typeId(value: string): void

      Parameters

      • value: string

      Returns void

    • get typeName(): string

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

      Returns string

    • set typeName(value: string): void

      Parameters

      • value: string

      Returns void

    • get version(): number

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

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

      Returns number

    • set version(value: number): void

      Parameters

      • value: number

      Returns void

    Methods

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

      Returns void

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

      Returns Card

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

      Returns boolean

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

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

      Returns void

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

      Returns IStorage

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

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

      Parameters

      • checkStates: boolean = true

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

      Returns boolean

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

    • Returns boolean

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

      Returns boolean

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

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

      Returns void

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

      Parameters

      • storeMode: CardStoreMode = CardStoreMode.Update

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

      • storeMethod: CardStoreMethod = CardStoreMethod.Default

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

      Returns void

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

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

      Parameters

      • deletedHandling: CardRemoveChangesDeletedHandling = CardRemoveChangesDeletedHandling.ResetToNone

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

      Returns boolean

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

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

      Returns void

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

      Returns void

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

      Returns null | StorageArray<CardFile>

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

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

      Returns null | IStorage

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

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

      Returns null | CardPermissionInfo

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

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

      Returns null | StorageMap<CardSection, IStorage>

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

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

      Returns null | StorageArray<CardTaskHistoryItem>

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

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

      Returns null | StorageArray<CardTaskHistoryGroup>

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

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

      Returns null | StorageArray<CardTask>

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

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

      Returns null | StorageArray<ForumTopicModel>

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

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

      Returns boolean

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

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

      Returns ValidationResult

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties - Other
    Properties - Static Keys
    Accessors
    Methods