IFile - методы |
Тип IFile предоставляет следующие члены.
Методы| Имя | Описание | |
|---|---|---|
 | Equals(T) | Indicates whether the current object is equal to another object of the same type. (Унаследован от IEquatableIFile.) |
| Equals(T) | (Унаследован от IEquatableIFileEntity.) |
| Equals(T) | (Унаследован от IEquatableIFileObject.) |
| GetState | Возвращает текущее состояние файла. |
| HasChanges | Возвращает признак того, что заданное состояние файла отличается от его текущего состояния. |
| InvalidateContentAsync |
Удаляет локально загруженный контент, переводя его в начальное состояние.
Следующий раз при получении контента он будет заново загружен.
(Унаследован от IFileObject.) |
| SetCategoryAsync | Устанавливает категорию файла или null, если файл не имеет категории. |
| SetContentStateAsync |
Устанавливает состояние загрузки контента файла или версии файла в кэш для последующего отображения пользователю.
(Унаследован от IFileObject.) |
| SetHashAsync |
Устанавливает хеш контента файла или версии файла, или null, если хеш не вычислен.
Хеш является необязательным свойством, которое по умолчанию не заполняется системой.
(Унаследован от IFileObject.) |
| SetNameAsync |
Устанавливает имя файла или версии файла, которое является допустимым именем файла на файловой системе,
но может отличаться от отображаемого имени файла.
(Унаследован от IFileObject.) |
| SetOriginAsync |
Устанавливает исходный файл, из которого был скопирован текущий файл,
или null, если текущий файл не был скопирован.
|
| SetPreviewContentAsync |
Устанавливает содержимое файла, отображаемое для предпросмотра.
По умолчанию значение равно [IFileObject.Content],
но оно может быть переопределено. Рекомендуется создавать такой контент из кэша, например:
file.AllocateAdditionalLocalContent("filename.txt").
|
| SetStateAsync | Устанавливает текущее состояние файла, равное заданному состоянию. |
| SetTypeAsync | Устанавливает тип файла. |
| UpdateInitialStateAsync |
Обновляет начальное состояние файла и устанавливаем его как равное заданному состоянию.
Не рекомендуется вызывать этот метод для существующих файлов, которые уже мог отредактировать пользователь.
|
Методы расширения| Имя | Описание | |
|---|---|---|
 | AllocateAdditionalLocalContentAsync |
