将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-response |
ContextHub.Constants.SERVICE_RESPONSE_TIME_KEY | 存储指示何时获取JSON数据的特定时间戳 | /_/response time |
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-unecriment |
ContextHub.Constants.EVENT_UI_MODE_RENDERER_REGISTERED | 注册模式渲染器时触发 | ui-mode-renderer-registered |
ContextHub.Constants.EVENT_UI_MODE_RENDERER_UNREGISTERED | 未注册模式渲染器时触发 | ui-mode-renderer-unregisterd |
ContextHub.Constants.EVENT_UI_MODE_ADDED | 添加新模式时触发 | 添加了ui-mode |
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-module-registered |
ContextHub.Constants.EVENT_UI_MODULE_UNREGISTERED | 取消注册模块时触发 | ui-module-unregisterd |
ContextHub.Constants.EVENT_UI_MODULE_RENDERER_REGISTERED | 注册模块渲染器时触发 | ui-module-renderer-registered |
ContextHub.Constants.EVENT_UI_MODULE_RENDERER_UNREGISTERED | 未注册模块渲染器时触发 | ui-module-renderer-unregisterd |
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 |
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-mode |
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)](/docs/experience-manager-65/developing/personlization/contexthub-api.html?lang=zh-Hans#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: 商店的名称。
配置: 包含配置属性的对象:
确定是否暂停此存储的事件。
返回结果
布尔值:
true
:事件暂停,因此不会为此存储触发任何事件。false
:事件不会暂停,因此会为此存储触发事件。暂停存储的事件,以便不触发任何事件。 此函数不需要任何参数,也不返回任何值。
从存储中删除键/值对。
删除键后,函数将触发data
事件。 事件数据包括存储名称、已删除键的名称、已删除的值、键的新值(null)以及“remove”操作类型。
或者,您也可以防止触发data
事件。
参数
key: (字符串)要删除的键的名称。
选项: (对象)选项的对象。以下对象属性有效:
true
可阻止触发data
事件。 默认值为 false
.返回结果
boolean
值:
true
表示已删除键/值对。false
表示数据存储未更改,因为在存储中未找到密钥。从存储中删除引用。
参数
addReference
函数的key
参数相对应。返回结果
boolean
值:
true
表示已删除引用。false
表示键无效,且存储未更改。重置存储保留数据的初始值。 或者,您也可以从存储中删除所有其他数据。 重置存储时,会暂停此存储的事件。 此函数不返回任何值。
初始值在用于实例化存储对象的配置对象的initialValues属性中提供。
参数
重置存储保留数据的初始值。 或者,您也可以从存储中删除所有其他数据。 重置存储时,会暂停此存储的事件。 此函数不返回任何值。
初始值在用于实例化存储对象的配置对象的initialValues属性中提供。
参数
检索引用的键值。 或者,您可以指定用于解析最佳匹配的迭代次数。
参数
键: (字符串)要用于解析引用的键。此key
参数与addReference
函数的key
参数相对应。
重试: (数量)要使用的迭代次数。
返回结果
表示引用键的string
值。 如果未解析引用,则返回key
参数的值。
恢复此存储的事件,以便触发事件。 此函数未定义任何参数,且不返回任何值。
向存储添加键/值对。
仅当键的值与当前存储的键值不同时,才会触发data
事件。 您可以选择阻止触发data
事件。
事件数据包括存储名称、键、前一个值、新值和set
的操作类型。
参数
key: (字符串)键的名称。
选项: (对象)选项的对象。以下对象属性有效:
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对象。
参数:(对象)表示为对象属性的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参数,表示为对象属性。参数名称是属性名称,参数值是属性值。
路径: (字符串)服务的路径。
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
。
参数:(对象)表示为对象属性的URL参数。 参数名称和值分别是对象属性名称和值。
路径:(字符串)服务的路径。
端口:(数字)服务的端口号。
安全:(字符串或布尔值)确定用于服务URL的协议:
超时:(数字)等待JSONP服务在超时前做出响应的时间(以毫秒为单位)。
ttl:在对JSONP服务的调用之间传递的最小时间(以毫秒为单位)。 (请参阅queryService函数)。
查询远程JSONP服务并缓存响应。 如果自上次调用此函数以来的时间小于config.service.ttl
的值,则不会调用服务,也不会更改缓存的响应。 或者,您也可以强制调用服务。 调用init函数以初始化存储时,将设置config.service.ttl
属性。
查询完成后会触发就绪事件。 如果未设置JSONP服务URL,则函数不执行任何操作。
参数
重置存储保留数据的初始值,然后调用JSONP服务。 或者,您也可以从存储中删除所有其他数据。 重置初始值时,会暂停此存储的事件。 此函数不返回任何值。
初始值在用于实例化存储对象的配置对象的initialValues属性中提供。
参数
解析给定参数。
ContextHub.Store.PersiredJSONPStore扩展了ContextHub.Store.JSONPStore,因此它继承了该类的所有函数。 但是,从JSONP服务检索的数据将根据ContextHub持久性的配置进行保留。 (请参阅持久性模式。)
ContextHub.Store.PersiredStore扩展了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。
参数
(可选)filter:匹配Cookie键的条件。 要返回所有Cookie,请指定无值。 支持以下类型:
返回结果
Cookie的对象。 对象属性是Cookie键,键值是Cookie值。
示例
ContextHub.Utils.Cookie.getAllItems([/^cq-authoring/, /^cq-editor/])
返回Cookie值。
参数
返回结果
Cookie值,或者null
(如果未找到该键的Cookie)。
示例
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-65/developing/personlization/contexthub-api.html?lang=zh-Hans#setitem-key-value-options)
函数。 expires
属性无效。
返回结果
此函数不返回值。
示例
ContextHub.Utils.Cookie.vanish([/^cq-authoring/, 'cq-scrollpos']);
创建给定键值的Cookie,并将该Cookie添加到当前文档。 或者,您也可以指定用于配置Cookie属性的选项。
参数
键: 包含Cookie键的字符串。
值: 包含Cookie值的字符串。
选项: (可选)一个对象,其中包含用于配置Cookie属性的以下任意属性:
date
或number
值,用于指定Cookie何时过期。 日期值指定到期的绝对时间。 数字(以天为单位)会将到期时间设置为当前时间加上数字。 默认值为 undefined
.Secure
属性的boolean
值。 默认值为 false
.Path
属性的String
值。 默认值为 undefined
.返回结果
具有设置值的Cookie。
示例
ContextHub.Utils.Cookie.setItem("name", "mycookie", {
expires: 3,
domain: 'localhost',
path: '/some/directory',
secure: true
});
删除与给定过滤器匹配的所有Cookie。 Cookie使用getKeys函数进行匹配,并使用removeItem函数删除。
参数
filter: 在 filter
函数调用中使用的参 [getKeys](/docs/experience-manager-65/developing/personlization/contexthub-api.md#getkeys-filter)
数。
选项: 在 options
函数调用中使用的参 [removeItem](/docs/experience-manager-65/developing/personlization/contexthub-api.md#removeitem-key-options)
数。
返回结果
此函数不返回值。
允许您将函数绑定和取消绑定到ContextHub存储事件。 使用存储的eventing属性访问存储的ContextHub.Utils.Eventing对象。
从事件中取消绑定函数。
参数
返回结果
此函数不返回任何值。
将函数绑定到事件。 每次发生事件时都会调用函数。 或者,也可以在建立绑定之前,为过去发生的事件调用函数。
参数
name: (字符串)要 将函 数绑定到的事件的名称。
handler: (函数)要绑定到事件的函数。
选择器: (字符串)绑定的唯一标识符。如果要使用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: (字符串)要 将函 数绑定到的事件的名称。
handler: (函数)要绑定到事件的函数。
选择器: (字符串)绑定的唯一标识符。如果要使用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
以在添加密钥之前对其进行整理。返回结果
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.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);