queue API methods Batch Content

The queue API provides the possibility to collect file and directory entries to be used with batch commands like batchDelete(), batchRename and alike. You can add entries to the batch list using e.g. listSever() for entries on FSI Server, listLocal() for local files, or adding entries using addEntries().

clearList( ):void ~> boolean

Remove all collected entries from the list.

logBatchContentSummary( ):void ~> boolean

Output a summary of the current batch content list to standard output.

logBatchContent( ):void ~> boolean

Output all entries in the current batch content list to standard output. This might be handy to check if the list contains the expected entries before running a batch command against the entries.

const queue = client.createQueue({continueOnError:false});
queue.login("user", "password");
queue.listServer("images/foo");
queue.logBatchContent();
// queue.batchDelete();
queue.logout();

// the following line actually starts the execution
queue.run();

addItemsFromDataTransferItemList(dataTransferItemList: DataTransferItemList, options: IListOptions): Promise<IListData | boolean>

Add files and folders from a dataTransferItemList to the batch content when dropping files in a browser.

addEntries(paths: string[], options: IListOptions = {recursive: true}):void ~> Promise<IListData[]>

Add items on FSI Server to the batch content by specifying their paths. The client will check each item for validity and add files or folders accordingly.

---

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.