LockFile Method

Locks the specified file.

Syntax

box.lockFile(expDate, isDownloadAllowed, [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 locks the file specified by ResourceId so other users cannot modify it.

ExpDate specifies the time at which the lock expires. This parameter is required.

IsDownloadAllowed indicates whether the file can be downloaded by other users while locked.

Dates are formatted as RFC 3399 timestamps. When specifying a date in a request it should be converted to UTC for instance:

2016-04-17T09:12:36-00:00

2016-03-02T13:40:24-08:00