VintaSoft Twain .NET SDK 15.0: Documentation for Web developer
Vintasoft.Shared Namespace / WebImageCollectionJS type / openFiles Methods / openFiles(string[],function,function) Property
Syntax BrowserCompatibility SeeAlso
In This Topic
    openFiles(string[],function,function) Method
    In This Topic
    Sends an asynchronous request to a server, gets information about images, which are stored in files on server, and clears the image collection and adds images to the image collection. Function uses web service specified by WebServiceJS.defaultImageCollectionService property.
    Syntax
    var instance = new Vintasoft.Shared.WebImageCollectionJS();
    
    var value; // Type: any
    
    // Parameters
    var fileIds; // Type: string[]
    var successFunc; // Type: function
    var errorFunc; // Type: function
    
    value = instance.openFiles(fileIds, successFunc, errorFunc);
    
    
    function openFiles(
    fileIds
    An array of strings, which represent file identifiers.
    : string[],
    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:
    • files (object): Array of informations about images in image files. Information is object with following properties:
      • imageInfos (object): Information about images in image file.
      • isAuthenticationRequired (boolean): A value indicating whether current image file requres authentication.
    • images (object): An array of WebImageJS objects created using imageInfos property from all files.
    : Function,
    errorFunc
    Function that will be executed if request is failed.
    Here is function prototype "function __error(data)".
    The data parameter can be:
    1. 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.
    2. Otherwise, jqXHR object.
    : Function
    ) : any;

    Parameters

    fileIds
    An array of strings, which represent file identifiers.
    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:
    • files (object): Array of informations about images in image files. Information is object with following properties:
      • imageInfos (object): Information about images in image file.
      • isAuthenticationRequired (boolean): A value indicating whether current image file requres authentication.
    • images (object): An array of WebImageJS objects created using imageInfos property from all files.
    errorFunc
    Function that will be executed if request is failed.
    Here is function prototype "function __error(data)".
    The data parameter can be:
    1. 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.
    2. Otherwise, jqXHR object.
    Browser Compatibility
    9
    See Also