ClientContext JavaScript API client-context-javascript-api

CQ_Analytics.ClientContextMgr cq-analytics-clientcontextmgr

CQ_Analytics.ClientContextMgr オブジェクトは、自己登録されたセッションストアのセットを含むシングルトンで、セッションストアを登録、保持、管理するためのメソッドを提供します。

CQ_Analytics.PersistedSessionStore を拡張します。

メソッド methods

getRegisteredStore(name) getregisteredstore-name

指定された名前のセッションストアを返します。セッションストアへのアクセスも参照してください。

パラメーター

戻り値

指定された名前のセッションストアを表す CQ_Analytics.SessionStore オブジェクト。指定された名前のストアが存在しない場合は、null を返します。

register(sessionstore) register-sessionstore

セッションストアを ClientContext に登録します。完了時に storeregister イベントと storeupdate イベントを発生させます。

パラメーター

戻り値

戻り値はありません。

CQ_Analytics.ClientContextUtils cq-analytics-clientcontextutils

セッションストアのアクティベーションと登録をリッスンするためのメソッドを提供します。セッションストアの定義および初期化の確認も参照してください。

メソッド methods-1

onStoreInitialized(storeName, callback, delay) onstoreinitialized-storename-callback-delay

セッションストアが初期化されたときに呼び出されるコールバック関数を登録します。複数回初期化されるストアの場合は、コールバック関数が一度だけ呼び出されるように、コールバック遅延を指定します。

例えば、JSON オブジェクトをベースとするセッションストアがあり、JSON リクエストを使用して取得するものとします。次の初期化シナリオが考えられます。

遅延を true またはミリ秒単位に設定すると、メソッドはコールバックメソッドが呼び出されるまで待機します。delay で設定した遅延時間が経過する前に別の初期化イベントが発生した場合は、初期化イベントを発生させないまま、遅延時間が経過するまで待機します。これにより、2 番目の初期化イベントが発生するまで待機して、最適な状況でコールバック関数を呼び出すことができます。

パラメーター

戻り値

戻り値はありません。

onStoreRegistered(storeName, callback) onstoreregistered-storename-callback

セッションストアが登録されたときに呼び出されるコールバック関数を登録します。ストアが CQ_Analytics.ClientContextMgr に登録されると、登録イベントが発生します。

パラメーター

戻り値

戻り値はありません。

CQ_Analytics.JSONPStore cq-analytics-jsonpstore

JSON データを格納する非永続セッションストア。データは外部 JSONP サービスから取得されます。getInstance メソッドまたは getRegisteredInstance メソッドを使用して、このクラスのインスタンスを作成します。

CQ_Analytics.JSONStore を拡張します。

プロパティ properties

継承されるプロパティについては、CQ_Analytics.JSONStore および CQ_Analytics.SessonStore を参照してください。

メソッド methods-2

継承されるメソッドについては、CQ_Analytics.JSONStore および CQ_Analytics.SessonStore も参照してください。

getInstance(storeName, serviceURL, dynamicData, deferLoading, loadingCallback) getinstance-storename-serviceurl-dynamicdata-deferloading-loadingcallback

CQ_Analytics.JSONPStore オブジェクトを作成します。

パラメーター

戻り値

新しい CQ_Analytics.JSONPStore オブジェクト、または storeName が Null の場合は Null。

getServiceURL() getserviceurl

このオブジェクトが JSON データの所得に使用する JSONP サービスの URL を取得します。

パラメーター

なし。

戻り値

サービス URL を表す String、またはサービス URL が設定されていない場合は null。

load(serviceURL, dynamicData, callback) load-serviceurl-dynamicdata-callback

JSONP サービスを呼び出します。JSONP の URL は、指定されたコールバック関数名が後ろに付いたサービス URL です。

パラメーター

戻り値

戻り値はありません。

registerNewInstance(storeName, serviceURL, dynamicData, callback) registernewinstance-storename-serviceurl-dynamicdata-callback

CQ_Analytics.JSONPStore オブジェクトを作成し、ストアを ClientContext に登録します。

パラメーター

戻り値

登録された CQ_Analytics.JSONPStore オブジェクト。

setServiceURL(serviceURL) setserviceurl-serviceurl

