sfcc-dev-mcp 1.0.19 → 1.0.20

package/docs/dw_web/ClickStreamEntry.md

@@ -1,289 +0,0 @@
-## Package: dw.web
-
-# Class ClickStreamEntry
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.web.ClickStreamEntry
-
-## Description
-
-Represent an entry in the click stream.
-
-## Properties
-
-### host
-
-**Type:** String (Read Only)
-
-The host.
-
-### locale
-
-**Type:** String (Read Only)
-
-The locale sent from the user agent.
-
-### path
-
-**Type:** String (Read Only)
-
-The path.
-
-### pipelineName
-
-**Type:** String (Read Only)
-
-The name of the called pipeline. In most cases the
- name can be derived from the path, but not in all cases. If with
- URL rewritting a special landing page is defined for a DNS name, than
- the system internally might use a specific pipeline associated with
- this landing page.
-
-### queryString
-
-**Type:** String (Read Only)
-
-The query string.
-
-### referer
-
-**Type:** String (Read Only)
-
-The referer.
-
-### remoteAddress
-
-**Type:** String (Read Only)
-
-The remote address.
-
-### timestamp
-
-**Type:** Number (Read Only)
-
-The entry's timestamp.
-
-### url
-
-**Type:** String (Read Only)
-
-The full URL for this click. The URL is returned as relative
- URL.
-
-### userAgent
-
-**Type:** String (Read Only)
-
-The user agent.
-
-## Constructor Summary
-
-## Method Summary
-
-### getHost
-
-**Signature:** `getHost() : String`
-
-Returns the host.
-
-### getLocale
-
-**Signature:** `getLocale() : String`
-
-Returns the locale sent from the user agent.
-
-### getParameter
-
-**Signature:** `getParameter(name : String) : String`
-
-Returns a specific parameter value from the stored query string.
-
-### getPath
-
-**Signature:** `getPath() : String`
-
-Returns the path.
-
-### getPipelineName
-
-**Signature:** `getPipelineName() : String`
-
-Returns the name of the called pipeline.
-
-### getQueryString
-
-**Signature:** `getQueryString() : String`
-
-Returns the query string.
-
-### getReferer
-
-**Signature:** `getReferer() : String`
-
-Returns the referer.
-
-### getRemoteAddress
-
-**Signature:** `getRemoteAddress() : String`
-
-Returns the remote address.
-
-### getTimestamp
-
-**Signature:** `getTimestamp() : Number`
-
-Returns the entry's timestamp.
-
-### getUrl
-
-**Signature:** `getUrl() : String`
-
-Returns the full URL for this click.
-
-### getUserAgent
-
-**Signature:** `getUserAgent() : String`
-
-Returns the user agent.
-
-## Method Detail
-
-## Method Details
-
-### getHost
-
-**Signature:** `getHost() : String`
-
-**Description:** Returns the host.
-
-**Returns:**
-
-the host.
-
----
-
-### getLocale
-
-**Signature:** `getLocale() : String`
-
-**Description:** Returns the locale sent from the user agent.
-
-**Returns:**
-
-the locale sent from the user agent.
-
----
-
-### getParameter
-
-**Signature:** `getParameter(name : String) : String`
-
-**Description:** Returns a specific parameter value from the stored query string. The method can be used to extract a source code or affiliate id out of the URLs in the click stream. The method returns null if there is no parameter with the given name.
-
-**Parameters:**
-
-- `name`: the name of the parameter.
-
-**Returns:**
-
-the value associated with the specified parameter, or null.
-
----
-
-### getPath
-
-**Signature:** `getPath() : String`
-
-**Description:** Returns the path.
-
-**Returns:**
-
-the path.
-
----
-
-### getPipelineName
-
-**Signature:** `getPipelineName() : String`
-
-**Description:** Returns the name of the called pipeline. In most cases the name can be derived from the path, but not in all cases. If with URL rewritting a special landing page is defined for a DNS name, than the system internally might use a specific pipeline associated with this landing page.
-
-**Returns:**
-
-the name of the called pipeline.
-
----
-
-### getQueryString
-
-**Signature:** `getQueryString() : String`
-
-**Description:** Returns the query string.
-
-**Returns:**
-
-the query string.
-
----
-
-### getReferer
-
-**Signature:** `getReferer() : String`
-
-**Description:** Returns the referer.
-
-**Returns:**
-
-the referer.
-
----
-
-### getRemoteAddress
-
-**Signature:** `getRemoteAddress() : String`
-
-**Description:** Returns the remote address.
-
-**Returns:**
-
-the remote address.
-
----
-
-### getTimestamp
-
-**Signature:** `getTimestamp() : Number`
-
-**Description:** Returns the entry's timestamp.
-
-**Returns:**
-
-the entry's timestamp.
-
----
-
-### getUrl
-
-**Signature:** `getUrl() : String`
-
-**Description:** Returns the full URL for this click. The URL is returned as relative URL.
-
-**Returns:**
-
-the full URL for this click.
-
----
-
-### getUserAgent
-
-**Signature:** `getUserAgent() : String`
-
-**Description:** Returns the user agent.
-
-**Returns:**
-
-the user agent.
-
----

