Class PageScriptContext

This is the context that is handed over to the render and serialize function of the respective page type script.

1String : render( [PageScriptContext](dw.experience.PageScriptContext.md) context)
2    Object : serialize( [PageScriptContext](dw.experience.PageScriptContext.md) context)

Property Summary 

PropertyDescription
content: Map (read-only)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.
page: Page (read-only)Returns the page for which the corresponding page type script is currently executed.
renderParameters: String (read-only)Returns the parameters argument as passed when kicking off page rendering via and serialization
runtimeParameters: String (read-only)Returns 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 

MethodDescription
getContent()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()Returns the page for which the corresponding page type script is currently executed.
getRenderParameters()Returns the parameters argument as passed when kicking off page rendering via and serialization
getRuntimeParameters()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

Property Details 

content 

content: Map (read-only)

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.

  1. expansion- dynamic placeholders are transformed into actual values, for example url/link placeholders in markup text are resolved to real URLs
  2. 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
    • boolean-> boolean
    • category-> Category
    • custom-> Map
    • cms_record-> CMSRecord
    • enum-> either string or integer
    • file-> MediaFile
    • image-> Image
    • integer-> integer
    • markup-> string
    • page-> string
    • product-> Product
    • string-> string
    • text-> string
    • url-> string

page 

page: Page (read-only)

Returns the page for which the corresponding page type script is currently executed.


renderParameters 

renderParameters: String (read-only)

Returns the parameters argument as passed when kicking off page rendering via

and serialization

Deprecated:

Please use getRuntimeParameters() instead.

Warning


runtimeParameters 

runtimeParameters: String (read-only)

Returns the parameters argument as passed when kicking off page rendering via

and page serialization via


Method Details 

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.

  1. expansion- dynamic placeholders are transformed into actual values, for example url/link placeholders in markup text are resolved to real URLs
  2. 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
    • boolean-> boolean
    • category-> Category
    • custom-> Map
    • cms_record-> CMSRecord
    • enum-> either string or integer
    • file-> MediaFile
    • image-> Image
    • integer-> integer
    • markup-> string
    • page-> string
    • product-> Product
    • string-> string
    • text-> string
    • url-> string

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

Returns:

  • the parameters passed to page rendering and serialization

Deprecated:

Please use getRuntimeParameters() instead.

Warning


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

DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!