URL Property

The base URL for the site.

Syntax

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

Default Value

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

The following are examples of valid URLs:

http://server/SharePoint/
http://server/Sites/mysite/
http://server:90/

The class will used URL as base from which to derive URLs for other calls to the server. If you need to override the complete URL for a specific service, you can use the SiteURL configuration setting.

Data Type

String