URL Property

The server URL.

Syntax

 onedrive.getURL([callback])
 onedrive.setURL( URL, [callback])

Default Value

"https://api.onedrive.com/v1.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 getURL([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 setURL([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

This property defines the server URL.

When using the class in legacy API mode, personal OneDrive accounts should use "https://api.onedrive.com/v1.0", and OneDrive for Business accounts should use a URL in the format "https://{tenant}-my.sharepoint.com/_api/v2.0".

When using the class with the Microsoft Graph API, the URL should be "https://graph.microsoft.com/v1.0" regardless of the account type (personal, business, and education accounts are all supported by the Graph API).

The value of this property will change if you configure the class to operate in a different API mode. Refer to the UseGraphAPI configuration setting's documentation for more information.

Data Type

String