JSON データの取得に使用する JSONP サービスの URL を設定します。

パラメーター

戻り値

戻り値はありません。

CQ_Analytics.JSONStore cq-analytics-jsonstore

JSON オブジェクトのコンテナ。JSON データを含む非永続セッションストアを作成するために、このクラスのインスタンスを作成します。

myjsonstore = new CQ_Analytics.JSONStore

初期化時にストアに設定される一連のデータを定義できます。

CQ_Analytics.SessionStore を拡張します。

プロパティ properties-1

STOREKEY storekey

ストアを識別するキー。この値を取得するには、getInstance メソッドを使用します。

STORENAME storename

ストアの名前。この値を取得するには、getInstance メソッドを使用します。

メソッド methods-3

継承されるメソッドについては、CQ_Analytics.SessionStore も参照してください。

clear() clear

セッションストアのデータを削除し、すべての初期化プロパティを削除します。

パラメーター

なし。

戻り値

戻り値はありません。

getInstance(storeName, jsonData) getinstance-storename-jsondata

指定された名前で、指定された JSON データを使用して初期化される（initJSON メソッドを呼び出す）CQ_Analytics.JSONStore オブジェクトを作成します。

パラメーター

戻り値

CQ_Analytics.JSONStore オブジェクト。

getJSON() getjson

セッションストアのデータを JSON 形式で取得します。

パラメーター

なし。

戻り値

JSON 形式のストアデータを表すオブジェクト。

init() init

セッションストアをクリアし、初期化プロパティを使用して初期化します。初期化フラグを true に設定し、initialize イベントと update イベントを発生させます。

パラメーター

なし。

戻り値

戻り値はありません。

initJSON(jsonData, doNotClear) initjson-jsondata-donotclear

JSON オブジェクト内のデータから初期化プロパティを作成します。オプションで、既存の初期化プロパティをすべて削除できます。

プロパティの名前は、JSON オブジェクト内のデータの階層から得られます。次のサンプルのコードは、JSON オブジェクトを表しています。

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

この例では、以下のプロパティがストア内に作成されます。

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

パラメーター

戻り値

戻り値はありません。

registerNewInstance(storeName, jsonData) registernewinstance-storename-jsondata

指定された名前で、指定された JSON データを使用して初期化される（initJSON メソッドを呼び出す）CQ_Analytics.JSONStore オブジェクトを作成します。新しいオブジェクトは、Clickstream Cloud Manager に自動的に登録されます。

パラメーター

戻り値

CQ_Analytics.JSONStore オブジェクト。

CQ_Analytics.Observable cq-analytics-observable

イベントを発生させ、他のオブジェクトがこれらのイベントをリッスンして対処できるようにします。このクラスを拡張したクラスは、リスナーを呼び出すイベントを発生させることができます。

メソッド methods-4

addListener(event, fct, scope) addlistener-event-fct-scope

イベントのリスナーを登録します。セッションストアの更新に対処するリスナーの作成も参照してください。

パラメーター

戻り値

戻り値はありません。

removeListener(event, fct) removelistener-event-fct

イベントに対して指定されたイベントハンドラーを削除します。

パラメーター

戻り値

戻り値はありません。

CQ_Analyics.PersistedJSONPStore cq-analyics-persistedjsonpstore

リモート JSONP サービスから取得される JSON オブジェクトの永続コンテナ。

CQ_Analytics.PersistedJSONStore を拡張します。

メソッド methods-5

継承されるメソッドについては、CQ_Analytics.PersistedJSONStore も参照してください。

getInstance(storeName, serviceURL, dynamicData, deferLoading, loadingCallback) getinstance-storename-serviceurl-dynamicdata-deferloading-loadingcallback-1

CQ_Analytics.PersistedJSONPStore オブジェクトを作成します。

パラメーター

戻り値

新しい CQ_Analytics.PersistedJSONPStore オブジェクト、または storeName が Null の場合は Null。

getServiceURL() getserviceurl-1

このオブジェクトが JSON データの所得に使用する JSONP サービスの URL を取得します。

パラメーター

なし。

戻り値

サービス URL を表す String、またはサービス URL が設定されていない場合は null。

load(serviceURL, dynamicData, callback) load-serviceurl-dynamicdata-callback-1

