dw.experience
Class PageScriptContext
dw.experience.PageScriptContext
This is the context that is handed over to the
render and serialize function of the respective page type
script.
String : render( PageScriptContext context)Object : serialize( PageScriptContext context)
Properties
content
:
Map
(Read Only)
The processed version of the underlying unprocessed raw values (also see Page.getAttribute(String))
of this page's attributes which you can use in your respective page type
render and serialize function
implementing your business and rendering/serialization functionality. Processing the raw value is comprised of expansion
and conversion, in this order.
- expansion - dynamic placeholders are transformed into actual values, for example url/link placeholders in markup text are resolved to real URLs
- conversion - the raw value (see Page.getAttribute(String)) is resolved into an actual DWScript object depending on the type of the attribute as specified in its respective attribute definition
page
:
Page
(Read Only)
The page for which the corresponding page type script is currently executed.
renderParameters
:
String
(Read Only)
The
parameters argument as passed when kicking off page rendering via
and serialization
Deprecated:
Please use getRuntimeParameters() instead.
runtimeParameters
:
String
(Read Only)
The
parameters argument as passed when kicking off page rendering via
and page serialization via
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
getContent()
:
Map
Returns the processed version of the underlying unprocessed raw values (also see Page.getAttribute(String)) of this page's attributes which you can use in your respective page type
render and serialize function implementing your business and rendering/serialization functionality.
getPage()
:
Page
Returns the page for which the corresponding page type script is currently executed.
getRenderParameters()
:
String
Returns the
parameters argument as passed when kicking off page rendering via and serialization
getRuntimeParameters()
:
String
Returns the
parameters argument as passed when kicking off page rendering via and page serialization via
Methods inherited from class
Object
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
Method Detail
getContent
getContent()
:
Map
Returns the processed version of the underlying unprocessed raw values (also see Page.getAttribute(String))
of this page's attributes which you can use in your respective page type
render and serialize function
implementing your business and rendering/serialization functionality. Processing the raw value is comprised of expansion
and conversion, in this order.
- expansion - dynamic placeholders are transformed into actual values, for example url/link placeholders in markup text are resolved to real URLs
- conversion - the raw value (see Page.getAttribute(String)) is resolved into an actual DWScript object depending on the type of the attribute as specified in its respective attribute definition
Returns:
processed content attributes of the page
getPage
getPage()
:
Page
Returns the page for which the corresponding page type script is currently executed.
Returns:
the currently rendered page
getRenderParameters
getRenderParameters()
:
String
Returns the
parameters argument as passed when kicking off page rendering via
and serialization
Deprecated:
Please use getRuntimeParameters() instead.
Returns:
the parameters passed to page rendering and serialization
getRuntimeParameters
getRuntimeParameters()
:
String
Returns the
parameters argument as passed when kicking off page rendering via
and page serialization via
Returns:
the parameters passed to page rendering and serialization