Methods

Events

Observable
  SessionStore
    PersistedSessionStore
      PersistedJSONStore

Class CQ_Analytics.PersistedJSONStore

Package:	CQ_Analytics
Class:	PersistedJSONStore
Subclasses:	PersistedJSONPStore
Extends:	CQ_Analytics.PersistedSessionStore
Clientlib:	personalization.core

A PersistedJSONStore is a persisted container of a JSON object.
Added in CQ 5.5.

Public Properties

This class has no public properties.

Public Methods

Method		Defined By
	PersistedJSONStore() Creates a new PersistedJSONStore. Creates a new PersistedJSONStore. Parameters: None. Returns: Added in CQ 5.5.	PersistedJSONStore
	PersistedJSONStore.getInstance( `String storeName`, `Object jsonData` ) : CQ_Analytics.PersistedJSONStore <static> Returns a new instance of a CQ_Analytics.PersistedJSONStore instance is initialized with the JSON object. <static> Returns a new instance of a CQ_Analytics.PersistedJSONStore instance is initialized with the JSON object. Parameters: `storeName` : String The name of the new store `jsonData` : Object The initial data as JSON object Returns: `CQ_Analytics.PersistedJSONStore` The new store instance	PersistedJSONStore
	PersistedJSONStore.registerNewInstance( `String storeName`, `Object jsonData` ) : CQ_Analytics.PersistedJSONStore <static> Creates, registers in the ClientContext and returns a new instance of a CQ_Analytics.PersistedJSONStor... <static> Creates, registers in the ClientContext and returns a new instance of a CQ_Analytics.PersistedJSONStore instance initialized with the JSON object. Parameters: `storeName` : String The name of the new store `jsonData` : Object The initial data as JSON object Returns: `CQ_Analytics.PersistedJSONStore` The new store instance	PersistedJSONStore
	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
	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
	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
	getJSON() : Object Returns the store data as a JSON object. Returns the store data as a JSON object. Parameters: None. Returns: `Object` The JSON object.	PersistedJSONStore
	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
	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
	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
	init() : void Initializes the store. Initializes the store. Parameters: None. Returns: `void`	SessionStore
	initJSON( `Object jsonData` ) : void Sets the store data with the specified JSON object. Note that inside the store, properties are stored based on proper... Sets the store data with the specified JSON object. Note that inside the store, properties are stored based on property path in the store. `{ A: "valueA", B: { B1: "valueBB1" }` will be accessed in the store as: `A: "valueA" B/B1: "valueBB1"` Parameters: `jsonData` : Object The JSON object containing the data. Returns: `void`	PersistedJSONStore
	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
	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
	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
	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
	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

Public Events

This class has no public events.