Config2_SiteManager

Site management interface for the Version 2 API.

Instances of this class are obtained from:

Methods

MethodReturnsDescription
add() Config2_Site

Add a new site

.
get() Config2_Site

Get a site by name

.
remove() void

Remove a site

.
toArray() Array.<Config2_Site>

Get all sites as array

.

Method Details

add(templateSite, copyUsers) → {Config2_Site}

Description:

  • Add a new site

Parameters:
Name Type Description
templateSite String

Template site name to copy from
copyUsers Boolean

Whether to copy user settings
Returns:

Created site object

Type
Config2_Site

get(siteName) → {Config2_Site|null}

Description:

  • Get a site by name

Parameters:
Name Type Description
siteName String

Site name
Returns:

Site object or null if not found

Type
Config2_Site | null

remove(siteName)

Description:

  • Remove a site

Parameters:
Name Type Description
siteName String

Site name to remove

toArray() → {Array.<Config2_Site>}

Description:

  • Get all sites as array

Returns:

Array of all site objects

Type
Array.<Config2_Site>