Client Context Javascript API

CQ_Analytics.ClientContextMgr

CQ_Analytics.ClientContextMgr对象是一个单独的对象，其中包含一组自注册的会话存储，并提供了用于注册、保留和管理会话存储的方法。

扩展CQ_Analytics.PersiredSessionStore。

方法

getRegisteredStore(name)

返回指定名称的会话存储。 另请参阅访问会话存储。

参数

• 名称：字符串。 会话存储的名称。

返回结果

表示给定名称的会话存储的CQ_Analytics.SessionStore对象。 如果给定名称不存在存储，则返回null。

register(sessionstore)

使用Client Context注册会话存储。 完成后触发storeregister和storeupdate事件。

参数

• sessionstore:CQ_Analytics.SessionStore。 要注册的会话存储对象。

返回结果

没有返回值。

CQ_Analytics.ClientContextUtils

提供用于侦听会话存储激活和注册的方法。 另请参阅检查会话存储是否已定义并已初始化。

方法

onStoreInitialized(storeName， callback， delay)

注册在初始化会话存储时调用的回调函数。 对于已初始化多次的存储，请指定回调延迟，以便只调用一次回调函数：

• 当在先前初始化的延迟期间初始化存储时，取消先前的函数调用，并且再次为当前初始化调用该函数。
• 如果延迟期在后续初始化之前过期，则执行回调函数两次。

例如，会话存储基于JSON对象，并通过JSON请求进行检索。 可以使用以下初始化方案：

• 请求已完成，数据已检索并加载到存储中。 在这种情况下，会进行一次初始化。
• 请求失败（超时）。 在这种情况下，不会进行初始化，并且存储中没有数据。
• 存储已预填充默认值（init属性），但请求失败（超时）。 只有一个具有默认值的初始化。
• 已预填充该商店。

当延迟设置为true或毫秒数时，方法将等待调用回调方法。 如果在延迟传递之前触发另一个初始化事件，则会等待延迟时间超过且没有初始化事件。 这允许等待触发第二个初始化事件，并在最佳情况下调用回调函数。

参数

• storeName:字符串。 要添加监听程序的会话存储的名称。
• 回调：函数。 在存储初始化时要调用的函数。
• 延迟：布尔值或数字。 回调函数的调用延迟时间（以毫秒为单位）。 布尔值true使用默认延迟200 ms。 布尔值false或负数不会导致使用延迟。

返回结果

没有返回值。

onStoreRegistered(storeName， callback)

注册会话存储时调用的回调函数。 将存储注册到CQ_Analytics.ClientContextMgr时，会发生注册事件。

参数

• storeName:字符串。 要添加监听程序的会话存储的名称。
• 回调：函数。 在存储初始化时要调用的函数。

返回结果

没有返回值。

CQ_Analytics.JSONPStore

包含JSON数据的非持久会话存储。 数据从外部JSONP服务中检索。 使用getInstance或getRegisteredInstance方法创建此类的实例。

扩展CQ_Analytics.JSONStore。

属性

有关继承属性，请参阅CQ_Analytics.JSONStore和CQ_Analytics.SessonStore 。

方法

另请参阅CQ_Analytics.JSONStore和CQ_Analytics.SessonStore ，了解继承的方法。

getInstance(storeName， serviceURL， dynamicData， deferLoading， loadingCallback)

创建CQ_Analytics.JSONPStore对象。

参数

• storeName:字符串。 用作STORENAME属性的名称。 STOREKEY属性的值将设置为具有所有大写字符的storeName。 如果未提供storeName，则方法将返回null。
• serviceURL:字符串。 JSONP服务的URL
• dynamicData:（可选）对象。 在调用回调函数之前附加到存储的初始化数据的JSON数据。
• deferLoading:（可选）布尔值。 值为true可阻止在创建对象时调用JSONP服务。 值为false会导致调用JSONP服务。
• loadingCallback:（可选）字符串。 用于处理JSONP服务返回的JSONP对象的函数的名称。 回调函数必须定义一个参数，该参数为CQ_Analytics.JSONPStore对象。