Создаёт дополнительный объект локального содержимого (на диске) для файла или версии файла.
Загрузка такого содержимого отменяется вместе с основным содержимым.
(Определяется FileExtensions.) |
| CancelDownloadingContent |
Отменяет асинхронную загрузку содержимого файла или версии. При отмене загрузки файла
также отменяется загрузка всех его версий.
(Определяется FileExtensions.) |
| ChangeCategoryAsync(String, CancellationToken) | Перегружен.
Изменяет категорию файла без указания идентификатора категории.
(Определяется FileExtensions.) |
| ChangeCategoryAsync(IFileCategory, CancellationToken) | Перегружен.
Изменяет категорию файла и уведомляет об этом его источник,
если категория в действительности изменилась.
(Определяется FileExtensions.) |
| ChangeCategoryAsync(String, Guid, CancellationToken) | Перегружен.
Изменяет категорию файла с указанием идентификатора категории.
(Определяется FileExtensions.) |
| CopyAsync |
Создаёт копию заданного файла. Если контент копируемого файла не загружен, то он загружается перед созданием копии.
Первым значением возвращается копия заданного файла или null, если копию создать не удалось.
В этом случае возвращённый результат валидации не будет успешным.
(Определяется FileExtensions.) |
| EnsureContentDownloadedAsync |
Загружает контент файла или версии файла, если он ещё не был загружен.
На загруженном контенте вызывается метод [IFileContent.EnsureLocalUpdatedAsync].
(Определяется FileExtensions.) |
| EnsureContentDownloadedInUIAsync |
Загружает контент файла или версии файла, если он ещё не был загружен.
На загруженном контенте вызывается метод [IFileContent.EnsureLocalUpdatedAsync].
Изменение состояния контента выполняется в основном потоке UI, если выполнение производится на клиенте,
и в текущем потоке, если выполнение производится посредством серверного API.
(Определяется FileExtensions.) |
| EnsureContentModifiedAsync |
Проверяет, что источник файла был уведомлён об изменениях,
сделанных для контента файла [IFileObject.Content].
(Определяется FileExtensions.) |
| EnsureVersionsLoadedAsync | Загружает версии файла, если они ещё не были загружены. (Определяется FileExtensions.) |
| GetActionName |
Возвращает имя действия, в рамках которого был создан файл или версия файла,
или null, если файл не был создан специальным способом.
(Определяется FileExtensions.) |
| GetLinkAsync | Возвращает ссылку на файл. (Определяется FileExtensions.) |
| GetRootedOrigin |
Возвращает корневой элемент в дереве файлов, связанных посредством свойства Origin,
или null, если значение свойства Origin для файла file
равно null.
(Определяется FileExtensions.) |
| IsLarge |
Возвращает признак того, что содержимое версии файла считается большим файлом, поэтому будет обрабатываться особым образом.
Проверка выполняется по наличию тега Large.
(Определяется FileExtensions.) |
| IsValidForContentOperations |
Возвращает признак того, что заданный объект (файл или версия файла)
может участвовать в операциях, связанных с контентом. Обычно это означает,
что при загрузке контента не возникло ошибок и контент полностью загружен на сервер
(не находится в процессе загрузки). При этом на клиент контент мог ещё не быть загружен,
т.е. потребуется вызвать EnsureContentDownloadedAsync(IFileObject, FuncIFileObject, FileContentDownloadState, FuncFileContentDownloadState, CancellationToken, ValueTask, FuncIFileObject, CancellationToken, ValueTaskIFileContent, CancellationToken).
(Определяется FileExtensions.) |
| NotifyAsync |
Уведомляет источник заданного файла IFileSource о возникшем событии FileNotificationType.
Используйте при изменении свойств файла вручную, чтобы эти свойства были сохранены в пакете карточки (если файл связан с карточкой).
(Определяется 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.) |
| RenameAsync | Переименовывает файл с уведомлением его источника, если имя изменилось. (Определяется FileExtensions.) |
| ReplaceAsync(Stream, CancellationToken) | Перегружен. Заменяет контент заданного файла на контент из заданного потока. (Определяется FileExtensions.) |
| ReplaceAsync(Byte, CancellationToken) | Перегружен.
Заменяет содержимое файла на заданный массив байт.
(Определяется FileExtensions.) |
| ReplaceAsync(String, Boolean, CancellationToken) | Перегружен.
Заменяет контент заданного файла на контент файла с указанным именем.
Если отличается не только путь к указанному файлу, но и имя,
а также параметр changeName равен true,
то имя файла также будет изменено.
(Определяется FileExtensions.) |
| ReplaceAsync(FuncCancellationToken, ValueTaskStream, FuncCancellationToken, ValueTaskInt64, CancellationToken) | Перегружен. Заменяет контент заданного файла на контент, определяемый заданными функциями. (Определяется FileExtensions.) |
| ReplaceTextAsync |
Заменяет содержимое файла на заданный текст с указанием кодировки.
Содержимое файла будет сохранено во временной папке и доступно для пользователя в UI.
(Определяется FileExtensions.) |
| RestoreDownloadingContentAfterCancel |
Восстанавливает возможность асинхронной загрузки содержимого файла или версии после отмены.
При восстановлении загрузки файла также восстанавливается загрузка всех его версий.
(Определяется FileExtensions.) |
| RevertAsync | Восстанавливает контент и имя файла к виду до его изменения. (Определяется FileExtensions.) |
| SaveAsync(String, FuncIFileObject, FileContentDownloadState, FuncFileContentDownloadState, CancellationToken, ValueTask, FuncIFileObject, CancellationToken, ValueTaskIFileContent, CancellationToken) | Перегружен. Сохраняет контент заданного файла или версии файла в файле с указанным именем. (Определяется FileExtensions.) |
| SaveAsync(Stream, FuncIFileObject, FileContentDownloadState, FuncFileContentDownloadState, CancellationToken, ValueTask, FuncIFileObject, CancellationToken, ValueTaskIFileContent, CancellationToken) | Перегружен. Сохраняет контент заданного файла или версии файла в файле с указанным именем. (Определяется FileExtensions.) |
| SetActionName |
Устанавливает имя действия, в рамках которого был создан файл или версия файла.
Например: FileMenuActionNames.Scan или FileMenuActionNames.AddFromTemplate.
(Определяется FileExtensions.) |
| TryGetActualFile |
Возвращает объект IFile, соответствующей переданному файлу или файлу переданной версии.
Возвращает null, если переданный объект не является файлом IFile или версией IFileVersion.
(Определяется FileExtensions.) |
| TryGetActualVersion |
Возвращает объект IFileVersion, соответствующей переданной версии или последней версии переданного файла.
Возвращает null, если переданный объект не является файлом IFile или версией IFileVersion.
(Определяется FileExtensions.) |
См. также