sfcc-dev-mcp 1.0.19 → 1.0.21

package/docs/dw_value/Quantity.md

@@ -1,376 +0,0 @@
-## Package: dw.value
-
-# Class Quantity
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.value.Quantity
-
-## Description
-
-Represents the quantity of an item.
-
-## Properties
-
-### available
-
-**Type:** boolean (Read Only)
-
-Identifies if the instance contains settings for value and unit.
-
-### decimalValue
-
-**Type:** Decimal (Read Only)
-
-The quantity as Decimal, null is returned when the quantity is not available.
-
-### unit
-
-**Type:** String (Read Only)
-
-The value for unit which identifies the
- unit of measure for the quantity. Examples of unit
- are 'inches' or 'pounds'.
-
-### value
-
-**Type:** Number (Read Only)
-
-The quantity value.
-
-## Constructor Summary
-
-Quantity(value : Number, unit : String) Creates a new quantity instance with the specified value and unit.
-
-## Method Summary
-
-### add
-
-**Signature:** `add(value : Quantity) : Quantity`
-
-Add Quantity object to the current object.
-
-### compareTo
-
-**Signature:** `compareTo(other : Quantity) : Number`
-
-Compares two Quantity values.
-
-### divide
-
-**Signature:** `divide(divisor : Number) : Quantity`
-
-Divide Quantity object by specified divisor.
-
-### equals
-
-**Signature:** `equals(other : Object) : boolean`
-
-Compares two decimal values whether they are equivalent.
-
-### getDecimalValue
-
-**Signature:** `getDecimalValue() : Decimal`
-
-Returns the quantity as Decimal, null is returned when the quantity is not available.
-
-### getUnit
-
-**Signature:** `getUnit() : String`
-
-Returns the value for unit which identifies the unit of measure for the quantity.
-
-### getValue
-
-**Signature:** `getValue() : Number`
-
-Returns the quantity value.
-
-### hashCode
-
-**Signature:** `hashCode() : Number`
-
-Calculates the hash code for a decimal.
-
-### isAvailable
-
-**Signature:** `isAvailable() : boolean`
-
-Identifies if the instance contains settings for value and unit.
-
-### isOfSameUnit
-
-**Signature:** `isOfSameUnit(value : Quantity) : boolean`
-
-Identifies if two Quantities have the same unit.
-
-### multiply
-
-**Signature:** `multiply(factor : Number) : Quantity`
-
-Multiply Quantity object by specified factor.
-
-### newQuantity
-
-**Signature:** `newQuantity(value : Decimal) : Quantity`
-
-Method returns a new instance of Quantity with the same unit but different value.
-
-### round
-
-**Signature:** `round(precision : Number) : Quantity`
-
-Rounds the Quantity value to the number of specified decimal digits.
-
-### subtract
-
-**Signature:** `subtract(value : Quantity) : Quantity`
-
-Subtract Quantity object from the current object.
-
-### toString
-
-**Signature:** `toString() : String`
-
-Returns a string representation of this quantity object.
-
-### valueOf
-
-**Signature:** `valueOf() : Object`
-
-According to the ECMA spec returns the "natural" primitive value.
-
-## Constructor Detail
-
-## Method Detail
-
-## Method Details
-
-### add
-
-**Signature:** `add(value : Quantity) : Quantity`
-
-**Description:** Add Quantity object to the current object. Only objects representing the same unit can be added.
-
-**Parameters:**
-
-- `value`: Quantity object
-
-**Returns:**
-
-Quantity object representing the sum of the operands
-
----
-
-### compareTo
-
-**Signature:** `compareTo(other : Quantity) : Number`
-
-**Description:** Compares two Quantity values. An exception is thrown if the two Quantities values are of different unit. If one of the Quantity values represents the N/A value it is treated as 0.0.
-
-**Parameters:**
-
-- `other`: the other quantity to compare.
-
-**Returns:**
-
-the comparison.
-
----
-
-### divide
-
-**Signature:** `divide(divisor : Number) : Quantity`
-
-**Description:** Divide Quantity object by specified divisor.
-
-**Parameters:**
-
-- `divisor`: divisor
-
-**Returns:**
-
-Quantity object representing division result
-
----
-
-### equals
-
-**Signature:** `equals(other : Object) : boolean`
-
-**Description:** Compares two decimal values whether they are equivalent.
-
-**Parameters:**
-
-- `other`: the object to compare against this quantity instance.
-
-**Returns:**
-
-true if equal, false otherwise.
-
----
-
-### getDecimalValue
-
-**Signature:** `getDecimalValue() : Decimal`
-
-**Description:** Returns the quantity as Decimal, null is returned when the quantity is not available.
-
-**Returns:**
-
-the quantity as Decimal
-
----
-
-### getUnit
-
-**Signature:** `getUnit() : String`
-
-**Description:** Returns the value for unit which identifies the unit of measure for the quantity. Examples of unit are 'inches' or 'pounds'.
-
-**Returns:**
-
-the unit value.
-
----
-
-### getValue
-
-**Signature:** `getValue() : Number`
-
-**Description:** Returns the quantity value.
-
-**Returns:**
-
-the quantity value.
-
-**See Also:**
-
-getDecimalValue()
-
----
-
-### hashCode
-
-**Signature:** `hashCode() : Number`
-
-**Description:** Calculates the hash code for a decimal.
-
-**Returns:**
-
-the hash code.
-
----
-
-### isAvailable
-
-**Signature:** `isAvailable() : boolean`
-
-**Description:** Identifies if the instance contains settings for value and unit.
-
-**Returns:**
-
-true if the instance is initialized with value and unit, false if the state is 'not available'.
-
----
-
-### isOfSameUnit
-
-**Signature:** `isOfSameUnit(value : Quantity) : boolean`
-
-**Description:** Identifies if two Quantities have the same unit.
-
-**Parameters:**
-
-- `value`: the second quantity for the comparison.
-
-**Returns:**
-
-true if both quantities have the same unit, false otherwise.
-
----
-
-### multiply
-
-**Signature:** `multiply(factor : Number) : Quantity`
-
-**Description:** Multiply Quantity object by specified factor.
-
-**Parameters:**
-
-- `factor`: multiplication factor
-
-**Returns:**
-
-Quantity object representing multiplication result
-
----
-
-### newQuantity
-
-**Signature:** `newQuantity(value : Decimal) : Quantity`
-
-**Description:** Method returns a new instance of Quantity with the same unit but different value. An N/A instance is returned if value is null.
-
-**Parameters:**
-
-- `value`: as a decimal
-
-**Returns:**
-
-new Quantity instance with same unit
-
----
-
-### round
-
-**Signature:** `round(precision : Number) : Quantity`
-
-**Description:** Rounds the Quantity value to the number of specified decimal digits.
-
-**Parameters:**
-
-- `precision`: number of decimal digits after the decimal point
-
-**Returns:**
-
-the new rounded Quantity value
-
----
-
-### subtract
-
-**Signature:** `subtract(value : Quantity) : Quantity`
-
-**Description:** Subtract Quantity object from the current object. Only objects representing the same unit can be subtracted.
-
-**Parameters:**
-
-- `value`: Quantity object to subtract
-
-**Returns:**
-
-Quantity object representing the result of subtraction
-
----
-
-### toString
-
-**Signature:** `toString() : String`
-
-**Description:** Returns a string representation of this quantity object.
-
-**Returns:**
-
-a string representation of this quantity object.
-
----
-
-### valueOf
-
-**Signature:** `valueOf() : Object`
-
-**Description:** According to the ECMA spec returns the "natural" primitive value. Here the value portion of the Quantity is returned.
-
----

