TESSA Web API
    Preparing search index...

    Class CardFile

    Общая информация о файле, прикреплённом к карточке.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties - Other

    cachedMemberChanged fieldChanged stateChanged

    Properties - Static Keys

    cardKey categoryCaptionKey categoryIdKey categoryOrderKey externalSourceKey hashKey infoKey isVirtualKey nameKey newVersionTagsKey optionsKey originalFileIdKey originalVersionRowIdKey requestInfoKey rowIdKey sectionRowsKey sizeKey storeSourceKey systemDeletionModeKey systemFlagsKey systemStateKey systemVersionsLoadedKey taskIdKey typeCaptionKey typeIdKey typeNameKey versionNumberKey versionRowIdKey versionsKey

    Accessors

    cachedMembers card categoryCaption categoryId categoryOrder deletionMode externalSource flags hash info isObservable isVirtual lastVersion name newVersionTags options originalFileId originalVersionRowId requestInfo rowId sectionRows size state storeSource taskId typeCaption typeId typeName versionNumber versionRowId versions versionsLoaded

    Methods

    addNewVersionTag clean clone deserializeOptions ensureCacheResolved getIgnoreExternalSourceContent getStorage getStorageSettings hasChanges hasContent hasNewVersionTag hasPendingStateChanges hasSize invalidateLastVersion isEmpty isValid notifyStorageUpdated removeChanges removeNewVersionTag removeSystemInfo removeUserInfo resetSize revertReplacedState setCard setIgnoreExternalSourceContent setOptions setReplacedState tryGetCard tryGetInfo tryGetRequestInfo tryGetSectionRows tryGetVersions updateState validate

    Constructors

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

      Parameters

      • storage: IStorage = {}

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

      Returns CardFile

    Properties - Other

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

    Событие, возникающее при изменении состояния файла state.

    Properties - Static Keys

    cardKey: "Card" = 'Card'
    categoryCaptionKey: "CategoryCaption" = 'CategoryCaption'
    categoryIdKey: "CategoryID" = 'CategoryID'
    categoryOrderKey: "CategoryOrder" = 'CategoryOrder'
    externalSourceKey: "ExternalSource" = 'ExternalSource'
    hashKey: "Hash" = 'Hash'
    infoKey: "Info" = 'Info'
    isVirtualKey: "IsVirtual" = 'IsVirtual'
    nameKey: "Name" = 'Name'
    newVersionTagsKey: "NewVersionTags" = 'NewVersionTags'
    optionsKey: "Options" = 'Options'
    originalFileIdKey: "OriginalFileID" = 'OriginalFileID'
    originalVersionRowIdKey: "OriginalVersionRowID" = 'OriginalVersionRowID'
    requestInfoKey: "RequestInfo" = 'RequestInfo'
    rowIdKey: "RowID" = 'RowID'
    sectionRowsKey: "SectionRows" = 'SectionRows'
    sizeKey: "Size" = 'Size'
    storeSourceKey: "StoreSource" = 'StoreSource'
    systemDeletionModeKey: string = ...
    systemFlagsKey: string = ...
    systemStateKey: string = ...
    systemVersionsLoadedKey: string = ...
    taskIdKey: "TaskID" = 'TaskID'
    typeCaptionKey: "TypeCaption" = 'TypeCaption'
    typeIdKey: "TypeID" = 'TypeID'
    typeNameKey: "TypeName" = 'TypeName'
    versionNumberKey: "VersionNumber" = 'VersionNumber'
    versionRowIdKey: "VersionRowID" = 'VersionRowID'
    versionsKey: "Versions" = 'Versions'

    Accessors

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

      Returns ReadonlyMap<string, unknown>

    • get card(): Card

      Карточка файла.

      Returns Card

    • set card(value: Card): void

      Parameters

      Returns void

    • get categoryCaption(): null | string

      Отображаемое имя категории файла или null, если категория файла не указана.

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    • get categoryId(): null | string

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

      Значение categoryCaption обязательно должно быть указано для того, чтобы файл был включён в категорию, а значение categoryId является опциональным для идентификации категории.

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    • get categoryOrder(): null | number

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

      Returns null | number

    • set categoryOrder(value: null | number): void

      Parameters

      • value: null | number

      Returns void

    • get externalSource(): null | CardFileContentSource

      Внешний источник контента для файла или null, если внешний источник отсутствует и контент для файла загружается стандартным образом.

      Returns null | CardFileContentSource

      Для того, чтобы удалить внешний источник контента, установите это свойство равным null.

    • set externalSource(value: null | CardFileContentSource): void

      Parameters

      Returns void

    • get hash(): null | string

      Хеш контента для последней версии файла или null, если хеш не указан. Рекомендуется указать при создании новой версии, чтобы в дальнейшем для этой версии был доступен хеш контента.

      Укажите флаг CardFileFlags.CalculateHash в свойстве flags для того, чтобы при сохранении файла хеш-сумма была вычислена на сервере, независимо от значения в свойстве hash.

      По умолчанию значение равно null, при этом для новых версий хеш считается не заданным.

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    • get info(): IStorage

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

      Returns IStorage

    • set info(value: IStorage): void

      Parameters

      Returns void

    • get isObservable(): boolean

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

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

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

      Returns boolean

    • set isObservable(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get isVirtual(): boolean

      Признак того, что файл виртуальный, такой как "Лист согласования". Некоторые расширения учитывают этот признак, и, например, игнорируют файл при назначении разрешений в процессе чтения карточки.

      Returns boolean

    • set isVirtual(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get lastVersion(): null | CardFileVersion

      Последняя версия файла или null, если последняя версия неизвестна.

      Returns null | CardFileVersion

    • get name(): string

      Имя файла.

      Returns string

    • set name(value: string): void

      Parameters

      • value: string

      Returns void

    • get newVersionTags(): null | string

      Теги новой версии файла, если такая версия будет создана в процессе сохранения. Могут быть равны null или пустой строке, если теги не заданы, или если файл не подготовлен для сохранения.

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    • get options(): null | string

      Сериализованные в типизированный JSON настройки файла. Могут быть равны null или пустой строке, если настройки не заданы. Для установки значения рекомендуется использовать метод CardFile.setOptions, а для получения - CardFile.deserializeOptions.

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    • get originalFileId(): null | string

      Идентификатор файла, копией версии которого является текущий файл, или null, если файл является оригиналом, а не копией.

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    • get originalVersionRowId(): null | string

      Идентификатор версии файла, копией которой является текущий файл, или null, если файл является оригиналом, а не копией.

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    • get requestInfo(): IStorage

      Дополнительная пользовательская информация, передаваемая в запросы CardGetFileContentRequest (в т.ч. при загрузке или сохранении ExternalSource), в запросы на загрузку списка версий CardGetFileVersionsRequest, а также в запросы на загрузку списка подписей CardRequestTypes.GetVersionSignatures.

      Returns IStorage

    • set requestInfo(value: IStorage): void

      Parameters

      Returns void

    • get rowId(): string

      Идентификатор строки с описанием файла.

      Returns string

    • set rowId(value: string): void

      Parameters

      • value: string

      Returns void

    • get sectionRows(): StorageMap<CardRow>

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

      Returns StorageMap<CardRow>

    • set sectionRows(value: StorageMap<CardRow>): void

      Parameters

      Returns void

    • get size(): number

      Размер контента последней версии файла в байтах или -1, если размер неизвестен или не был задан. В серверных расширениях на сохранение это свойство можно использовать для определения размера контента сохраняемых файлов.

      Returns number

    • set size(value: number): void

      Parameters

      • value: number

      Returns void

    • get state(): CardFileState

      Состояние файла.

      Returns CardFileState

    • set state(value: CardFileState): void

      Parameters

      Returns void

    • get storeSource(): number

      Местоположение, которое следует использовать для сохраняемого контента файла. Актуально только для файла, для которого создаётся новая версия.

      Returns number

    • set storeSource(value: number): void

      Parameters

      • value: number

      Returns void

    • get taskId(): null | string

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

      Returns null | string

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

      Parameters

      • value: null | string

      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 versionNumber(): number

      Актуальная версия файла.

      Returns number

    • set versionNumber(value: number): void

      Parameters

      • value: number

      Returns void

    • get versionRowId(): string

      Идентификатор актуальной версии файла.

      Returns string

    • set versionRowId(value: string): void

      Parameters

      • value: string

      Returns void

    • get versionsLoaded(): boolean

      Признак того, что список версий versions был загружен.

      Returns boolean

    • set versionsLoaded(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    Methods

    • Добавляет заданный тег в список тегов, соответствующих новой версии файла newVersionTags. Возвращает признак того, что тег отсутствовал и был добавлен.

      Parameters

      • tag: string

        Добавляемый тег. Не должен быть равен пустой строке.

      Returns boolean

      true, если тег отсутствовал и был добавлен; false, если тег уже присутствовал.

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

      Returns void

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

      Returns CardFile

    • Десериализует настройки options. Если настройки не заданы, то возвращается пустой объект.

      Returns IStorage

      Настройки options.

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

      Returns void

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

      Returns boolean

      Признак того, что при обработке файла системой не следует учитывать свойство CardFile.externalSource. Если признак не был установлен, то возвращается false.

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

      Returns IStorage

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

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

      Parameters

      • checkStates: boolean = true

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

      Returns boolean

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

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

      Returns boolean

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

      Parameters

      • tag: string

        Тег, проверка наличия которого выполняется.

      Returns boolean

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

    • Возвращает признак того, что во флагах flags установлены флаги, влияющие на смену состояния на изменённое.

      Returns boolean

      true, если во флагах flags установлены флаги, влияющие на смену состояния; false в противном случае.

    • Возвращает признак того, что файл содержит информацию о длине контента файла, т.е. свойство size отлично от значения -1.

      Returns boolean

      true, если файл содержит информацию о длине контента файла; false в противном случае.

    • Returns void

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

      Returns boolean

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

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

      Returns boolean

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

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

      Returns void

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

      Parameters

      • deletedHandling: CardRemoveChangesDeletedHandling = CardRemoveChangesDeletedHandling.ResetToNone

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

      Returns boolean

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

    • Удаляет заданный тег из списка тегов, соответствующих новой версии файла newVersionTags. Возвращает признак того, что тег присутствовал и был удалён.

      Parameters

      • tag: string

        Удаляемый тег. Не должен быть равен пустой строке.

      Returns boolean

      true, если тег присутствовал и был удалён; false, если тег уже отсутствовал.

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

      Returns void

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

      Returns void

    • Устанавливает признак того, что файл не содержит информацию о длине контента файла, т.е. свойство size устанавливается как -1.

      Returns void

    • Связывает данные текущего объекта с заданной карточкой задания.

      При это устанавливаются свойства rowId, typeId, typeName, typeCaption и card.

      Parameters

      • card: Card

        Карточка задания, с которой связывается текущий объект.

      Returns void

    • Устанавливает признак того, что при обработке файла системой не следует учитывать свойство CardFile.externalSource как необходимость копировать контент файла. Например, при создании шаблона контент копируется средствами расширения и не должен копироваться системой.

      Parameters

      • value: boolean

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

      Returns void

    • Устанавливает значение свойства options с выполнением сериализации указанного хранилища.

      Parameters

      • storage: null | IStorage

        Хранилище, которое сериализуется в json для свойства options. Может быть равно null.

      Returns void

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

      Returns null | Card

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

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

      Returns null | IStorage

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

    • Возвращает дополнительную пользовательскую информацию по текущему объекту, передаваемую в запросы CardGetFileContentRequest (в т.ч. при загрузке или сохранении ExternalSource), в запросы на загрузку списка версий CardGetFileVersionsRequest, а также в запросы на загрузку списка подписей CardRequestTypes.GetVersionSignatures, или null, если информация ещё не была задана.

      Returns null | IStorage

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

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

      Returns null | StorageMap<CardRow, IStorage>

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

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

      Returns null | StorageArray<CardFileVersion>

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

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

      Returns boolean

      true, если состояние файла было изменено; false, если состояние файла не требуется изменять, т.к. изменения уже зафиксированы или отсутствуют.

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

      Returns ValidationResult

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties - Other
    Properties - Static Keys
    Accessors
    Methods