UploadSessionId Property

The Id of the resumable upload session.

Syntax

 dropbox.getUploadSessionId([callback])
 dropbox.setUploadSessionId( uploadSessionId, [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 getUploadSessionId([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 setUploadSessionId([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 the Id of the resumable upload session. This is populated by the class when UseResumableUpload is set to True and UploadFile is called to initiate the upload.

This must be set when resuming an upload. See UploadFile for details.

This property is not available at design time.

Data Type

String