ContextHub Javascript API參考資料 contexthub-javascript-api-reference

當 頁面已新增ContextHub元件.

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存放區的物件。 每個商店都是一個使用與商店相同名稱的對象。

範例

下列範例會擷取所有商店，然後擷取地理位置商店：

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

getStore(name) getstore-name

以Javascript物件擷取商店。

參數

傳回

代表存放區的物件。

範例

下列範例會擷取地理位置存放區：

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

A ContextHub.Utils.Eventing 物件。 使用此對象來綁定函式以儲存事件。 有關預設值和初始化的資訊，請參閱 init(name,config).

名稱 name

商店的名稱。

持續性 persistence

ContextHub.Utils.Persistence物件。 有關預設值和初始化的資訊，請參閱 init(name,config).

函式(ContextHub.Store.Core) functions-contexthub-store-core

addAllItems(tree, options) addallitems-tree-options

將資料對象或陣列與儲存資料合併。 物件或陣列中的每個索引鍵/值組會新增至儲存區(透過 setItem 函式):

請注意，值可以是物件。

參數

傳回

A boolean 值：

addReference(key, anotherKey) addreference-key-anotherkey

建立從一個鍵到另一個鍵的引用。 鍵無法引用本身。

參數

傳回

A 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

判斷是否暫停此商店的事件。

傳回

布林值：

pauseEventing() pauseeventing

暫停儲存的事件，以便不觸發任何事件。 此函式不需要參數且不傳回值。

removeItem(key, options) removeitem-key-options

從存放區移除金鑰/值組。

移除金鑰時，函式會觸發 data 事件。 事件資料包括儲存名稱、已移除的金鑰名稱、已移除的值、金鑰的新值(null)，以及「remove」的動作類型。

（可選）您可以防止 data 事件。

參數

傳回

A boolean 值：

removeReference(key) removereference-key

從儲存中刪除引用。

參數

傳回

A boolean 值：

reset(keepRemainingData) reset-keepremainingdata

重設儲存的持續資料的初始值。 您可以選擇從存放區移除所有其他資料。 重設存放區時，此存放區的事件會暫停。 此函式不會傳回任何值。

初始值會提供在用於實例化儲存對象的配置對象的initialValues屬性中。

參數

重設儲存的持續資料的初始值。 您可以選擇從存放區移除所有其他資料。 重設存放區時，此存放區的事件會暫停。 此函式不會傳回任何值。

初始值會提供在用於實例化儲存對象的配置對象的initialValues屬性中。

參數

resolveReference(key, retry) resolvereference-key-retry

擷取參考的金鑰。 或者，您可以指定用於解析最佳匹配的迭代次數。

參數

傳回

A string 代表參考索引鍵的值。 如果未解析任何引用，則 key 參數。

resumeEventing() resumeeventing

繼續此存放區的事件，以觸發事件。 此函式不定義參數，也不傳回值。

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

將索引鍵/值組新增至商店。

觸發 data 事件，條件是索引鍵的值與目前儲存用於索引鍵的值不同。 您可以選擇防止 data 事件。

事件資料包含的儲存名稱、索引鍵、先前的值、新值，以及 set.

參數

傳回

A 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。

參數

傳回

A string 代表服務URL的值。

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

初始化ContextHub.Store.JSONPStore對象。

參數

queryService(reload) queryservice-reload

查詢遠程JSONP服務並快取響應。 如果自上次呼叫此函式以來的時間量小於 config.service.ttl，則不會呼叫服務，且不會變更快取回應。 您可以視需要強制呼叫服務。 此 config.service.ttl在呼叫 init 函式來初始化儲存。

查詢完成時觸發就緒事件。 如果未設定JSONP服務URL，函式則不會執行任何動作。

參數

重設 reset

重設儲存區持續資料的初始值，然後呼叫JSONP服務。 您可以選擇從存放區移除所有其他資料。 初始值重設時，此存放區的事件會暫停。 此函式不會傳回任何值。

初始值會提供在用於實例化儲存對象的配置對象的initialValues屬性中。

參數

resolveParameter(f) resolveparameter-f

解析給定參數。

ContextHub.Store.PersistedJSONPStore contexthub-store-persistedjsonpstore

ContextHub.Store.PerisentJSONPStore延伸 ContextHub.Store.JSONPStore 因此它繼承該類的所有函式。 不過，從JSONP服務擷取的資料會根據ContextHub持續性的設定而持續保存。 (請參閱 持續性模式.)

