var instance = new Vintasoft.Imaging.WebFileConverterJS(updateTimeout, service); var value; // Type: Vintasoft.Shared.WebRequestJS // Parameters var converterParams; // Type: object var successFunc; // Type: function value = instance.convertFileTo(converterParams, successFunc);
function convertFileTo(
converterParamsНастройки для преобразования файла изображения/документа.: object,
Объект со следующими свойствами:
- fileId (string): Идентификатор файла. Обязательный параметр.
- encoderSettings (object): Экземпляр класса WebImageEncoderSettingsJS, определяющий настройки энкодера. Обязательный параметр.
- password (string): Пароль к файлу. Необязательный параметр, значение по умолчанию - null.
- renderingSettings (object): Объект WebRenderingSettingsJS. Необязательный параметр, значение по умолчанию - null.
- pageSize (object): Настройки размера страницы.
- createFileInCacheFolder (boolean): Значение, указывающее, должен ли конвертированный файл быть создан в папке кэша. True - конвертированный файл должен быть создан в папке кэша (по умолчанию папка "VintasoftCache/{SessionId}/ConvertedFiles/"); False - конвертированный файл должен быть создан в папке с исходным файлом (по умолчанию папка "UploadedImageFiles/{SessionId}/"). Значение по умолчанию - True.
successFuncФункция, которая будет выполнена, если запрос будет выполнен успешно.: Function
) : WebRequestJS;
Parameters
- converterParams
- Настройки для преобразования файла изображения/документа.
Объект со следующими свойствами:
- fileId (string): Идентификатор файла. Обязательный параметр.
- encoderSettings (object): Экземпляр класса WebImageEncoderSettingsJS, определяющий настройки энкодера. Обязательный параметр.
- password (string): Пароль к файлу. Необязательный параметр, значение по умолчанию - null.
- renderingSettings (object): Объект WebRenderingSettingsJS. Необязательный параметр, значение по умолчанию - null.
- pageSize (object): Настройки размера страницы.
- createFileInCacheFolder (boolean): Значение, указывающее, должен ли конвертированный файл быть создан в папке кэша. True - конвертированный файл должен быть создан в папке кэша (по умолчанию папка "VintasoftCache/{SessionId}/ConvertedFiles/"); False - конвертированный файл должен быть создан в папке с исходным файлом (по умолчанию папка "UploadedImageFiles/{SessionId}/"). Значение по умолчанию - True.
- successFunc
- Функция, которая будет выполнена, если запрос будет выполнен успешно.
Return Value
Объект запроса.