ComponentStateModel

Represents a derived state of the page request

implements: hash
bundle: online channel standard (oc)
since 4.2.0
Represents a derived state of the page request

The ComponentStateModel represents a derived state of the page request. This includes the values of all component parameters as well as the navigation state.

Defined hash keys

snippetUrl ↦ StateUrlModel
since 4.8.0
Returns a model which encodes the navigation state and the values of all query-related component parameters. The security mode of the URL is set to automatic.

url ↦ StateUrlModel
since 4.2.0
Returns a model which encodes the navigation state and the values of all query-related component parameters. The security mode of the URL is set to automatic.

Methods

locale(String:locale) ↦ ComponentStateModel
since 4.7.3
Changes the locale of the component state.

navigation(AssetModel | object) ↦ ComponentStateModel
since 4.2.0
since 4.7.3
since 4.2.0: navigation(NavigationTreeNodeModel | AssetModel : object) : ComponentState -- resolves a given NavigationTreeNodeModel or AssetModel
since 4.7.3: Resolves a given TemplateModel 'object' based on the current state.

parameter(String:name, Scalar:value) ↦ ComponentStateModel
since 4.2.0
Sets the value of the component's parameter given with by ''name to 'value'.