public interface IFileVersion : IFileObject,
IFileEntity, IEquatable<IFileEntity>, INotifyPropertyChanged, IEquatable<IFileObject>,
IEquatable<IFileVersion>Public Interface IFileVersion
Inherits IFileObject, IFileEntity, IEquatable(Of IFileEntity),
INotifyPropertyChanged, IEquatable(Of IFileObject), IEquatable(Of IFileVersion)public interface class IFileVersion : IFileObject,
IFileEntity, IEquatable<IFileEntity^>, INotifyPropertyChanged, IEquatable<IFileObject^>,
IEquatable<IFileVersion^>type IFileVersion =
interface
interface IFileObject
interface IFileEntity
interface IEquatable<IFileEntity>
interface INotifyPropertyChanged
interface IEquatable<IFileObject>
interface IEquatable<IFileVersion>
end| Cancellation |
Объект, который может использоваться для отмены асинхронных операций с файлом или версией файла, которые поддерживают отмену.
На текущий момент это доступно для загрузки содержимого версии файла.
(Унаследован от IFileObject) |
| Content |
Контент файла или версии файла. Контент файла обычно равен контенту его последней версии,
но имя файла на файловой системе может отличаться.
(Унаследован от IFileObject) |
| ContentSource | Местоположение контента версии файла. |
| ContentState |
Состояние загрузки контента файла или версии файла в кэш для последующего отображения пользователю.
(Унаследован от IFileObject) |
| Created | Дата создания версии. |
| CreatedByID | Идентификатор пользователя, который создал версию. |
| CreatedByName | Имя пользователя, который создал версию. |
| ErrorInfo | Информация по ошибке, возникшей при сохранении версии файла, или null, если ошибок не было. |
| File | Файл, к которому относится версия. Свойства файла имеют текущее состояние, а не таковое на момент создания версии. |
| Hash |
Хеш контента файла или версии файла, или null, если хеш не вычислен.
Хеш является необязательным свойством, которое по умолчанию не заполняется системой.
(Унаследован от IFileObject) |
| ID | Идентификатор объекта. (Унаследован от IFileEntity) |
| Info | Дополнительная информация, используемая в расширениях. (Унаследован от IFileObject) |
| LinkID | Внешний идентификатор версии файла или null, если такой идентификатор не задан. Может использоваться в расширениях для связи с содержимым во внешнем местоположении. |
| Name |
Имя файла или версии файла, которое является допустимым именем файла на файловой системе,
но может отличаться от отображаемого имени файла.
(Унаследован от IFileObject) |
| Number | Порядковый номер версии файла, отсчитываемый от 1. |
| Options | Настройки файла или версии файла. Сериализуются в карточке в форме JSON. (Унаследован от IFileObject) |
| RequestInfo |
Дополнительная пользовательская информация, передаваемая в запросы к серверу,
которые относятся к загрузке содержимого файла/версии, к загрузке списка версий файла или к загрузке списка подписей.
(Унаследован от IFileObject) |
| Signatures | Подписи для версии файла. |
| Size |
Размер файла или версии файла в байтах. Устанавливается при создании объекта и затем обновляется
в зависимости от действительного размера контента [IFileContent.Size].
Значение [FileContent.UnknownSize] определяет, что размер неизвестен.
(Унаследован от IFileObject) |
| Source |
Объект, обеспечивающий взаимодействие текущего объекта с подсистемой,
в которой он был создан, например, с карточкой.
(Унаследован от IFileEntity) |
| State | Состояние версии файла. |
| Tags | Теги, связанные с версией файла. Например, признак того, что размер содержимого файла трактуется как большой файл, поэтому файл не копируется во временную папку. |
| Equals(T) | Indicates whether the current object is equal to another object of the same type. (Унаследован от IEquatableIFileEntity) |
| Equals(T) | (Унаследован от IEquatableIFileObject) |
| Equals(T) | (Унаследован от IEquatableIFileVersion) |
| InvalidateContentAsync |
Удаляет локально загруженный контент, переводя его в начальное состояние.
Следующий раз при получении контента он будет заново загружен.
(Унаследован от IFileObject) |
| SetContentStateAsync |
Устанавливает состояние загрузки контента файла или версии файла в кэш для последующего отображения пользователю.
(Унаследован от IFileObject) |
| SetHashAsync |
Устанавливает хеш контента файла или версии файла, или null, если хеш не вычислен.
Хеш является необязательным свойством, которое по умолчанию не заполняется системой.
(Унаследован от IFileObject) |
| SetNameAsync |
Устанавливает имя файла или версии файла, которое является допустимым именем файла на файловой системе,
но может отличаться от отображаемого имени файла.
(Унаследован от IFileObject) |
| PropertyChanged | Occurs when a property value changes. (Унаследован от INotifyPropertyChanged) |
| AllocateAdditionalLocalContentAsync |
Создаёт дополнительный объект локального содержимого (на диске) для файла или версии файла.
Загрузка такого содержимого отменяется вместе с основным содержимым.
(Определяется FileExtensions) |
| CancelDownloadingContent |
Отменяет асинхронную загрузку содержимого файла или версии. При отмене загрузки файла
также отменяется загрузка всех его версий.
(Определяется FileExtensions) |
| EnsureContentDownloadedAsync |
Загружает контент файла или версии файла, если он ещё не был загружен.
На загруженном контенте вызывается метод [IFileContent.EnsureLocalUpdatedAsync].
(Определяется FileExtensions) |
| EnsureContentDownloadedInUIAsync |
Загружает контент файла или версии файла, если он ещё не был загружен.
На загруженном контенте вызывается метод [IFileContent.EnsureLocalUpdatedAsync].
Изменение состояния контента выполняется в основном потоке UI, если выполнение производится на клиенте,
и в текущем потоке, если выполнение производится посредством серверного API.
(Определяется FileExtensions) |
| EnsureSignaturesLoadedAsync | Загружает подписи для версии файла, если они ещё не были загружены. (Определяется FileExtensions) |
| GetActionName |
Возвращает имя действия, в рамках которого был создан файл или версия файла,
или null, если файл не был создан специальным способом.
(Определяется FileExtensions) |
| GetLinkAsync | Возвращает ссылку на версию файла. (Определяется FileExtensions) |
| IsLarge |
Возвращает признак того, что содержимое версии файла считается большим файлом, поэтому будет обрабатываться особым образом.
Проверка выполняется по наличию тега Large.
(Определяется FileExtensions) |
| IsValidForContentOperations |
Возвращает признак того, что заданный объект (файл или версия файла)
может участвовать в операциях, связанных с контентом. Обычно это означает,
что при загрузке контента не возникло ошибок и контент полностью загружен на сервер
(не находится в процессе загрузки). При этом на клиент контент мог ещё не быть загружен,
т.е. потребуется вызвать EnsureContentDownloadedAsync(IFileObject, FuncIFileObject, FileContentDownloadState, FuncFileContentDownloadState, CancellationToken, ValueTask, FuncIFileObject, CancellationToken, ValueTaskIFileContent, CancellationToken).
(Определяется FileExtensions) |
| OpenAsync | Открывает контент заданного файла или версии файла для чтения или для редактирования. (Определяется FileExtensions) |
| OpenInFolderAsync | Открывает контент заданного файла или версии файла для чтения или для редактирования в окне проводника. (Определяется FileExtensions) |
| ReadAllBytesAsync |
Возвращает контент файла или версии файла в виде массива байт. Контент должен быть уже загружен методом
EnsureContentDownloadedAsync(IFileObject, FuncIFileObject, FileContentDownloadState, FuncFileContentDownloadState, CancellationToken, ValueTask, FuncIFileObject, CancellationToken, ValueTaskIFileContent, CancellationToken) или EnsureContentDownloadedInUIAsync(IFileObject, FuncIFileObject, CancellationToken, ValueTaskIFileContent, CancellationToken).
Этот метод оптимизирован по потреблению памяти, поэтому для получения данных рекомендуется использовать именно его.
(Определяется FileExtensions) |
| ReadAllTextAsync |
Возвращает контент текстового файла или версии файла в виде строки. Контент должен быть уже загружен методом
EnsureContentDownloadedAsync(IFileObject, FuncIFileObject, FileContentDownloadState, FuncFileContentDownloadState, CancellationToken, ValueTask, FuncIFileObject, CancellationToken, ValueTaskIFileContent, CancellationToken) или EnsureContentDownloadedInUIAsync(IFileObject, FuncIFileObject, CancellationToken, ValueTaskIFileContent, CancellationToken).
Этот метод оптимизирован по потреблению памяти, поэтому для получения данных рекомендуется использовать именно его.
(Определяется FileExtensions) |
| RestoreDownloadingContentAfterCancel |
Восстанавливает возможность асинхронной загрузки содержимого файла или версии после отмены.
При восстановлении загрузки файла также восстанавливается загрузка всех его версий.
(Определяется FileExtensions) |
| SaveAsync | Сохраняет контент заданного файла или версии файла в файле с указанным именем. (Определяется FileExtensions) |
| SaveAsync | Сохраняет контент заданного файла или версии файла в файле с указанным именем. (Определяется FileExtensions) |
| SetActionName |
Устанавливает имя действия, в рамках которого был создан файл или версия файла.
Например: FileMenuActionNames.Scan или FileMenuActionNames.AddFromTemplate.
(Определяется FileExtensions) |
| TryGetActualFile |
Возвращает объект IFile, соответствующей переданному файлу или файлу переданной версии.
Возвращает null, если переданный объект не является файлом IFile или версией IFileVersion.
(Определяется FileExtensions) |
| TryGetActualVersion |
Возвращает объект IFileVersion, соответствующей переданной версии или последней версии переданного файла.
Возвращает null, если переданный объект не является файлом IFile или версией IFileVersion.
(Определяется FileExtensions) |