Class CardFile

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

Hierarchy

Implements

Constructors

constructor

Properties - Other

stateChanged

Properties - Static Keys

cardKey categoryCaptionKey categoryIdKey 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

card categoryCaption categoryId deletionMode externalSource flags hash info 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

constructor

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

    Parameters

    • storage: IStorage<unknown> = {}

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

    Returns CardFile

Other Properties

Readonly stateChanged

stateChanged: EventHandler<CardFileStateChangedEventArgs, CardFile>

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

Static Keys Properties

Static Readonly cardKey

cardKey: "Card" = 'Card'

Static Readonly categoryCaptionKey

categoryCaptionKey: "CategoryCaption" = 'CategoryCaption'

Static Readonly categoryIdKey

categoryIdKey: "CategoryID" = 'CategoryID'

Static Readonly externalSourceKey

externalSourceKey: "ExternalSource" = 'ExternalSource'

Static Readonly hashKey

hashKey: "Hash" = 'Hash'

Static Readonly infoKey

infoKey: "Info" = 'Info'

Static Readonly isVirtualKey

isVirtualKey: "IsVirtual" = 'IsVirtual'

Static Readonly nameKey

nameKey: "Name" = 'Name'

Static Readonly newVersionTagsKey

newVersionTagsKey: "NewVersionTags" = 'NewVersionTags'

Static Readonly optionsKey

optionsKey: "Options" = 'Options'

Static Readonly originalFileIdKey

originalFileIdKey: "OriginalFileID" = 'OriginalFileID'

Static Readonly originalVersionRowIdKey

originalVersionRowIdKey: "OriginalVersionRowID" = 'OriginalVersionRowID'

Static Readonly requestInfoKey

requestInfoKey: "RequestInfo" = 'RequestInfo'

Static Readonly rowIdKey

rowIdKey: "RowID" = 'RowID'

Static Readonly sectionRowsKey

sectionRowsKey: "SectionRows" = 'SectionRows'

Static Readonly sizeKey

sizeKey: "Size" = 'Size'

Static Readonly storeSourceKey

storeSourceKey: "StoreSource" = 'StoreSource'

Static Readonly systemDeletionModeKey

systemDeletionModeKey: string = ...

Static Readonly systemFlagsKey

systemFlagsKey: string = ...

Static Readonly systemStateKey

systemStateKey: string = ...

Static Readonly systemVersionsLoadedKey

systemVersionsLoadedKey: string = ...

Static Readonly taskIdKey

taskIdKey: "TaskID" = 'TaskID'

Static Readonly typeCaptionKey

typeCaptionKey: "TypeCaption" = 'TypeCaption'

Static Readonly typeIdKey

typeIdKey: "TypeID" = 'TypeID'

Static Readonly typeNameKey

typeNameKey: "TypeName" = 'TypeName'

Static Readonly versionNumberKey

versionNumberKey: "VersionNumber" = 'VersionNumber'

Static Readonly versionRowIdKey

versionRowIdKey: "VersionRowID" = 'VersionRowID'

Static Readonly versionsKey

versionsKey: "Versions" = 'Versions'

Accessors

card

  • get card(): Card

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

    Returns Card

  • set card(value: Card): void

  • Parameters

    Returns void

categoryCaption

  • get categoryCaption(): null | string

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

    Returns null | string

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

  • Parameters

    • value: null | string

    Returns void

categoryId

  • get categoryId(): null | string

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

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

    Returns null | string

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

  • Parameters

    • value: null | string

    Returns void

deletionMode

externalSource

  • get externalSource(): null | CardFileContentSource

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

    Remarks

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

    Returns null | CardFileContentSource

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

  • Parameters

    Returns void

flags

  • get flags(): CardFileFlags

  • Флаги файла.

    Returns CardFileFlags

  • set flags(value: CardFileFlags): void

  • Parameters

    Returns void

hash

  • get hash(): null | string

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

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

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

    Returns null | string

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

  • Parameters

    • value: null | string

    Returns void

info

  • get info(): IStorage<unknown>

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

    Returns IStorage<unknown>

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

  • Parameters

    Returns void

