@salesforce/b2c-tooling-sdk 0.0.1 → 0.0.3

package/data/script-api/dw.web.Forms.md

@@ -0,0 +1,25 @@
+<!-- prettier-ignore-start -->
+# Class Forms
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.web.Forms](dw.web.Forms.md)
+
+The Forms object provides access to all current forms in the session. The individual forms are retrieved as a dynamic
+property, for example 'forms.searchform'. It is typically retrieved from the session via
+[Session.getForms()](dw.system.Session.md#getforms). But it is also available in the [PipelineDictionary](dw.system.PipelineDictionary.md) and can be
+accessed via 'pdict.CurrentForms'.
+
+
+Note that values stored with a form on the session are deleted if the request locale is changed during the session.
+
+
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+### 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.web.HttpParameter.md

@@ -0,0 +1,462 @@
+<!-- prettier-ignore-start -->
+# Class HttpParameter
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.web.HttpParameter](dw.web.HttpParameter.md)
+
+Represents an HTTP parameter.
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [booleanValue](#booleanvalue): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns the value of the current HttpParameter attribute as a boolean. |
+| [dateValue](#datevalue): [Date](TopLevel.Date.md) `(read-only)` | Returns the value of the current HttpParameter attribute as a date. |
+| [doubleValue](#doublevalue): [Number](TopLevel.Number.md) `(read-only)` | Returns the value of the current HttpParameter attribute as a number. |
+| [empty](#empty): [Boolean](TopLevel.Boolean.md) `(read-only)` | Identifies if there is a value for the http parameter attribute  and whether the value is empty. |
+| [intValue](#intvalue): [Number](TopLevel.Number.md) `(read-only)` | Returns the value of the current HttpParameter attribute as int. |
+| [rawValue](#rawvalue): [String](TopLevel.String.md) `(read-only)` | Returns the raw value for this HttpParameter instance. |
+| [rawValues](#rawvalues): [Collection](dw.util.Collection.md) `(read-only)` | Returns a Collection of all raw values for this HTTP parameter. |
+| [stringValue](#stringvalue): [String](TopLevel.String.md) `(read-only)` | Returns the value of the current HttpParameter attribute. |
+| [stringValues](#stringvalues): [Collection](dw.util.Collection.md) `(read-only)` | Returns a Collection of all defined values for this HTTP parameter. |
+| [submitted](#submitted): [Boolean](TopLevel.Boolean.md) `(read-only)` | Identifies if the parameter was submitted. |
+| [value](#value): [String](TopLevel.String.md) `(read-only)` | Returns the value of the current HttpParameter attribute. |
+| [values](#values): [Collection](dw.util.Collection.md) `(read-only)` | Returns a Collection of all defined values for this current HTTP parameter. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [containsStringValue](dw.web.HttpParameter.md#containsstringvaluestring)([String](TopLevel.String.md)) | Identifies if the given value is part of the actual values. |
+| [getBooleanValue](dw.web.HttpParameter.md#getbooleanvalue)() | Returns the value of the current HttpParameter attribute as a boolean. |
+| [getBooleanValue](dw.web.HttpParameter.md#getbooleanvalueboolean)([Boolean](TopLevel.Boolean.md)) | Returns the value of the current HttpParameter attribute as a boolean. |
+| [getDateValue](dw.web.HttpParameter.md#getdatevalue)() | Returns the value of the current HttpParameter attribute as a date. |
+| [getDateValue](dw.web.HttpParameter.md#getdatevaluedate)([Date](TopLevel.Date.md)) | Returns the value of the current HttpParameter attribute as a date. |
+| [getDoubleValue](dw.web.HttpParameter.md#getdoublevalue)() | Returns the value of the current HttpParameter attribute as a number. |
+| [getDoubleValue](dw.web.HttpParameter.md#getdoublevaluenumber)([Number](TopLevel.Number.md)) | Returns the value of the current HttpParameter attribute as a number. |
+| [getIntValue](dw.web.HttpParameter.md#getintvalue)() | Returns the value of the current HttpParameter attribute as int. |
+| [getIntValue](dw.web.HttpParameter.md#getintvaluenumber)([Number](TopLevel.Number.md)) | Returns the value of the current HttpParameter attribute as an integer. |
+| [getRawValue](dw.web.HttpParameter.md#getrawvalue)() | Returns the raw value for this HttpParameter instance. |
+| [getRawValues](dw.web.HttpParameter.md#getrawvalues)() | Returns a Collection of all raw values for this HTTP parameter. |
+| [getStringValue](dw.web.HttpParameter.md#getstringvalue)() | Returns the value of the current HttpParameter attribute. |
+| [getStringValue](dw.web.HttpParameter.md#getstringvaluestring)([String](TopLevel.String.md)) | Returns the value of the current HttpParameter attribute. |
+| [getStringValues](dw.web.HttpParameter.md#getstringvalues)() | Returns a Collection of all defined values for this HTTP parameter. |
+| [getValue](dw.web.HttpParameter.md#getvalue)() | Returns the value of the current HttpParameter attribute. |
+| [getValues](dw.web.HttpParameter.md#getvalues)() | Returns a Collection of all defined values for this current HTTP parameter. |
+| [isChecked](dw.web.HttpParameter.md#ischeckedstring)([String](TopLevel.String.md)) | Identifies if the given String is an actual value of this http parameter. |
+| [isEmpty](dw.web.HttpParameter.md#isempty)() | Identifies if there is a value for the http parameter attribute  and whether the value is empty. |
+| [isSubmitted](dw.web.HttpParameter.md#issubmitted)() | Identifies if the parameter was submitted. |
+| [toString](dw.web.HttpParameter.md#tostring)() | Returns the value of the current HttpParameter attribute. |
+
+### 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
+
+### booleanValue
+- booleanValue: [Boolean](TopLevel.Boolean.md) `(read-only)`
+  - : Returns the value of the current HttpParameter attribute as a boolean. If
+      there is more than one value defined, only the first one is returned. For an
+      undefined attribute it returns null.
+
+
+
+---
+
+### dateValue
+- dateValue: [Date](TopLevel.Date.md) `(read-only)`
+  - : Returns the value of the current HttpParameter attribute as a date. If
+      there is more than one value defined, only the first one is returned. For
+      an undefined attribute and if attribute is not a date it return null.
+
+
+
+---
+
+### doubleValue
+- doubleValue: [Number](TopLevel.Number.md) `(read-only)`
+  - : Returns the value of the current HttpParameter attribute as a number. If
+      there is more than one value defined, only the first one is returned. For
+      an undefined attribute it returns 0.0.
+
+
+
+---
+
+### empty
+- empty: [Boolean](TopLevel.Boolean.md) `(read-only)`
+  - : Identifies if there is a value for the http parameter attribute
+      and whether the value is empty.
+      A value is treated as empty if it's not blank.
+
+
+
+---
+
+### intValue
+- intValue: [Number](TopLevel.Number.md) `(read-only)`
+  - : Returns the value of the current HttpParameter attribute as int. If there
+      is more than one value defined, only the first one is returned. For an
+      undefined attribute it returns null.
+
+
+
+---
+
+### rawValue
+- rawValue: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the raw value for this HttpParameter instance.
+      The raw value is the not trimmed String value of this HTTP parameter.
+      If there is more than one value defined, only the first one is returned. For an
+      undefined attribute the method returns a null.
+
+
+    **See Also:**
+    - [getStringValue()](dw.web.HttpParameter.md#getstringvalue)
+
+
+---
+
+### rawValues
+- rawValues: [Collection](dw.util.Collection.md) `(read-only)`
+  - : Returns a Collection of all raw values for this HTTP parameter.
+      The raw value is the not trimmed String value of this HTTP parameter.
+
+
+    **See Also:**
+    - [getStringValues()](dw.web.HttpParameter.md#getstringvalues)
+
+
+---
+
+### stringValue
+- stringValue: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the value of the current HttpParameter attribute. If there is
+      more than one value defined, only the first one is returned. For an
+      undefined attribute the method returns a null.
+
+
+
+---
+
+### stringValues
+- stringValues: [Collection](dw.util.Collection.md) `(read-only)`
+  - : Returns a Collection of all defined values for this HTTP parameter.
+
+
+---
+
+### submitted
+- submitted: [Boolean](TopLevel.Boolean.md) `(read-only)`
+  - : Identifies if the parameter was submitted. This is equivalent to the
+      check, whether the parameter has a value.
+
+
+
+---
+
+### value
+- value: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the value of the current HttpParameter attribute. If there is
+      more than one value defined, only the first one is returned. For an
+      undefined attribute the method returns null.
+
+
+
+---
+
+### values
+- values: [Collection](dw.util.Collection.md) `(read-only)`
+  - : Returns a Collection of all defined values for this current HTTP parameter.
+
+    **See Also:**
+    - [getStringValues()](dw.web.HttpParameter.md#getstringvalues)
+
+
+---
+
+## Method Details
+
+### containsStringValue(String)
+- containsStringValue(value: [String](TopLevel.String.md)): [Boolean](TopLevel.Boolean.md)
+  - : Identifies if the given value is part of the actual values.
+
+    **Parameters:**
+    - value - the value to check.
+
+    **Returns:**
+    - true if the value is among the actual values, false otherwise.
+
+
+---
+
+### getBooleanValue()
+- getBooleanValue(): [Boolean](TopLevel.Boolean.md)
+  - : Returns the value of the current HttpParameter attribute as a boolean. If
+      there is more than one value defined, only the first one is returned. For an
+      undefined attribute it returns null.
+
+
+    **Returns:**
+    - the actual value as a boolean or null of no value is available.
+
+
+---
+
+### getBooleanValue(Boolean)
+- getBooleanValue(defaultValue: [Boolean](TopLevel.Boolean.md)): [Boolean](TopLevel.Boolean.md)
+  - : Returns the value of the current HttpParameter attribute as a boolean. If there
+      is more than one value defined, only the first one is returned. For an
+      undefined attribute it returns the given default value.
+
+
+    **Parameters:**
+    - defaultValue - the default value to use.
+
+    **Returns:**
+    - the value of the parameter or the default value if empty.
+
+
+---
+
+### getDateValue()
+- getDateValue(): [Date](TopLevel.Date.md)
+  - : Returns the value of the current HttpParameter attribute as a date. If
+      there is more than one value defined, only the first one is returned. For
+      an undefined attribute and if attribute is not a date it return null.
+
+
+    **Returns:**
+    - the actual value as date or null if empty.
+
+
+---
+
+### getDateValue(Date)
+- getDateValue(defaultValue: [Date](TopLevel.Date.md)): [Date](TopLevel.Date.md)
+  - : Returns the value of the current HttpParameter attribute as a date. If
+      there is more than one value defined, only the first one is returned. For
+      an undefined attribute it returns the given default value and if
+      the attributes is not a date it returns null.
+
+
+    **Parameters:**
+    - defaultValue - the default value to use.
+
+    **Returns:**
+    - the data value of the attribute or the default value if empty
+
+
+---
+
+### getDoubleValue()
+- getDoubleValue(): [Number](TopLevel.Number.md)
+  - : Returns the value of the current HttpParameter attribute as a number. If
+      there is more than one value defined, only the first one is returned. For
+      an undefined attribute it returns 0.0.
+
+
+    **Returns:**
+    - the actual value as double or null if the parameter has no value.
+
+
+---
+
+### getDoubleValue(Number)
+- getDoubleValue(defaultValue: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
+  - : Returns the value of the current HttpParameter attribute as a number. If
+      there is more than one value defined, only the first one is returned. For
+      an undefined attribute it returns the given default value.
+
+
+    **Parameters:**
+    - defaultValue - the default value to use.
+
+    **Returns:**
+    - the actual value as double or the default value if empty.
+
+
+---
+
+### getIntValue()
+- getIntValue(): [Number](TopLevel.Number.md)
+  - : Returns the value of the current HttpParameter attribute as int. If there
+      is more than one value defined, only the first one is returned. For an
+      undefined attribute it returns null.
+
+
+    **Returns:**
+    - the actual value as an integer or null of no value is available.
+
+
+---
+
+### getIntValue(Number)
+- getIntValue(defaultValue: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
+  - : Returns the value of the current HttpParameter attribute as an integer. If there
+      is more than one value defined, only the first one is returned. For an
+      undefined attribute it returns the given default value.
+
+
+    **Parameters:**
+    - defaultValue - the default value to use.
+
+    **Returns:**
+    - the value of the parameter or the default value if empty.
+
+
+---
+
+### getRawValue()
+- getRawValue(): [String](TopLevel.String.md)
+  - : Returns the raw value for this HttpParameter instance.
+      The raw value is the not trimmed String value of this HTTP parameter.
+      If there is more than one value defined, only the first one is returned. For an
+      undefined attribute the method returns a null.
+
+
+    **Returns:**
+    - the actual value or null.
+
+    **See Also:**
+    - [getStringValue()](dw.web.HttpParameter.md#getstringvalue)
+
+
+---
+
+### getRawValues()
+- getRawValues(): [Collection](dw.util.Collection.md)
+  - : Returns a Collection of all raw values for this HTTP parameter.
+      The raw value is the not trimmed String value of this HTTP parameter.
+
+
+    **Returns:**
+    - the raw values as a Collection of String, might be empty
+
+    **See Also:**
+    - [getStringValues()](dw.web.HttpParameter.md#getstringvalues)
+
+
+---
+
+### getStringValue()
+- getStringValue(): [String](TopLevel.String.md)
+  - : Returns the value of the current HttpParameter attribute. If there is
+      more than one value defined, only the first one is returned. For an
+      undefined attribute the method returns a null.
+
+
+    **Returns:**
+    - the actual value or null.
+
+
+---
+
+### getStringValue(String)
+- getStringValue(defaultValue: [String](TopLevel.String.md)): [String](TopLevel.String.md)
+  - : Returns the value of the current HttpParameter attribute. If there is
+      more than one value defined, only the first one is returned. For an
+      undefined attribute the method returns the given default value.
+
+
+    **Parameters:**
+    - defaultValue - the default value to use.
+
+    **Returns:**
+    - the actual value or the default value.
+
+
+---
+
+### getStringValues()
+- getStringValues(): [Collection](dw.util.Collection.md)
+  - : Returns a Collection of all defined values for this HTTP parameter.
+
+    **Returns:**
+    - the actual values as Collection.
+
+
+---
+
+### getValue()
+- getValue(): [String](TopLevel.String.md)
+  - : Returns the value of the current HttpParameter attribute. If there is
+      more than one value defined, only the first one is returned. For an
+      undefined attribute the method returns null.
+
+
+    **Returns:**
+    - the actual value or null.
+
+
+---
+
+### getValues()
+- getValues(): [Collection](dw.util.Collection.md)
+  - : Returns a Collection of all defined values for this current HTTP parameter.
+
+    **Returns:**
+    - the actual values as Collection.
+
+    **See Also:**
+    - [getStringValues()](dw.web.HttpParameter.md#getstringvalues)
+
+
+---
+
+### isChecked(String)
+- isChecked(value: [String](TopLevel.String.md)): [Boolean](TopLevel.Boolean.md)
+  - : Identifies if the given String is an actual value of this http parameter.
+
+    **Parameters:**
+    - value - the value to check.
+
+    **Returns:**
+    - true if the value is among the actual values, false otherwise.
+
+
+---
+
+### isEmpty()
+- isEmpty(): [Boolean](TopLevel.Boolean.md)
+  - : Identifies if there is a value for the http parameter attribute
+      and whether the value is empty.
+      A value is treated as empty if it's not blank.
+
+
+    **Returns:**
+    - true if a value is empty, false otherwise.
+
+
+---
+
+### isSubmitted()
+- isSubmitted(): [Boolean](TopLevel.Boolean.md)
+  - : Identifies if the parameter was submitted. This is equivalent to the
+      check, whether the parameter has a value.
+
+
+    **Returns:**
+    - true if a value is there, false otherwise.
+
+
+---
+
+### toString()
+- toString(): [String](TopLevel.String.md)
+  - : Returns the value of the current HttpParameter attribute. If there is
+      more than one value defined, only the first one is returned. For an
+      undefined attribute the method returns an empty string.
+
+
+    **Returns:**
+    - the actual value or an empty String.
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.web.HttpParameterMap.md

@@ -0,0 +1,194 @@
+<!-- prettier-ignore-start -->
+# Class HttpParameterMap
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.web.HttpParameterMap](dw.web.HttpParameterMap.md)
+
+A map of HTTP parameters.
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [parameterCount](#parametercount): [Number](TopLevel.Number.md) `(read-only)` | Returns the number of paramters in this http parameter map. |
+| [parameterNames](#parameternames): [Set](dw.util.Set.md) `(read-only)` | Returns a collection of all parameter names. |
+| [requestBodyAsString](#requestbodyasstring): [String](TopLevel.String.md) `(read-only)` | Returns the HTTP request body as string (e.g. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [get](dw.web.HttpParameterMap.md#getobject)([Object](TopLevel.Object.md)) | Returns the http parameter for the given key or an empty http parameter,  if no parameter is defined for that key. |
+| [getParameterCount](dw.web.HttpParameterMap.md#getparametercount)() | Returns the number of paramters in this http parameter map. |
+| [getParameterMap](dw.web.HttpParameterMap.md#getparametermapstring)([String](TopLevel.String.md)) | Returns a sub-map containing all parameters that start with the given  prefix. |
+| [getParameterNames](dw.web.HttpParameterMap.md#getparameternames)() | Returns a collection of all parameter names. |
+| [getRequestBodyAsString](dw.web.HttpParameterMap.md#getrequestbodyasstring)() | Returns the HTTP request body as string (e.g. |
+| [isParameterSubmitted](dw.web.HttpParameterMap.md#isparametersubmittedstring)([String](TopLevel.String.md)) | Identifies if the parameter has been submitted. |
+| [processMultipart](dw.web.HttpParameterMap.md#processmultipartfunction)([Function](TopLevel.Function.md)) | This method can be called to process a form submission for an HTML form  with encoding type "multipart/form-data". |
+
+### 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
+
+### parameterCount
+- parameterCount: [Number](TopLevel.Number.md) `(read-only)`
+  - : Returns the number of paramters in this http parameter map.
+
+
+---
+
+### parameterNames
+- parameterNames: [Set](dw.util.Set.md) `(read-only)`
+  - : Returns a collection of all parameter names.
+
+
+---
+
+### requestBodyAsString
+- requestBodyAsString: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the HTTP request body as string (e.g. useful for XML posts). A body
+      is only returned if the request is a POST or PUT request and was not send
+      with "application/x-www-form-urlencoded" encoding. If the request was send
+      with that encoding it is interpreted as form data and the body will be empty.
+
+
+
+---
+
+## Method Details
+
+### get(Object)
+- get(name: [Object](TopLevel.Object.md)): [HttpParameter](dw.web.HttpParameter.md)
+  - : Returns the http parameter for the given key or an empty http parameter,
+      if no parameter is defined for that key. An empty parameter returns
+      false for the method isDefined().
+
+
+    **Parameters:**
+    - name - the key whose associated http parameter is to be returned.
+
+    **Returns:**
+    - the http parameter or an empty http parameter.
+
+
+---
+
+### getParameterCount()
+- getParameterCount(): [Number](TopLevel.Number.md)
+  - : Returns the number of paramters in this http parameter map.
+
+    **Returns:**
+    - the number parameters.
+
+
+---
+
+### getParameterMap(String)
+- getParameterMap(prefix: [String](TopLevel.String.md)): [HttpParameterMap](dw.web.HttpParameterMap.md)
+  - : Returns a sub-map containing all parameters that start with the given
+      prefix. The prefix will be removed from the parameter names in the returned
+      sub-map. For example with the parameters "pre\_P1" and "pre\_p2" a call with
+      "pre\_" as parameter will return a HttpParameterMap containing "P1" and "P2".
+
+
+    **Parameters:**
+    - prefix - the prefix to use when creating the sub-map.
+
+    **Returns:**
+    - the sub-map containing the target parameters.
+
+
+---
+
+### getParameterNames()
+- getParameterNames(): [Set](dw.util.Set.md)
+  - : Returns a collection of all parameter names.
+
+    **Returns:**
+    - a set of all parameter names
+
+
+---
+
+### getRequestBodyAsString()
+- getRequestBodyAsString(): [String](TopLevel.String.md)
+  - : Returns the HTTP request body as string (e.g. useful for XML posts). A body
+      is only returned if the request is a POST or PUT request and was not send
+      with "application/x-www-form-urlencoded" encoding. If the request was send
+      with that encoding it is interpreted as form data and the body will be empty.
+
+
+    **Returns:**
+    - the http request body
+
+
+---
+
+### isParameterSubmitted(String)
+- isParameterSubmitted(key: [String](TopLevel.String.md)): [Boolean](TopLevel.Boolean.md)
+  - : Identifies if the parameter has been submitted.
+
+    **Parameters:**
+    - key - the parameter to check.
+
+    **Returns:**
+    - true if the parameter has been submitted, false otherwise.
+
+
+---
+
+### processMultipart(Function)
+- processMultipart(callback: [Function](TopLevel.Function.md)): [LinkedHashMap](dw.util.LinkedHashMap.md)
+  - : This method can be called to process a form submission for an HTML form
+      with encoding type "multipart/form-data". Such a form can have a mixture
+      of "regular" HTML form fields and also file uploads.
+      
+      
+      Form fields are available via [get(Object)](dw.web.HttpParameterMap.md#getobject) without calling this method.
+      Uploaded files still need to be processed via the passed callback function.
+      
+      
+      This callback function is called for each file upload part in the request.
+      The parameters are the field name, the content type and the original file
+      name. The function can return either a null, which means that the upload
+      of this part should be skipped, or return a dw.io.File instance. If the
+      file is an existing directory the system will automatically generate a
+      unique file name. If the file is not an existing directory the uploaded
+      content will be directly stored into that file. An existing file with the
+      same name will be deleted. If the file can't be deleted for whatever reason,
+      the upload is stored with a generated unique file name in the indicated directory.
+      
+      
+      An automatically generated file name consists of the the prefix "upload",
+      a time stamp, a unique id and the extension tmp. For example:
+      "upload\_20070114221535\_bc7H1aOadI9qYaaacovPd3lqna.tmp".
+      
+      
+      ```
+      var params : HttpParameterMap = pdict.CurrentHttpParameterMap;
+      
+      // Get the file name from the first field. This is works because the
+      // parameter map is updated before the file part is parsed.
+      var files : LinkedHashMap = params.processMultipart( (function( field, ct, oname ){
+          return new File( File.IMPEX + "/" + params.firstField );
+      }) );
+      ```
+
+
+    **Parameters:**
+    - callback - a callback function, which takes the field name, content type and             original file name as input
+
+    **Returns:**
+    - a LinkedHashMap where the keys are the actual file names and the values are references to the [File](dw.io.File.md),
+              _or_ `null` if this is not a multipart request
+
+
+
+---
+
+<!-- prettier-ignore-end -->