JSONP サービスを呼び出します。JSONP の URL は、指定されたコールバック関数名が後ろに付いたサービス URL です。

パラメーター

戻り値

戻り値はありません。

registerNewInstance(storeName, serviceURL, dynamicData, callback) registernewinstance-storename-serviceurl-dynamicdata-callback-1

CQ_Analytics.PersistedJSONPStore オブジェクトを作成し、ストアを ClientContext に登録します。

パラメーター

戻り値

登録された CQ_Analytics.PersistedJSONPStore オブジェクト。

setServiceURL(serviceURL) setserviceurl-serviceurl-1

JSON データの取得に使用する JSONP サービスの URL を設定します。

パラメーター

戻り値

戻り値はありません。

CQ_Analytics.PersistedJSONStore cq-analytics-persistedjsonstore

JSON オブジェクトの永続コンテナ。

CQ_Analytics.PersistedSessionStore を拡張します。

プロパティ properties-2

STOREKEY storekey-1

ストアを識別するキー。この値を取得するには、getInstance メソッドを使用します。

STORENAME storename-1

ストアの名前。この値を取得するには、getInstance メソッドを使用します。

メソッド methods-6

継承されるメソッドについては、CQ_Analytics.PersistedSessionStore も参照してください。

getInstance(storeName, jsonData) getinstance-storename-jsondata-1

指定された名前で、指定された JSON データを使用して初期化される（initJSON メソッドを呼び出す）CQ_Analytics.PersistedJSONStore オブジェクトを作成します。

パラメーター

戻り値

CQ_Analytics.PersistedJSONStore オブジェクト。

getJSON() getjson-1

セッションストアのデータを JSON 形式で取得します。

パラメーター

なし。

戻り値

JSON 形式のストアデータを表すオブジェクト。

initJSON(jsonData, doNotClear) initjson-jsondata-donotclear-1

JSON オブジェクト内のデータから初期化プロパティを作成します。オプションで、既存の初期化プロパティをすべて削除できます。

プロパティの名前は、JSON オブジェクト内のデータの階層から得られます。次のサンプルのコードは、JSON オブジェクトを表しています。

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

この例では、以下のプロパティがストア内に作成されます。

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

パラメーター

戻り値

戻り値はありません。

registerNewInstance(storeName, jsonData) registernewinstance-storename-jsondata-1

指定された名前で、指定された JSON データを使用して初期化される（initJSON メソッドを呼び出す）CQ_Analytics.PersistedJSONStore オブジェクトを作成します。新しいオブジェクトは、ClientContext Manager に自動的に登録されます。

パラメーター

戻り値

CQ_Analytics.PersistedJSONStore オブジェクト。

CQ_Analytics.PersistedSessionStore cq-analytics-persistedsessionstore

プロパティと値のコンテナ。データは CQ_Analytics.SessionPersistence を使用して永続化されます。永続セッションストアを作成するには、このクラスのインスタンスを作成します。

mypersistedstore = new CQ_Analytics.PersistedSessionStore

CQ_Analytics.SessionStore を拡張します。

プロパティ properties-3

STOREKEY storekey-2

デフォルト値は key です。

メソッド methods-7

継承されるメソッドについては、CQ_Analytics.SessionStore を参照してください。

継承されるメソッド clear、setProperty、setProperties、removeProperty を使用してストアデータを変更すると、変更されたプロパティに notPersisted というフラグが設定されない限り、変更内容が自動的に保持されます。

getStoreKey() getstorekey

STOREKEY プロパティを取得します。

パラメーター

なし

戻り値

STOREKEY プロパティの値。

isPersisted(name) ispersisted-name

データプロパティが永続化されているかどうかを判断します。

パラメーター

戻り値

値が永続プロパティの場合は Boolean 値 true、永続プロパティではない場合は値 false。

persist() persist

セッションストアを保持します。デフォルトの永続モードでは、ClientSidePersistence を名前として使用するブラウザーの localStorage を使用します（window.localStorage.set("ClientSidePersistance", store);）。

localStorage が使用できない、または書き込めない場合、ストアはウィンドウのプロパティとして永続化されます。

完了時に persist イベントを発生させます。

