TESSA Web API
    Preparing search index...

    Class CardFileVersion

    Информация о версии файла.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties - Other

    cachedMemberChanged fieldChanged

    Properties - Static Keys

    createdByIdKey createdByNameKey createdKey errorDateKey errorMessageKey hashKey linkIdKey nameKey numberKey optionsKey requestInfoKey rowIdKey sizeKey sourceKey stateKey tagsKey

    Accessors

    cachedMembers created createdById createdByName errorDate errorMessage hash isObservable linkId name number options requestInfo rowId size source state tags

    Methods

    addTag clean clone ensureCacheResolved getStorage getStorageSettings hasTag isEmpty isValid notifyStorageUpdated removeTag setFrom tryGetRequestInfo validate

    Constructors

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

      Parameters

      • storage: IStorage = {}

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

      Returns CardFileVersion

    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'
    errorDateKey: "ErrorDate" = 'ErrorDate'
    errorMessageKey: "ErrorMessage" = 'ErrorMessage'
    hashKey: "Hash" = 'Hash'
    linkIdKey: "LinkID" = 'LinkID'
    nameKey: "Name" = 'Name'
    numberKey: "Number" = 'Number'
    optionsKey: "Options" = 'Options'
    requestInfoKey: "RequestInfo" = 'RequestInfo'
    rowIdKey: "RowID" = 'RowID'
    sizeKey: "Size" = 'Size'
    sourceKey: "Source" = 'Source'
    stateKey: "State" = 'State'
    tagsKey: "Tags" = 'Tags'

    Accessors

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

      Returns ReadonlyMap<string, unknown>

    • get created(): string

      Дата создания версии (изменения файла).

      Returns string

    • set created(value: string): void

      Parameters

      • value: 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 errorDate(): null | string

      Дата ошибки, произошедшей для версии файла, или null, если ошибок не было.

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    • get errorMessage(): null | string

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

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    • get hash(): null | string

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

      Изменение этого значения позволяет установить другой хеш для использования в расширениях, но не позволяет изменить хеш у версии. Для установки хеша создаваемой версии укажите свойство CardFile.hash.

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    • get isObservable(): boolean

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

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

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

      Returns boolean

    • set isObservable(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get linkId(): null | string

      Внешний идентификатор версии файла или null, если такой идентификатор не задан. Может использоваться в расширениях для связи с содержимым во внешнем местоположении.

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    • get name(): string

      Имя версии файла.

      Returns string

    • set name(value: string): void

      Parameters

      • value: string

      Returns void

    • get number(): number

      Номер версии файла, отсчитываемый от единицы.

      Returns number

    • set number(value: number): void

      Parameters

      • value: number

      Returns void

    • get options(): null | string

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

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    • get requestInfo(): IStorage

      Дополнительная пользовательская информация, передаваемая в запрос CardGetFileContentRequest и в запрос на загрузку списка подписей 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 size(): number

      Размер контента в байтах для версии файла.

      Returns number

    • set size(value: number): void

      Parameters

      • value: number

      Returns void

    • get source(): number

      Местоположение контента версии файла.

      Returns number

    • set source(value: number): void

      Parameters

      • value: number

      Returns void

    • get tags(): null | string

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

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    Methods

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

      Parameters

      • tag: string

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

      Returns boolean

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

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

      Returns void

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

      Returns CardFileVersion

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

      Returns void

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

      Returns IStorage

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

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

      Parameters

      • tag: string

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

      Returns boolean

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

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

      Returns boolean

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

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

      Returns boolean

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

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

      Returns void

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

      Parameters

      • tag: string

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

      Returns boolean

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

    • Устанавливает свойства текущего объекта в соответствии с заданной версией файла.

      Parameters

      • version: CardFileVersion

        Версия, в соответствии с которой устанавливаются поля текущего объекта.

      Returns void

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

      Returns null | IStorage

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

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

      Returns ValidationResult

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties - Other
    Properties - Static Keys
    Accessors
    Methods