package/docs/dw_web/CSRFProtection.md

@@ -1,83 +0,0 @@
-## Package: dw.web
-
-# Class CSRFProtection
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.web.CSRFProtection
-
-## Description
-
-Used to generate and validate CSRF tokens. CSRFProtection allows applications to protect themselves against CSRF attacks, using synchronizer tokens, a best practice. Once created, these tokens are tied to a user’s session and valid for 60 minutes. Usage: Adding CSRF token to forms: //CSRF token generation <form ... action="<protected location>"> <input name="foo" value="bar"> <input name="${dw.web.CSRFProtection.getTokenName()}" value="${dw.web.CSRFProtection.generateToken()"> </form> Then, in scripts call: dw.web.CSRFProtection.validateRequest();
-
-## Properties
-
-### tokenName
-
-**Type:** String (Read Only)
-
-The system generated CSRF token name. Currently, this name is not user configurable. Must be used for
- validateRequest() to work
-
-## Constructor Summary
-
-## Method Summary
-
-### generateToken
-
-**Signature:** `static generateToken() : String`
-
-Constructs a new unique CSRF token for this session.
-
-### getTokenName
-
-**Signature:** `static getTokenName() : String`
-
-Returns the system generated CSRF token name.
-
-### validateRequest
-
-**Signature:** `static validateRequest() : boolean`
-
-Verifies that a client request contains a valid CSRF token, and that the token has not expired.
-
-## Method Detail
-
-## Method Details
-
-### generateToken
-
-**Signature:** `static generateToken() : String`
-
-**Description:** Constructs a new unique CSRF token for this session.
-
-**Returns:**
-
-a new CSRF token
-
----
-
-### getTokenName
-
-**Signature:** `static getTokenName() : String`
-
-**Description:** Returns the system generated CSRF token name. Currently, this name is not user configurable. Must be used for validateRequest() to work
-
-**Returns:**
-
-System-generated CSRF token parameter name
-
----
-
-### validateRequest
-
-**Signature:** `static validateRequest() : boolean`
-
-**Description:** Verifies that a client request contains a valid CSRF token, and that the token has not expired. Returns true if these conditions are met, and false otherwise
-
-**Returns:**
-
-true if request contains a valid CSRF token, false otherwise
-
----

