DriveState Property
The drive's storage quota state.
Syntax
onedrive.getDriveState(index, [callback])
Possible Values
0 (dsNormal), 1 (dsNearing), 2 (dsCritical), 3 (dsExceeded)
Default Value
0
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 getDriveState([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 setDriveState([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
The drive's storage quota state.
This property reflects the drive's current storage quota state. Possible values are:
0 (dsNormal) | The drive has >= 10% free space remaining. |
1 (dsNearing) | The drive has < 10% free space remaining. |
2 (dsCritical) | The drive has < 1% free space remaining. |
3 (dsExceeded) | The drive has reached or exceeded its storage quota. |
The index parameter specifies the index of the item in the array. The size of the array is controlled by the DriveCount property.
This property is read-only and not available at design time.
Data Type
Integer