This class represents a site in Commerce Cloud Digital and provides access to several site-level configuration values which are managed from within the Business Manager. It is only possible to get a reference to the current site as determined by the current request. The static method getCurrent() returns a reference to the current site.
| Constant | Description |
|---|---|
| SITE_STATUS_MAINTENANCE: Number = 3 | Constant that represents the Site under maintenance/offline |
| SITE_STATUS_ONLINE: Number = 1 | Constant that represents the Site is Online |
| SITE_STATUS_PROTECTED: Number = 5 | Constant that represents the Site is in preview mode or online/password (protected) |
| Property | Description |
|---|---|
ID: String (read-only) | Returns the ID of the site. |
(read-only) | Whether oms is active in the current site. |
allSites: List (read-only) | Returns all sites. |
allowedCurrencies: List (read-only) | Returns the allowed currencies of the current site as a collection of currency codes. |
allowedLocales: List (read-only) | Returns the allowed locales of the current site as a collection of locale ID’s. |
calendar: Calendar (read-only) | Returns a new Calendar object in the time zone of the current site. |
(read-only) | Returns the default currency code for the current site. |
current: Site (read-only) | Returns the current site. |
defaultCurrency: String (read-only) | Returns the default currency code for the current site. |
defaultLocale: String (read-only) | Return default locale for the site. |
einsteinSiteID: String (read-only) | Returns the Einstein site Id. |
httpHostName: String (read-only) | Returns the configured HTTP host name. |
httpsHostName: String (read-only) | Returns the configured HTTPS host name. |
name: String (read-only) | Returns a descriptive name for the site. |
pageMetaTags: Array (read-only) | Returns all page meta tags, defined for this instance for which content can be generated. |
preferences: SitePreferences (read-only) | This method returns a container of all site preferences of this site. |
status: Number (read-only) | Returns the status of this site. |
timezone: String (read-only) | Returns the code for the time zone in which the storefront is running. |
timezoneOffset: Number (read-only) | Returns time zone offset in which the storefront is running. |
This class does not have a constructor, so you cannot create it directly.
| Method | Description |
|---|---|
| static getAllSites() | Returns all sites. |
| getAllowedCurrencies() | Returns the allowed currencies of the current site as a collection of currency codes. |
| getAllowedLocales() | Returns the allowed locales of the current site as a collection of locale ID’s. |
| static getCalendar() | Returns a new Calendar object in the time zone of the current site. |
| Returns the default currency code for the current site. | |
| static getCurrent() | Returns the current site. |
| getCustomPreferenceValue(String) | Returns a custom preference value. |
| getDefaultCurrency() | Returns the default currency code for the current site. |
| getDefaultLocale() | Return default locale for the site. |
| getEinsteinSiteID() | Returns the Einstein site Id. |
| getHttpHostName() | Returns the configured HTTP host name. |
| getHttpsHostName() | Returns the configured HTTPS host name. |
| getID() | Returns the ID of the site. |
| getName() | Returns a descriptive name for the site. |
| getPageMetaTag(String) | Returns the page meta tag for the specified id. |
| getPageMetaTags() | Returns all page meta tags, defined for this instance for which content can be generated. |
| getPreferences() | This method returns a container of all site preferences of this site. |
| getStatus() | Returns the status of this site. |
| getTimezone() | Returns the code for the time zone in which the storefront is running. |
| getTimezoneOffset() | Returns time zone offset in which the storefront is running. |
| Whether oms is active in the current site. | |
| setCustomPreferenceValue(String, Object) | The method sets a value for a custom preference. |
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
Constant that represents the Site under maintenance/offline
Constant that represents the Site is Online
Constant that represents the Site is in preview mode or online/password (protected)
(read-only)Returns the ID of the site.
(read-only)Whether oms is active in the current site. This depends on a general property which states whether oms is active for the server, and a site-dependent preference whether oms is available for the current site.
(read-only)Returns all sites.
(read-only)Returns the allowed currencies of the current site as a collection of currency codes.
(read-only)Returns the allowed locales of the current site as a collection of locale ID's.
(read-only)Returns a new Calendar object in the time zone of the current site.
(read-only)Returns the default currency code for the current site.
Deprecated:
Use getDefaultCurrency() method instead,
Warning
(read-only)Returns the current site.
(read-only)Returns the default currency code for the current site.
(read-only)Return default locale for the site.
(read-only)Returns the Einstein site Id. Typically this is a concatenation of the realm, underscore character and the site id. It can be overwritten by support users to help with realm moves to continue using the Einstein data from the old realm. Used when making calls to the Einstein APIs.
(read-only)Returns the configured HTTP host name. If no host name is configured the method returns the instance hostname.
(read-only)Returns the configured HTTPS host name. If no host name is configured the method returns the HTTP host name or the instance hostname, if that is not configured as well.
(read-only)Returns a descriptive name for the site.
(read-only)Returns all page meta tags, defined for this instance for which content can be generated.
The meta tag content is generated based on the home page meta tag context and rules. The rules are obtained from the current repository domain.
(read-only)This method returns a container of all site preferences of this site.
(read-only)Returns the status of this site.
Possible values are SITE_STATUS_ONLINE, SITE_STATUS_MAINTENANCE, SITE_STATUS_PROTECTED
(read-only)Returns the code for the time zone in which the storefront is running.
(read-only)Returns time zone offset in which the storefront is running.
Returns all sites.
Returns:
Returns the allowed currencies of the current site as a collection of currency codes.
Returns:
Returns the allowed locales of the current site as a collection of locale ID's.
Returns:
Returns a new Calendar object in the time zone of the current site.
Returns:
Returns the default currency code for the current site.
Returns:
Deprecated:
Use getDefaultCurrency() method instead,
Warning
Returns the current site.
Returns:
Returns a custom preference value. If the preference does not exist the method returns null. This method is simply a shortcut method for accessing the value for a custom attribute defined on the SitePreferences object.
1// Method #1
2var mySitePrefValue1 : String = dw.system.Site.getCurrent().
3 getCustomPreferenceValue("mySitePref");
4
5// Method #2
6var sitePrefs : SitePreferences = dw.system.Site.getCurrent().getPreferences();
7var mySitePrefValue2 : String = sitePrefs.getCustom()["mySitePref"];Parameters:
Returns:
Returns the default currency code for the current site.
Returns:
Return default locale for the site.
Returns:
Returns the Einstein site Id. Typically this is a concatenation of the realm, underscore character and the site id. It can be overwritten by support users to help with realm moves to continue using the Einstein data from the old realm. Used when making calls to the Einstein APIs.
Returns:
Returns the configured HTTP host name. If no host name is configured the method returns the instance hostname.
Returns:
Returns the configured HTTPS host name. If no host name is configured the method returns the HTTP host name or the instance hostname, if that is not configured as well.
Returns:
Returns the ID of the site.
Returns:
Returns a descriptive name for the site.
Returns:
Returns the page meta tag for the specified id.
The meta tag content is generated based on the home page meta tag context and rule. The rule is obtained from the current repository domain.
Null will be returned if the meta tag is undefined on the current instance, or if no rule can be found for the current context, or if the rule resolves to an empty string.
Parameters:
Returns:
Returns all page meta tags, defined for this instance for which content can be generated.
The meta tag content is generated based on the home page meta tag context and rules. The rules are obtained from the current repository domain.
Returns:
This method returns a container of all site preferences of this site.
Returns:
Returns the status of this site.
Possible values are SITE_STATUS_ONLINE, SITE_STATUS_MAINTENANCE, SITE_STATUS_PROTECTED
Returns:
Returns the code for the time zone in which the storefront is running.
Returns:
Returns time zone offset in which the storefront is running.
Returns:
Whether oms is active in the current site. This depends on a general property which states whether oms is active for the server, and a site-dependent preference whether oms is available for the current site.
Returns:
The method sets a value for a custom preference. The type of the value must match with the declared type of the preference definition.
Parameters:
j