Overwrite Property

Whether to overwrite the local or remote file.

Syntax

 onedrive.getOverwrite([callback])
 onedrive.setOverwrite( overwrite, [callback])

Default Value

FALSE

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 the getOverwrite([callback]) method is defined as:

function(err, data){ }

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

'data' is the value returned by the method.

The callback for the setOverwrite([callback]) 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 property specifies whether the file is overwritten. When calling DownloadFile this determines if LocalFile is overwritten. When calling UploadFile this determines if the resource is overwritten. When uploading the file can also be renamed if it already exists, see RenameIfExists for details.

Data Type

Boolean