Class representing a folder for organizing content assets in Commerce Cloud Digital.
| Property | Description |
|---|---|
ID: String (read-only) | Returns the ID of the folder. |
content: Collection (read-only) | Returns the content objects for this folder, sorted by position. |
description: String (read-only) | Returns the description for the folder as known in the current locale or null if it cannot be found. |
displayName: String (read-only) | Returns the display name for the folder as known in the current locale or null if it cannot be found. |
online: Boolean (read-only) | Indicates if the folder is set online or offline. |
onlineContent: Collection (read-only) | Returns the online content objects for this folder, sorted by position. |
onlineSubFolders: Collection (read-only) | Returns the online subfolders of this folder, sorted by position. |
pageDescription: String (read-only) | Returns the page description for this folder using the value in the current locale, or returns null if no value was found. |
pageKeywords: String (read-only) | Returns the page keywords for this folder using the value in the current locale, or returns null if no value was found. |
pageTitle: String (read-only) | Returns the page title for this folder using the value in the current locale, or returns null if no value was found. |
pageURL: String (read-only) | Returns the page URL for this folder using the value in the current locale, or returns null if no value was found. |
parent: Folder (read-only) | Returns the parent folder of this folder. |
root: Boolean (read-only) | Indicates if this is the root folder. |
siteMapChangeFrequency: String (read-only) | Returns the folder’s sitemap change frequency. |
siteMapIncluded: Number (read-only) | Returns the folder’s sitemap inclusion. |
siteMapPriority: Number (read-only) | Returns the folder’s sitemap priority. |
subFolders: Collection (read-only) | Returns the subfolders of this folder, sorted by position. |
template: String (read-only) | Returns the name of the template used to render the folder in the store front. |
This class does not have a constructor, so you cannot create it directly.
| Method | Description |
|---|---|
| getContent() | Returns the content objects for this folder, sorted by position. |
| getDescription() | Returns the description for the folder as known in the current locale or null if it cannot be found. |
| getDisplayName() | Returns the display name for the folder as known in the current locale or null if it cannot be found. |
| getID() | Returns the ID of the folder. |
| getOnlineContent() | Returns the online content objects for this folder, sorted by position. |
| getOnlineSubFolders() | Returns the online subfolders of this folder, sorted by position. |
| getPageDescription() | Returns the page description for this folder using the value in the current locale, or returns null if no value was found. |
| getPageKeywords() | Returns the page keywords for this folder using the value in the current locale, or returns null if no value was found. |
| getPageTitle() | Returns the page title for this folder using the value in the current locale, or returns null if no value was found. |
| getPageURL() | Returns the page URL for this folder using the value in the current locale, or returns null if no value was found. |
| getParent() | Returns the parent folder of this folder. |
| getSiteMapChangeFrequency() | Returns the folder’s sitemap change frequency. |
| getSiteMapIncluded() | Returns the folder’s sitemap inclusion. |
| getSiteMapPriority() | Returns the folder’s sitemap priority. |
| getSubFolders() | Returns the subfolders of this folder, sorted by position. |
| getTemplate() | Returns the name of the template used to render the folder in the store front. |
| isOnline() | Indicates if the folder is set online or offline. |
| isRoot() | Indicates if this is the root folder. |
getCreationDate, getLastModified, getUUID
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
(read-only)Returns the ID of the folder. The ID can be used to uniquely identify a folder within any given library. This folder ID provides an alternative lookup mechanism for folders frequently used in the storefront.
(read-only)Returns the content objects for this folder, sorted by position.
(read-only)Returns the description for the folder as known in the current locale or null if it cannot be found.
(read-only)Returns the display name for the folder as known in the current locale or null if it cannot be found.
(read-only)Indicates if the folder is set online or offline. Initially, all folders are set online.
(read-only)Returns the online content objects for this folder, sorted by position.
(read-only)Returns the online subfolders of this folder, sorted by position.
(read-only)Returns the page description for this folder using the value in the current locale, or returns null if no value was found.
(read-only)Returns the page keywords for this folder using the value in the current locale, or returns null if no value was found.
(read-only)Returns the page title for this folder using the value in the current locale, or returns null if no value was found.
(read-only)Returns the page URL for this folder using the value in the current locale, or returns null if no value was found.
(read-only)Returns the parent folder of this folder.
(read-only)Indicates if this is the root folder.
(read-only)Returns the folder's sitemap change frequency.
(read-only)Returns the folder's sitemap inclusion.
(read-only)Returns the folder's sitemap priority.
(read-only)Returns the subfolders of this folder, sorted by position.
(read-only)Returns the name of the template used to render the folder in the store front.
Returns the content objects for this folder, sorted by position.
Returns:
Returns the description for the folder as known in the current locale or null if it cannot be found.
Returns:
Returns the display name for the folder as known in the current locale or null if it cannot be found.
Returns:
Returns the ID of the folder. The ID can be used to uniquely identify a folder within any given library. This folder ID provides an alternative lookup mechanism for folders frequently used in the storefront.
Returns:
Returns the online content objects for this folder, sorted by position.
Returns:
Returns the online subfolders of this folder, sorted by position.
Returns:
Returns the page description for this folder using the value in the current locale, or returns null if no value was found.
Returns:
Returns the page keywords for this folder using the value in the current locale, or returns null if no value was found.
Returns:
Returns the page title for this folder using the value in the current locale, or returns null if no value was found.
Returns:
Returns the page URL for this folder using the value in the current locale, or returns null if no value was found.
Returns:
Returns the parent folder of this folder.
Returns:
Returns the folder's sitemap change frequency.
Returns:
Returns the folder's sitemap inclusion.
Returns:
Returns the folder's sitemap priority.
Returns:
Returns the subfolders of this folder, sorted by position.
Returns:
Returns the name of the template used to render the folder in the store front.
Returns:
Indicates if the folder is set online or offline. Initially, all folders are set online.
Returns:
Indicates if this is the root folder.
Returns:
j