CopyResource Method

Copies the specified resource to a new location.

Syntax

box.copyResource(folderId, newResourceName, [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 copies the resource specified by ResourceId to the folder specified by the FolderId parameter.

Note: ResourceType must be set to the appropriate value before calling this method (file or folder).

The NewResourceName parameter is optional. If specified it is a new name for the resource.

Copy Examples

//Copy a file to a new folder and keep the same name
box.ResourceType = BoxResourceTypes.rtFile
box.CopyResource(new_folder_id, "");

//Copy a file to a new folder with a new name
box.ResourceType = BoxResourceTypes.rtFile
box.CopyResource(new_folder_id, "newfile.txt");

//Copy a folder and keep the same name
box.ResourceType = BoxResourceTypes.rtFolder
box.CopyResource(new_parent_folder_id, "");

//Copy a folder and use a new name
box.ResourceType = BoxResourceTypes.rtFolder
box.CopyResource(new_parent_folder_id, "newfolder");