SiteLevel Property

The site level.

Syntax

 spadmin.getSiteLevel([callback])
 spadmin.setSiteLevel( siteLevel, [callback])

Possible Values

  0 (slSiteCollection), 
  1 (slSite)

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 getSiteLevel([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 setSiteLevel([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

For certain method calls, this property is used to specify the level to which the call is made within the Web Application.

This is a table to clarify the structure of the different hierarchical levels in SharePoint:


Level	Value	Description
Web Application		This is the highest object in a SharePoint installation.
Site Collection	slSiteCollection	Each Web Application must contain at least one Site Collection. The Site Collection is the root of the Web Application.
Site	slSite	A site collection may contain one or more sites.
Sub Site	slSite	Sites may contain sub sites.

The following methods use this property during execution:

Data Type

Integer