Class CardFile

constructor

• new CardFile(storage?: IStorage): CardFile

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

  Parameters

  • storage: IStorage = {}

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

  Returns CardFile

ReadonlystateChanged

Static ReadonlycardKey

Static ReadonlycategoryCaptionKey

Static ReadonlycategoryIdKey

Static ReadonlycategoryOrderKey

Static ReadonlyexternalSourceKey

Static ReadonlyhashKey

Static ReadonlyisVirtualKey

Static ReadonlynameKey

Static ReadonlynewVersionTagsKey

Static ReadonlyoptionsKey

Static ReadonlyoriginalFileIdKey

Static ReadonlyoriginalVersionRowIdKey

Static ReadonlyrequestInfoKey

Static ReadonlyrowIdKey

Static ReadonlysectionRowsKey

Static ReadonlysizeKey

Static ReadonlystoreSourceKey

Static ReadonlysystemDeletionModeKey

Static ReadonlysystemFlagsKey

Static ReadonlysystemStateKey

Static ReadonlysystemVersionsLoadedKey

Static ReadonlytaskIdKey

Static ReadonlytypeCaptionKey

Static ReadonlytypeIdKey

Static ReadonlytypeNameKey

Static ReadonlyversionNumberKey

Static ReadonlyversionRowIdKey

Static ReadonlyversionsKey

card

• get card(): Card

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

  Returns Card
• set card(value: Card): void

  Parameters

  • value: Card

  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

categoryOrder

• get categoryOrder(): null | number

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

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

  Parameters

  • value: null | number

  Returns void

deletionMode

• get deletionMode(): CardFileDeletionMode

  Способ удаления файла.

  Returns CardFileDeletionMode
• set deletionMode(value: CardFileDeletionMode): void

  Parameters

  • value: CardFileDeletionMode

  Returns void

externalSource

• get externalSource(): null | CardFileContentSource

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

  Returns null | CardFileContentSource

  Remarks

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

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

  Parameters

  • value: null | CardFileContentSource

  Returns void

flags

• get flags(): CardFileFlags

  Флаги файла.

  Returns CardFileFlags
• set flags(value: CardFileFlags): void

  Parameters

  • value: CardFileFlags

  Returns void

hash

• 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

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 или пустой строке, если настройки не заданы. Для установки значения рекомендуется использовать метод CardFile.setOptions, а для получения - CardFile.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

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

  Returns IStorage
• set requestInfo(value: IStorage): void

  Parameters

  • value: IStorage

  Returns void

rowId

• get rowId(): string

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

  Returns string
• set rowId(value: string): void

  Parameters

  • value: string

  Returns void

sectionRows

• get sectionRows(): StorageMap<CardRow>

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

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

  Parameters

  • value: StorageMap<CardRow>

  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

  • value: CardFileState

  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

• get versions(): StorageArray<CardFileVersion>

  Список версий файла. Загружается отложено; список заполнен, если значение versionsLoaded равно true.

  Returns StorageArray<CardFileVersion>
• set versions(value: CardFileVersion[]): void

  Parameters

  • value: CardFileVersion[]

  Returns void

versionsLoaded

• get versionsLoaded(): boolean

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

  Returns boolean
• set versionsLoaded(value: boolean): void

  Parameters

  • value: boolean

  Returns void

addNewVersionTag

• addNewVersionTag(tag: string): boolean

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

  Parameters

  • tag: string

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

  Returns boolean

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

clean

• clean(): void

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

  Returns void

clone

• clone(): CardFile

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

  Returns CardFile

deserializeOptions

• deserializeOptions(): IStorage

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

  Returns IStorage

  Настройки options.

ensureCacheResolved

• ensureCacheResolved(): void

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

  Returns void

getIgnoreExternalSourceContent

• getIgnoreExternalSourceContent(): boolean

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

  Returns boolean

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

hasChanges

• hasChanges(checkStates?: boolean): boolean

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

  Parameters

  • checkStates: boolean = true

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

  Returns boolean

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

hasContent

• hasContent(): boolean

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

  Returns boolean

hasNewVersionTag

• hasNewVersionTag(tag: string): boolean

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

  Parameters

  • tag: string

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

  Returns boolean

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

hasPendingStateChanges

• hasPendingStateChanges(): boolean

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

  Returns boolean

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

hasSize

• hasSize(): boolean

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

  Returns boolean

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

invalidateLastVersion

• invalidateLastVersion(): void

  Returns void

isEmpty

• isEmpty(): boolean

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

  Returns boolean

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

removeChanges

• removeChanges(deletedHandling?: CardRemoveChangesDeletedHandling): boolean

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

  Parameters

  • deletedHandling: CardRemoveChangesDeletedHandling = CardRemoveChangesDeletedHandling.ResetToNone

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

  Returns boolean

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

removeNewVersionTag

• removeNewVersionTag(tag: string): boolean

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

  Parameters

  • tag: string

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

  Returns boolean

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

resetSize

• resetSize(): void

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

  Returns void

revertReplacedState

• revertReplacedState(): CardFileReplacementResult

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

  Returns CardFileReplacementResult

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

setCard

• setCard(card: Card): void

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

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

  Parameters

  • card: Card

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

  Returns void

setIgnoreExternalSourceContent

• setIgnoreExternalSourceContent(value: boolean): void

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

  Parameters

  • value: boolean

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

  Returns void

setOptions

• setOptions(storage: null | IStorage): void

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

  Parameters

  • storage: null | IStorage

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

  Returns void

setReplacedState

• setReplacedState(): CardFileReplacementResult

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

  Returns CardFileReplacementResult

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

tryGetCard

• tryGetCard(): null | Card

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

  Returns null | Card

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

tryGetRequestInfo

• tryGetRequestInfo(): null | IStorage

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

  Returns null | IStorage

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

tryGetSectionRows

• tryGetSectionRows(): null | StorageMap<CardRow, IStorage>

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

  Returns null | StorageMap<CardRow, IStorage>

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

tryGetVersions

• tryGetVersions(): null | StorageArray<CardFileVersion>

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

  Returns null | StorageArray<CardFileVersion>

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

updateState

• updateState(): boolean

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

  Returns boolean

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