copyFile(string,function,function) Method

In This Topic

Sends an asynchronous request (using default web service) to a server for copying specified file on server to the working directory of current user.

Syntax

Javascript (Usage)
Javascript (Specification)

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

var value; // Type: any

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

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

function copyFile(
   fileIdAn identifier of file that should be downloaded.
 : 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:
  fileId (string): A file identifier.
 
 : 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
) : any;

Parameters

fileId

An identifier of file that should be downloaded.

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:

fileId (string): A file identifier.

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.

Exceptions

Exception	Description
	Thrown if arguments have wrong types.

Browser Compatibility

56+

45+

Reference

VintasoftFileAPI Class
VintasoftFileAPI Members

Send Feedback