Class: module:models/Site

module:models/Site()

new module:models/Site()

Constructs a new Site. Document representing a site.

Source:

Members

(readonly) StatusEnum :String

Allowed values for the status property.

Type:
  • String
Source:

(inner) allowed_currencies :Array.<String>

The list of allowed currencies.

Type:
  • Array.<String>
Source:

(inner) allowed_locales :Array.<module:models/Locale>

A list of all allowed site locales.

Type:
Source:

(inner) default_currency :String

The currency mnemonic of the site.

Type:
  • String
Source:

(inner) default_locale :String

The default locale of the site.

Type:
  • String
Source:

(inner) http_dis_base_url :String

The HTTP DIS base URL.

Type:
  • String
Source:

(inner) http_hostname :String

The configured HTTP host name. If no host name is configured the instance host name is returned.

Type:
  • String
Source:

(inner) http_library_content_url :String

The HTTP URL to the library content location of the site.

Type:
  • String
Source:

(inner) http_site_content_url :String

The HTTP URL to the site content location.

Type:
  • String
Source:

(inner) https_dis_base_url :String

The HTTPS DIS base URL.

Type:
  • String
Source:

(inner) https_hostname :String

The configured HTTPS host name. If no host name is configured the instance host name is returned.

Type:
  • String
Source:

(inner) https_library_content_url :String

The HTTPS URL to the library content location of the site.

Type:
  • String
Source:

(inner) https_site_content_url :String

The HTTPS URL to the site content location.

Type:
  • String
Source:

(inner) id :String

The id of the site.

Type:
  • String
Source:

(inner) name :String

The descriptive name for the site.

Type:
  • String
Source:

(inner, constant) offline

value: "offline"

Source:

(inner, constant) online

value: "online"

Source:

(inner) status :module:models/Site.StatusEnum

The site status online/offline.

Type:
  • module:models/Site.StatusEnum
Source:

(inner) timezone :String

The time zone of the site (for example, USA/Eastern).

Type:
  • String
Source:

(inner) timezone_offset :Number

The time zone offset from UTC for the current time in milliseconds (for example, -14400000).

Type:
  • Number
Source:

Methods

(static) constructFromObject(data, obj) → {module:models/Site}

Constructs a Site from a plain JavaScript object, optionally creating a new instance. Copies all relevant properties from data to obj if supplied or a new instance if not.

Parameters:
Name Type Description
data Object

The plain JavaScript object bearing properties of interest.
obj module:models/Site

Optional instance to populate.
Source:
Returns:

The populated Site instance.

Type
module:models/Site