IPWorks Cloud 2020 Node.js Edition

Questions / Feedback?

DeleteResource Method

Deletes a resource.

Syntax

dropbox.deleteResource(resource, [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 the resource specified by Resource.

Resource must be a path, an Id-based relative path, or a resource Id.

When deleting file resources, the IfRevision configuration setting can be set to a revision Id before calling this method. This will ensure that the server only deletes the file resource if its latest revision Id matches the one provided.

For Dropbox Business accounts, the PermanentlyDelete configuration setting can be enabled to delete resources permanently.

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