返回结果

新的CQ_Analytics.JSONPStore对象；或者，如果storeName为null，则为null。

getServiceURL()

检索此对象用于检索JSON数据的JSONP服务的URL。

参数

无.

返回结果

表示服务URL的字符串，或者如果未配置服务URL，则为null。

load(serviceURL， dynamicData， callback)

调用JSONP服务。 JSONP URL是后缀为给定回调函数名称的服务URL。

参数

• serviceURL:（可选）字符串。 要呼叫的JSONP服务。 值为null会导致使用已配置的服务URL。 非空值会设置要用于此对象的JSONP服务。 （请参阅setServiceURL。）
• dynamicData:（可选）对象。 在调用回调函数之前附加到存储的初始化数据的JSON数据。
• 回调：（可选）字符串。 用于处理JSONP服务返回的JSONP对象的函数的名称。 回调函数必须定义一个参数，该参数为CQ_Analytics.JSONPStore对象。

返回结果

没有返回值。

registerNewInstance(storeName， serviceURL， dynamicData， callback)

创建CQ_Analytics.JSONPStore对象，并使用Client Context注册存储。

参数

• storeName:字符串。 用作STORENAME属性的名称。 STOREKEY属性的值将设置为具有所有大写字符的storeName。 如果未提供storeName，则方法将返回null。
• serviceURL:（可选）字符串。 JSONP服务的URL。
• dynamicData:（可选）对象。 在调用回调函数之前附加到存储的初始化数据的JSON数据。
• 回调：（可选）字符串。 用于处理JSONP服务返回的JSONP对象的函数的名称。 回调函数必须定义一个参数，该参数为CQ_Analytics.JSONPStore对象。

返回结果

注册的CQ_Analytics.JSONPStore对象。

setServiceURL(serviceURL)

设置用于检索JSON数据的JSONP服务的URL。

参数

• serviceURL:字符串。 提供JSON数据的JSONP服务的URL

返回结果

没有返回值。

CQ_Analytics.JSONStore

JSON对象的容器。 创建此类的实例，以创建包含JSON数据的非持久会话存储：

myjsonstore = new CQ_Analytics.JSONStore

您可以定义一组数据，在初始化时填充存储。

扩展CQ_Analytics.SessionStore。

属性

STOREKEY

用于标识存储的键。 使用getInstance方法检索此值。

存储重命名

商店的名称。 使用getInstance方法检索此值。

方法

另请参阅CQ_Analytics.SessionStore ，了解继承的方法。

清除()

删除会话存储数据并删除所有初始化属性。

参数

无.

返回结果

没有返回值。

getInstance(storeName， jsonData)

创建一个具有给定名称的CQ_Analytics.JSONStore对象，并使用给定JSON数据进行初始化（调用initJSON方法）。

参数

• storeName:字符串。 用作STORENAME属性的名称。 STOREKEY属性的值将设置为具有所有大写字符的storeName。
• jsonData:对象。 包含JSON数据的对象。

返回结果

CQ_Analytics.JSONStore对象。

getJSON()

检索JSON格式的会话存储的数据。

参数

无.

返回结果

表示JSON格式的存储数据的对象。

init()

清除会话存储，并使用初始化属性对其进行初始化。 将初始化标志设置为true，然后触发initialize和update事件。

参数

无.

返回结果

没有返回的数据。

initJSON(jsonData， doNotClear)

从JSON对象中的数据创建初始化属性。 您可以选择删除所有现有的初始化属性。

属性的名称从JSON对象中数据的层次结构派生。 以下示例代码表示一个JSON对象：

{
A: "valueA",  
B: {
     B1: "valueBB1"
    }
}

在本例中，在存储中创建了以下属性：

A: "valueA" 
B/B1: "valueBB1"

参数

