downloadFile(string,function) Метод

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

Downloads a file from server.

Синтаксис

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

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

var value; // Type: any

// Parameters
var fileId; // Type: string
var successFunc; // Type: function

value = instance.downloadFile(fileId, successFunc);

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

Parameters

fileId

Строка, представляющая идентификатор файла, который необходимо загрузить.

successFunc

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

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

Исключения

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

Пример

JavaScript

ThisJavaScriptcodeshowshowtodownloadaspecifiedfilefromserver:
                  // download a file from server
                  docViewer1.downloadFile(
                      "pdfDocumentWithPassword.pdf",
                      function(data) {
                          console.log("File is downloaded successfully.");
                      }
                  );

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

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

Справочник

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

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