Skip to content

queue API methods download

hannsolo edited this page May 6, 2020 · 2 revisions

There are 3 different types of downloads you can receive:

  • original file
  • rendered image
  • ICC color profile

public batchDownload(targetPath: string, options: IDownloadOptions = {}): void ~> Promise<boolean | string>

Downloads the files currently collected in the queue as original files or rendered images to the given local target path.
To download rendered images you need to specify options.renderOptions and the source connector of the files must be of type "storage" or "multiresolution".

const queue = client.createQueue(
  {
    continueOnError:true,
    fnProgress: FSIServerClient.defaultProgress
  }
);

queue.login("user", "password");

queue.listServer("images/foo", {recursive:true});
queue.batchDownload("myFSIServerDownloads", 
  {
    overwriteExisting:true,
    renderOptions:{
      format: "png",
      width: 400  
    } 
  }
);

queue.logout();
queue.run();

public batchDownloadICCProfiles(targetPath: string, options: IDownloadOptions = {}): void ~> Promise<boolean | string>

Downloads the ICC color profiles of the files currently collected in the queue.


Note: the methods above just add the commands to the queue. Execution starts when calling queue.run() or queue.runWithResults(). The ~> indicates the result type.
Clone this wiki locally