• jsonData:包含要存储的数据的JSON对象。
• doNotClear:值“true”将保留现有的初始化属性，并添加从JSON对象派生的属性。 值false会先删除现有的初始化属性，然后再添加从JSON对象派生的属性。

返回结果

没有返回值。

registerNewInstance(storeName， jsonData)

创建一个具有给定名称的CQ_Analytics.JSONStore对象，并使用给定JSON数据进行初始化（调用initJSON方法）。 新对象将自动在Clickstream Cloud Manager中注册。

参数

• storeName:字符串。 用作STORENAME属性的名称。 STOREKEY属性的值将设置为具有所有大写字符的storeName。
• jsonData:对象。 包含JSON数据的对象。

返回结果

CQ_Analytics.JSONStore对象。

CQ_Analytics.可观察

触发事件并允许其他对象侦听这些事件并做出反应。 扩展此类的类可以触发导致调用侦听器的事件。

方法

addListener(event， fct， scope)

为事件注册侦听器。 另请参阅创建侦听器以对会话存储更新做出响应。

参数

• 事件：字符串。 要侦听的事件的名称。
• fct:函数。 发生事件时调用的函数。
• 范围：（可选）对象。 执行处理程序函数的范围。 处理程序函数的“this”上下文。

返回结果

没有返回值。

removeListener(event， fct)

删除事件的给定事件处理程序。

参数

• 事件：字符串。 事件的名称。
• fct:函数。 事件处理程序。

返回结果

没有返回值。

CQ_Analyics.PeristedJSONPStore

从远程JSONP服务中检索的JSON对象的持久容器。

扩展CQ_Analytics.PersiredJSONStore。

方法

另请参阅CQ_Analytics.PeristedJSONStore ，了解继承的方法。

getInstance(storeName， serviceURL， dynamicData， deferLoading， loadingCallback)

创建CQ_Analytics.PersiredJSONPStore对象。

参数

• storeName:字符串。 用作STORENAME属性的名称。 STOREKEY属性的值将设置为具有所有大写字符的storeName。 如果未提供storeName，则方法将返回null。
• serviceURL:字符串。 JSONP服务的URL
• dynamicData:（可选）对象。 在调用回调函数之前附加到存储的初始化数据的JSON数据。
• deferLoading:（可选）布尔值。 值为true可阻止在创建对象时调用JSONP服务。 值为false会导致调用JSONP服务。
• loadingCallback:（可选）字符串。 用于处理JSONP服务返回的JSONP对象的函数的名称。 回调函数必须定义一个参数，该参数为CQ_Analytics.JSONPStore对象。

返回结果

新的CQ_Analytics.PersiredJSONPStore对象；或者，如果storeName为null，则为null。

getServiceURL()

检索此对象用于检索JSON数据的JSONP服务的URL。

参数

无.

返回结果

表示服务URL的字符串，或者如果未配置服务URL，则为null。

load(serviceURL， dynamicData， callback)

调用JSONP服务。 JSONP URL是后缀为给定回调函数名称的服务URL。

参数

• serviceURL:（可选）字符串。 要呼叫的JSONP服务。 值为null会导致使用已配置的服务URL。 非空值会设置要用于此对象的JSONP服务。 （请参阅setServiceURL。）
• dynamicData:（可选）对象。 在调用回调函数之前附加到存储的初始化数据的JSON数据。
• 回调：（可选）字符串。 用于处理JSONP服务返回的JSONP对象的函数的名称。 回调函数必须定义一个参数，该参数为CQ_Analytics.JSONPStore对象。

返回结果

没有返回值。

registerNewInstance(storeName， serviceURL， dynamicData， callback)

创建CQ_Analytics.PersiedJSONPStore对象，并在Client Context中注册该存储。

参数

