Properties

Methods

Events

Class CQ_Analytics.ClientContextUtils

Package:	CQ_Analytics
Class:	ClientContextUtils
Extends:	Object
Clientlib:	personalization.core

A helper class providing a set of ClientContext utility methods.

Added in CQ 5.5.

Public Properties

Property		Defined By
	ClientContextUtils.DEFAULT_INIT_DELAY : Number <static> Default init delay. See onStoreInitialized.	ClientContextUtils

Public Methods

Method		Defined By
	init( `String ccPath`, `String pagePath` ) : void <static> Inits the ClientContext. <static> Inits the ClientContext. Parameters: `ccPath` : String ClientContext path `pagePath` : String Current page path Returns: `void`	ClientContextUtils
	initUI( `String ccPath`, `String pagePath` ) : void <static> Inits the ClientContext UI. <static> Inits the ClientContext UI. Parameters: `ccPath` : String ClientContext path `pagePath` : String Current page path Returns: `void`	ClientContextUtils
	onStoreInitialized( `String storeName`, `Function callback`, `Boolean/Number delay` ) : void <static> Executes a callback function when a store is initialized. Some store might be initialized several time... <static> Executes a callback function when a store is initialized. Some store might be initialized several times (default init + asynchronous data loading): use delay parameter to try to get only one call of the callback. A timeout is defined before every init event, next init event kills all previous calls. Latest one execute the callback. WARNING: if time between 2 init events is bigger than timeout, callback is called several times. Parameters: `storeName` : String Name of the store `callback` : Function Function to execute `delay` : Boolean/Number True to enable a default delay (value is DEFAULT_INIT_DELAY or a number of milliseconds (defaults false). Returns: `void`	ClientContextUtils
	onStoreRegistered( `String storeName`, `Function callback` ) : void <static> Executes a callback function when a store is registered. <static> Executes a callback function when a store is registered. Parameters: `storeName` : String Name of the store `callback` : Function Function to execute Returns: `void`	ClientContextUtils
	renderStore( `String id`, `String storeName` ) : void <static> Renders a store into the DOM. On store update, rendering will be updated. Rendering is done by calling... <static> Renders a store into the DOM. On store update, rendering will be updated. Rendering is done by calling the `renderer` method of the store. Parameters: `id` : String Id of the DOM element that will contain the property rendering `storeName` : String Name of the store Returns: `void`	ClientContextUtils
	renderStoreProperty( `String id`, `String storeName`, `String propertyName`, [`String prefix`], [`String suffix`], [`String defaultValue`] ) : void <static> Renders a store property value into the DOM. On store update, rendering will be updated. <static> Renders a store property value into the DOM. On store update, rendering will be updated. Parameters: `id` : String Id of the DOM element that will contain the property rendering `storeName` : String Name of the store `propertyName` : String Name of the property `prefix` : String (Optional) Fixed prefix to prepend to property value `suffix` : String (Optional) Fixed suffix to append to property value `defaultValue` : String (Optional) Default value to render if property is not in the store Returns: `void`	ClientContextUtils
	storePropertiesOptionsProvider( `String storeName`, [`Boolean showValue`] ) : Object[] <static> Returns a list of options: list of properties of a store. <static> Returns a list of options: list of properties of a store. Parameters: `storeName` : String Name of the store `showValue` : Boolean (Optional) True to add value to the options (defaults to false) Returns: `Object[]` Computed options	ClientContextUtils
	storesOptionsProvider() : Object[] <static> Returns a list of options: list of stores registered in the CQ_Analytics.StoreRegistry. <static> Returns a list of options: list of stores registered in the CQ_Analytics.StoreRegistry. Parameters: None. Returns: `Object[]` Computed options	ClientContextUtils

Public Events

This class has no public events.