IFileConverterComposer - интерфейс

Объект, выполнющий пошаговое преобразование файлов из одного формата в другой.

Definition

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

Методы

BeginConversionAsync Запускает процесс конвертации файла карточки в заданный формат и возвращает идентификатор операции, по которой можно контролировать ход конвертации. Вторым полем возвращает новое значение параметра requestHash. Файл после конвертации обычно помещается в кэш, но этот метод всегда создаёт новую операцию по конвертации, даже если конвертация этой версии файла уже была выполнена и содержится в кэше.
CalculateHashВычисляет хеш запроса, который может использоваться при обращении к кэшу.
DeleteFileAsync Удаляет сконвертированный файл из кэша файлов, если он там присутствует. Возвращает результат удаления с сообщениями об ошибках и предупреждениями, а также признак того, был ли файл в кэше на момент вызова метода. Используйте метод в таких сценариях, как конвертация, инициируемая с веб-сервиса, но фактически выполняемая в плагине Chronos, где кэш файлов требуется как способ передачи содержимого файла после конвертации. Если известно, что операция по конвертации уникальна и результат конвертации не будет нужен, то посредством этого метода можно удалить содержимое файла из кэша файлов.
EndConversionAsync Возвращает результат конвертации, который предоставляет доступ к содержимому файла, для которого была выполнена конвертация. После выполнения функции операция удаляется, поэтому повторный вызов метода возвращает ошибку. Результат всегда не равен null, ошибки и исключения будут сохранены в объекте результата.
InProgressAsync Возвращает признак того, что операция по конвертации запущена и ещё выполняется. Возвращает false, если операция завершилась или она была удалена (например, администратором).
TryConvertFromCacheAsync Возвращает результат конвертации, который предоставляет доступ к потоку файла, для которого была выполнена конвертация, но только если выходной файл присутствует в кэше на момент вызова, т.е. конвертация выполнялась ранее. В противном случае возвращает null, т.е. для получения файла потребуется выполнить конвертацию. Вторым полем возвращает новое значение параметра requestHash.
TryConvertFromCacheOrBeginConversionAsync Возвращает результат конвертации, если объект доступен через кэш, или null, если объект недоступен, и был запущен асинхронный процесс конвертации файла карточки в заданный формат, и возвращает идентификатор операции, по которой можно контролировать ход конвертации. Файл после конвертации обычно помещается в кэш. Вторым полем возвращает идентификатор операции, по которой можно контролировать ход конвертации. Он актуален только в том случае, если метод первым полем вернул null, т.е. не удалось получить значение из кэша.

См. также