• storeName:字符串。 用作STORENAME属性的名称。 STOREKEY属性的值将设置为具有所有大写字符的storeName。 如果未提供storeName，则方法将返回null。
• serviceURL:（可选）字符串。 JSONP服务的URL。
• dynamicData:（可选）对象。 在调用回调函数之前附加到存储的初始化数据的JSON数据。
• 回调：（可选）字符串。 用于处理JSONP服务返回的JSONP对象的函数的名称。 回调函数必须定义一个参数，该参数为CQ_Analytics.JSONPStore对象。

返回结果

已注册的CQ_Analytics.PersiredJSONPStore对象。

setServiceURL(serviceURL)

设置用于检索JSON数据的JSONP服务的URL。

参数

• serviceURL:字符串。 提供JSON数据的JSONP服务的URL

返回结果

没有返回值。

CQ_Analytics.PeristedJSONStore

JSON对象的持久容器。

扩展CQ_Analytics.PersistedSessionStore。

属性

STOREKEY

用于标识存储的键。 使用getInstance方法检索此值。

存储

商店的名称。 使用getInstance方法检索此值。

方法

另请参阅CQ_Analytics.PersiredSessionStore ，了解继承的方法。

getInstance(storeName， jsonData)

创建一个具有给定名称的CQ_Analytics.PersiredJSONStore对象，并使用给定JSON数据进行初始化（调用initJSON方法）。

参数

• storeName:字符串。 用作STORENAME属性的名称。 STOREKEY属性的值将设置为具有所有大写字符的storeName。
• jsonData:对象。 包含JSON数据的对象。

返回结果

CQ_Analytics.PersiredJSONStore对象。

getJSON()

检索JSON格式的会话存储的数据。

参数

无.

返回结果

表示JSON格式的存储数据的对象。

initJSON(jsonData， doNotClear)

从JSON对象中的数据创建初始化属性。 您可以选择删除所有现有的初始化属性。

属性的名称从JSON对象中数据的层次结构派生。 以下示例代码表示一个JSON对象：

{
A: "valueA",  
B: {
     B1: "valueBB1"
    }
}

在本例中，在存储中创建了以下属性：

A: "valueA" 
B/B1: "valueBB1"

参数

• jsonData:包含要存储的数据的JSON对象。
• doNotClear:值“true”将保留现有的初始化属性，并添加从JSON对象派生的属性。 值false会先删除现有的初始化属性，然后再添加从JSON对象派生的属性。

返回结果

没有返回值。

registerNewInstance(storeName， jsonData)

创建一个具有给定名称的CQ_Analytics.PersiredJSONStore对象，并使用给定JSON数据进行初始化（调用initJSON方法）。 新对象将自动注册到Client Context Manager中。

参数

• storeName:字符串。 用作STORENAME属性的名称。 STOREKEY属性的值将设置为具有所有大写字符的storeName。
• jsonData:对象。 包含JSON数据的对象。

返回结果

CQ_Analytics.PersiredJSONStore对象。

CQ_Analytics.PersiredSessionStore

属性和值的容器。 使用CQ_Analytics.SessionPersistence保留数据。 创建此类的实例以创建持久会话存储：

mypersistedstore = new CQ_Analytics.PersistedSessionStore

扩展CQ_Analytics.SessionStore。

属性

STOREKEY

默认值为 key.

方法

有关继承的方法，请参阅CQ_Analytics.SessionStore 。

当使用继承方法clear、setProperty、setProperties、removeProperty来更改存储数据时，将自动保留所做的更改，除非将更改的属性标记为“未持久”。

getStoreKey()

检索STOREKEY属性。

参数

无

返回结果

STOREKEY属性的值。

isPersisted(name)

确定是否保留数据属性。

参数

• 名称：字符串。 属性的名称。

返回结果

如果保留属性，则布尔值为true；如果值不是保留属性，则布尔值为false。

persist()

保留会话存储。 默认持久性模式使用浏览器localStorage作为名称(window.localStorage.set("ClientSidePersistance", store);)ClientSidePersistence

如果localStorage不可用或不可写，则该存储将作为窗口的属性被保留。

