FileExtensions - методы |
Тип FileExtensions предоставляет следующие члены.
Методы| Имя | Описание | |
|---|---|---|
  | AddRangeIfNotExists |
Добавляет указанные теги в коллекцию, если они не были добавлены ранее.
|
| AddVirtualAsync(IFileContainer, VirtualFile, CancellationToken, VirtualFileVersion) |
Создаёт и добавляет виртуальный файл, возвращает созданный файл. Этот метод добавляет файл
в источник по умолчанию Source для контейнера container.
|
| AddVirtualAsync(IFileContainer, IFileSource, VirtualFile, CancellationToken, VirtualFileVersion) |
Создаёт и добавляет виртуальный файл, возвращает созданный файл. Этот метод добавляет файл в указанный источник fileSource,
что позволяет, например, добавить файл в структуру карточки CardFile, с которой не связан контейнер файлов container.
|
| AddWithNotificationAsync(ICollectionIFileSignature, IEnumerableIFileSignature, CancellationToken) |
Добавляет несколько подписей файла с уведомлением их источников Source.
При этом автоматически устанавливается свойство Added,
если тип коллекции signatures задан соответствующий.
Этот метод следует использовать для стандартного добавления новых подписей.
|
| AddWithNotificationAsync(ICollectionIFileSignature, IFileSignature, CancellationToken) |
Добавляет подпись файла с уведомлением её источника Source.
При этом автоматически устанавливается свойство Added,
если тип коллекции signatures задан соответствующий.
Этот метод следует использовать для стандартного добавления новой подписи.
|
| AddWithNotificationAsync(ICollectionIFile, IEnumerableIFile, Boolean, CancellationToken) |
Добавляет несколько файлов с уведомлением их источников Source.
Этот метод следует использовать для стандартного добавления новых файлов.
|
| AddWithNotificationAsync(ICollectionIFile, IFile, Boolean, CancellationToken) |
Добавляет файл с уведомлением его источника Source.
Этот метод следует использовать для стандартного добавления нового файла.
|
| AllocateAdditionalLocalContentAsync |
Создаёт дополнительный объект локального содержимого (на диске) для файла или версии файла.
Загрузка такого содержимого отменяется вместе с основным содержимым.
|
| BuildFile |
Возвращает объект, выполняющий поэтапное создание файла с возможностью последующего добавления в коллекцию
файлов заданного контейнера.
По умолчанию файл создаётся с использованием источника Source, заданного в контейнере.
На возвращаемом объекте IFileBuilder необходимо вызвать один из методов установки контента SetContent.
|
| CancelDownloadingContent |
Отменяет асинхронную загрузку содержимого файла или версии. При отмене загрузки файла
также отменяется загрузка всех его версий.
|
| ChangeCategoryAsync(IFile, String, CancellationToken) |
Изменяет категорию файла без указания идентификатора категории.
|
| ChangeCategoryAsync(IFile, IFileCategory, CancellationToken) |
Изменяет категорию файла и уведомляет об этом его источник,
если категория в действительности изменилась.
|
| ChangeCategoryAsync(IFile, String, Guid, CancellationToken) |
Изменяет категорию файла с указанием идентификатора категории.
|
| CopyAsync |
Создаёт копию заданного файла. Если контент копируемого файла не загружен, то он загружается перед созданием копии.
Первым значением возвращается копия заданного файла или null, если копию создать не удалось.
В этом случае возвращённый результат валидации не будет успешным.
|
| CreateFileAsync(IFileSource, Stream, String, IFileType, IFileCategory, IUser, FuncIFileCreationToken, CancellationToken, ValueTask, FuncIFileVersionCreationToken, CancellationToken, ValueTask, CancellationToken) |
Создаёт файл с указанными параметрами и единственной версией.
Возвращает созданный файл или null, если создать файл не удалось.
|
| CreateFileAsync(IFileSource, String, IFileType, IFileCategory, FuncCancellationToken, ValueTaskIFileContent, IUser, FuncIFileCreationToken, CancellationToken, ValueTask, FuncIFileVersionCreationToken, CancellationToken, ValueTask, CancellationToken) |
Создаёт файл с указанными параметрами и единственной версией.
Это вспомогательный метод, который нельзя переопределить.
Возвращает созданный файл или null, если создать файл не удалось.
|
| CreateFileAsync(IFileSource, String, IFileType, IFileCategory, FuncIFileContent, CancellationToken, ValueTask, IUser, FuncIFileCreationToken, CancellationToken, ValueTask, FuncIFileVersionCreationToken, CancellationToken, ValueTask, CancellationToken) |
Создаёт файл с указанными параметрами и единственной версией.
Это вспомогательный метод, который нельзя переопределить.
Возвращает созданный файл или null, если создать файл не удалось.
|
| CreateFileAsync(IFileSource, String, IFileType, IFileCategory, String, IUser, FuncIFileCreationToken, CancellationToken, ValueTask, FuncIFileVersionCreationToken, CancellationToken, ValueTask, CancellationToken) |
Создаёт файл с указанными параметрами и единственной версией.
Возвращает созданный файл или null, если создать файл не удалось.
|
| EnsureAllContentModifiedAsync |
Проверяет, что источник файла был уведомлён об изменениях,
сделанных для контента файла Content
для каждого из файлов в текущей коллекции.
|
| EnsureContentDownloadedAsync |
Загружает контент файла или версии файла, если он ещё не был загружен.
На загруженном контенте вызывается метод [IFileContent.EnsureLocalUpdatedAsync].
|
| EnsureContentDownloadedInUIAsync |
Загружает контент файла или версии файла, если он ещё не был загружен.
На загруженном контенте вызывается метод [IFileContent.EnsureLocalUpdatedAsync].
Изменение состояния контента выполняется в основном потоке UI, если выполнение производится на клиенте,
и в текущем потоке, если выполнение производится посредством серверного API.
|
| EnsureContentModifiedAsync |
Проверяет, что источник файла был уведомлён об изменениях,
сделанных для контента файла [IFileObject.Content].
|
| EnsureSignaturesLoadedAsync | Загружает подписи для версии файла, если они ещё не были загружены. |
| EnsureVersionsLoadedAsync | Загружает версии файла, если они ещё не были загружены. |
| GetActionName |
Возвращает имя действия, в рамках которого был создан файл или версия файла,
или null, если файл не был создан специальным способом.
|
| GetLinkAsync(IFile, CancellationToken) | Возвращает ссылку на файл. |
| GetLinkAsync(IFileVersion, CancellationToken) | Возвращает ссылку на версию файла. |
| GetNullableBytesAsync |
Возвращает бинарные данные подписи файла в виде массива байт
или null, если бинарные данные отсутствуют или ещё не загружены.
|
| GetRootedOrigin | |
| Has | Возвращает признак того, что заданный флаг установлен. |
| HasAny | Возвращает признак того, что один из заданных флагов установлен. |
| HasNot | Возвращает признак того, что заданный флаг не установлен. |
| IsLarge(IFile) |
Возвращает признак того, что содержимое версии файла считается большим файлом, поэтому будет обрабатываться особым образом.
Проверка выполняется по наличию тега Large.
|
| IsLarge(IFileVersion) |
Возвращает признак того, что содержимое версии файла считается большим файлом, поэтому будет обрабатываться особым образом.
Проверка выполняется по наличию тега Large.
|
| IsValidForContentOperations |
Возвращает признак того, что заданный объект (файл или версия файла)
может участвовать в операциях, связанных с контентом. Обычно это означает,
что при загрузке контента не возникло ошибок и контент полностью загружен на сервер
(не находится в процессе загрузки). При этом на клиент контент мог ещё не быть загружен,
т.е. потребуется вызвать EnsureContentDownloadedAsync(IFileObject, FuncIFileObject, FileContentDownloadState, FuncFileContentDownloadState, CancellationToken, ValueTask, FuncIFileObject, CancellationToken, ValueTaskIFileContent, CancellationToken).
|
| NotifyAsync(IFile, FileNotificationType, CancellationToken) |
Уведомляет источник заданного файла IFileSource о возникшем событии FileNotificationType.
Используйте при изменении свойств файла вручную, чтобы эти свойства были сохранены в пакете карточки (если файл связан с карточкой).
|
| NotifyAsync(IFileSignature, FileSignatureNotificationType, CancellationToken) |
Уведомляет источник заданной подписи IFileSource о возникшем событии FileSignatureNotificationType.
Используйте при изменении свойств подписи вручную, чтобы эти свойства были сохранены в пакете карточки (если подпись связана с карточкой).
|
| OpenAsync | Открывает контент заданного файла или версии файла для чтения или для редактирования. |
| OpenInFolderAsync | Открывает контент заданного файла или версии файла для чтения или для редактирования в окне проводника. |
| ReadAllBytesAsync |
Возвращает контент файла или версии файла в виде массива байт. Контент должен быть уже загружен методом
EnsureContentDownloadedAsync(IFileObject, FuncIFileObject, FileContentDownloadState, FuncFileContentDownloadState, CancellationToken, ValueTask, FuncIFileObject, CancellationToken, ValueTaskIFileContent, CancellationToken) или EnsureContentDownloadedInUIAsync(IFileObject, FuncIFileObject, CancellationToken, ValueTaskIFileContent, CancellationToken).
Этот метод оптимизирован по потреблению памяти, поэтому для получения данных рекомендуется использовать именно его.
|
| ReadAllTextAsync |
Возвращает контент текстового файла или версии файла в виде строки. Контент должен быть уже загружен методом
EnsureContentDownloadedAsync(IFileObject, FuncIFileObject, FileContentDownloadState, FuncFileContentDownloadState, CancellationToken, ValueTask, FuncIFileObject, CancellationToken, ValueTaskIFileContent, CancellationToken) или EnsureContentDownloadedInUIAsync(IFileObject, FuncIFileObject, CancellationToken, ValueTaskIFileContent, CancellationToken).
Этот метод оптимизирован по потреблению памяти, поэтому для получения данных рекомендуется использовать именно его.
|
| RegisterFilesOnServer |
Регистрирует API файлов в контейнере Unity со стороны сервера.
|
| RemoveWithNotificationAsync(ICollectionIFile, IEnumerableIFile, CancellationToken) |
Удаляет файлы с уведомлением их источников Source.
Этот метод следует использовать для стандартного удаления файлов.
|
| RemoveWithNotificationAsync(ICollectionIFile, IFile, CancellationToken) |
Удаляет файл с уведомлением его источника Source.
Этот метод следует использовать для стандартного удаления файла.
|
| RemoveWithNotificationAsync(ICollectionIFileSignature, IEnumerableIFileSignature, CancellationToken) |
Удаляет подписи файла с уведомлением их источников Source.
Этот метод следует использовать для стандартного удаления подписей файла.
|
| RemoveWithNotificationAsync(ICollectionIFileSignature, IFileSignature, CancellationToken) |
Удаляет подпись файла с уведомлением её источника Source.
Этот метод следует использовать для стандартного удаления подписи файла.
|
| RenameAsync | Переименовывает файл с уведомлением его источника, если имя изменилось. |
| ReplaceAsync(IFile, Byte, CancellationToken) |
Заменяет содержимое файла на заданный массив байт.
|
| ReplaceAsync(IFile, Stream, CancellationToken) | Заменяет контент заданного файла на контент из заданного потока. |
| ReplaceAsync(IFile, FuncCancellationToken, ValueTaskStream, FuncCancellationToken, ValueTaskInt64, CancellationToken) | Заменяет контент заданного файла на контент, определяемый заданными функциями. |
| ReplaceAsync(IFile, String, Boolean, CancellationToken) |
Заменяет контент заданного файла на контент файла с указанным именем.
Если отличается не только путь к указанному файлу, но и имя,
а также параметр changeName равен true,
то имя файла также будет изменено.
|
| ReplaceAsync(IFileManager, IFile, Byte, CancellationToken) |
Заменяет содержимое файла на заданный массив байт.
|
| ReplaceTextAsync(IFile, String, Encoding, CancellationToken) |
Заменяет содержимое файла на заданный текст с указанием кодировки.
Содержимое файла будет сохранено во временной папке и доступно для пользователя в UI.
|
| ReplaceTextAsync(IFileManager, IFile, String, Encoding, CancellationToken) |
Заменяет содержимое файла на заданный текст с указанием кодировки.
Содержимое файла будет сохранено во временной папке и доступно для пользователя в UI.
|
| ResolveRoot | |
| RestoreDownloadingContentAfterCancel |
Восстанавливает возможность асинхронной загрузки содержимого файла или версии после отмены.
При восстановлении загрузки файла также восстанавливается загрузка всех его версий.
|
| RevertAsync | Восстанавливает контент и имя файла к виду до его изменения. |
| SaveAsync(IFileObject, Stream, FuncIFileObject, FileContentDownloadState, FuncFileContentDownloadState, CancellationToken, ValueTask, FuncIFileObject, CancellationToken, ValueTaskIFileContent, CancellationToken) | Сохраняет контент заданного файла или версии файла в файле с указанным именем. |
| SaveAsync(IFileObject, String, FuncIFileObject, FileContentDownloadState, FuncFileContentDownloadState, CancellationToken, ValueTask, FuncIFileObject, CancellationToken, ValueTaskIFileContent, CancellationToken) | Сохраняет контент заданного файла или версии файла в файле с указанным именем. |
| SetActionName |
Устанавливает имя действия, в рамках которого был создан файл или версия файла.
Например: FileMenuActionNames.Scan или FileMenuActionNames.AddFromTemplate.
|
| SetCategory(IFileBuilder, String) |
Устанавливает категорию файла в виде строки без указания идентификатора категории.
|
| SetCategory(IFileBuilder, String, Guid) |
Устанавливает категорию файла в виде строки без указания идентификатора категории.
|
| SetContent(IFileBuilder, IFileContent) |
Устанавливает содержимое создаваемого файла по заданному объекту контента IFileContent.
Содержимое и размер создаваемого файла будут вычисляться на основании заданного объекта.
Содержимое является нелокальным, т.е. не сохраняется во временную папку.
Поэтому не используйте его на клиенте, если файл будет доступен пользователю в UI.
|
| SetContent(IFileBuilder, Byte, Boolean) |
Устанавливает содержимое создаваемого файла по заданному массиву байт.
|
| SetContent(IFileBuilder, FuncCancellationToken, ValueTaskStream, FuncCancellationToken, ValueTaskInt64) |
Устанавливает содержимое создаваемого файла по функции, возвращающей контент,
и по функции, возвращающей его размер.
Содержимое является нелокальным, т.е. не сохраняется во временную папку.
Поэтому не используйте его на клиенте, если файл будет доступен пользователю в UI.
|
| SetContent(IFileBuilder, FuncCancellationToken, ValueTaskStream, Int64) |
Устанавливает содержимое создаваемого файла по функции, возвращающей контент,
и по фиксированному (заранее вычисленному) размеру.
Содержимое является нелокальным, т.е. не сохраняется во временную папку.
Поэтому не используйте его на клиенте, если файл будет доступен пользователю в UI.
|
| SetContentReadOnly |
Устанавливает содержимое создаваемого файла на основании локального файла,
который не копируется в папку с кэшем. Рекомендуется использовать этот способ,
если файл создаётся только для чтения, например, для того, чтобы сохраниться на сервер.
Содержимое является нелокальным, т.е. не сохраняется во временную папку.
Поэтому не используйте его на клиенте, если файл будет доступен пользователю в UI.
|
| SetContentText |
Устанавливает содержимое создаваемого файла по заданному тексту с указанием кодировки.
|
| SetRemoteFromPathAsync |
Устанавливает содержимое IFileContent по физическому файлу, расположенному по заданному пути.
Метод доступен и для локального, и для нелокального (remote) содержимого.
|
| TryGetActualFile |
Возвращает объект IFile, соответствующей переданному файлу или файлу переданной версии.
Возвращает null, если переданный объект не является файлом IFile или версией IFileVersion.
|
| TryGetActualVersion |
Возвращает объект IFileVersion, соответствующей переданной версии или последней версии переданного файла.
Возвращает null, если переданный объект не является файлом IFile или версией IFileVersion.
|
| TryGetFile(IFileContainer, Guid) |
Возвращает файл, полученный по заданному идентификатору ID,
или null, если подходящий файл не был найден.
|
| TryGetFile(IFileContainer, String) |
Возвращает файл, полученный по заданному имени Name,
или null, если подходящий файл не был найден.
|
См. также