ClientContext JavaScript API

CQ_Analytics.ClientContextMgr

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

CQ_Analytics.PersistedSessionStore を拡張します。

メソッド

getRegisteredStore(name)

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

パラメーター

  • name：String。セッションストアの名前。

戻り値

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

register(sessionstore)

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

パラメーター

  • sessionstore：CQ_Analytics.SessionStore。登録するセッションストアオブジェクト。

戻り値

戻り値はありません。

CQ_Analytics.ClientContextUtils

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

メソッド

onStoreInitialized(storeName, callback, delay)

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

  • 前回の初期化の遅延期間中にストアが初期化されると、前回の関数呼び出しがキャンセルされ、現在の初期化に対して関数が再度呼び出されます。
  • 次の初期化が発生する前に遅延期間が経過した場合、コールバック関数は 2 回実行されます。

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

  • 要求が完了し、データが取得され、ストアに読み込まれます。この場合、初期化は一度だけおこなわれます。
  • 要求が失敗します（タイムアウト）。この場合、初期化はおこなわれず、ストアにデータは読み込まれません。
  • ストアにはデフォルト値（初期化プロパティ）が事前設定されていますが、要求は失敗します（タイムアウト）。デフォルト値を使用した初期化は一度だけおこなわれます。
  • ストアは事前設定されています。

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

パラメーター

  • storeName：String。リスナーに追加するセッションストアの名前。
  • callback：Function。ストアの初期化時に呼び出す関数。
  • delay：Boolean または Number。コールバック関数の呼び出しを遅延させる時間（ミリ秒単位）。Boolean 値 true の場合、デフォルトの遅延 200 ms が使用されます。Boolean 値 false または負の数の場合、遅延は使用されません。

戻り値

戻り値はありません。

onStoreRegistered(storeName, callback)

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

パラメーター

  • storeName：String。リスナーに追加するセッションストアの名前。
  • callback：Function。ストアの初期化時に呼び出す関数。

戻り値

戻り値はありません。

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：String。STORENAME プロパティとして使用する名前。STOREKEY プロパティの値は、すべて大文字で storeName に設定されます。storeName が指定されていない場合、メソッドは null を返します。
  • serviceURL：String。JSONP サービスの URL
  • dynamicData：（オプション）Object。コールバック関数を呼び出す前に、ストアの初期化データに追加する JSON データ。
  • deferLoading：（オプション）Boolean。値が true の場合は、オブジェクトの作成時に JSONP サービスが呼び出されません。値が false の場合は、JSONP サービスが呼び出されます。
  • loadingCallback：（オプション）文字列。JSONP サービスが返す JSONP オブジェクトの処理のために呼び出す関数の名前。コールバック関数は、CQ_Analytics.JSONPStore オブジェクトである単一のパラメーターを定義する必要があります。

戻り値

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

getServiceURL()

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

パラメーター

なし。

戻り値

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

load(serviceURL, dynamicData, callback)

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

パラメーター

  • serviceURL：（オプション）String。呼び出す JSONP サービス。値が null の場合は、既に設定済みのサービス URL が使用されます。null 以外の値は、このオブジェクトに使用する JSONP サービスを設定します。（setServiceURL を参照）。
  • dynamicData：（オプション）Object。コールバック関数を呼び出す前に、ストアの初期化データに追加する JSON データ。
  • callback：（オプション）String。JSONP サービスが返す JSONP オブジェクトの処理のために呼び出す関数の名前。コールバック関数は、CQ_Analytics.JSONPStore オブジェクトである単一のパラメーターを定義する必要があります。

戻り値

戻り値はありません。

registerNewInstance(storeName, serviceURL, dynamicData, callback)

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

パラメーター

  • storeName：String。STORENAME プロパティとして使用する名前。STOREKEY プロパティの値は、すべて大文字で storeName に設定されます。storeName が指定されていない場合、メソッドは null を返します。
  • serviceURL：（オプション）String。JSONP サービスの URL。
  • dynamicData：（オプション）Object。コールバック関数を呼び出す前に、ストアの初期化データに追加する JSON データ。
  • callback：（オプション）String。JSONP サービスが返す JSONP オブジェクトの処理のために呼び出す関数の名前。コールバック関数は、CQ_Analytics.JSONPStore オブジェクトである単一のパラメーターを定義する必要があります。