package/docs/dw_web/Cookie.md

@@ -1,396 +0,0 @@
-## Package: dw.web
-
-# Class Cookie
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.web.Cookie
-
-## Description
-
-Represents an HTTP cookie used for storing information on a client browser. Cookies are passed along in the HTTP request and can be retrieved by calling dw.system.Request.getHttpCookies(). Cookies must comply with RFC6265. We recommend you use only printable ASCII characters without separators, such as a comma or equal sign. If JSON is used as a cookie value, it must be encoded. Note: this class allows access to sensitive security-related data. Pay special attention to PCI DSS v3. requirements 2, 4, and 12. See Request.getHttpCookies().
-
-## Constants
-
-### EMPTYNAME
-
-**Type:** String = "dw_emptyname__"
-
-Default name for cookies with empty strings.
-
-## Properties
-
-### comment
-
-**Type:** String
-
-The comment associated with the cookie.
-
-### domain
-
-**Type:** String
-
-The domain associated with the cookie.
-
-### httpOnly
-
-**Type:** boolean
-
-Identifies if the cookie is http-only.
-
-### maxAge
-
-**Type:** Number
-
-The maximum age of the cookie, specified in seconds.
- By default, -1 indicating the cookie will persist until client shutdown.
-
-### name
-
-**Type:** String (Read Only)
-
-The cookie's name.
-
-### path
-
-**Type:** String
-
-The path for the cookie.
-
-### secure
-
-**Type:** boolean
-
-Identifies if the cookie is secure.
-
-### value
-
-**Type:** String
-
-The cookie's value.
-
-### version
-
-**Type:** Number
-
-The version for the cookie. 0 means original Netscape cookie and
- 1 means RFC 2109 compliant cookie.
-
-## Constructor Summary
-
-Cookie(name : String, value : String) Constructs a new cookie using the specified name and value.
-
-## Method Summary
-
-### getComment
-
-**Signature:** `getComment() : String`
-
-Returns the comment associated with the cookie.
-
-### getDomain
-
-**Signature:** `getDomain() : String`
-
-Returns the domain associated with the cookie.
-
-### getMaxAge
-
-**Signature:** `getMaxAge() : Number`
-
-Returns the maximum age of the cookie, specified in seconds.
-
-### getName
-
-**Signature:** `getName() : String`
-
-Returns the cookie's name.
-
-### getPath
-
-**Signature:** `getPath() : String`
-
-Returns the path for the cookie.
-
-### getSecure
-
-**Signature:** `getSecure() : boolean`
-
-Identifies if the cookie is secure.
-
-### getValue
-
-**Signature:** `getValue() : String`
-
-Returns the cookie's value.
-
-### getVersion
-
-**Signature:** `getVersion() : Number`
-
-Returns the version for the cookie.
-
-### isHttpOnly
-
-**Signature:** `isHttpOnly() : boolean`
-
-Identifies if the cookie is http-only.
-
-### setComment
-
-**Signature:** `setComment(comment : String) : void`
-
-Sets the comment associated with the cookie.
-
-### setDomain
-
-**Signature:** `setDomain(domain : String) : void`
-
-Sets the domain associated with the cookie.
-
-### setHttpOnly
-
-**Signature:** `setHttpOnly(httpOnly : boolean) : void`
-
-Sets the http-only state for the cookie.
-
-### setMaxAge
-
-**Signature:** `setMaxAge(age : Number) : void`
-
-Sets the maximum age of the cookie in seconds.
-
-### setPath
-
-**Signature:** `setPath(path : String) : void`
-
-Sets the path for the cookie.
-
-### setSecure
-
-**Signature:** `setSecure(secure : boolean) : void`
-
-Sets the secure state for the cookie.
-
-### setValue
-
-**Signature:** `setValue(value : String) : void`
-
-Sets the cookie's value.
-
-### setVersion
-
-**Signature:** `setVersion(version : Number) : void`
-
-Sets the version for the cookie.
-
-## Constructor Detail
-
-## Method Detail
-
-## Method Details
-
-### getComment
-
-**Signature:** `getComment() : String`
-
-**Description:** Returns the comment associated with the cookie.
-
-**Returns:**
-
-the comment associated with the cookie.
-
----
-
-### getDomain
-
-**Signature:** `getDomain() : String`
-
-**Description:** Returns the domain associated with the cookie.
-
-**Returns:**
-
-the domain associated with the cookie.
-
----
-
-### getMaxAge
-
-**Signature:** `getMaxAge() : Number`
-
-**Description:** Returns the maximum age of the cookie, specified in seconds. By default, -1 indicating the cookie will persist until client shutdown.
-
-**Returns:**
-
-an integer specifying the maximum age of the cookie in seconds; if negative, means the cookie persists until client shutdown
-
----
-
-### getName
-
-**Signature:** `getName() : String`
-
-**Description:** Returns the cookie's name.
-
-**Returns:**
-
-the cookie's name.
-
----
-
-### getPath
-
-**Signature:** `getPath() : String`
-
-**Description:** Returns the path for the cookie.
-
-**Returns:**
-
-the path for the cookie.
-
----
-
-### getSecure
-
-**Signature:** `getSecure() : boolean`
-
-**Description:** Identifies if the cookie is secure.
-
-**Returns:**
-
-true if the cookie is secure, false otherwise.
-
----
-
-### getValue
-
-**Signature:** `getValue() : String`
-
-**Description:** Returns the cookie's value.
-
-**Returns:**
-
-the cookie's value.
-
----
-
-### getVersion
-
-**Signature:** `getVersion() : Number`
-
-**Description:** Returns the version for the cookie. 0 means original Netscape cookie and 1 means RFC 2109 compliant cookie.
-
-**Returns:**
-
-the version for the cookie.
-
----
-
-### isHttpOnly
-
-**Signature:** `isHttpOnly() : boolean`
-
-**Description:** Identifies if the cookie is http-only.
-
-**Returns:**
-
-true if the cookie is http-only, false otherwise.
-
----
-
-### setComment
-
-**Signature:** `setComment(comment : String) : void`
-
-**Description:** Sets the comment associated with the cookie. Setting a comment automatically changes the cookie to be a RFC 2109 (set-cookie2) compliant cookie, because comments are only supported with RFC cookies and not with Netscapes original cookie.
-
-**Parameters:**
-
-- `comment`: the comment associated with the cookie.
-
----
-
-### setDomain
-
-**Signature:** `setDomain(domain : String) : void`
-
-**Description:** Sets the domain associated with the cookie.
-
-**Parameters:**
-
-- `domain`: the comment associated with the cookie.
-
----
-
-### setHttpOnly
-
-**Signature:** `setHttpOnly(httpOnly : boolean) : void`
-
-**Description:** Sets the http-only state for the cookie.
-
-**Parameters:**
-
-- `httpOnly`: sets http-only state for the cookie.
-
----
-
-### setMaxAge
-
-**Signature:** `setMaxAge(age : Number) : void`
-
-**Description:** Sets the maximum age of the cookie in seconds. A positive value indicates that the cookie will expire after that many seconds have passed. Note that the value is the maximum age when the cookie will expire, not the cookie's current age. A negative value means that the cookie is not stored persistently and will be deleted when the client exits. A zero value causes the cookie to be deleted.
-
-**Parameters:**
-
-- `age`: an integer specifying the maximum age of the cookie in seconds; if negative, means the cookie is not stored; if zero, deletes the cookie
-
----
-
-### setPath
-
-**Signature:** `setPath(path : String) : void`
-
-**Description:** Sets the path for the cookie.
-
-**Parameters:**
-
-- `path`: the path for the cookie.
-
----
-
-### setSecure
-
-**Signature:** `setSecure(secure : boolean) : void`
-
-**Description:** Sets the secure state for the cookie.
-
-**Parameters:**
-
-- `secure`: sets secure state for the cookie.
-
----
-
-### setValue
-
-**Signature:** `setValue(value : String) : void`
-
-**Description:** Sets the cookie's value.
-
-**Parameters:**
-
-- `value`: the value to set in the cookie.
-
----
-
-### setVersion
-
-**Signature:** `setVersion(version : Number) : void`
-
-**Description:** Sets the version for the cookie. 0 means original Netscape cookie and 1 means RFC 2109 compliant cookie. The default is 0.
-
-**Parameters:**
-
-- `version`: the version for the cookie.
-
----

package/docs/dw_web/Cookies.md

@@ -1,46 +0,0 @@
-## Package: dw.web
-
-# Class Cookies
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.web.Cookies
-
-## Description
-
-The class provides an index and associative array like access to the Cookies of the current request. Cookies can be retrieved by calling dw.system.Request.getHttpCookies(). Note: this class allows access to sensitive security-related data. Pay special attention to PCI DSS v3. requirements 2, 4, and 12. See Request.getHttpCookies().
-
-## Properties
-
-### cookieCount
-
-**Type:** Number (Read Only)
-
-The number of known cookies.
-
-## Constructor Summary
-
-## Method Summary
-
-### getCookieCount
-
-**Signature:** `getCookieCount() : Number`
-
-Returns the number of known cookies.
-
-## Method Detail
-
-## Method Details
-
-### getCookieCount
-
-**Signature:** `getCookieCount() : Number`
-
-**Description:** Returns the number of known cookies.
-
-**Returns:**
-
-the number of cookies
-
----