IFileBuilder - интерфейс

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

Definition

Пространство имён: Tessa.Files
Сборка: Tessa (в Tessa.dll) Версия: 4.0.4
C#
public interface IFileBuilder

Методы

AddWithNotificationAsync Создаёт файл, в случае успешного создания добавляет его в коллекцию с уведомлением источника о добавлении, а затем возвращает файл. При возникновении ошибок возвращает null, причём файл не добавляется в коллекцию. Вторым значением возвращает результат создания файла, который содержит описание возникших ошибок, если они возникли.
ReturnAsync Создаёт и возвращает файл. При возникновении ошибок возвращает null. Вторым значением возвращает результат создания файла, который содержит описание возникших ошибок, если они возникли.
SetAuthor

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

Как правило, информация по автору файла используется только в объекте файла (например, в других расширениях или в UI), т.к. стандартное API игнорирует её и использует текущего пользователя в качестве автора при сохранении в БД.

SetCategory Устанавливает категорию файла. По умолчанию создаётся файл без категории.
SetContent(FuncCancellationToken, ValueTaskIFileContent) Устанавливает функцию, создающую контент для создаваемого файла.
SetContent(FuncIFileContent, CancellationToken, ValueTask) Устанавливает действие, выполняющее инициализацию контента создаваемого файла.
SetContent(Stream) Устанавливает контент файла посредством чтения данных из заданного потока.
SetContent(String) Устанавливает контент файла по полному пути к файлу на диске. Если у создаваемого файла не было задано имя, то оно будет определено как имя файла по заданному пути.
SetFileToken Устанавливает метод, изменяющий токен на создание файла перед тем, как по нему будет создан файл.
SetModified Устанавливает дату и время последнего изменения файла, а также ID и имя автора этих изменений.
SetName Устанавливает имя файла. Имя файла можно не указывать, если контент файла определяется как путь к файлу на диске.
SetPermissions Устанавливает разрешения на файл. По умолчанию разрешения определяются источником файлов, но обычно это файл со всеми разрешениями.
SetSource Устанавливает заданный источник как используемый при создании файла. По умолчанию файл создаётся с источником, заданным при создании объекта.
SetType Устанавливает тип файла. По умолчанию тип может определяться источником файлов.
SetVersionToken Устанавливает метод, изменяющий токен на создание версии файла перед тем, как по нему будет создана версия.

Методы расширения

SetCategory Устанавливает категорию файла в виде строки без указания идентификатора категории.
(Определяется FileExtensions)
SetCategory Устанавливает категорию файла в виде строки без указания идентификатора категории.
(Определяется FileExtensions)
SetContent

Устанавливает содержимое создаваемого файла по заданному объекту контента IFileContent. Содержимое и размер создаваемого файла будут вычисляться на основании заданного объекта.

Содержимое является нелокальным, т.е. не сохраняется во временную папку. Поэтому не используйте его на клиенте, если файл будет доступен пользователю в UI.


(Определяется FileExtensions)
SetContent Устанавливает содержимое создаваемого файла по заданному массиву байт.
(Определяется FileExtensions)
SetContent

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

Содержимое является нелокальным, т.е. не сохраняется во временную папку. Поэтому не используйте его на клиенте, если файл будет доступен пользователю в UI.


(Определяется FileExtensions)
SetContent

Устанавливает содержимое создаваемого файла по функции, возвращающей контент, и по фиксированному (заранее вычисленному) размеру.

Содержимое является нелокальным, т.е. не сохраняется во временную папку. Поэтому не используйте его на клиенте, если файл будет доступен пользователю в UI.


(Определяется FileExtensions)
SetContentReadOnly

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

Содержимое является нелокальным, т.е. не сохраняется во временную папку. Поэтому не используйте его на клиенте, если файл будет доступен пользователю в UI.


(Определяется FileExtensions)
SetContentText Устанавливает содержимое создаваемого файла по заданному тексту с указанием кодировки.
(Определяется FileExtensions)

См. также