ContextHub JavaScript API リファレンス contexthub-javascript-api-reference

ContextHub コンポーネントをページに追加すると、ContextHub JavaScript API がスクリプトで使用できるようになります。

ContextHub 定数 contexthub-constants

ContextHub JavaScript API によって定義される定数値です。

イベント定数 event-constants

ContextHub ストアに対して発生する名前付きイベントを以下の表に示します。ContextHub.Utils.Eventing も参照してください。

UI イベント定数 ui-event-constants

次の表に、ContextHub UI に関して発生するイベントの名前を示します。

ContextHub JavaScript API リファレンス contexthub-javascript-api-reference-2

ContextHub オブジェクトを使用して、すべてのストアにアクセスできます。

関数（ContextHub） functions-contexthub

getAllStores() getallstores

登録されている ContextHub ストアをすべて返します。

この関数にパラメーターはありません。

戻り値

すべての ContextHub ストアを格納したオブジェクト。各ストアは、ストアと同じ名前を使用するオブジェクトです。

例

次の例では、すべてのストアを取得してから、geolocation ストアを取得しています。

var allStores = ContextHub.getAllStores();
var geoloc = allStores.geolocation

getStore(name) getstore-name

ストアを JavaScript オブジェクトとして取得します。

パラメーター

戻り値

ストアを表すオブジェクト。

例

次の例では、geolocation ストアを取得します。

var geoloc = ContextHub.getStore("geolocation");

ContextHub.SegmentEngine.Segment contexthub-segmentengine-segment

ContextHub セグメントを表します。ContextHub.SegmentEngine.SegmentManager を使用して、セグメントを取得します。

関数（ContextHub.ContextEngine.Segment） functions-contexthub-contextengine-segment

getName() getname

セグメント名を文字列の値として返します。

getPath() getpath

セグメント定義のリポジトリパスを文字列値として返します。

ContextHub.SegmentEngine.SegmentManager contexthub-segmentengine-segmentmanager

ContextHub セグメントへのアクセスを提供します。

関数（ContextHub.SegmentEngine.SegmentManager） functions-contexthub-segmentengine-segmentmanager

getResolvedSegments() getresolvedsegments

現在のコンテキストで解決されたセグメントを返します。この関数にパラメーターはありません。

戻り値

ContextHub.SegmentEngine.Segment オブジェクトの配列。

ContextHub.Store.Core contexthub-store-core

ContextHub ストアのベースクラス。

プロパティ（ContextHub.Store.Core） properties-contexthub-store-core

eventing eventing

ContextHub.Utils.Eventing オブジェクト。このオブジェクトを使用して、関数をストアイベントにバインドします。デフォルト値と初期化については、init(name,config) を参照してください。

name name

ストアの名前。

persistence persistence

