authenticateFile(string,string,function,function,Vintasoft.Shared.WebServiceJS) Метод
В этом разделе
Отправляет асинхронный запрос на сервер для проверки правильности указанного пароля для указанного файла на сервере.
Синтаксис
var instance = new Vintasoft.Imaging.VintasoftFileAPI();
var value; // Type: any
// Parameters
var fileId; // Type: string
var filePassword; // Type: string
var successFunc; // Type: function
var errorFunc; // Type: function
var service; // Type: WebServiceJS
value = instance.authenticateFile(fileId, filePassword, successFunc, errorFunc, service);
function authenticateFile(
: string,
: string,
: Function,
: Function,
: WebServiceJS
) : any;
Parameters
- fileId
- Идентификатор файла.
- filePassword
- Пароль к файлу.
- successFunc
- Функция, которая будет выполнена, если запрос выполнен успешно.
Вот прототип функции "function __success(data)".
Параметр 'data' имеет следующие свойства:
- fileId (string): Идентификатор файла изображения.
- isAuthenticationRequired (boolean): Значение, указывающее, требует ли исходный файл изображения аутентификации.
- isCorrect (boolean): Значение, указывающее верен ли пароль для исходного файла изображения.
- errorFunc
- Функция, которая будет выполнена в случае неудачного запроса.
Вот прототип функции "function __error(data) )".
Параметр 'data' может быть:
- Объект с следующими свойствами:
- fileId (string): Идентификатор файла изображения.
- errorMessage (string): Сообщение об ошибке.
- blocked (boolean): Указывает, что запрошенное действие заблокировано другим запросом.
, если исключение перехватывается внутри веб сервиса. - Иначе - объект jqXHR.
- service
- Экземпляр класса WebServiceJS, который будет обслуживать запросы этой функции.
Исключения
| Исключение | Описание |
|---|
| Выбрасывается, если аргументы имеют неправильный тип. |
Совместимость с веб браузерами
Смотрите также