完成后触发persist事件。

参数

无

返回结果

没有返回值。

reset(deferEvent)

从存储中删除所有数据属性并保留该存储。 （可选）在完成后不触发udpate事件。

参数

• deferEvent:值为true可阻止触发update事件。 值false会触发更新事件。

返回结果

没有返回值。

setNonPersisted(name)

将数据属性标记为不保留。

参数

• 名称：字符串。 不要保留的属性的名称。

返回结果

没有返回值。

CQ_Analytics.SessionStore

CQ_Analytics.SessionStore表示会话存储。 创建此类的实例以创建会话存储：

mystore = new CQ_Analytics.SessionStore

扩展CQ_Analytics.Ovearable。

属性

存储

会话存储的名称。 使用getName检索此属性的值。

方法

addInitProperty(name， value)

向会话存储初始化数据添加属性和值。

使用loadInitProperties用初始化值填充会话存储数据。

参数

• 名称：字符串。 要添加的属性的名称。
• 值：字符串。 要添加的属性的值。

返回结果

没有返回值。

清除()

从存储中删除所有数据属性。

参数

无.

返回结果

没有返回值。

getData(excluded)

返回存储数据。 （可选）从数据中排除名称属性。 如果存储的data属性不存在，则调用init方法。

参数

排除：（可选）要从返回的数据中排除的属性名称数组。

返回结果

属性及其值的对象。

getInitProperty(name)

检索数据属性的值。

参数

• 名称：字符串。 要检索的数据属性的名称。

返回结果

数据属性的值。 如果会话存储不包含给定名称的属性，则返回null。

getName()

返回会话存储的名称。

参数

无.

返回结果

表示存储名称的字符串值。

getProperty(name， raw)

返回属性的值。 返回的值将作为原始属性或XSS筛选的值。 如果存储的data属性不存在，则调用init方法。

参数

• 名称：字符串。 要检索的数据属性的名称。
• 原始：布尔值。 如果值为true，则返回原始属性值。 值为false时，会将返回的值进行XSS过滤。

返回结果

数据属性的值。

getPropertyNames(excluded)

返回会话存储所包含属性的名称。 如果存储的data属性不存在，则调用init方法。

参数

排除：（可选）要在结果中忽略的属性名称数组。

返回结果

表示会话属性名称的字符串值数组。

getSessionStore()

返回附加到当前对象的会话存储。

参数

无.

返回结果

此

init()

将存储标记为已初始化，并触发initialize事件。

参数

无.

返回结果

没有返回值。

isInitialized()

指示是否初始化会话存储。

参数

无.

返回结果

如果存储已初始化，则值为true；如果存储未初始化，则值为false。

loadInitProperties(obj， setValues)

将给定对象的属性添加到会话存储的初始化数据中。 或者，对象数据也被添加到存储数据中。

参数

• obj:包含可枚举属性的对象。
• setValues:当为true时，如果会话存储数据中尚未包含同名属性，则会将obj属性添加到会话存储数据中。 如果为false，则不会向会话存储数据添加任何数据。

返回结果

没有返回值。

removeProperty(name)

从会话存储中删除属性。 完成后触发update事件。 如果存储的data属性不存在，则调用init方法。

参数

• 名称：字符串。 要删除的属性的名称。

返回结果

没有返回值。

重置()

恢复数据存储的初始值。 默认实施只会删除所有数据。 完成后触发update事件。

参数

无.

返回结果

没有返回值。

setProperties(properties)

设置多个属性的值。 完成后触发update事件。 如果存储的data属性不存在，则调用init方法。

参数

• 属性：对象。 包含可枚举属性的对象。 每个属性名称和值都会添加到存储中。

返回结果

没有返回值。

setProperty(name， value)

设置属性的值。 完成后触发update事件。 如果存储的data属性不存在，则调用init方法。

参数

• 名称：字符串。 属性的名称。
• 值：字符串。 属性值。

返回结果

没有返回值。