package/docs/dw_web/ClickStream.md

@@ -1,157 +0,0 @@
-## Package: dw.web
-
-# Class ClickStream
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.web.ClickStream
-
-## Description
-
-Represents the click stream in the session. A maximum number of 50 clicks is recorded per session. After the maximum is reached, each time the customer clicks on a new link, the oldest click stream entry is purged. The ClickStream always remembers the first click. The click stream is consulted when the GetLastVisitedProducts pipelet is called to retrieve the products that the customer has recently visited.
-
-## Properties
-
-### clicks
-
-**Type:** List (Read Only)
-
-A collection with all clicks. The first entry is the oldest
- entry. The last entry is the latest entry. The method returns a copy of
- the click stream, which makes it safe to work with the click stream,
- while it might be modified.
-
-### enabled
-
-**Type:** Session.isTrackingAllowed() (Read Only)
-
-Identifies if the clickstream recording is enabled or not.
- It is considered enabled if either:
- the method Session.isTrackingAllowed() returns true
- or if the above method returns false but the preference 'ClickstreamHonorDNT' is set to false.
- 
- When clickstream tracking is not enabled the getFirst() method still operates as expected
- but the rest of the clicks are not collected.
-
-### first
-
-**Type:** ClickStreamEntry (Read Only)
-
-The first click within this session. This first click
- is stored independent of whether entries are purged.
-
-### last
-
-**Type:** ClickStreamEntry (Read Only)
-
-The last recorded click stream, which is also typically
- the current click. In where rare cases (e.g. RedirectURL pipeline) this
- is not the current click, but instead the last recorded click.
-
-### partial
-
-**Type:** boolean (Read Only)
-
-Identifies if this is only a partial click stream. If the maximum number
- of clicks (50) is recorded, the oldest entry is automatically purged with
- each additional click. In this case, this flag indicates that the click
- stream is only partial.
-
-## Constructor Summary
-
-## Method Summary
-
-### getClicks
-
-**Signature:** `getClicks() : List`
-
-Returns a collection with all clicks.
-
-### getFirst
-
-**Signature:** `getFirst() : ClickStreamEntry`
-
-Returns the first click within this session.
-
-### getLast
-
-**Signature:** `getLast() : ClickStreamEntry`
-
-Returns the last recorded click stream, which is also typically the current click.
-
-### isEnabled
-
-**Signature:** `isEnabled() : boolean`
-
-Identifies if the clickstream recording is enabled or not.
-
-### isPartial
-
-**Signature:** `isPartial() : boolean`
-
-Identifies if this is only a partial click stream.
-
-## Method Detail
-
-## Method Details
-
-### getClicks
-
-**Signature:** `getClicks() : List`
-
-**Description:** Returns a collection with all clicks. The first entry is the oldest entry. The last entry is the latest entry. The method returns a copy of the click stream, which makes it safe to work with the click stream, while it might be modified.
-
-**Returns:**
-
-a collection of ClickStreamEntry instances, sorted chronologically.
-
----
-
-### getFirst
-
-**Signature:** `getFirst() : ClickStreamEntry`
-
-**Description:** Returns the first click within this session. This first click is stored independent of whether entries are purged.
-
-**Returns:**
-
-the first click within this session.
-
----
-
-### getLast
-
-**Signature:** `getLast() : ClickStreamEntry`
-
-**Description:** Returns the last recorded click stream, which is also typically the current click. In where rare cases (e.g. RedirectURL pipeline) this is not the current click, but instead the last recorded click.
-
-**Returns:**
-
-the last recorded click stream, which is also typically the current click.
-
----
-
-### isEnabled
-
-**Signature:** `isEnabled() : boolean`
-
-**Description:** Identifies if the clickstream recording is enabled or not. It is considered enabled if either: the method Session.isTrackingAllowed() returns true or if the above method returns false but the preference 'ClickstreamHonorDNT' is set to false. When clickstream tracking is not enabled the getFirst() method still operates as expected but the rest of the clicks are not collected.
-
-**Returns:**
-
-whether clickstream tracking is enabled
-
----
-
-### isPartial
-
-**Signature:** `isPartial() : boolean`
-
-**Description:** Identifies if this is only a partial click stream. If the maximum number of clicks (50) is recorded, the oldest entry is automatically purged with each additional click. In this case, this flag indicates that the click stream is only partial.
-
-**Returns:**
-
-true if this click stream is partial, false otherwise.
-
----