isVirtual

  • get isVirtual(): boolean

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

    Returns boolean

  • set isVirtual(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

lastVersion

  • get lastVersion(): null | CardFileVersion

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

    Returns null | CardFileVersion

name

  • get name(): string

  • Имя файла.

    Returns string

  • set name(value: string): void

  • Parameters

    • value: string

    Returns void

newVersionTags

  • get newVersionTags(): null | string

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

    Returns null | string

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

  • Parameters

    • value: null | string

    Returns void

options

  • get options(): null | string

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

    Returns null | string

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

  • Parameters

    • value: null | string

    Returns void

originalFileId

  • get originalFileId(): null | string

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

    Returns null | string

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

  • Parameters

    • value: null | string

    Returns void

originalVersionRowId

  • get originalVersionRowId(): null | string

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

    Returns null | string

  • set originalVersionRowId(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

sectionRows

  • get sectionRows(): StorageMap<CardRow, IStorage<unknown>>

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

    Returns StorageMap<CardRow, IStorage<unknown>>

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

  • Parameters

    Returns void

size

  • get size(): number

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

    Returns number

  • set size(value: number): void

  • Parameters

    • value: number

    Returns void

state

  • get state(): CardFileState

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

    Returns CardFileState

  • set state(value: CardFileState): void

  • Parameters

    Returns void

storeSource

  • get storeSource(): number

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

    Returns number

  • set storeSource(value: number): void

  • Parameters

    • value: number

    Returns void

taskId

  • get taskId(): null | string

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

    Returns null | string

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

  • Parameters

    • value: null | string

    Returns void

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

versionNumber

  • get versionNumber(): number

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

    Returns number

  • set versionNumber(value: number): void

  • Parameters

    • value: number

    Returns void

versionRowId

  • get versionRowId(): string

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

    Returns string

  • set versionRowId(value: string): void

  • Parameters

    • value: string

    Returns void

versions

versionsLoaded

  • get versionsLoaded(): boolean

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

    Returns boolean

  • set versionsLoaded(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

Methods

addNewVersionTag

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

    Returns

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

    Parameters

    • tag: string

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

    Returns boolean

clean

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

    Returns void

clone

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

    Returns CardFile

deserializeOptions

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

    Returns

    Настройки options.

    Returns IStorage<unknown>

ensureCacheResolved

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

    Returns void

getIgnoreExternalSourceContent

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

    Returns

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

    Returns boolean

getStorage

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

    Returns

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

    Returns IStorage<unknown>

getStorageSettings

hasChanges

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

    Returns

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

    Parameters

    • checkStates: boolean = true

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

    Returns boolean

hasContent

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

    Returns boolean

hasNewVersionTag

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

    Returns

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

    Parameters

    • tag: string

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

    Returns boolean

hasPendingStateChanges

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

    Returns

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

    Returns boolean

hasSize

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

    Returns

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

    Returns boolean

invalidateLastVersion

  • Returns void

isEmpty

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

    Returns

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

    Returns boolean

isValid

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

    Returns

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

    Returns boolean

notifyStorageUpdated

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

    Returns void

removeChanges

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

    Returns

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

    Parameters

    • deletedHandling: CardRemoveChangesDeletedHandling = CardRemoveChangesDeletedHandling.ResetToNone

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

    Returns boolean

removeNewVersionTag

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

    Returns

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

    Parameters

    • tag: string

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

    Returns boolean

removeSystemInfo

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

    Returns void

removeUserInfo

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

    Returns void

resetSize

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

    Returns void

revertReplacedState

  • Устанавливает состояние None, если файл был в состоянии Replaced. Устанавливает состояние Modified, если файл был в состоянии ModifiedAndReplaced. В других случаях не выполняет действий. Возвращает WasReplaced, если состояние было изменено, и WasIncompatible.

    Returns

    Результат изменения состояния.

    Returns CardFileReplacementResult

setCard

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

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

    Parameters

    • card: Card

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

    Returns void

setIgnoreExternalSourceContent

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

    Parameters

    • value: boolean

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

    Returns void

setOptions

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

    Parameters

    • storage: null | IStorage<unknown>

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

    Returns void

setReplacedState

  • Устанавливает состояние Replaced, если файл был в состоянии None. Устанавливает состояние ModifiedAndReplaced, если файл был в состоянии Modified. В других случаях не выполняет действий.

    Returns

    Результат изменения состояния.

    Returns CardFileReplacementResult

tryGetCard

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

    Returns

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

    Returns null | Card

tryGetInfo

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

    Returns

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

    Returns null | IStorage<unknown>

tryGetRequestInfo

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

    Returns

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

    Returns null | IStorage<unknown>

tryGetSectionRows

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

    Returns

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

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

tryGetVersions

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

    Returns

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

    Returns null | StorageArray<CardFileVersion>

updateState

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

    Returns

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

    Returns boolean

validate

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

    Returns

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

    Returns ValidationResult

Generated using TypeDoc