將ContextHub元件新增至頁面時,您的指令碼即可使用ContextHub Javascript API。
ContextHub Javascript API定義的常數值。
下表列出ContextHub儲存區發生的名稱事件。 另請參閱ContextHub.Utils.Eventing。
常數 | 說明 | 值 |
---|---|---|
ContextHub.Constants.EVENT_NAMESPACE | ContextHub的事件命名空間 | ch |
ContextHub.Constants.EVENT_ALL_STORES_READY | 指示所有必需儲存庫都已註冊、初始化並準備好使用 | 全店就緒 |
ContextHub.Constants.EVENT_STORES_PARTIALLY_READY | 指出並非所有儲存都已在指定逾時內初始化 | 部分就緒 |
ContextHub.Constants.EVENT_STORE_REGISTERED | 在註冊商店時引發 | 儲存註冊 |
ContextHub.Constants.EVENT_STORE_READY | 指出存放區已準備就緒。 註冊後會立即觸發,但JSONP商店除外,擷取資料時會在此觸發)。 | 存放就緒 |
ContextHub.Constants.EVENT_STORE_UPDATED | 商店更新其持續性時引發 | 商店更新 |
ContextHub.Constants.PERSISTENCE_CONTAINER_NAME | 永續性容器名稱 | ContextHubPersistence |
ContextHub.Constants.SERVICE_RAW_RESPONSE_KEY | 儲儲存存原始JSON結果的特定永續性金鑰名稱 | /_/raw回應 |
ContextHub.Constants.SERVICE_RESPONSE_TIME_KEY | 儲存指出JSON資料擷取時的特定時間戳記 | /_/回應時間 |
ContextHub.Constants.SERVICE_LAST_URL_KEY | 儲存上次呼叫期間使用的JSON服務特定URL | /_/url |
ContextHub.Constants.IS_CONTAINER_EXPANDED | 指出ContextHub的UI是否已展開 | /_/容器擴展 |
下表列出ContextHub UI發生的事件名稱。
常數 | 說明 | 值 |
---|---|---|
ContextHub.Constants.EVENT_UI_MODE_REGISTERED | 註冊模式時引發 | ui-mode-registered |
ContextHub.Constants.EVENT_UI_MODE_UNREGISTERED | 未註冊模式時引發 | ui-mode-unecroved |
ContextHub.Constants.EVENT_UI_MODE_RENDERER_REGISTERED | 註冊模式轉譯器時引發 | ui-mode-renderer-registered |
ContextHub.Constants.EVENT_UI_MODE_RENDERER_UNREGISTERED | 未註冊模式轉譯器時引發 | ui-mode-renderer-unecroved |
ContextHub.Constants.EVENT_UI_MODE_ADDED | 新增模式時引發 | ui-mode-added |
ContextHub.Constants.EVENT_UI_MODE_REMOVED | 移除模式時引發 | ui-mode-removed |
ContextHub.Constants.EVENT_UI_MODE_SELECTED | 使用者選取模式時觸發 | ui-mode-selected |
ContextHub.Constants.EVENT_UI_MODULE_REGISTERED | 註冊新模組時引發 | ui模組已註冊 |
ContextHub.Constants.EVENT_UI_MODULE_UNREGISTERED | 未註冊模組時引發 | ui-module-uneclover |
ContextHub.Constants.EVENT_UI_MODULE_RENDERER_REGISTERED | 註冊模組轉譯器時引發 | ui-module-renderer-registered |
ContextHub.Constants.EVENT_UI_MODULE_RENDERER_UNREGISTERED | 未註冊模組轉譯器時引發 | ui-module-renderer-unregersted |
ContextHub.Constants.EVENT_UI_MODULE_ADDED | 新增模組時引發 | ui-module-added |
ContextHub.Constants.EVENT_UI_MODULE_REMOVED | 移除模組時觸發 | ui-module-removed |
ContextHub.Constants.EVENT_UI_CONTAINER_ADDED | 將UI容器新增至頁面時引發 | ui-container-added |
ContextHub.Constants.EVENT_UI_CONTAINER_OPENED | 開啟ContextHub UI時觸發 | ui-container-opened |
ContextHub.Constants.EVENT_UI_CONTAINER_CLOSED | 折疊ContextHub UI時觸發 | ui-container-closed |
ContextHub.Constants.EVENT_UI_PROPERTY_MODIFIED | 修改屬性時觸發 | ui-property-modified |
ContextHub.Constants.EVENT_UI_RENDERED | 每次轉譯ContextHub UI時(例如在屬性變更後)觸發 | ui呈現 |
ContextHub.Constants.EVENT_UI_INITIALIZED | 初始化UI容器時觸發 | ui初始化 |
ContextHub.Constants.ACTIVE_UI_MODE | 指示活動UI模式 | /_/active-ui模式 |
ContextHub物件可讓您存取所有存放區。
傳回所有已註冊的ContextHub存放區。
此函式沒有參數。
傳回
包含所有ContextHub存放區的物件。 每個商店都是一個使用與商店相同名稱的對象。
範例
下列範例會擷取所有商店,然後擷取地理位置商店:
var allStores = ContextHub.getAllStores();
var geoloc = allStores.geolocation;
以Javascript物件擷取商店。
參數
傳回
代表存放區的物件。
範例
下列範例會擷取地理位置存放區:
var geoloc = ContextHub.getStore("geolocation");
代表ContextHub區段。 使用ContextHub.SegmentEngine.SegmentManager來取得區段。
以字串值傳回區段名稱。
以字串值傳回區段定義的存放庫路徑。
提供ContextHub區段的存取權。
傳回在目前內容中解析的區段。 此函式沒有參數。
傳回
ContextHub.SegmentEngine.Segment物件的陣列。
ContextHub儲存庫的基類。
ContextHub.Utils.Eventing物件。 使用此對象來綁定函式以儲存事件。 有關預設值和初始化的資訊,請參見init(name,config)。
商店的名稱。
ContextHub.Utils.Persistence物件。 有關預設值和初始化的資訊,請參見init(name,config)
。
將資料對象或陣列與儲存資料合併。 對象或陣列中的每個鍵/值對都添加到儲存(通過setItem
函式):
請注意,值可以是物件。
參數
options
參數。傳回
boolean
值:
true
表示已儲存資料對象。false
表示資料儲存區未更改。建立從一個鍵到另一個鍵的引用。 鍵無法引用本身。
參數
索引鍵: 參考的索引 anotherKey
鍵。
另一個索引鍵: 是所參考的索引鍵 key
。
傳回
boolean
值:
true
表示已添加引用。false
表示未添加任何引用。觸發此商店的ready
事件。 此函式沒有參數且未傳回值。
從儲存中移除所有資料。 函式沒有參數,也沒有傳回值。
傳回與索引鍵相關聯的值。
參數
傳回
代表索引鍵值的物件。
從商店中擷取金鑰。 您可以選擇擷取ContextHub架構內部使用的索引鍵。
參數
true
結果中內部使用的索引鍵。這些鍵以下划線("_")字元開頭。 預設值為 false
.傳回
鍵名稱的陣列(string
值)。
從商店中檢索引用。
傳回
使用引用鍵作為引用鍵索引的陣列:
引用鍵與addReference
函式的key
參數對應。
引用的鍵與addReference
函式的anotherKey
參數對應。
從儲存中檢索資料樹。 您可以選擇包含ContextHub架構內部使用的索引鍵/值組。
參數
includeInternals:
的值包含 true
結果中內部使用的索引鍵/值組。此資料的鍵以下划線("_")字元開頭。 預設值為 false
.傳回
表示資料樹的對象。 鍵是對象的屬性名稱。
初始化儲存。
將儲存資料設定為空對象。
設定對空對象的儲存引用。
eventChannel是資料:name,其中name是商店名稱。
storeDataKey是/store/name,其中name是商店名稱。
參數
name: 商店的名稱。
config: 包含配置屬性的對象:
判斷是否暫停此商店的事件。
傳回
布林值:
true
:事件已暫停,因此不會為此存放區觸發任何事件。false
:事件不會暫停,因此會針對此存放區觸發事件。暫停儲存的事件,以便不觸發任何事件。 此函式不需要參數且不傳回值。
從存放區移除金鑰/值組。
移除金鑰時,函式會觸發data
事件。 事件資料包括儲存名稱、已移除的金鑰名稱、已移除的值、金鑰的新值(null),以及「remove」的動作類型。
您可以選擇防止data
事件的觸發。
參數
索引鍵: (字串)要移除的索引鍵名稱。
選項: (物件)選項的物件。以下對象屬性有效:
true
可防止觸發data
事件。 預設值為 false
.傳回
boolean
值:
true
表示已移除索引鍵/值組。false
表示資料儲存區未更改,因為在儲存區中找不到密鑰。從儲存中刪除引用。
參數
addReference
函式的key
參數對應。傳回
boolean
值:
true
表示已刪除引用。false
表示密鑰無效且儲存不變。重設儲存的持續資料的初始值。 您可以選擇從存放區移除所有其他資料。 重設存放區時,此存放區的事件會暫停。 此函式不會傳回任何值。
初始值會提供在用於實例化儲存對象的配置對象的initialValues屬性中。
參數
重設儲存的持續資料的初始值。 您可以選擇從存放區移除所有其他資料。 重設存放區時,此存放區的事件會暫停。 此函式不會傳回任何值。
初始值會提供在用於實例化儲存對象的配置對象的initialValues屬性中。
參數
擷取參考的金鑰。 或者,您可以指定用於解析最佳匹配的迭代次數。
參數
索引鍵: (字串)要解析參考的索引鍵。此key
參數與addReference
函式的key
參數對應。
重試: (數量)要使用的迭代次數。
傳回
代表引用鍵的string
值。 如果未解析任何引用,則返回key
參數的值。
繼續此存放區的事件,以觸發事件。 此函式不定義參數,也不傳回值。
將索引鍵/值組新增至商店。
僅當鍵的值與當前為鍵儲存的值不同時,才觸發data
事件。 您可以選擇性地防止data
事件的觸發。
事件資料包括儲存名稱、索引鍵、先前值、新值,以及set
的動作類型。
參數
索引鍵: (字串)索引鍵的名稱。
選項: (物件)選項的物件。以下對象屬性有效:
true
可防止觸發data
事件。 預設值為 false
.value: (物件)要與索引鍵關聯的值。
傳回
boolean
值:
true
表示已儲存資料對象。false
表示資料儲存區未更改。包含JSON資料的商店。 資料會從外部JSONP服務中擷取,或選擇性地從傳回JSON資料的服務中擷取。 建立此類的實例時,使用 init
函式指定服務詳細資訊。
存放區會使用記憶體中的持續時間(Javascript變數)。 儲存資料僅在頁面存留期期間可用。
ContextHub.Store.JSONPStore延伸ContextHub.Store.Core並繼承該類別的函式。
配置用於連接到此對象使用的JSONP服務的詳細資訊。 您可以更新或取代現有設定。 函式不會傳回任何值。
參數
serviceConfig: 包含下列屬性的物件:
主機:(字串)伺服器名稱或IP位址。
jsonp:(布林值)值true表示服務是JSONP服務,否則為false。 若為true,則{callback:"ContextHub.回呼。Object.name}物件已新增至service.params物件。
params:(物件)URL參數以物件屬性表示。 參數名稱是屬性名稱,參數值是屬性值。
路徑:(字串)服務的路徑。
埠:(數字)服務的埠號。
安全:(字串或布林值)決定要用於服務URL的通訊協定:
override: (布林值)。值true
會導致現有服務配置被serviceConfig
的屬性替換。 值false
會導致現有服務配置屬性與屬性serviceConfig
合併。
傳回自上次呼叫JSONP服務以來所快取的原始回應。 函式不需要參數。
傳回
代表原始回應的物件。
檢索此ContextHub.Store.JSONPStore對象的服務對象。 服務物件包含建立服務URL所需的所有資訊。
傳回
具有下列屬性的物件:
host: (字串)伺服器名稱或IP位址。
jsonp: (布林值)true值表示服務是JSONP服務,否則為false。若為true,則{callback:"ContextHub.回呼。Object.name}物件已新增至service.params物件。
params: (物件)URL參數以物件屬性表示。參數名稱是屬性名稱,參數值是屬性值。
path: (字串)服務的路徑。
port: (Number)服務的埠號。
secure: (字串或布林值)決定要用於服務URL的通訊協定:
擷取JSONP服務的URL。
參數
true
解析參數,而false
解析參數則不。傳回
代表服務URL的string
值。
初始化ContextHub.Store.JSONPStore對象。
參數
name: (字串)商店的名稱。
config: (物件)包含服務屬性的物件。JSONPStore物件使用service
物件的屬性來建構JSONP服務的URL:
eventDeferring:32.
事件:此儲存區的ContextHub.Utils.Eventing物件。 預設值為ContextHub.eventing
物件。
持續性:此儲存的ContextHub.Utils.Persistence物件。 預設會使用記憶體持續性(Javascript物件)。
服務:(物件)
主機:(字串)伺服器名稱或IP位址。
jsonp:(布林值)值true表示服務是JSONP服務,否則為false。 若為true,則會將{callback: "ContextHub.Callbacks.*Object.name*}
物件新增至service.params
。
params:(物件)URL參數以物件屬性表示。 參數名稱和值分別是對象屬性名稱和值。
路徑:(字串)服務的路徑。
埠:(數字)服務的埠號。
安全:(字串或布林值)決定要用於服務URL的通訊協定:
逾時:(數字)等待JSONP服務在超時前響應的時間長度(以毫秒為單位)。
ttl:在兩次JSONP服務呼叫之間傳遞的最小時間量(毫秒)。 (請參閱queryService函式)。
查詢遠程JSONP服務並快取響應。 如果自上次調用此函式以來的時間小於config.service.ttl
值,則不會調用該服務,並且快取響應不會更改。 您可以視需要強制呼叫服務。 呼叫init函式初始化儲存時設定config.service.ttl
屬性。
查詢完成時觸發就緒事件。 如果未設定JSONP服務URL,函式則不會執行任何動作。
參數
重設儲存區持續資料的初始值,然後呼叫JSONP服務。 您可以選擇從存放區移除所有其他資料。 初始值重設時,此存放區的事件會暫停。 此函式不會傳回任何值。
初始值會提供在用於實例化儲存對象的配置對象的initialValues屬性中。
參數
解析給定參數。
ContextHub.Store.PerisentJSONPStore延伸ContextHub.Store.JSONPStore,因此它繼承該類的所有函式。 不過,從JSONP服務擷取的資料會根據ContextHub持續性的設定而持續保存。 (請參閱持久模式。)
ContextHub.Store.PerisentStore延伸ContextHub.Store.Core,因此會繼承該類別的所有函式。 此存放區中的資料會根據ContextHub持續性的設定而保存。
ContextHub.Store.SessionStore延伸ContextHub.Store.Core,因此會繼承該類別的所有函式。 此存放區中的資料會使用記憶體中的持續性(Javascript物件)來保存。
管理UI模組和UI模組轉譯器。
向ContextHub註冊UI模組轉譯器。 註冊轉譯器後,可將其用於建立UI模組。 當您延伸ContextHub.UI.BaseModuleRenderer時,請使用此函式來建立自訂UI模組轉譯器。
參數
true
以防止在註冊轉譯器後轉譯ContextHub UI。預設值為 false
.範例
以下範例將轉譯器註冊為contexthub.browserinfo模組類型。
ContextHub.UI.registerRenderer('contexthub.browserinfo', new SurferinfoRenderer());
與Cookie互動的公用程式類別。
判斷Cookie是否存在。
參數
String
含您要測試之Cookie索引鍵的。傳回
boolean
值true表示Cookie存在。
範例
if (ContextHub.Utils.Cookie.exists("name")) {
// conditionally-executed code
}
傳回所有具有符合篩選器之索引鍵的Cookie。
參數
(選用)篩選器:比對Cookie索引鍵的條件。 若要傳回所有Cookie,請指定任何值。 支援下列類型:
傳回
Cookie的物件。 物件屬性是Cookie索引鍵,而索引鍵值是Cookie值。
範例
ContextHub.Utils.Cookie.getAllItems([/^cq-authoring/, /^cq-editor/])
傳回Cookie值。
參數
傳回
Cookie值;若找不到金鑰的Cookie,則為null
。
範例
ContextHub.Utils.Cookie.getItem("name");
傳回符合篩選器之現有Cookie的索引鍵陣列。
參數
篩選: 符合Cookie索引鍵的條件。支援下列類型:
true
。傳回
字串的陣列,其中每個字串是符合篩選條件之Cookie的索引鍵。
範例
ContextHub.Utils.Cookie.getKeys([/^cq-authoring/, /^cq-editor/])
移除Cookie。 若要移除Cookie,值會設為空白字串,而到期日會設為目前日期的前一天。
參數
索引鍵: String
代表要移除之Cookie索引鍵的值。
選項: 包含用於設定Cookie屬性之屬性值的物件。如需詳細資訊,請參閱 [setItem](/docs/experience-manager-64/developing/personlization/contexthub-api.html?lang=zh-Hant#setitem-key-value-options)
函式。 expires
屬性無效。
傳回
此函式不會傳回值。
範例
ContextHub.Utils.Cookie.vanish([/^cq-authoring/, 'cq-scrollpos']);
建立指定索引鍵和值的Cookie,並將Cookie新增至目前的檔案。 您可以選擇指定用以設定Cookie屬性的選項。
參數
索引鍵: 包含Cookie索引鍵的字串。
value: 包含Cookie值的字串。
選項: (選用)物件,包含設定Cookie屬性的下列任何屬性:
date
或number
值。 日期值指定到期的絕對時間。 數字(以天為單位)會將到期時間設為目前時間加上數字。 預設值為 undefined
.Secure
屬性的boolean
值。 預設值為 false
.Path
屬性的String
值。 預設值為 undefined
.傳回
具有設定值的Cookie。
範例
ContextHub.Utils.Cookie.setItem("name", "mycookie", {
expires: 3,
domain: 'localhost',
path: '/some/directory',
secure: true
});
移除符合指定篩選器的所有Cookie。 使用getKeys函式來比對Cookie,並使用removeItem函式來移除。
參數
filter: 在 filter
呼叫函式時使用的引 [getKeys](/docs/experience-manager-64/developing/personlization/contexthub-api.md#getkeys-filter)
數。
選項: 在 options
呼叫函式時使用的引 [removeItem](/docs/experience-manager-64/developing/personlization/contexthub-api.md#removeitem-key-options)
數。
傳回
此函式不會傳回值。
可讓您將函式系結和解除系結至ContextHub儲存事件。 使用儲存的eventing屬性訪問儲存的ContextHub.Utils.eventing對象。
從事件中取消綁定函式。
參數
傳回
此函式不會傳回任何值。
將函式綁定到事件。 每次發生事件時都會呼叫函式。 可選地,在建立綁定之前,可以為過去發生的事件調用函式。
參數
name: (字串)您 要系 結函式的事件名稱。
處理常式: (函式)要系結至事件的函式。
selector: (字串)系結的唯一識別碼。如果要使用off
函式來刪除綁定,則需要選擇器來標識綁定。
triggerForPastEvents: (布林值)指出是否應針對過去發生的事件執行處理常式。true
值會呼叫過去事件的處理常式。 值false
會呼叫未來事件的處理器。 預設值為 true
.
傳回
當triggerForPastEvents
引數為true
時,此函式會傳回boolean
值,指出事件是否發生在過去:
true
:事件在過去發生,將呼叫處理常式。false
:事件過去未發生。如果triggerForPastEvents
為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>
將函式綁定到事件。 對於事件的首次出現,函式只會呼叫一次。 或者,可以在建立綁定之前,為過去發生的事件調用函式。
參數
name: (字串)您 要系 結函式的事件名稱。
處理常式: (函式)要系結至事件的函式。
selector: (字串)系結的唯一識別碼。如果要使用off
函式來刪除綁定,則需要選擇器來標識綁定。
triggerForPastEvents: (布林值)指出是否應針對過去發生的事件執行處理常式。true
值會呼叫過去事件的處理常式。 值false
會呼叫未來事件的處理器。 預設值為 true
.
傳回
當triggerForPastEvents
引數為true
時,此函式會傳回boolean
值,指出事件是否發生在過去:
true
:事件在過去發生,將呼叫處理常式。false
:事件過去未發生。如果triggerForPastEvents
為false
,則此函式不返回值。
允許對象繼承另一個對象的屬性和方法的實用程式類。
使對象繼承另一個對象的屬性和方法。
參數
提供將物件序列化為JSON格式,以及將JSON字串反序列化為物件的函式。
將字串值剖析為JSON,並將其轉換為Javascript物件。
參數
傳回
Javascript物件。
範例
代碼ContextHub.Utils.JSON.parse("{'city':'Basel','country':'Switzerland','population':'173330'}");
返回以下對象:
Object {
city: "Basel",
country: "Switzerland",
population: 173330
}
將Javascript值和物件序列化為JSON格式的字串值。
參數
傳回
序列化字串值。 當data
為R egExp
值時,此函式返回空對象。 當data
為函式時,返回undefined
。
範例
以下代碼返回"{'city':'Basel','country':'Switzerland','population':'173330'}":
ContextHub.Utils.JSON.stringify({
city: "Basel",
country: "Switzerland",
population: 173330
});
此類便於操作要儲存或從ContextHub儲存中檢索的資料對象。
建立資料對象的副本,並從第二個對象添加到資料樹中。 函式返回副本,不修改任何一個原始對象。 當兩個對象的資料樹包含相同的鍵時,第二對象的值覆蓋第一對象的值。
參數
tree
像。傳回
包含合併資料的物件。
建立對象的副本,查找並刪除資料樹中不包含值、空值或未定義的項,並返回副本。
參數
傳回
已清理的樹的副本。
從物件中擷取金鑰的值。
參數
傳回
與鍵對應的值。 當索引鍵具有子索引鍵時,此函式會傳回複雜物件。 當鍵的值類型為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
}
}
}
從對象的資料樹中檢索所有鍵。 或者,您只能檢索特定鍵子項的鍵。 您也可以選擇指定擷取索引鍵的排序順序。
參數
傳回
鍵的陣列。
範例
請考量下列物件:
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"]
建立給定對象的副本,從資料樹中刪除指定的分支,並返回修改的副本。
參數
傳回
已移除鍵的原始資料物件復本。
範例
請考量下列物件:
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"
}
}
清除字串值,以便用作索引鍵。 若要處理字串,此函式會執行下列動作:
使用產生的陣列建立可用密鑰。 參數
string
方式。傳回
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("/");
將索引鍵/值組新增至物件復本的資料樹。 有關資料樹的資訊,請參閱持久性。
參數
ContextHub.Utils.JSON.tree.sanitize
以在新增索引鍵前處理索引鍵。傳回
包含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.registerStoreCandidate
函式的storeType
參數。傳回
儲存類型的物件。 對象屬性是儲存類型名稱,而屬性值是已註冊儲存候選項的陣列。
從註冊候選項返回儲存類型。 如果註冊了多個同名的儲存類型,則函式將返回具有最高優先順序的儲存類型。
參數
ContextHub.Utils.storeCandidates.registerStoreCandidate
函式的storeType
參數。傳回
表示註冊儲存候選項的對象。 如果未註冊請求的儲存類型,則會引發錯誤。
返回註冊為儲存候選項的儲存類型的名稱。 此函式不需要參數。
傳回
字串值的陣列,其中每個字串是註冊儲存候選項的儲存類型。 請參閱 ContextHub.Utils.storeCandidates.registerStoreCandidate
函式的storeType
參數。
使用名稱和優先順序將儲存對象註冊為儲存候選項。
優先順序是指出同名商店重要性的數字。 當使用與已註冊的儲存候選相同的名稱註冊儲存候選時,使用優先順序較高的候選。 當註冊儲存候選時,僅當優先順序高於同名註冊儲存候選時,才註冊儲存。
參數
true
,否則必須返回false
。 預設值是傳回true的函式:function() {return true;}
範例
ContextHub.Utils.storeCandidates.registerStoreCandidate(myStoreCandidate,
'contexthub.mystorecandiate', 0);