在以下情况下,您的脚本可以使用ContextHub Javascript API: 已将ContextHub组件添加到页面.
ContextHub Javascript API定义的常量值。
下表列出了ContextHub存储区发生的names事件。 另请参阅 ContextHub.Utils.Eventing.
常量 | 描述 | 值 |
---|---|---|
ContextHub.Constants.EVENT_NAMESPACE | ContextHub的事件命名空间 | ch |
ContextHub.Constants.EVENT_ALL_STORES_READY | 指示已注册、初始化所有必需存储并准备使用 | 全店就绪 |
ContextHub.Constants.EVENT_STORES_PARTIALLY_READY | 表示在给定的超时时间内并非所有存储都已初始化 | stores-partial-ready |
ContextHub.Constants.EVENT_STORE_REGISTERED | 在注册存储时触发 | 存储注册 |
ContextHub.Constants.EVENT_STORE_READY | 指示存储已准备就绪。 它会在注册后立即触发,但JSONP存储除外,因为它会在获取数据时触发)。 | 存储就绪 |
ContextHub.Constants.EVENT_STORE_UPDATED | 当存储更新其持久性时触发 | store-updates |
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是否展开 | /_/container-expanded |
下表列出了ContextHub UI中发生的事件名称。
常量 | 描述 | 值 |
---|---|---|
ContextHub.Constants.EVENT_UI_MODE_REGISTERED | 在注册模式时触发 | ui-mode-registered |
ContextHub.Constants.EVENT_UI_MODE_UNREGISTERED | 在模式未注册时触发 | ui-mode-unregistered |
ContextHub.Constants.EVENT_UI_MODE_RENDERER_REGISTERED | 在注册模式渲染器时触发 | ui-mode-renderer-register |
ContextHub.Constants.EVENT_UI_MODE_RENDERER_UNREGISTERED | 在取消注册模式渲染器时触发 | ui-mode-renderer-unregistered |
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-module-registered |
ContextHub.Constants.EVENT_UI_MODULE_UNREGISTERED | 在模块未注册时触发 | ui-module-unregistered |
ContextHub.Constants.EVENT_UI_MODULE_RENDERER_REGISTERED | 在注册模块渲染器时触发 | 已注册ui-module-renderer |
ContextHub.Constants.EVENT_UI_MODULE_RENDERER_UNREGISTERED | 在模块渲染器未注册时触发 | ui-module-renderer-unregistered |
ContextHub.Constants.EVENT_UI_MODULE_ADDED | 添加新模块时触发 | 已添加ui-module |
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-open |
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存储的基类。
A 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
参数 setItem(key,value,options).返回
A boolean
值:
true
指示存储的数据对象。false
表示数据存储未更改。创建从一个键到另一个键的引用。 键不能引用自身。
参数
键: 引用的键 anotherKey
.
其他键: 引用的键值 key
.
返回
A boolean
值:
true
表示已添加引用。false
表示未添加引用。触发 ready
此存储的事件。 此函数没有参数并且不返回任何值。
从存储中删除所有数据。 函数没有参数和返回值。
返回与键关联的值。
参数
返回
表示键值的对象。
从存储中检索密钥。 (可选)您可以检索ContextHub框架内部使用的键。
参数
true
结果中包含内部使用的键。 这些键以下划线(“_”)字符开头。 默认值为 false
。返回
键名称数组( string
值)。
从存储中检索引用。
返回
使用引用键作为引用键的索引的数组:
引用键对应于 key
的参数 addReference
函数。
引用的键对应于 anotherKey
的参数 addReference
函数。
从存储中检索数据树。 (可选)您可以包括ContextHub框架在内部使用的键/值对。
参数
includeInternals:
值 true
结果中包含内部使用的键/值对。 此数据的键以下划线(“_”)字符开头。 默认值为 false
。返回
表示数据树的对象。 键是对象的属性名称。
初始化存储。
将存储数据设置为空对象。
将存储引用设置为空对象。
eventChannel是数据:name,其中 name 是商店名称。
storeDataKey为/store/name,其中 name 是商店名称。
参数
名称: 存储的名称。
配置: 包含配置属性的对象:
确定是否暂停此存储的事件。
返回
布尔值:
true
:事件已暂停,因此不会为此存储触发任何事件。false
:不会暂停事件,因此会为此存储触发事件。暂停存储的事件,以便不触发任何事件。 此函数不需要任何参数,也不返回任何值。
从存储中删除键/值对。
删除某个键时,函数会触发 data
事件。 事件数据包括存储名称、已删除键的名称、已删除的值、键的新值(null)以及“删除”操作类型。
(可选)您可以防止触发 data
事件。
参数
键: (字符串)要删除的键的名称。
选项: (对象)选项的对象。 以下对象属性有效:
true
阻止触发 data
事件。 默认值为 false
。返回
A boolean
值:
true
表示已删除键/值对。false
表示数据存储未更改,因为在存储中未找到该键。从存储中删除引用。
参数
key
的参数 addReference
函数。返回
A boolean
值:
true
表示引用已被删除。false
表示密钥无效并且存储未更改。重置存储保留数据的初始值。 或者,您也可以从存储中删除所有其他数据。 重置存储时暂停此存储的事件。 此函数不返回任何值。
初始值在用于实例化存储对象的配置对象的initialValues属性中提供。
参数
重置存储保留数据的初始值。 或者,您也可以从存储中删除所有其他数据。 重置存储时暂停此存储的事件。 此函数不返回任何值。
初始值在用于实例化存储对象的配置对象的initialValues属性中提供。
参数
检索引用的键。 或者,您可以指定用于解析最佳匹配的迭代次数。
参数
键: (字符串)解析引用的键。 此 key
参数对应于 key
的参数 addReference
函数。
重试: (数量)要使用的迭代次数。
返回
A string
表示引用的键的值。 如果未解析任何引用,则其值 key
返回参数。
恢复此存储的事件,以便触发事件。 此函数不定义任何参数也不返回任何值。
向存储中添加一个键/值对。
触发 data
仅当键的值不同于当前为键存储的值时才会发生事件。 您可以选择防止触发 data
事件。
事件数据包括存储名称、键、上一个值、新值和操作类型 set
.
参数
键: (字符串)键的名称。
选项: (对象)选项的对象。 以下对象属性有效:
true
阻止触发 data
事件。 默认值为 false
。值: (对象)要与键关联的值。
返回
A boolean
值:
true
指示存储的数据对象。false
表示数据存储未更改。包含JSON数据的存储。 数据检索自外部JSONP服务,或者可选地检索自返回JSON数据的服务。 使用指定服务详细信息 init
函数创建此类的实例。
存储使用内存中持久性(Javascript变量)。 存储数据仅在页面的生命周期内可用。
ContextHub.Store.JSONPStore扩展 ContextHub.Store.Core 并继承了该类的函数。
配置用于连接到此对象使用的JSONP服务的详细信息。 您可以更新或替换现有配置。 函数未返回任何值。
参数
服务配置: 包含以下属性的对象:
host: (字符串)服务器名称或IP地址。
jsonp: (布尔值)值为true表示该服务是JSONP服务,否则为false。 如果为true,则{callback: "ContextHub.Callbacks.对象名称}对象已添加到service.params对象。
params: (对象)表示为对象属性的URL参数。 参数名是属性名,参数值是属性值。
path: (字符串)服务的路径。
port: (Number)服务的端口号。
secure: (String或Boolean)确定用于服务URL的协议:
覆盖: (布尔型)。 值 true
导致现有服务配置被替换为 serviceConfig
. 值 false
使现有服务配置属性与以下属性的属性合并: serviceConfig
.
返回自上次调用JSONP服务以来缓存的原始响应。 函数不需要参数。
返回
表示原始响应的对象。
检索此ContextHub.Store.JSONPStore对象的服务对象。 服务对象包含创建服务URL所需的所有信息。
返回
具有以下属性的对象:
主机: (字符串)服务器名称或IP地址。
jsonp: (布尔)值为true表示该服务是JSONP服务,否则为false。 如果为true,则{callback: "ContextHub.Callbacks.对象名称}对象已添加到service.params对象。
参数: (对象)表示为对象属性的URL参数。 参数名是属性名,参数值是属性值。
路径: (字符串)服务的路径。
端口: (Number)服务的端口号。
安全: (字符串或布尔值)确定用于服务URL的协议:
检索JSONP服务的URL。
参数
true
解析了参数,并且 false
不会。返回
A string
表示服务URL的值。
初始化ContextHub.Store.JSONPStore对象。
参数
名称: (字符串)存储的名称。
配置: (对象)包含服务属性的对象。 JSONPStore对象使用 service
用于构建JSONP服务的URL的对象:
eventDeferring: 32。
事件:此存储的ContextHub.Utils.Eventing对象。 默认值为 ContextHub.eventing
对象。
持久性:此存储的ContextHub.Utils.Persistence对象。 默认情况下,使用内存持久性(Javascript对象)。
服务: (对象)
host: (字符串)服务器名称或IP地址。
jsonp: (布尔值)值为true表示该服务是JSONP服务,否则为false。 如果为true,则 {callback: "ContextHub.Callbacks.*Object.name*}
对象已添加到 service.params
.
params: (对象)表示为对象属性的URL参数。 参数名称和值分别是对象属性名称和值。
path: (字符串)服务的路径。
port: (Number)服务的端口号。
secure: (String或Boolean)确定用于服务URL的协议:
timeout: (Number)超时前等待JSONP服务响应的时间(以毫秒为单位)。
ttl:在对JSONP服务的调用之间经过的最小时间(以毫秒为单位)。 (请参阅 查询服务 函数)。
查询远程JSONP服务并缓存响应。 如果自上次调用此函数后经过的时间小于的值 config.service.ttl
,则不会调用服务,并且不会更改缓存的响应。 或者,您也可以强制调用该服务。 此 config.service.ttl
属性是在调用 init 函数初始化存储。
查询完成时会触发就绪事件。 如果未设置JSONP服务URL,则函数不执行任何操作。
参数
重置存储区持久数据的初始值,然后调用JSONP服务。 或者,您也可以从存储中删除所有其他数据。 重置初始值时,将暂停此存储的事件。 此函数不返回任何值。
初始值在用于实例化存储对象的配置对象的initialValues属性中提供。
参数
解析给定的参数。
ContextHub.Store.PersistedJSONPStore扩展 ContextHub.Store.JSONPStore 所以它继承了类的所有功能。 但是,根据ContextHub持久性的配置,将保留从JSONP服务检索的数据。 (请参阅 持久性模式.)
ContextHub.Store.PersistedStore扩展 ContextHub.Store.Core 所以它继承了类的所有功能。 根据ContextHub持久性的配置,保留此存储中的数据。
ContextHub.Store.SessionStore扩展 ContextHub.Store.Core 所以它继承了类的所有功能。 使用内存中持久性(Javascript对象)保留此存储中的数据。
管理UI模块和UI模块渲染器。
在ContextHub中注册UI模块渲染器。 在注册渲染器后,它可用于 创建用户界面模块. 请在以下情况下使用此函数: 扩展ContextHub.UI.BaseModuleRenderer 以创建自定义UI模块渲染器。
参数
true
以防止在注册渲染器后渲染ContextHub UI。 默认值为 false
。示例
以下示例将渲染器注册为contexthub.browserinfo模块类型。
ContextHub.UI.registerRenderer('contexthub.browserinfo', new SurferinfoRenderer());
用于与Cookie交互的实用程序类。
确定Cookie是否存在。
参数
String
包含要测试的Cookie的键值。返回
A 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值,或 null
如果未找到密钥的Cookie,则为。
示例
ContextHub.Utils.Cookie.getItem("name");
返回与过滤器匹配的现有Cookie键的数组。
参数
过滤器: 匹配Cookie键的条件。 支持以下类型:
true
如果测试确认匹配。返回
一个字符串数组,其中每个字符串是与过滤器匹配的Cookie的键。
示例
ContextHub.Utils.Cookie.getKeys([/^cq-authoring/, /^cq-editor/])
删除Cookie。 要删除Cookie,该值将设置为空字符串,而到期日期将设置为当前日期之前的日期。
参数
键: A 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
。boolean
值,指定 Secure
Cookie的属性。 默认值为 false
。String
值将用作 Path
Cookie的属性。 默认值为 undefined
。返回
具有设置值的Cookie。
示例
ContextHub.Utils.Cookie.setItem("name", "mycookie", {
expires: 3,
domain: 'localhost',
path: '/some/directory',
secure: true
});
删除与给定过滤器匹配的所有Cookie。 Cookie使用getKeys函数进行匹配,并使用removeItem函数删除。
参数
过滤器: 此 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存储事件。 使用访问存储的ContextHub.Utils.Eventing对象 事件 存储的属性。
从事件中取消函数绑定。
参数
返回
此函数不返回任何值。
将函数绑定到事件。 每次发生事件时都会调用函数。 (可选)可以为过去发生的事件(在建立绑定之前)调用函数。
参数
名称: (字符串) 事件的名称 函数将绑定到的对象。
处理程序: (函数)要绑定到事件的函数。
选择器: (字符串)绑定的唯一标识符。 如果要使用 off
函数以移除绑定。
triggerForPastEvents: (布尔值)指示是否应为过去发生的事件执行处理程序。 值 true
调用过去事件的处理程序。 值 false
为将来的活动调用手势。 默认值为 true
。
返回
当 triggerForPastEvents
参数为 true
,此函数返回 boolean
指示事件是否在过去发生的值:
true
:该事件发生在过去,并将调用处理程序。false
:该事件在过去未发生。如果 triggerForPastEvents
是 false
,此函数不返回任何值。
示例
以下示例将函数绑定到地理位置存储的数据事件。 函数会使用存储中latitude数据项的值填充页面上的某个元素。
<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>
将函数绑定到事件。 对于第一次出现该事件,函数仅调用一次。 (可选)可以为过去发生的事件(在建立绑定之前)调用函数。
参数
名称: (字符串) 事件的名称 函数将绑定到的对象。
处理程序: (函数)要绑定到事件的函数。
选择器: (字符串)绑定的唯一标识符。 如果要使用 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对象具有以下值:
使您能够注册商店候选者并获取注册的商店候选者。
返回注册为候选商店的存储类型。 检索特定商店类型或所有商店类型的已注册候选商品。
参数
storeType
的参数 ContextHub.Utils.storeCandidates.registerStoreCandidate
函数。返回
存储类型的对象。 对象属性是存储类型名称,属性值是已注册的存储候选对象数组。
从注册的候选中返回存储类型。 如果注册了多个同名的存储类型,则函数将返回具有最高优先级的存储类型。
参数
storeType
的参数 ContextHub.Utils.storeCandidates.registerStoreCandidate
函数。返回
一个对象,表示已注册的商店候选。 如果未注册所请求的存储类型,则会引发错误。
返回注册为商店候选者的商店类型的名称。 此函数不需要任何参数。
返回
一个字符串值数组,其中每个字符串是用来注册存储候选项的存储类型。 请参阅 storeType
的参数 ContextHub.Utils.storeCandidates.registerStoreCandidate
函数。
使用名称和优先级将存储对象注册为存储候选项。
优先级是一个数字,指示同名存储的重要性。 当使用与已注册的存储候选相同的名称注册存储候选时,使用具有较高优先级的候选。 在注册存储候选时,仅当优先级高于同名已注册的存储候选时才注册存储。
参数
true
如果存储区适用,并且 false
否则。 默认值是一个返回true的函数: function() {return true;}
示例
ContextHub.Utils.storeCandidates.registerStoreCandidate(myStoreCandidate,
'contexthub.mystorecandiate', 0);