ListDrives Method

List drives available to the user.

Syntax

onedrive.listDrives([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 lists drives available to the user.

After calling this method DriveCount will be populated with the number of drives available. DriveIndex may be set to any value from 0 to DriveCount to select a drive. By default the DriveIndex is automatically set to 0 to select the first drive returned. After calling this method the following properties may be queried to obtain information about the drive:

If the class is using the Graph API (UseGraphAPI is set to True), and you authenticated with a Microsoft business or education account, this method will list the drives of a user's groups by default. You can change what ListGroupDrives is set to to control this behavior. (For personal Microsoft accounts, the only drive ever returned is the user's default drive.)