@salesforce/b2c-tooling-sdk 1.19.0 → 1.20.0

package/data/script-api/dw.customer.shoppercontext.ShopperContextMgr.md

@@ -1,209 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class ShopperContextMgr
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.customer.shoppercontext.ShopperContextMgr](dw.customer.shoppercontext.ShopperContextMgr.md)
-
-
-
-Provides static helper methods for managing Shopper Context.
-
-
-
-
-Shopper Context is used to personalize shopper experiences with context values such as custom session attributes,
-assignment qualifiers, geolocation, effective datetime, source code and more. When Shopper Context is set for a
-shopper, it can activate promotions or price books assigned to customer groups, source codes, or stores (via
-assignments) in the subsequent requests, not the current request.
-
-
-
-
-Shopper Context is used to personalize the shopper experience in case of Composable/Headless or Hybrid storefront
-implementations that use Shopper Login and API Access Service (SLAS).
-
-
-
-
-NOTE: This script API is not intended to be used for standard server-side storefront implementations. Only for
-Composable/Headless or Hybrid storefront implementations.
-
-
-
-
-Unlike [CustomerContextMgr](dw.customer.CustomerContextMgr.md) which is used to set just Effective Time for which the customer is
-shopping at, Shopper Context API provides a way to set many types of contexts such as custom session attributes,
-assignment qualifiers, geolocation, effective datetime, source code etc.
-
-
-
-
-The following feature toggles and site preferences must be enabled in order to use this script API:
-
-- Enable Shopper Context Feature
-- Hybrid Auth Settings' site preference - only in case of Hybrid storefront implementations
-
-
-
-
-
-For more details on Shopper Context please refer to: [Shopper Context
-API Overview](https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-context?meta=Summary)
-
-
-
-
-For more details on Hybrid Authentication for Hybrid storefronts please refer to:
-[Hybrid
-Authentication](https://developer.salesforce.com/docs/commerce/commerce-api/guide/hybrid-auth.html)
-
-
-
-
-[ShopperContextMgr](dw.customer.shoppercontext.ShopperContextMgr.md) is used to create, access and delete Shopper Context.
-
-- To add Shopper Context, use methods [setShopperContext(ShopperContext, Boolean)](dw.customer.shoppercontext.ShopperContextMgr.md#setshoppercontextshoppercontext-boolean).    - To access Shopper Context, use method [getShopperContext()](dw.customer.shoppercontext.ShopperContextMgr.md#getshoppercontext).        - To delete Shopper Context, use methods [removeShopperContext()](dw.customer.shoppercontext.ShopperContextMgr.md#removeshoppercontext).            - To fetch Geolocation based on clientIP already set in Shopper Context, use method [getGeolocation()](dw.customer.shoppercontext.ShopperContextMgr.md#getgeolocation)
-
-Typical usage:                
-        ```
-        // get the ShopperContext if it exists ShopperContext context = ShopperContextMgr.getShopperContext(); if (context == null) {     context = new ShopperContext(); } // set the values in the ShopperContext object context.setSourceCode( "sourcecode" ); var customQualifiers = new dw.util.HashMap(); customQualifiers.put( "deviceType", "iPad" ); context.setCustomQualifiers( customQualifiers ); // Save the ShopperContext ShopperContextMgr.setShopperContext( context, true );
-        ```
-NOTE: Ensure the ShopperContext object is saved using [setShopperContext(ShopperContext, Boolean)](dw.customer.shoppercontext.ShopperContextMgr.md#setshoppercontextshoppercontext-boolean)after        setting or updating the context values.        
-
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [geolocation](#geolocation): [Geolocation](dw.util.Geolocation.md) `(read-only)` | Gets the [Geolocation](dw.util.Geolocation.md) object for the clientIP set in  [ShopperContext](dw.customer.shoppercontext.ShopperContext.md) or null if no shopperContext is found, or no clientIP was set  or Geolocation for the clientIP was not found. |
-| [shopperContext](#shoppercontext): [ShopperContext](dw.customer.shoppercontext.ShopperContext.md) | Returns the [ShopperContext](dw.customer.shoppercontext.ShopperContext.md) if it exists for the customer. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| static [getGeolocation](dw.customer.shoppercontext.ShopperContextMgr.md#getgeolocation)() | Gets the [Geolocation](dw.util.Geolocation.md) object for the clientIP set in  [ShopperContext](dw.customer.shoppercontext.ShopperContext.md) or null if no shopperContext is found, or no clientIP was set  or Geolocation for the clientIP was not found. |
-| static [getShopperContext](dw.customer.shoppercontext.ShopperContextMgr.md#getshoppercontext)() | Returns the [ShopperContext](dw.customer.shoppercontext.ShopperContext.md) if it exists for the customer. |
-| static [removeShopperContext](dw.customer.shoppercontext.ShopperContextMgr.md#removeshoppercontext)() | Removes the [ShopperContext](dw.customer.shoppercontext.ShopperContext.md) for the customer. |
-| static [setShopperContext](dw.customer.shoppercontext.ShopperContextMgr.md#setshoppercontextshoppercontext-boolean)([ShopperContext](dw.customer.shoppercontext.ShopperContext.md), [Boolean](TopLevel.Boolean.md)) | <p>  Sets new [ShopperContext](dw.customer.shoppercontext.ShopperContext.md) for the customer or overwrites the existing context. |
-
-### Methods inherited from class Object
-
-[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
-## Property Details
-
-### geolocation
-- geolocation: [Geolocation](dw.util.Geolocation.md) `(read-only)`
-  - : Gets the [Geolocation](dw.util.Geolocation.md) object for the clientIP set in
-      [ShopperContext](dw.customer.shoppercontext.ShopperContext.md) or null if no shopperContext is found, or no clientIP was set
-      or Geolocation for the clientIP was not found.
-      
-      
-      The method throws an exception if the call fails.
-
-
-
----
-
-### shopperContext
-- shopperContext: [ShopperContext](dw.customer.shoppercontext.ShopperContext.md)
-  - : Returns the [ShopperContext](dw.customer.shoppercontext.ShopperContext.md) if it exists for the customer. Returns null if it
-      does not exist.
-
-
-
----
-
-## Method Details
-
-### getGeolocation()
-- static getGeolocation(): [Geolocation](dw.util.Geolocation.md)
-  - : Gets the [Geolocation](dw.util.Geolocation.md) object for the clientIP set in
-      [ShopperContext](dw.customer.shoppercontext.ShopperContext.md) or null if no shopperContext is found, or no clientIP was set
-      or Geolocation for the clientIP was not found.
-      
-      
-      The method throws an exception if the call fails.
-
-
-    **Throws:**
-    - dw.customer.shoppercontext.ShopperContextException - This exception is thrown if error occurs while trying              to retrieve Geolocation string from the Shopper Context.
-
-
----
-
-### getShopperContext()
-- static getShopperContext(): [ShopperContext](dw.customer.shoppercontext.ShopperContext.md)
-  - : Returns the [ShopperContext](dw.customer.shoppercontext.ShopperContext.md) if it exists for the customer. Returns null if it
-      does not exist.
-
-
-    **Returns:**
-    - The Shopper Context or null.
-
-    **Throws:**
-    - dw.customer.shoppercontext.ShopperContextException - This exception is thrown if an error occurs while              fetching the Shopper Context.
-
-
----
-
-### removeShopperContext()
-- static removeShopperContext(): void
-  - : Removes the [ShopperContext](dw.customer.shoppercontext.ShopperContext.md) for the customer.
-      
-      
-      The method throws an exception if the deletion of Shopper Context fails.
-
-
-    **Throws:**
-    - dw.customer.shoppercontext.ShopperContextException - This exception is thrown if error occurs while              deleting the Shopper Context.
-
-
----
-
-### setShopperContext(ShopperContext, Boolean)
-- static setShopperContext(shopperContext: [ShopperContext](dw.customer.shoppercontext.ShopperContext.md), evaluateContextWithClientIP: [Boolean](TopLevel.Boolean.md)): void
-  - : 
-      
-      Sets new [ShopperContext](dw.customer.shoppercontext.ShopperContext.md) for the customer or overwrites the existing context.
-      
-      
-      
-      
-      Note: This method does not save the attributes from the given Shopper Context such as - custom session
-      attributes, source code, effective date time etc., - in the current session object. These attributes are read
-      from Shopper Context and stored in the corresponding session attributes during subsequent requests and not in the
-      current request. Hence, promotions, price books etc., are triggered in subsequent requests.
-      
-      
-      If `clientIP` is set in [ShopperContext](dw.customer.shoppercontext.ShopperContext.md), the geolocation information
-      is retrieved and set in `x-geolocation` header.
-      
-      
-      And if the parameter `evaluateContextWithClientIP` is set to true, the `clientIP` will be
-      saved to the Shopper Context.
-      
-      
-      If parameter `evaluateContextWithClientIP` is set to false, the `clientIP` will not be
-      saved to the Shopper Context.
-      
-      
-      If the `geoLocation` attribute is set, it overrides any geolocation context set by
-      `clientIP`.
-
-
-    **Parameters:**
-    - shopperContext - The new Shopper Context to set. See documentation for             [ShopperContext](dw.customer.shoppercontext.ShopperContext.md)
-    - evaluateContextWithClientIP - The boolean to determine if Shopper Context should be evaluated with clientIP             address.
-
-    **Throws:**
-    - dw.customer.shoppercontext.ShopperContextException - This exception is thrown if the Shopper Context is not              saved or if validation fails.
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/dw.customer.shoppercontext.md

@@ -1,9 +0,0 @@
-# Package dw.customer.shoppercontext
-
-## Classes
-| Class | Description |
-| --- | --- |
-| [ShopperContext](dw.customer.shoppercontext.ShopperContext.md) | The class represents Shopper Context. |
-| [ShopperContextErrorCodes](dw.customer.shoppercontext.ShopperContextErrorCodes.md) | Helper class containing error codes to indicate why a Shopper Context cannot be accessed, set or modified. |
-| [ShopperContextException](dw.customer.shoppercontext.ShopperContextException.md) | This exception could be thrown by  [ShopperContextMgr.setShopperContext(ShopperContext, Boolean)](dw.customer.shoppercontext.ShopperContextMgr.md#setshoppercontextshoppercontext-boolean),  [ShopperContextMgr.getShopperContext()](dw.customer.shoppercontext.ShopperContextMgr.md#getshoppercontext) and  [ShopperContextMgr.removeShopperContext()](dw.customer.shoppercontext.ShopperContextMgr.md#removeshoppercontext) when an error occurs. |
-| [ShopperContextMgr](dw.customer.shoppercontext.ShopperContextMgr.md) | <p>  Provides static helper methods for managing Shopper Context. |

package/data/script-api/dw.experience.AspectAttributeValidationException.md

@@ -1,25 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class AspectAttributeValidationException
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.experience.AspectAttributeValidationException](dw.experience.AspectAttributeValidationException.md)
-
-This APIException is thrown by method [PageMgr.renderPage(String, Map, String)](dw.experience.PageMgr.md#renderpagestring-map-string)
-and [PageMgr.serializePage(String, Map, String)](dw.experience.PageMgr.md#serializepagestring-map-string)
-to indicate that the passed aspect attributes failed during validation against the
-definition provided through the aspect type of the page.
-
-
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-### Methods inherited from class Error
-
-[captureStackTrace](TopLevel.Error.md#capturestacktraceerror-function), [toString](TopLevel.Error.md#tostring)
-### Methods inherited from class Object
-
-[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
-<!-- prettier-ignore-end -->

package/data/script-api/dw.experience.Component.md

@@ -1,166 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class Component
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.experience.Component](dw.experience.Component.md)
-
-This class represents a page designer managed component as part of a
-page. A component comprises of multiple regions that again hold components,
-thus spanning a hierarchical tree of components. Using the [PageMgr.renderRegion(Region)](dw.experience.PageMgr.md#renderregionregion) or
-[PageMgr.renderRegion(Region, RegionRenderSettings)](dw.experience.PageMgr.md#renderregionregion-regionrendersettings) a region can be rendered which
-implicitly includes rendering of all contained visible components. All
-content attributes (defined by the corresponding component type) can be
-accessed, reading the accordant persisted values as provided by the content editor
-who created this component.
-
-
-**See Also:**
-- [Page](dw.experience.Page.md)
-- [Region](dw.experience.Region.md)
-- [PageMgr](dw.experience.PageMgr.md)
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [ID](#id): [String](TopLevel.String.md) `(read-only)` | Returns the id of this component. |
-| [name](#name): [String](TopLevel.String.md) `(read-only)` | Returns the name of this component |
-| [typeID](#typeid): [String](TopLevel.String.md) `(read-only)` | Returns the type id of this component. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getAttribute](dw.experience.Component.md#getattributestring)([String](TopLevel.String.md)) | <p>Returns the raw attribute value identified by the specified attribute id. |
-| [getID](dw.experience.Component.md#getid)() | Returns the id of this component. |
-| [getName](dw.experience.Component.md#getname)() | Returns the name of this component |
-| [getRegion](dw.experience.Component.md#getregionstring)([String](TopLevel.String.md)) | Returns the component region that matches the given id. |
-| [getTypeID](dw.experience.Component.md#gettypeid)() | Returns the type id of this component. |
-
-### Methods inherited from class Object
-
-[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
-## Property Details
-
-### ID
-- ID: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the id of this component.
-
-
----
-
-### name
-- name: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the name of this component
-
-
----
-
-### typeID
-- typeID: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the type id of this component.
-
-
----
-
-## Method Details
-
-### getAttribute(String)
-- getAttribute(attributeID: [String](TopLevel.String.md)): [Object](TopLevel.Object.md)
-  - : 
-      Returns the raw attribute value identified by the specified attribute id.
-      By raw attribute value we denote the unprocessed value as provided for the attribute
-      driven by the type of the respective attribute definition:
-      
-      - `boolean`-> boolean
-      - `category`-> string representing a catalog category ID
-      - `custom`-> [Map](dw.util.Map.md)that originates from a stringified curly brackets {} JSON object
-      - `cms_record`-> [Map](dw.util.Map.md)that originates from a stringified curly brackets {} JSON object whose entries must adhere to the `cmsrecord.json`schema
-      - `enum`-> either string or integer
-      - `file`-> string representing a file path within a library
-      - `image`-> [Map](dw.util.Map.md)that originates from a stringified curly brackets {} JSON object whose entries must adhere to the `content/schema/image.json`schema
-      - `integer`-> integer
-      - `markup`-> string representing HTML markup
-      - `page`-> string representing a page ID
-      - `product`-> string representing a product SKU
-      - `string`-> string
-      - `text`-> string
-      - `url`-> string representing a URL
-      
-      
-      
-      
-      
-      There is two places an attribute value can come from - either it was persisted at design time (e.g.
-      by the merchant by editing a component in Page Designer) or it was injected in shape of an aspect attribute at rendering time
-      through the execution of code. The persistent value, if existing, takes precedence over the injected aspect
-      attribute one. Injection of a value through an aspect attribute will only occur if the component attribute's
-      attribute definition was declared using the `"dynamic_lookup"` property and its aspect attribute alias matches
-      the ID of the respective aspect attribute.
-      
-      
-      
-      Accessing the raw value can be helpful if render and serialization logic of the
-      component needs to operate on these unprocessed values. An unprocessed value
-      might be fundamentally different from its processed counterpart, the latter being
-      provided through the content dictionary (see [ComponentScriptContext.getContent()](dw.experience.ComponentScriptContext.md#getcontent))
-      when the render/serialize function of the component is invoked.
-
-
-    **Parameters:**
-    - attributeID - the id of the desired attribute
-
-    **Returns:**
-    - the unprocessed raw value of the desired attribute, or null if not found
-
-
----
-
-### getID()
-- getID(): [String](TopLevel.String.md)
-  - : Returns the id of this component.
-
-    **Returns:**
-    - the component id
-
-
----
-
-### getName()
-- getName(): [String](TopLevel.String.md)
-  - : Returns the name of this component
-
-    **Returns:**
-    - the component name
-
-
----
-
-### getRegion(String)
-- getRegion(id: [String](TopLevel.String.md)): [Region](dw.experience.Region.md)
-  - : Returns the component region that matches the given id.
-
-    **Parameters:**
-    - id - the id of the desired component region
-
-    **Returns:**
-    - the region, or null if not found.
-
-
----
-
-### getTypeID()
-- getTypeID(): [String](TopLevel.String.md)
-  - : Returns the type id of this component.
-
-    **Returns:**
-    - the component type id
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/dw.experience.ComponentRenderSettings.md

@@ -1,130 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class ComponentRenderSettings
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.experience.ComponentRenderSettings](dw.experience.ComponentRenderSettings.md)
-
-A config that drives how the component is rendered. One can basically decide which kind of tag is used as wrapper
-element (e.g. `<div>...</div>`) and which attributes are to be placed into this wrapper
-element (e.g. `class="foo bar"`). In case no attributes are provided then the system default settings will
-apply. In case no tag name is provided then the system default one will apply.
-
-- tag\_name : div
-- attributes : {"class":"experience-component experience-\[COMPONENT\_TYPE\_ID\]"}
-
-As the \[COMPONENT\_TYPE\_ID\] can contain dots due to its package like naming scheme (e.g. assets.image)
-any occurrences of these dots will be replaced by dashes (e.g. assets-image) so that CSS selectors
-do not have to be escaped.
-
-
-**See Also:**
-- [RegionRenderSettings](dw.experience.RegionRenderSettings.md)
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [attributes](#attributes): [Object](TopLevel.Object.md) | Returns the configured attributes of the wrapper element as set by [setAttributes(Object)](dw.experience.ComponentRenderSettings.md#setattributesobject). |
-| [tagName](#tagname): [String](TopLevel.String.md) | Returns the tag name of the component wrapper element. |
-
-## Constructor Summary
-
-| Constructor | Description |
-| --- | --- |
-| [ComponentRenderSettings](#componentrendersettings)() | Creates region render settings which can then be configured further. |
-
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getAttributes](dw.experience.ComponentRenderSettings.md#getattributes)() | Returns the configured attributes of the wrapper element as set by [setAttributes(Object)](dw.experience.ComponentRenderSettings.md#setattributesobject). |
-| [getTagName](dw.experience.ComponentRenderSettings.md#gettagname)() | Returns the tag name of the component wrapper element. |
-| [setAttributes](dw.experience.ComponentRenderSettings.md#setattributesobject)([Object](TopLevel.Object.md)) | Sets the to be configured <String,String> attributes of the wrapper element. |
-| [setTagName](dw.experience.ComponentRenderSettings.md#settagnamestring)([String](TopLevel.String.md)) | Sets the tag name of the component wrapper element. |
-
-### Methods inherited from class Object
-
-[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
-## Property Details
-
-### attributes
-- attributes: [Object](TopLevel.Object.md)
-  - : Returns the configured attributes of the wrapper element as set by [setAttributes(Object)](dw.experience.ComponentRenderSettings.md#setattributesobject).
-
-
----
-
-### tagName
-- tagName: [String](TopLevel.String.md)
-  - : Returns the tag name of the component wrapper element. Defaults to 'div'.
-
-
----
-
-## Constructor Details
-
-### ComponentRenderSettings()
-- ComponentRenderSettings()
-  - : Creates region render settings which can then be configured further. They are to be used for detailed
-      configuration of a [RegionRenderSettings](dw.experience.RegionRenderSettings.md) which is subsequently used for
-      [PageMgr.renderRegion(Region, RegionRenderSettings)](dw.experience.PageMgr.md#renderregionregion-regionrendersettings) calls.
-
-
-    **See Also:**
-    - [RegionRenderSettings](dw.experience.RegionRenderSettings.md)
-
-
----
-
-## Method Details
-
-### getAttributes()
-- getAttributes(): [Object](TopLevel.Object.md)
-  - : Returns the configured attributes of the wrapper element as set by [setAttributes(Object)](dw.experience.ComponentRenderSettings.md#setattributesobject).
-
-    **Returns:**
-    - the configured attributes of the wrapper element
-
-
----
-
-### getTagName()
-- getTagName(): [String](TopLevel.String.md)
-  - : Returns the tag name of the component wrapper element. Defaults to 'div'.
-
-    **Returns:**
-    - the tag name of the component wrapper element
-
-
----
-
-### setAttributes(Object)
-- setAttributes(attributes: [Object](TopLevel.Object.md)): [ComponentRenderSettings](dw.experience.ComponentRenderSettings.md)
-  - : Sets the to be configured <String,String> attributes of the wrapper element. Set it to `null` in case
-      you want to system defaults to be applied.
-
-
-    **Parameters:**
-    - attributes - the to be configured attributes of the wrapper element
-
-    **Returns:**
-    - this
-
-
----
-
-### setTagName(String)
-- setTagName(tagName: [String](TopLevel.String.md)): [ComponentRenderSettings](dw.experience.ComponentRenderSettings.md)
-  - : Sets the tag name of the component wrapper element. Must not be empty.
-
-    **Parameters:**
-    - tagName - the tag name of the component wrapper element
-
-    **Returns:**
-    - this
-
-
----
-
-<!-- prettier-ignore-end -->