ContextHub.Utils.Persistence オブジェクト。デフォルト値と初期化については、[init(name,config)](https://experienceleague.adobe.com/docs/experience-manager-65/content/implementing/developing/personlization/contexthub-api.html?lang=ja#init-name-config). を参照してください。

関数（ContextHub.Store.Core） functions-contexthub-store-core

addAllItems(tree, options) addallitems-tree-options

データオブジェクトまたは配列とストアデータを結合します。オブジェクトのキーと値の各ペアまたは配列が（setItem 関数を使用して）ストアに追加されます。

値にオブジェクトを使用できます。

パラメーター

戻り値

boolean 値：

addReference(key, anotherKey) addreference-key-anotherkey

1 つのキーから別のキーへの参照を作成します。キーは自分自身を参照できません。

パラメーター

戻り値

boolean 値：

announceReadiness() announcereadiness

このストアに対する ready イベントを発生させます。この関数にパラメーターはなく、値を返しません。

clean() clean

すべてのデータをストアから削除します。この関数にパラメーターおよび戻り値はありません。

getItem(key) getitem-key

キーに関連付けられている値を返します。

パラメーター

戻り値

キーの値を表すオブジェクト。

getKeys(includeInternals) getkeys-includeinternals

ストアからキーを取得します。オプションで、ContextHub フレームワークが内部的に使用するキーを取得できます。

パラメーター

戻り値

キー名（string 値）の配列。

getReferences() getreferences

ストアから参照を取得します。

戻り値

参照キーを被参照キーのインデックスとして使用する配列。

getTree(includeInternals) gettree-includeinternals

データツリーをストアから取得します。オプションで、ContextHub フレームワークが内部的に使用しているキーと値のペアを含めることができます。

パラメーター

戻り値

データツリーを表すオブジェクト。キーは、オブジェクトのプロパティ名です。

init(name, config) init-name-config

ストアを初期化します。

パラメーター

isEventingPaused() iseventingpaused

このストアに対するイベンティングが一時停止されているかどうかを判断します。

戻り値

次の boolean 値。

pauseEventing() pauseeventing

このストアに対するイベンティングを一時停止して、イベントが発生しないようにします。この関数にパラメーターは必要なく、値を返しません。

removeItem(key, options) removeitem-key-options

キーと値のペアをストアから削除します。

キーが削除されると、この関数が data イベントを発生させます。イベントデータには、ストア名、削除されたキーの名前、削除された値、キーの新しい値（null）およびアクションタイプ「remove」が含まれます。

オプションで、data イベントを発生させないようにすることができます。

パラメーター

戻り値

boolean 値：

removeReference(key) removereference-key

参照をストアから削除します。

パラメーター

戻り値

boolean 値：

reset(keepRemainingData) reset-keepremainingdata

ストアの永続データの初期値を再設定します。オプションで、その他すべてのデータをストアから削除できます。ストアが再設定されている間、このストアに対するイベンティングは一時停止されます。この関数は値を返しません。

初期値は、ストアオブジェクトのインスタンス化に使用される config オブジェクトの initialValues プロパティで提供されます。

パラメーター

ストアの永続データの初期値を再設定します。オプションで、その他すべてのデータをストアから削除できます。ストアが再設定されている間、このストアに対するイベンティングは一時停止されます。この関数は値を返しません。

初期値は、ストアオブジェクトのインスタンス化に使用される config オブジェクトの initialValues プロパティで提供されます。

パラメーター

resolveReference(key, retry) resolvereference-key-retry

被参照キーを取得します。オプションで、最良一致の解決に使用する繰り返し回数を指定できます。

パラメーター

戻り値

被参照キーを表す string 値。参照が解決されない場合は、key パラメーターの値が返されます。

resumeEventing() resumeeventing

このストアに対するイベンティングを再開し、イベントが発生するようにします。この関数はパラメーターを定義せず、値を返しません。

setItem(key, value, options) setitem-key-value-options

キーと値のペアをストアに追加します。

キーの値がそのキーに対して現在保存されている値と異なる場合にのみ data イベントを発生させます。オプションで、data イベントを発生させないようにすることができます。

イベントデータには、ストア名、キー、前の値、新しい値およびアクションタイプ set が含まれます。

パラメーター

戻り値

boolean 値：

ContextHub.Store.JSONPStore contexthub-store-jsonpstore

JSON データを格納するストア。データは外部の JSONP サービスから取得されるか、オプションで JSON データを返すサービスから取得されます。このクラスのインスタンスを作成する際に、init 関数を使用してサービスの詳細を指定します。

ストアは、インメモリパーシスタンス（JavaScript 変数）を使用します。ストアデータは、ページが持続している間のみ使用可能です。

ContextHub.Store.JSONPStore は ContextHub.Store.Core を拡張したものなので、このクラスの関数を継承しています。

関数（ContextHub.Store.JSONPStore） functions-contexthub-store-jsonpstore

configureService(serviceConfig, override) configureservice-serviceconfig-override

このオブジェクトが使用する JSONP サービスへの接続の詳細を設定します。既存の設定を更新または置換できます。この関数は値を返しません。

パラメーター

getRawResponse() getrawresponse

JSONP サービスへの最後の呼び出し以降キャッシュされている未加工の応答を返します。この関数にパラメーターは必要ありません。

戻り値

未加工の応答を表すオブジェクト。

getServiceDetails() getservicedetails

この ContextHub.Store.JSONPStore オブジェクトのサービスオブジェクトを取得します。サービスオブジェクトには、サービス URL の作成に必要なすべての情報が格納されています。

戻り値

次のプロパティを持つオブジェクト。

getServiceURL(resolve) getserviceurl-resolve

JSONP サービスの URL を取得します。

パラメーター

戻り値

サービス URL を表す string 値。

init(name, config) init-name-config-1

ContextHub.Store.JSONPStore オブジェクトを初期化します。

パラメーター

queryService(reload) queryservice-reload

リモート JSONP サービスをクエリし、応答をキャッシュします。この関数の前回の呼び出しからの時間が config.service.ttl の値より小さい場合、サービスは呼び出されず、キャッシュされた応答は変更されません。オプションで、サービスを強制的に呼び出すことができます。config.service.ttl プロパティは、ストアを初期化するために init 関数を呼び出すと設定されます。

クエリが完了すると、ready イベントが発生します。JSONP サービス URL が設定されていない場合、この関数は何もしません。

パラメーター

reset reset

ストアの永続データを初期値にリセットしてから、JSONP サービスを呼び出します。オプションで、その他すべてのデータをストアから削除できます。初期値が再設定されている間、このストアに対するイベンティングは一時停止されます。この関数は値を返しません。

初期値は、ストアオブジェクトのインスタンス化に使用される config オブジェクトの initialValues プロパティで提供されます。

パラメーター

resolveParameter(f) resolveparameter-f

指定されたパラメーターを解決します。

ContextHub.Store.PersistedJSONPStore contexthub-store-persistedjsonpstore

ContextHub.Store.PersistedJSONPStore は ContextHub.Store.JSONPStore を拡張したものなので、このクラスのすべての関数を継承しています。ただし、JSONP サービスから取得されるデータは、ContextHub の永続性に応じて保持されます（永続モードを参照）。

ContextHub.Store.PersistedStore contexthub-store-persistedstore

ContextHub.Store.PersistedStore は ContextHub.Store.Core を拡張したものなので、このクラスのすべての関数を継承しています。このストアのデータは、ContextHub の永続性の設定に応じて保持されます。

ContextHub.Store.SessionStore contexthub-store-sessionstore

ContextHub.Store.SessionStore は ContextHub.Store.Core を拡張したものなので、このクラスのすべての関数を継承しています。このストアのデータは、インメモリパーシスタンス（JavaScript オブジェクト）を使用して保持されます。

ContextHub.UI contexthub-ui

UI モジュールおよび UI モジュールレンダラーを管理します。

関数（ContextHub.UI） functions-contexthub-ui

registerRenderer(moduleType, renderer, dontRender) registerrenderer-moduletype-renderer-dontrender

UI モジュールレンダラーを ContextHub に登録します。レンダラーが登録された後は、レンダラーを UI モジュールの作成に使用できます。ContextHub.UI.BaseModuleRenderer を拡張してカスタム UI モジュールレンダラーを作成する場合は、この関数を使用します。

パラメーター

例

次の例では、レンダラーを contexthub.browserinfo モジュールタイプとして登録します。

ContextHub.UI.registerRenderer('contexthub.browserinfo', new SurferinfoRenderer());

ContextHub.Utils.Cookie contexthub-utils-cookie

Cookie とやり取りするためのユーティリティクラス。

関数（ContextHub.Utils.Cookie） functions-contexthub-utils-cookie

exists(key) exists-key

cookie が存在するかどうかを判断します。

パラメーター

戻り値

boolean 値 true は、cookie が存在することを示します。

例

if (ContextHub.Utils.Cookie.exists("name")) {
   // conditionally-executed code
}

getAllItems(filter) getallitems-filter

フィルターに一致するキーを持つすべての cookie を返します。

パラメーター

戻り値

Cookie のオブジェクト。オブジェクトプロパティは Cookie のキーで、キー値は Cookie の値です。

例

ContextHub.Utils.Cookie.getAllItems([/^cq-authoring/, /^cq-editor/])

getItem(key) getitem-key-1

cookie の値を返します。

パラメーター

戻り値

cookie の値、またはそのキーの cookie が見つからなかった場合は null。

例

ContextHub.Utils.Cookie.getItem("name");

getKeys(filter) getkeys-filter

フィルターに一致する既存の cookie のキーからなる配列を返します。

パラメーター

戻り値

それぞれがフィルターに一致する cookie のキーである文字列からなる配列。

例

ContextHub.Utils.Cookie.getKeys([/^cq-authoring/, /^cq-editor/])

removeItem(key, options) removeitem-key-options-1

cookie を削除します。Cookie を削除するには、値を空の文字列に設定し、有効期限を現在の日付より前の日に設定します。

パラメーター

戻り値

この関数は値を返しません。

例

ContextHub.Utils.Cookie.vanish([/^cq-authoring/, 'cq-scrollpos']);

setItem(key, value, options) setitem-key-value-options-1

指定されたキーと値の Cookie を作成し、その Cookie を現在のドキュメントに追加します。オプションで、Cookie の属性を設定するオプションを指定できます。

パラメーター

戻り値

値が設定された cookie。

例

ContextHub.Utils.Cookie.setItem("name", "mycookie", {
    expires: 3,
    domain: 'localhost',
    path: '/some/directory',
    secure: true
});

vanish(filter, options) vanish-filter-options

指定されたフィルターに一致するすべての cookie を削除します。Cookie は、getKeys 関数を使用して照合され、removeItem 関数を使用して削除されます。

パラメーター

戻り値

この関数は値を返しません。

ContextHub.Utils.Eventing contexthub-utils-eventing

関数を ContextHub ストアイベントにバインドおよびバインド解除できます。ストアの eventing プロパティを使用して、ストアの ContextHub.Utils.Eventing オブジェクトにアクセスします。

関数（ContextHub.Utils.Eventing） functions-contexthub-utils-eventing

off(name, selector) off-name-selector

イベントから関数をバインド解除します。

パラメーター

戻り値

この関数は値を返しません。

on(name, handler, selector, triggerForPastEvents) on-name-handler-selector-triggerforpastevents

関数をイベントにバインドします。イベントが発生するたびに関数が呼び出されます。オプションで、バインディングが確立される前に過去に発生したイベントに対して関数を呼び出すことができます。

パラメーター

戻り値

triggerForPastEvents 引数が true の場合、この関数はイベントが過去に発生したかどうかを示す boolean 値を返します。

triggerForPastEvents が false の場合、この関数は値を返しません。

例

次の例では、関数を geolocation ストアの data イベントにバインドします。この関数は、ページ上の要素にストアの緯度データ項目の値を設定しています。

<div class="location">
    <p>latitude: <span id="lat"></span></p>
</div>

<script>
    var geostore = ContextHub.getStore("geolocation");
    geostore.eventing.on(ContextHub.Constants.EVENT_DATA_UPDATE,getlat,"getlat");

    function getlat(){
       latitude = geostore.getItem("latitude");
       $("#lat").html(latitude);
    }
</script>

once(name, handler, selector, triggerForPastEvents) once-name-handler-selector-triggerforpastevents

関数をイベントにバインドします。イベントが最初に発生した際に、関数が 1 回だけ呼び出されます。オプションで、バインディングが確立される前に過去に発生したイベントに対して関数を呼び出すことができます。

パラメーター

戻り値

triggerForPastEvents 引数が true の場合、この関数はイベントが過去に発生したかどうかを示す boolean 値を返します。

triggerForPastEvents が false の場合、この関数は値を返しません。

ContextHub.Utils.inheritance contexthub-utils-inheritance

オブジェクトが別のオブジェクトのプロパティおよびメソッドを継承できるようにするユーティリティクラス。

関数（ContextHub.Utils.inheritance） functions-contexthub-utils-inheritance

inherit(child, parent) inherit-child-parent

オブジェクトに別のオブジェクトのプロパティとメソッドを継承させます。

パラメーター

ContextHub.Utils.JSON contexthub-utils-json

オブジェクトを JSON 形式にシリアライズする関数および JSON 文字列をオブジェクトにデシリアライズする関数を提供します。

関数（ContextHub.Utils.JSON） functions-contexthub-utils-json

parse(data) parse-data

文字列値を JSON として解析し、JavaScript オブジェクトに変換します。

パラメーター

戻り値

JavaScript オブジェクト。

例

このコード ContextHub.Utils.JSON.parse("{'city':'Basel','country':'Switzerland','population':'173330'}"); は次のオブジェクトを返します。

Object {
   city: "Basel",
   country: "Switzerland",
   population: 173330
}

stringify(data) stringify-data

JavaScript の値およびオブジェクトを JSON 形式の文字列値にシリアライズします。

パラメーター

戻り値

シリアライズされた文字列値。data が egExp 値の場合、この関数は空のオブジェクトを返します。data が関数の場合は、undefined を返します。

例

次のコードは "{'city':'Basel','country':'Switzerland','population':'173330'}": を返します。

ContextHub.Utils.JSON.stringify({
   city: "Basel",
   country: "Switzerland",
   population: 173330
});

ContextHub.Utils.JSON.tree contexthub-utils-json-tree

このクラスは、保存される、または ContextHub ストアから取得されるデータオブジェクトの操作を容易にします。

関数（ContextHub.Utils.JSON.tree） functions-contexthub-utils-json-tree

addAllItems() addallitems

データオブジェクトのコピーを作成し、2 つ目のオブジェクトのデータツリーに追加します。この関数はコピーを返し、元のオブジェクトは変更しません。2 つのオブジェクトのデータツリーに同じキーが含まれている場合、2 つ目のオブジェクトの値は、最初のオブジェクトの値を上書きします。

パラメーター

戻り値

結合されたデータを格納するオブジェクト。

cleanup() cleanup

オブジェクトのコピーを作成し、値を含まないか、null 値または undefined 値を含むデータツリーの項目を探して削除し、コピーを返します。

パラメーター

戻り値

クリーンアップされるツリーのコピー。

getItem() getitem

キーに対する値をオブジェクトから取得します。

パラメーター

戻り値

キーに対応する値。キーに子キーがある場合、この関数は複合オブジェクトを返します。キーの値のタイプが undefined の場合、null が返されます。

例

次の JavaScript オブジェクトについて考えてみます。

myObject {
  user: {
    location: {
      city: "Basel",
        details: {
          population: 173330,
          elevation: 260
        }
      }
    }
  }

次のサンプルコードは、値 260 を返します。

ContextHub.Utils.JSON.tree.getItem(myObject, "/user/location/details/elevation");

次のサンプルコードは、子キーを持つキーの値を取得します。

ContextHub.Utils.JSON.tree.getItem(myObject, "/user");

この関数は次のオブジェクトを返します。

Object {
  location: {
    city: "Basel",
    details: {
      population: 173330,
      elevation: 260
    }
  }
}

getKeys() getkeys

オブジェクトのデータツリーからすべてのキーを取得します。オプションで、特定のキーの子のキーのみを取得できます。オプションで、取得したキーのソート順を指定することもできます。

パラメーター

戻り値

キーからなる配列。

例

次のオブジェクトについて考えてみます。

myObject {
  location: {
    weather: {
      temperature: "28C",
      humidity: "77%",
      precipitation: "10%",
      wind: "8km/h"
    },
    city: "Basel",
    country: "Switzerland",
    longitude: 7.5925727,
    latitude: 47.557421
  }
}

ContextHub.Utils.JSON.tree.getKeys(myObject); スクリプトは、次の配列を返します。

["/location", "/location/city", "/location/country", "/location/latitude", "/location/longitude", "/location/weather", "/location/weather/humidity", "/location/weather/precipitation", "/location/weather/temperature", "/location/weather/wind"]

removeItem() removeitem

指定されたオブジェクトのコピーを作成し、指定されたブランチをデータツリーから削除し、変更されたコピーを返します。

パラメーター

戻り値

キーが削除された元のデータオブジェクトのコピー。

例

次のオブジェクトについて考えてみます。

myObject {
  one: {
    foo: "bar",
    two: {
      three: {
        four: {
          five: 5,
          six: 6
        }
      }
    }
  }
}

次のサンプルスクリプトでは、データツリーから /one/two/three/four ブランチを削除しています。

myObject = ContextHub.Utils.JSON.tree.removeItem(myObject, "/one/two/three/four");

この関数は次のオブジェクトを返します。

myObject {
  one: {
    foo: "bar"
  }
}

sanitizeKey(key) sanitizekey-key

文字列値の不要部分を削除して、キーとして使用できるようにします。文字列の不要部分を削除するには、この関数で次のアクションを実行します。

作成された配列を使用して、使用可能なキーを作成します。パラメーター

戻り値

string 値からなる配列で、各文字列はスラッシュで区切られた key の一部です。不要部分が削除されたキーを表します。不要部分が削除された配列の長さがゼロの場合、この関数は null を返します。

例

次のコードは、文字列の不要部分を削除して ["this", "is", "a", "path"] という配列を作成し、その配列からキー "/this/is/a/path" を生成します。

var key = " / this////is/a/path ";
ContextHub.Utils.JSON.tree.sanitizeKey(key)
"/" + ContextHub.Utils.JSON.tree.sanitizeKey(key).join("/");

setItem(tree, key, value) setitem-tree-key-value

オブジェクトのコピーのデータツリーにキーと値のペアを追加します。データツリーについて詳しくは、永続性を参照してください。

パラメーター

戻り値

key と value のペアを含む tree オブジェクトのコピー。

例

次の JavaScript コードについて考えてみます。

var myObject = {
     user: {
        location: {
           city: "Basel"
           }
        }
     };

var myKey = "/user/location/details";

var myValue = {
      population: 173330,
      elevation: 260
     };

myObject = ContextHub.Utils.JSON.tree.setItem(myObject, myKey, myValue);

myObject オブジェクトは次の値を持ちます。

ContextHub.Utils.storeCandidates contexthub-utils-storecandidates

ストア候補を登録し、登録されたストア候補を取得できます。

関数（ContextHub.Utils.storeCandidates） functions-contexthub-utils-storecandidates

getRegisteredCandidates(storeType) getregisteredcandidates-storetype

ストア候補として登録されているストアタイプを返します。特定のストアタイプまたはすべてのストアタイプの登録されている候補を取得します。

パラメーター

戻り値

ストアタイプのオブジェクト。オブジェクトプロパティはストアタイプ名で、プロパティ値は登録済みのストア候補の配列です。

getStoreFromCandidates(storeType) getstorefromcandidates-storetype

登録されている候補からストアタイプを返します。複数のストアタイプが同じ名前で登録されている場合、この関数は最も優先度が高いストアタイプを返します。

パラメーター

戻り値

登録済みのストア候補を表すオブジェクト。要求されたストアタイプが登録されていない場合は、エラーが発生します。

getSupportedStoreTypes() getsupportedstoretypes

ストア候補として登録されているストアタイプの名前を返します。この関数はパラメーターを必要としません。

戻り値

文字列値からなる配列で、各文字列はストア候補と一緒に登録されたストアタイプです。storeType 関数の ContextHub.Utils.storeCandidates.registerStoreCandidate パラメーターを参照してください。

registerStoreCandidate(store, storeType, priority, applies) registerstorecandidate-store-storetype-priority-applies

名前と優先度を使用して、ストアオブジェクトをストア候補として登録します。

優先度は、同じ名前のストアの重要性を示す数値です。既に登録済みのストア候補と同じ名前を使用してストア候補を登録した場合、優先度の高い候補が使用されます。ストア候補を登録する場合、優先度が同じ名前の登録済みストア候補より高い場合にのみ、ストアが登録されます。

パラメーター

例

ContextHub.Utils.storeCandidates.registerStoreCandidate(myStoreCandidate,
                                'contexthub.mystorecandiate', 0);