var instance = new Vintasoft.Imaging.WebFileConverterJS(updateTimeout, service); var value; // Type: Vintasoft.Shared.WebRequestJS // Parameters var converterParams; // Type: object var successFunc; // Type: function var errorFunc; // Type: function value = instance.convertFileTo(converterParams, successFunc, errorFunc);
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,
errorFuncФункция, которая будет выполнена в случае неудачного запроса.: Function
Вот прототип функции "function __error(data)".
Параметр 'data' может быть:
- Объект с следующими свойствами:
, если исключение перехватывается внутри веб сервиса.
- errorMessage (string): Сообщение об ошибке.
- blocked (boolean): Указывает, что запрошенное действие заблокировано другим запросом.
- В противном случае - объект jqXHR.
) : 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
- Функция, которая будет выполнена, если запрос будет выполнен успешно.
- errorFunc
- Функция, которая будет выполнена в случае неудачного запроса.
Вот прототип функции "function __error(data)".
Параметр 'data' может быть:
- Объект с следующими свойствами:
- errorMessage (string): Сообщение об ошибке.
- blocked (boolean): Указывает, что запрошенное действие заблокировано другим запросом.
- В противном случае - объект jqXHR.
- Объект с следующими свойствами:
Return Value
Объект запроса.