copyFile(string,function,function,Vintasoft.Shared.WebServiceJS) Method
In This Topic
Sends an asynchronous request to a server for copying specified file on server to the working directory of current user.
Syntax
var instance = new Vintasoft.Imaging.VintasoftFileAPI();
var value; // Type: any
// Parameters
var fileId; // Type: string
var successFunc; // Type: function
var errorFunc; // Type: function
var service; // Type: WebServiceJS
value = instance.copyFile(fileId, successFunc, errorFunc, service);
function copyFile(
: string,
: Function,
: Function,
: WebServiceJS
) : 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.
- 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
See Also