ContextHub.Store.PersistedStore contexthub-store-persistedstore

ContextHub.Store.PerisentStore延伸 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, dontRenderer) registerrenderer-moduletype-renderer-dontrender

向ContextHub註冊UI模組轉譯器。 註冊轉譯器後，可將其用於 建立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是否存在。

參數

傳回

A 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值，或 null 若找不到金鑰的cookie。

範例

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

移除符合指定篩選器的所有Cookie。 使用getKeys函式來比對Cookie，並使用removeItem函式來移除。

參數

傳回

此函式不會傳回值。

ContextHub.Utils.Eventing contexthub-utils-eventing

可讓您將函式系結和解除系結至ContextHub儲存事件。 使用訪問儲存的ContextHub.Utils.Eventing對象 事件 商店的屬性。

函式(ContextHub.Utils.Eventing) functions-contexthub-utils-eventing

off（名稱，選取器） off-name-selector

從事件中取消綁定函式。

參數

傳回

此函式不會傳回任何值。

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

將函式綁定到事件。 每次發生事件時都會呼叫函式。 可選地，在建立綁定之前，可以為過去發生的事件調用函式。

參數

傳回

當 triggerForPastEvents 引數 true，此函式會傳回 boolean 指出事件是否發生在過去的值：

若 triggerForPastEvents is false，此函式不會傳回任何值。

範例

以下範例將函式系結至地理位置存放區的資料事件。 函式會以商店中緯度資料項目的值填入頁面上的元素。

<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

將函式綁定到事件。 對於事件的首次出現，函式只會呼叫一次。 或者，可以在建立綁定之前，為過去發生的事件調用函式。

參數

傳回

當 triggerForPastEvents 引數 true，此函式會傳回 boolean 指出事件是否發生在過去的值：

若 triggerForPastEvents is false，此函式不會傳回任何值。

ContextHub.Utils.inheritance contexthub-utils-inheritance

允許對象繼承另一個對象的屬性和方法的實用程式類。

函式(ContextHub.Utils.inheritation) 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 是R 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

建立資料對象的副本，並從第二個對象添加到資料樹中。 函式返回副本，不修改任何一個原始對象。 當兩個對象的資料樹包含相同的鍵時，第二對象的值覆蓋第一對象的值。

參數

傳回

包含合併資料的物件。

cleanup() cleanup

建立對象的副本，查找並刪除資料樹中不包含值、空值或未定義的項，並返回副本。

參數

傳回

已清理的樹的副本。

getItem() getitem

從物件中擷取金鑰的值。

參數

傳回

與鍵對應的值。 當索引鍵具有子索引鍵時，此函式會傳回複雜物件。 鍵的值類型為 undefined, null 的URL。

範例

請考量下列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); script會傳回下列陣列：

["/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

將索引鍵/值組新增至物件復本的資料樹。 如需資料樹的相關資訊，請參閱 持久性.

參數

傳回

此 tree 包含 key/ value 配對。

範例

請考量下列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.storeCandiates) functions-contexthub-utils-storecandidates

getRegisteredCandiates(storeType) getregisteredcandidates-storetype

返回註冊為儲存候選項的儲存類型。 檢索特定儲存類型或所有儲存類型的註冊證書。

參數

傳回

儲存類型的物件。 對象屬性是儲存類型名稱，而屬性值是已註冊儲存候選項的陣列。

getStoreFromCapdiations(storeType) getstorefromcandidates-storetype

從註冊候選項返回儲存類型。 如果註冊了多個同名的儲存類型，則函式將返回具有最高優先順序的儲存類型。

參數

傳回

表示註冊儲存候選項的對象。 如果未註冊請求的儲存類型，則會引發錯誤。

getSupportedStoreTypes() getsupportedstoretypes

返回註冊為儲存候選項的儲存類型的名稱。 此函式不需要參數。

傳回

字串值的陣列，其中每個字串是註冊儲存候選項的儲存類型。 請參閱 storeType 參數 ContextHub.Utils.storeCandidates.registerStoreCandidate 函式。

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

使用名稱和優先順序將儲存對象註冊為儲存候選項。

優先順序是指出同名商店重要性的數字。 當使用與已註冊的儲存候選相同的名稱註冊儲存候選時，使用優先順序較高的候選。 當註冊儲存候選時，僅當優先順序高於同名註冊儲存候選時，才註冊儲存。

參數

範例

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