IPWorks Cloud 2020 Node.js Edition

Questions / Feedback?

DeleteChildItems Method

Removes multiple items from a parent item.

Syntax

sharefile.deleteChildItems(parentId, itemIds, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method deletes multiple files or folders specified by ItemIds permanently. ParentId is the id of the parent item that contains the items that should be deleted. ItemIds is a comma separated list of ItemIds that are going to be deleted permanently. The items must be a child to the specified parent.

Note that the string root may be used as a ParentId to represent the root folder, and the string home may be used as a folder Id to represent the home folder for the current user. Other special id's include:

  • favorites
  • allshared
  • connectors
  • box
  • top

string ParentId = shareFile.CreateFolder(test, "home");
shareFile.LocalFile = "./test1.txt";
string fileId1 = shareFile.UploadFile("test1.txt", dirId);
shareFile.LocalFile = "./test2.txt";
string fileId2 = shareFile.UploadFile("test2.txt", dirId);
shareFile.DeleteChildItems(ParentId, fileId1 + "," + fileId2);

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 Node.js Edition - Version 20.0 [Build 8265]