CopyStatus Property

The status of the copy operation.

Syntax

 onedrive.getCopyStatus([callback])

Default Value

""

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 getCopyStatus([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 setCopyStatus([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 holds the status of the copy operation. This is populated after calling GetCopyInfo. Possible values are:

• "notStarted"
• "inProgress"
• "completed"
• "updating"
• "failed"
• "waiting"

This property is read-only and not available at design time.

Data Type

String