パラメーター

なし

戻り値

戻り値はありません。

reset(deferEvent) reset-deferevent

すべてのデータプロパティをストアから削除して、ストアを保持します。オプションで、完了時に udpate イベントを発生させません。

パラメーター

戻り値

戻り値はありません。

setNonPersisted(name) setnonpersisted-name

データプロパティに「非永続」というフラグを設定します。

パラメーター

戻り値

戻り値はありません。

CQ_Analytics.SessionStore cq-analytics-sessionstore

CQ_Analytics.SessionStore はセッションストアを表します。セッションストアを作成するには、このクラスのインスタンスを次のように作成します。

mystore = new CQ_Analytics.SessionStore

CQ_Analytics.Observable を拡張します。

プロパティ properties-4

STORENAME storename-2

セッションストアの名前。このプロパティの値を取得するには、getName を使用します。

メソッド methods-8

addInitProperty(name, value) addinitproperty-name-value

プロパティと値をセッションストアの初期化データに追加します。

初期化の値をセッションストアデータに設定するには、loadInitProperties を使用します。

パラメーター

戻り値

戻り値はありません。

clear() clear-1

ストアからすべてのデータプロパティを削除します。

パラメーター

なし。

戻り値

戻り値はありません。

getData(excluded) getdata-excluded

ストアデータを返します。オプションで、名前プロパティをデータから除外します。ストアのデータプロパティが存在しない場合は、init メソッドを呼び出します。

パラメーター

excluded：（オプション）返されるデータから除外するプロパティ名の配列。

戻り値

プロパティとその値からなるオブジェクト。

getInitProperty(name) getinitproperty-name

データプロパティの値を取得します。

パラメーター

戻り値

データプロパティの値。指定された名前のプロパティがセッションストアに格納されていない場合は null を返します。

getName() getname

セッションストアの名前を返します。

パラメーター

なし。

戻り値

ストア名を表す String 値。

getProperty(name, raw) getproperty-name-raw

プロパティの値を返します。値は、未加工のプロパティまたは XSS フィルタリングされた値として返されます。ストアのデータプロパティが存在しない場合は、init メソッドを呼び出します。

パラメーター

戻り値

データプロパティの値。

getPropertyNames(excluded) getpropertynames-excluded

セッションストアに格納されているプロパティの名前を返します。ストアのデータプロパティが存在しない場合は、init メソッドを呼び出します。

パラメーター

excluded：（オプション）結果から除外するプロパティ名の配列。

戻り値

セッションプロパティ名を表す String 値の配列。

getSessionStore() getsessionstore

現在のオブジェクトに結び付けられているセッションストアを返します。

パラメーター

なし。

戻り値

this

init() init-1

ストアを初期化済みとしてマークし、initialize イベントを発生させます。

パラメーター

なし。

戻り値

戻り値はありません。

isInitialized() isinitialized

セッションストアが初期化されていることを示します。

パラメーター

なし。

戻り値

ストアが初期化されている場合は値 true、ストアが初期化されていない場合は値 false。

loadInitProperties(obj, setValues) loadinitproperties-obj-setvalues

指定されたオブジェクトのプロパティをセッションストアの初期化データに追加します。オプションで、オブジェクトデータもストアデータに追加します。

パラメーター

戻り値

戻り値はありません。

removeProperty(name) removeproperty-name

セッションストアからプロパティを削除します。完了時に update イベントを発生させます。ストアのデータプロパティが存在しない場合は、init メソッドを呼び出します。

パラメーター

戻り値

戻り値はありません。

reset() reset

データストアの初期値を復元します。デフォルトの実装では、すべてのデータが削除されるだけです。完了時に update イベントを発生させます。

パラメーター

なし。

戻り値

戻り値はありません。

setProperties(properties) setproperties-properties

複数のプロパティの値を設定します。完了時に update イベントを発生させます。ストアのデータプロパティが存在しない場合は、init メソッドを呼び出します。

パラメーター

戻り値

戻り値はありません。

setProperty(name, value) setproperty-name-value

プロパティの値を設定します。完了時に update イベントを発生させます。ストアのデータプロパティが存在しない場合は、init メソッドを呼び出します。

パラメーター

戻り値

戻り値はありません。