戻り値

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

setServiceURL(serviceURL)

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

パラメーター

  • serviceURL：String。JSON データを提供する JSONP サービスの URL

戻り値

戻り値はありません。

CQ_Analytics.JSONStore

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

myjsonstore = new CQ_Analytics.JSONStore

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

CQ_Analytics.SessionStore を拡張します。

プロパティ

STOREKEY

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

STORENAME

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

メソッド

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

clear()

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

パラメーター

なし。

戻り値

戻り値はありません。

getInstance(storeName, jsonData)

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

パラメーター

  • storeName：String。STORENAME プロパティとして使用する名前。STOREKEY プロパティの値は、すべて大文字で storeName に設定されます。
  • jsonData：Object。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)

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

パラメーター

  • storeName：String。STORENAME プロパティとして使用する名前。STOREKEY プロパティの値は、すべて大文字で storeName に設定されます。
  • jsonData：Object。JSON データを格納するオブジェクト。

戻り値

CQ_Analytics.JSONStore オブジェクト。

CQ_Analytics.Observable

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

メソッド

addListener(event, fct, scope)

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

パラメーター

  • event：String。リッスンするイベントの名前。
  • fct：Function。イベント発生時に呼び出される関数。
  • scope：（オプション）オブジェクト。ハンドラー関数の実行範囲。ハンドラー関数の「this」コンテキストとなります。

戻り値

戻り値はありません。

removeListener(event, fct)

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

パラメーター

  • event：String。イベントの名前。
  • fct：Function。イベントハンドラー。

戻り値

戻り値はありません。

CQ_Analyics.PersistedJSONPStore

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

CQ_Analytics.PersistedJSONStore を拡張します。

メソッド

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

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

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

パラメーター

  • storeName：String。STORENAME プロパティとして使用する名前。STOREKEY プロパティの値は、すべて大文字で storeName に設定されます。storeName が指定されていない場合、メソッドは null を返します。
  • serviceURL：String。JSONP サービスの URL
  • dynamicData：（オプション）Object。コールバック関数を呼び出す前に、ストアの初期化データに追加する JSON データ。
  • deferLoading：（オプション）Boolean。値が true の場合は、オブジェクトの作成時に JSONP サービスが呼び出されません。値が false の場合は、JSONP サービスが呼び出されます。
  • loadingCallback：（オプション）文字列。JSONP サービスが返す JSONP オブジェクトの処理のために呼び出す関数の名前。コールバック関数は、CQ_Analytics.JSONPStore オブジェクトである単一のパラメーターを定義する必要があります。

戻り値

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

getServiceURL()

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

パラメーター

なし。

戻り値

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

load(serviceURL, dynamicData, callback)

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

パラメーター

  • serviceURL：（オプション）String。呼び出す JSONP サービス。値が null の場合は、既に設定済みのサービス URL が使用されます。null 以外の値は、このオブジェクトに使用する JSONP サービスを設定します。（setServiceURL を参照）。
  • dynamicData：（オプション）Object。コールバック関数を呼び出す前に、ストアの初期化データに追加する JSON データ。
  • callback：（オプション）String。JSONP サービスが返す JSONP オブジェクトの処理のために呼び出す関数の名前。コールバック関数は、CQ_Analytics.JSONPStore オブジェクトである単一のパラメーターを定義する必要があります。

戻り値

戻り値はありません。

registerNewInstance(storeName, serviceURL, dynamicData, callback)

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

パラメーター

  • storeName：String。STORENAME プロパティとして使用する名前。STOREKEY プロパティの値は、すべて大文字で storeName に設定されます。storeName が指定されていない場合、メソッドは null を返します。
  • serviceURL：（オプション）String。JSONP サービスの URL。
  • dynamicData：（オプション）Object。コールバック関数を呼び出す前に、ストアの初期化データに追加する JSON データ。
  • callback：（オプション）String。JSONP サービスが返す JSONP オブジェクトの処理のために呼び出す関数の名前。コールバック関数は、CQ_Analytics.JSONPStore オブジェクトである単一のパラメーターを定義する必要があります。

