Methods

Events

Observable
  SessionStore
    PersistedSessionStore
      ClientContextMgr

Class CQ_Analytics.ClientContextMgr

Package:	CQ_Analytics
Class:	ClientContextMgr
Extends:	CQ_Analytics.PersistedSessionStore
Clientlib:	personalization.core

The CQ_Analytics.ClientContextMgr object is a singleton providing methods for registration, persistence and management of different session stores linked to the clientcontext.
Each store is basically a set of pairs (key,value) and will be used by segmentation (see CQ_Analytics.SegmentMgr) and displayed by clientcontext UI (see CQ_Analytics.ClientContextUI).

This class is a singleton and cannot be created directly.

Public Properties

Property		Defined By
	CONFIG_PATH : String <static> Location of the config.	ClientContextMgr

Public Methods

Method		Defined By
	addInitProperty( `String name`, `String value` ) : void Adds an initial property to the store. Adds an initial property to the store. Parameters: `name` : String Property name. `value` : String Property value. Returns: `void`	SessionStore
	addListener( `String event`, `Function fct`, [`Object scope`] ) : void Appends an event handler to the current Observable. Appends an event handler to the current Observable. Parameters: `event` : String Event name. `fct` : Function The method the event invokes. `scope` : Object (optional) The scope in which to execute the handler function. The handler function's "this" context. Returns: `void`	Observable
	clear() : void Clears the store. Clears the store. Parameters: None. Returns: `void`	SessionStore
	get( `Boolean toServer` ) : Object Returns the current clientcontext object. Object can contain the non server persited data. Returns the current clientcontext object. Object can contain the non server persited data. Parameters: `toServer` : Boolean true to exclue non server persisted data. Returns: `Object` object representing the clientcontext.	ClientContextMgr
	getConfig() : Object Returns the config object. Returns the config object. Parameters: None. Returns: `Object` config object if loaded, null otherwise.	ClientContextMgr
	getData( `String[] excluded` ) : Object Returns the store data. Returns the store data. Parameters: `excluded` : String[] Property names to exclude from the result. Returns: `Object` Object containing the store data (obj["property"] = value).	SessionStore
	getEditConfig( `String storename` ) : Object Returns the edit config object for the give store name. Shortcut to `config["configs"][storename]["edit"]`. Returns the edit config object for the give store name. Shortcut to `config["configs"][storename]["edit"]`. Parameters: `storename` : String Request config store name. Returns: `Object` config object if loaded, {} otherwise.	ClientContextMgr
	getId() : String Returns the current clientcontext ID. Can be either: visitor ID if defined session unique ID in other case. If visi... Returns the current clientcontext ID. Can be either: visitor ID if defined session unique ID in other case. If visitor ID is not defined, clientcontext is considered as anonymous. Parameters: None. Returns: `String` the ID.	ClientContextMgr
	getInitProperty( `String name` ) : String Returns the value of an initial property. Returns the value of an initial property. Parameters: `name` : String Property name. Returns: `String` The value.	SessionStore
	getInitialData( `String storename` ) : Object Returns the initial data for the give store name. Shortcut to `config["data"][storename]`. Returns the initial data for the give store name. Shortcut to `config["data"][storename]`. Parameters: `storename` : String Request config store name. Returns: `Object` data object if loaded, {} otherwise.	ClientContextMgr
	getLabel( `String name` ) : String Returns a store property friendly label. Returns a store property friendly label. Parameters: `name` : String Property name. Returns: `String` the label.	SessionStore
	getLink( `String name` ) : String Returns a store property in a link format. Returns a store property in a link format. Parameters: `name` : String Property name. Returns: `String` the link value.	SessionStore
	getName() : void Returns the store name. Returns the store name. Parameters: None. Returns: `void`	SessionStore
	getProperty( `String name`, `Boolean raw` ) : String Returns the value of a store property (XSS filtered value). Returns the value of a store property (XSS filtered value). Parameters: `name` : String Property name. `raw` : Boolean Raw value, no XSS filtering Returns: `String` the value.	SessionStore
	getPropertyNames( [`String[] excluded`] ) : String[] Returns all store property names. Returns all store property names. Parameters: `excluded` : String[] (Optional) Array of excluded properties (not returned). Returns: `String[]` Array of the property names.	SessionStore
	getRegisteredStore( `String name` ) : CQ_Analytics.SessionStore Returns the registered store looked up by name. Returns the registered store looked up by name. Parameters: `name` : String Name of the store to retrieve Returns: `CQ_Analytics.SessionStore` The registered store or null. Added in CQ 5.5.	ClientContextMgr
	getSessionId() : String Returns the unique session ID. Returns the unique session ID. Parameters: None. Returns: `String` the session ID.	ClientContextMgr
	getSessionStore() : CQ_Analytics.SessionStore Returns the session store attached to the current object (returns this). Returns the session store attached to the current object (returns this). Parameters: None. Returns: `CQ_Analytics.SessionStore` Session store.	SessionStore
	getStoreConfig( `String storename` ) : Object Returns the store config object for the give store name. Shortcut to `config["configs"][storename]["store"]`. Returns the store config object for the give store name. Shortcut to `config["configs"][storename]["store"]`. Parameters: `storename` : String Request config store name. Returns: `Object` config object if loaded, {} otherwise.	ClientContextMgr
	getStoreKey() : String Returns the store key name used by persistence. Returns the store key name used by persistence. Parameters: None. Returns: `String` The key name.	PersistedSessionStore
	getStores() : Object Returns the registered stores. Returns the registered stores. Parameters: None. Returns: `Object` All registered stores Added in CQ 5.5.	ClientContextMgr
	getUIConfig( `String storename` ) : Object Returns the UI config object for the give store name. Shortcut to `config["configs"][storename]["ui"]`. Returns the UI config object for the give store name. Shortcut to `config["configs"][storename]["ui"]`. Parameters: `storename` : String Request config store name. Returns: `Object` config object if loaded, {} otherwise.	ClientContextMgr
	getVisitorId() : String Returns the visitor ID if defined. Returns the visitor ID if defined. Parameters: None. Returns: `String` the visitor ID, `undefined` if not defined.	ClientContextMgr
	init() : void Initializes the store. Initializes the store. Parameters: None. Returns: `void`	SessionStore
	isAnonymous() : Boolean Returns if manager is still defined in anonymous mode (no visitor id defined). Returns if manager is still defined in anonymous mode (no visitor id defined). Parameters: None. Returns: `Boolean` true if anonymous.	ClientContextMgr
	isInitialized() : void Returns true if the store is initialized. False otherwise. Returns true if the store is initialized. False otherwise. Parameters: None. Returns: `void`	SessionStore
	isMode( `Number mode` ) : Boolean Returns if mode is defined. Returns if mode is defined. Parameters: `mode` : Number Mode to check. Returns: `Boolean` true if mode is defined.	ClientContextMgr
	isPersisted( `String name` ) : Boolean Returns if a property in persisted or not. Returns if a property in persisted or not. Parameters: `name` : String Property name. Returns: `Boolean` true if persisted, false otherwise.	PersistedSessionStore
	loadConfig() : void Loads the config and fires `configloaded` and `storesloaded` events. Loads the config and fires `configloaded` and `storesloaded` events. Parameters: None. Returns: `void`	ClientContextMgr
	loadInitProperties( `Object obj`, `Boolean setValues` ) : void Loads initial properties from an object. Loads initial properties from an object. Parameters: `obj` : Object Object containing the initial store data (obj["property"] = value). `setValues` : Boolean True to set the value in the store IF property does is not already present Returns: `void`	SessionStore
	onReady( `Function callback`, [`Object scope`] ) : void Executes the callback when the current ClientContextMgr is ready, i.e. when all stores are loaded. Executes the callback when the current ClientContextMgr is ready, i.e. when all stores are loaded. Parameters: `callback` : Function Function to execute on ready `scope` : Object (optional) The execution scope; window object if null Returns: `void` Added in CQ 5.5.	ClientContextMgr
	persist() : void Persists the store. All properties will be persisted as property=value using a CQ_Analytics.SessionPersistence. Persists the store. All properties will be persisted as property=value using a CQ_Analytics.SessionPersistence. Parameters: None. Returns: `void`	PersistedSessionStore
	post() : void Posts the current clientcontext object to the server (occurs only if posting is started). Posts the current clientcontext object to the server (occurs only if posting is started). Parameters: None. Returns: `void`	ClientContextMgr
	register( `CQ_Analytics.SessionStore sessionstore` ) : void Registers a session store. The current ClickstreamcloudManager will handle its own persistence store depending on upd... Registers a session store. The current ClickstreamcloudManager will handle its own persistence store depending on updates done into the registred session store. Parameters: `sessionstore` : CQ_Analytics.SessionStore The session store Returns: `void`	ClientContextMgr
	removeListener( `String event`, `Function fct` ) : void Removes an event handler from the current Observable. Removes an event handler from the current Observable. Parameters: `event` : String Event name. `fct` : Function The method the event invokes. Returns: `void`	Observable
	removeProperty( `String name` ) : void Removes a property from the store. Removes a property from the store. Parameters: `name` : String Property name. Returns: `void`	SessionStore
	reset() : void Resets the store: restores initial values. Resets the store: restores initial values. Parameters: None. Returns: `void`	SessionStore
	setNonPersisted( `String name` ) : void Defines a property as non persited. By default all properties are persisted. Defines a property as non persited. By default all properties are persisted. Parameters: `name` : String Property name Returns: `void`	PersistedSessionStore
	setProperties( `Object values` ) : void Sets the value of multiple properties Sets the value of multiple properties Parameters: `values` : Object The key-value store of values to set Returns: `void`	SessionStore
	setProperty( `String name`, `String value` ) : void Sets the value of a property. Sets the value of a property. Parameters: `name` : String Property name. `value` : String Property value. Returns: `void`	SessionStore
	setSuppressEvents( `Boolean suppressEvents` ) : void Sets the value of the `suppressEvents` property Sets the value of the `suppressEvents` property Parameters: `suppressEvents` : Boolean Returns: `void`	Observable
	setVisitorId( `String id` ) : void Sets the visitor ID. Sets the visitor ID. Parameters: `id` : String the visitor ID. Returns: `void`	ClientContextMgr
	startPosting() : void Starts the posting. Starts the posting. Parameters: None. Returns: `void`	ClientContextMgr
	stopPosting() : void Stops the posting. Stops the posting. Parameters: None. Returns: `void`	ClientContextMgr
	update( `CQ_Analytics.SessionStore sessionstore` ) : void Updates a session store. The current registred session store with the same name is updated by the given one. Updates a session store. The current registred session store with the same name is updated by the given one. Parameters: `sessionstore` : CQ_Analytics.SessionStore The session store Returns: `void`	ClientContextMgr

Public Events

This class has no public events.