GetId Method

Retrieve the Document Id of the specified document.

Syntax

sharepoint.getId(remoteFile, [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, data){ }

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

'data' is the value returned by the method.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The GetId method will return the value of the Document Id for the specified RemoteFile.

Note: This is only available in the 2010 version of SharePoint and later.