戻り値

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

setServiceURL(serviceURL)

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

パラメーター

  • serviceURL：String。JSON データを提供する JSONP サービスの URL

戻り値

戻り値はありません。

CQ_Analytics.PersistedJSONStore

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

CQ_Analytics.PersistedSessionStore を拡張します。

プロパティ

STOREKEY

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

STORENAME

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

メソッド

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

getInstance(storeName, jsonData)

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

パラメーター

  • storeName：String。STORENAME プロパティとして使用する名前。STOREKEY プロパティの値は、すべて大文字で storeName に設定されます。
  • jsonData：Object。JSON データを格納するオブジェクト。

戻り値

CQ_Analytics.PersistedJSONStore オブジェクト。

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)

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

パラメーター

  • storeName：String。STORENAME プロパティとして使用する名前。STOREKEY プロパティの値は、すべて大文字で storeName に設定されます。
  • jsonData：Object。JSON データを格納するオブジェクト。

戻り値

CQ_Analytics.PersistedJSONStore オブジェクト。

CQ_Analytics.PersistedSessionStore

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

mypersistedstore = new CQ_Analytics.PersistedSessionStore

CQ_Analytics.SessionStore を拡張します。

プロパティ

STOREKEY

デフォルト値は key です。

メソッド

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

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

getStoreKey()

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

パラメーター

なし

戻り値

STOREKEY プロパティの値。

isPersisted(name)

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

パラメーター

  • name：String。プロパティの名前。

戻り値

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

persist()

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

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

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

パラメーター

なし

戻り値

戻り値はありません。

reset(deferEvent)

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

パラメーター

  • deferEvent：値が true の場合は、update イベントを発生させないようにします。値が false の場合は、update イベントを発生させます。

戻り値

戻り値はありません。

setNonPersisted(name)

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

パラメーター

  • name：String。永続化しないプロパティの名前。

戻り値

戻り値はありません。

CQ_Analytics.SessionStore

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

mystore = new CQ_Analytics.SessionStore

CQ_Analytics.Observable を拡張します。

プロパティ

STORENAME

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

メソッド

addInitProperty(name, value)

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

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

パラメーター

  • name：String。追加するプロパティの名前。
  • value：String。追加するプロパティの値。

戻り値

戻り値はありません。

clear()

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

パラメーター

なし。

戻り値

戻り値はありません。

getData(excluded)

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

パラメーター

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

戻り値

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

getInitProperty(name)

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

パラメーター

  • name：String。取得するデータプロパティの名前。

戻り値

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

getName()

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

パラメーター

なし。

戻り値

ストア名を表す String 値。

getProperty(name, raw)

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

パラメーター

  • name：String。取得するデータプロパティの名前。
  • raw：Boolean。値が true の場合は、未加工のプロパティ値が返されます。値が false の場合は、返す値が XSS フィルタリングされます。

戻り値

データプロパティの値。

getPropertyNames(excluded)

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

パラメーター

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

戻り値

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

getSessionStore()

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

パラメーター

なし。

戻り値

this

init()

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

パラメーター

なし。

戻り値

戻り値はありません。

isInitialized()

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

パラメーター

なし。

戻り値

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

loadInitProperties(obj, setValues)

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

パラメーター

  • obj：可算プロパティを格納するオブジェクト。
  • setValues：true の場合、ストアデータに同じ名前のプロパティがまだ含まれていなければ、obj のプロパティがセッションストアデータに追加されます。false の場合、セッションストアデータに追加されるデータはありません。

戻り値

戻り値はありません。

removeProperty(name)

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

パラメーター

  • name：String。削除するプロパティの名前。

戻り値

戻り値はありません。

reset()

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

パラメーター

なし。

戻り値

戻り値はありません。

setProperties(properties)

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

パラメーター

  • Properties：Object。可算プロパティを格納するオブジェクト。各プロパティ名と値がストアに追加されます。

戻り値

戻り値はありません。

setProperty(name, value)

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

パラメーター

  • name：String。プロパティの名前。
  • value：String。プロパティ値。

戻り値

戻り値はありません。

このページ