IPWorks Cloud 2020 Node.js Edition

Questions / Feedback?

MoveItem Method

Moves an item to a different folder.

Syntax

sharefile.moveItem(itemId, parentId, newName, [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 will move the item, specified by the ItemId string, and moves it to a new folder, specified by the ParentId. NewName specifies the new name of the item; if empty, the item's original name is used.

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

// Creates an item in a folder called Parent 1 and moves it to a folder called Parent 2 with the new name MovedTest.txt.
string ParentId1 = shareFile.CreateFolder("Parent 1", "home");
string ParentId2 = shareFile.CreateFolder("Parent 2", "home");
string ItemId = shareFile.UploadFile("Test.txt", ParentId1);

ShareFile.MoveItem(ItemId, ParentId2, "MovedTest.txt");

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