Class CardFileVersion

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

Hierarchy

Implements

Constructors

constructor

Properties - Static Keys

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

Accessors

created createdById createdByName errorDate errorMessage hash 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

constructor

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

    Parameters

    • storage: IStorage<unknown> = {}

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

    Returns CardFileVersion

Static Keys Properties

Static Readonly createdByIdKey

createdByIdKey: "CreatedByID" = 'CreatedByID'

Static Readonly createdByNameKey

createdByNameKey: "CreatedByName" = 'CreatedByName'

Static Readonly createdKey

createdKey: "Created" = 'Created'

Static Readonly errorDateKey

errorDateKey: "ErrorDate" = 'ErrorDate'

Static Readonly errorMessageKey

errorMessageKey: "ErrorMessage" = 'ErrorMessage'

Static Readonly hashKey

hashKey: "Hash" = 'Hash'

Static Readonly linkIdKey

linkIdKey: "LinkID" = 'LinkID'

Static Readonly nameKey

nameKey: "Name" = 'Name'

Static Readonly numberKey

numberKey: "Number" = 'Number'

Static Readonly optionsKey

optionsKey: "Options" = 'Options'

Static Readonly requestInfoKey

requestInfoKey: "RequestInfo" = 'RequestInfo'

Static Readonly rowIdKey

rowIdKey: "RowID" = 'RowID'

Static Readonly sizeKey

sizeKey: "Size" = 'Size'

Static Readonly sourceKey

sourceKey: "Source" = 'Source'

Static Readonly stateKey

stateKey: "State" = 'State'

Static Readonly tagsKey

tagsKey: "Tags" = 'Tags'

Accessors

created

  • get created(): string

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

    Returns string

  • set created(value: string): void

  • Parameters

    • value: 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

errorDate

  • get errorDate(): null | string

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

    Returns null | string

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

  • Parameters

    • value: null | string

    Returns void

errorMessage

  • get errorMessage(): null | string

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

    Returns null | string

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

  • Parameters

    • value: null | string

    Returns void

hash

  • get hash(): null | string

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

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

    Returns null | string

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

  • Parameters

    • value: null | string

    Returns void

linkId

  • get linkId(): null | string

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

    Returns null | string

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

  • Parameters

    • value: null | string

    Returns void

name

  • get name(): string

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

    Returns string

  • set name(value: string): void

  • Parameters

    • value: string

    Returns void

number

  • get number(): number

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

    Returns number

  • set number(value: number): void

  • Parameters

    • value: number

    Returns void

options

  • get options(): null | string

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

    Returns null | string

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

  • Parameters

    • value: null | string

    Returns void

requestInfo

  • get requestInfo(): IStorage<unknown>

  • Дополнительная пользовательская информация, передаваемая в запрос CardGetFileContentRequest и в запрос на загрузку списка подписей CardRequestTypes.GetVersionSignatures.

    Returns IStorage<unknown>

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

  • Parameters

    Returns void

rowId

  • get rowId(): string

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

    Returns string

  • set rowId(value: string): void

  • Parameters

    • value: string

    Returns void

size

  • get size(): number

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

    Returns number

  • set size(value: number): void

  • Parameters

    • value: number

    Returns void

source

  • get source(): number

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

    Returns number

  • set source(value: number): void

  • Parameters

    • value: number

    Returns void

state

tags

  • get tags(): null | string

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

    Returns null | string

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

  • Parameters

    • value: null | string

    Returns void

Methods

addTag

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

    Returns

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

    Parameters

    • tag: string

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

    Returns boolean

clean

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

    Returns void

clone

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

    Returns CardFileVersion

ensureCacheResolved

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

    Returns void

getStorage

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

    Returns

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

    Returns IStorage<unknown>

getStorageSettings

hasTag

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

    Returns

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

    Parameters

    • tag: string

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

    Returns boolean

isEmpty

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

    Returns

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

    Returns boolean

isValid

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

    Returns

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

    Returns boolean

notifyStorageUpdated

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

    Returns void

removeTag

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

    Returns

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

    Parameters

    • tag: string

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

    Returns boolean

setFrom

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

    Parameters

    • version: CardFileVersion

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

    Returns void

tryGetRequestInfo

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

    Returns

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

    Returns null | IStorage<unknown>

validate

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

    Returns

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

    Returns ValidationResult

Generated using TypeDoc