Class CQ_Analytics.ClientContext
| Package: | CQ_Analytics |
| Class: | ClientContext |
| Extends: | Object |
| Clientlib: | personalization.clientcontext |
The
ClientContext object is a facade to access / update the session stores and
their properties contained in the
CQ_Analytics.ClientContextMgr.
This class is a singleton and cannot be created directly. Added in CQ 5.5.
Public Properties
This class has no public properties.
Public Methods
| |
clear() : void
Clears all the stores loaded in the ClientContext (removes properties and values)
Clears all the stores loaded in the ClientContext (removes properties and values)
|
ClientContext |
| |
get( String path, Boolean resolveVariables ) : Object/String
Returns a store or the value of a property from a store loaded in the ClientContext
Returns a store or the value of a property from a store loaded in the ClientContext
Parameters:
path : StringFormat: /"storeName" or /"storeName"/"propertyName". E.g.: /profile, /profile/email
or /geolocation/address/city. First / can be omitted - "profile" or profile/email would work too. resolveVariables : BooleanTrue to resolves the variables contained in the value (defaults to false).
Returns:
|
ClientContext |
| |
persist( String storeName ) : void
Persists the full ClientContext content or the specified store.
Persists the full ClientContext content or the specified store.
|
ClientContext |
| |
reset() : void
Resets all the stores loaded in the ClientContext (reset to initial values)
Resets all the stores loaded in the ClientContext (reset to initial values)
|
ClientContext |
| |
set( String path, String value ) : void
Sets the value of a property from a store loaded in the ClientContext
Sets the value of a property from a store loaded in the ClientContext
Parameters:
path : StringFormat: /"storeName" or /"storeName"/"propertyName". E.g.: /profile, /profile/email
or /geolocation/address/city. First / can be omitted - "profile" or profile/email would work too. value : StringNew value of the property
Returns:
|
ClientContext |
Public Events
This class has no public events.