CheckIn Method

Checks in a document.

Syntax

sharepoint.checkIn(remoteFile, comment, [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

The Comment parameter should contain a brief description of the changes that were made since the last checkout.

Documents may be checked out and locked for a specific user by using the CheckOut method.

The local document is specified by the LocalFile property. RemoteFile specifies the name of the document on the server. If RemoteFile is empty, LocalFile will be used as the document name on the server.