public interface IFileConverterContext : IExtensionContextPublic Interface IFileConverterContext
Inherits IExtensionContextpublic interface class IFileConverterContext : IExtensionContexttype IFileConverterContext =
interface
interface IExtensionContext
end| CancellationToken |
Объект, посредством которого можно отменить асинхронную задачу.
(Унаследован от IExtensionContext) |
| FinalizationQueue | Список из методов обратного вызова, которые будут вызваны при завершении обработки операции по конвертации файла. В случае возникновение исключения при вызове одного из методов выполнение остальных методов не прерывается. Методы выполняются в обратном порядке. |
| GetInputContentAsync | Асинхронно предоставляет поток с контентом входного файла для конвертации. Поток обязательно должен быть освобождён с помощью метода [System.IDisposable.Dispose] или [System.IAsyncDisposable.DisposeAsync]. |
| GetOutputContentAsync | Асинхронно предоставляет поток с контентом выходного сконвертированного файла и его размером. Поток обязательно должен быть освобождён с помощью метода [System.IDisposable.Dispose] или [System.IAsyncDisposable.DisposeAsync]. |
| Info | Неструктурированная информация для цепочки расширений. Такая информация нигде не сохраняется после завершения конвертации. |
| InputExtension | Расширение для конвертируемого файла. Задаётся как расширение файла в нижнем регистре без ведущей точки. Может быть равно null или пустой строке, если у файла нет расширения. |
| Operation | Операция, в рамках которой выполняется конвертация, или null, если операция неизвестна или отсутствует. Из операции можно получить информацию по тому, какой сотрудник создал запрос на конвертацию, и, например, в соответствии с этим локализовать сообщения. |
| OutputExtension | Расширение для выходного формата файла. Задаётся как расширение файла в нижнем регистре без ведущей точки. Может быть равно null или пустой строке, если у файла нет расширения. |
| Request | Запрос на выполнение операции, в рамках которого выполняется конвертация, или null, если запрос неизвестен или отсутствует. |
| RequestInfo | Информация, полученная из запроса на выполнение операции. В отличие от свойства Request, это возвращаемое значение не равно null, причём при отсутствии информации по запросу будет получен пустой объект. |
| RequestIsSuccessful | Признак того, что запрос успешно выполнен. Проверять значение рекомендуется только в методах расширений AfterRequest. |
| RequestParameters | Параметры, полученные из запроса на выполнение операции, которые влияют на вычисление хеша запроса. Файлы, сгенерированные с разными параметрами, могут конвертироваться параллельно и могут сохраняться в кэш одновременно. В отличие от свойства Request, это возвращаемое значение не равно null, причём при отсутствии информации по запросу будет получен пустой объект. |
| ResponseInfo | Информация, передаваемая вместе с результатом выполнения операции. |
| SuggestedName | Предпочитаемое имя преобразуемого файла. |
| ValidationResult | Результат валидации, содержащий сообщения, возникающие в процессе конвертации. Если сообщения содержат ошибки, то считается, что конвертация не выполнена и выходной файл может отсутствовать. |