DeleteResource Method

Deletes the specified resource.

Syntax

box.deleteResource([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 deleted the resource specified by ResourceId. Before calling this method ResourceType must also be set to the appropriate value for the resource being deleted.

When deleting a folder the entire contents (including sub-directories) will be deleted.

box.ResourceId = id;
box.ResourceType = BoxResourceTypes.rtFolder;
box.DeleteResource();

When deleting a resource it will be moved to the trash. To permanently delete a resource after it has been moved to the trash call DeleteResource again.

Note: A deleted resource can be identified by checking ResourceDeleted.