uploadBase64Images Method

In This Topic

Sends an asynchronous request to a server for uploading the images, which are represented by a Base64 strings, to a server.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new Vintasoft.Imaging.VintasoftFileAPI();

var value; // Type: any

// Parameters
var imagesAsBase64; // Type: string
var fileName; // Type: string
var successFunc; // Type: function
var errorFunc; // Type: function
var service; // Type: WebServiceJS

value = instance.uploadBase64Images(imagesAsBase64, fileName, successFunc, errorFunc, service);

function uploadBase64Images(
   imagesAsBase64An array of images, which are represented by Base64 strings.
 : string, 
   fileNameA name of file in which uploaded images will be saved on server.
 : string, 
   successFuncFunction that will be executed if request is executed successfully.
 Here is function prototype "function __success(data)".
 The data parameter has the following properties:
  imageInfos (object): Array with information about images (image ID and page index for each image).
 
 : Function, 
   errorFuncFunction that will be executed if request is failed.
 Here is function prototype "function __error(data)".
 The data parameter can be:
  An object with following properties:
  errorMessage (string): Error message.
 blocked (boolean): Indicates that the requested action is blocked by another request.
 
 if exception is catched inside web service. 
 Otherwise, jqXHR object.
 
 : Function, 
   serviceAn instance, of WebServiceJS class, which will serve the request of this function.
 : WebServiceJS
) : any;

Parameters

imagesAsBase64

An array of images, which are represented by Base64 strings.

fileName

A name of file in which uploaded images will be saved on server.

successFunc

Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:

imageInfos (object): Array with information about images (image ID and page index for each image).

errorFunc

Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:

An object with following properties:
- errorMessage (string): Error message.
- blocked (boolean): Indicates that the requested action is blocked by another request.
if exception is catched inside web service.
Otherwise, jqXHR object.

service

An instance, of WebServiceJS class, which will serve the request of this function.

Exceptions

Exception	Description
	Thrown if arguments have wrong types.

Browser Compatibility

56+

45+

Reference

VintasoftFileAPI Class
VintasoftFileAPI Members

Send Feedback