openFileWithAuthentication(Vintasoft.Shared.WebFileInfoJS,function,function) Метод

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

Sends an asynchronous request to a server, gets information (with file authentication) about images, which are stored in file on server, clears the web document viewer and adds images to the web document viewer.

Синтаксис

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

var instance = new Vintasoft.Imaging.UI.WebDocumentViewerBaseJS(settings);

var value; // Type: any

// Parameters
var fileId; // Type: WebFileInfoJS
var successFunc; // Type: function
var errorFunc; // Type: function

value = instance.openFileWithAuthentication(fileId, successFunc, errorFunc);

function openFileWithAuthentication(
   fileIdЭкземпляр класса WebFileInfoJS.
 : WebFileInfoJS, 
   successFuncФункция, которая будет выполнена, если запрос выполнен успешно.
 Вот прототип функции "function __success(data)".
 Параметр 'data' имеет следующие свойства:
  imageInfos (object): Информация об изображениях в файле изображения.
 isAuthenticationRequired (boolean): Значение, указывающее, требует ли текущий файл изображения аутентификации.
 images (object): Массив объектов WebImageJS, созданный с использованием свойства imageInfos.
 
 : Function, 
   errorFuncФункция, которая будет выполнена в случае неудачного запроса.
 Вот прототип функции "function __error(data)".
 Параметр 'data' может быть:
  Объект с следующими свойствами:
  errorMessage (string): Сообщение об ошибке.
 blocked (boolean): Указывает, что запрошенное действие заблокировано другим запросом.
 
, если исключение перехватывается внутри веб сервиса.
 В противном случае - объект jqXHR.
 
 : Function
) : any;

Parameters

fileId

Экземпляр класса WebFileInfoJS.

successFunc

Функция, которая будет выполнена, если запрос выполнен успешно.
Вот прототип функции "function __success(data)".
Параметр 'data' имеет следующие свойства:

imageInfos (object): Информация об изображениях в файле изображения.
isAuthenticationRequired (boolean): Значение, указывающее, требует ли текущий файл изображения аутентификации.
images (object): Массив объектов WebImageJS, созданный с использованием свойства imageInfos.

errorFunc

Функция, которая будет выполнена в случае неудачного запроса.
Вот прототип функции "function __error(data)".
Параметр 'data' может быть:

Объект с следующими свойствами:
- errorMessage (string): Сообщение об ошибке.
- blocked (boolean): Указывает, что запрошенное действие заблокировано другим запросом.
, если исключение перехватывается внутри веб сервиса.
В противном случае - объект jqXHR.

Ремарки

Метод вызывает событие fileOpened, если файл открыт успешно.

Пример

JavaScript

ThisJavaScriptcodeshowshowtoopenfile,whichisstoredonserverandhavepassword,inwebdocumentviewer:
                  // open file with authentication - the web document viewer will show the password dialog only if specified password is not correct
                  docViewer1.openFileWithAuthentication(
                      new Vintasoft.Shared.WebFileInfoJS("pdfDocumentWithPassword.pdf", 'password'),
                      function(data) {
                          console.log("File is opened successfully.");
                      },
                      function(data) {
                          console.log("File is not opened.");
                      }
                  );

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

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

Справочник

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

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