authenticateFile(string,string,function,function) Метод

В этом разделе

Sends an asynchronous request (using default web service) to a server for checking that specified password is correct for specified file on server.

Синтаксис

Javascript (Использование)
Javascript (Спецификация)

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

value = instance.authenticateFile(fileId, filePassword, successFunc, errorFunc);

function authenticateFile(
   fileIdИдентификатор файла.
 : string, 
   filePasswordПароль файла.
 : string, 
   successFuncФункция, которая будет выполнена, если запрос выполнен успешно.
 Вот прототип функции "function __success(data)".
 Параметр 'data' имеет следующие свойства:
  fileId (string): Идентификатор файла изображения.
 isAuthenticationRequired (boolean): Значение, указывающее, требует ли исходный файл изображения аутентификации.
 isCorrect (boolean): Значение, указывающее верен ли пароль для исходного файла изображения.
 
 : Function, 
   errorFuncФункция, которая будет выполнена в случае неудачного запроса.
 Вот прототип функции "function __error(data)". 
 Параметр 'data' может быть:
  Объект с следующими свойствами:
  fileId (string): Идентификатор файла изображения.
 errorMessage (string): Сообщение об ошибке.
 blocked (boolean): Указывает, что запрошенное действие заблокировано другим запросом.
 
, если исключение перехватывается внутри веб сервиса.
 Иначе, объект jqXHR.
 
 : Function
) : 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.

Исключения

Исключение	Описание
	Выбрасывается, если аргументы имеют неверные типы.

Совместимость с веб браузерами

Смотрите также

Справочник

VintasoftFileAPI Class
Члены типа VintasoftFileAPI

Отправить отзыв