# 交换数据 exchange
# 接口声明
提供了一个不同快应用间数据交互的方式。快应用可以利用它发布数据,或从其他快应用获取数据
数据交互有三个数据空间,分别是应用空间(application)、应用开发商空间(vendor)和全局空间(global)
application:数据发布在应用空间,读取、修改、删除 时需同时指定发布方的包名和签名,并且需要发布方授权
vendor:数据发布在应用开发商空间,同签名的多个应用的写操作会相互覆盖,读取时不能指定发布方的包名和签名,不需要发布方授权
global:数据发布在全局空间,多个应用的写操作会相互覆盖,读取时不能指定发布方的包名和签名,不需要发布方授权
注意:
set、get 操作支持在 application
、vendor
和global
空间上操作数据
{ "name": "service.exchange" }
1
# 导入模块
import exchange from '@service.exchange' 或 const exchange = require('@service.exchange')
1
# 接口定义
# exchange.get (OBJECT)
读取快应用平台数据,可获取到应用空间
(application)、应用开发商空间
(vendor)或全局空间
(global)的数据
# 参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
package | String | 否 | 数据发布方的包名,scope 为 application 时必须提供,为 vendor 或 global 时必须为空 |
sign | String | 否 | 数据发布方签名的 SHA-256,scope 为 application 时必须提供,为 vendor 或 global 时必须为空 |
scope | String | 否 | 数据发布的空间类型,支持 application、vendor 和 global,默认为 application |
key | String | 是 | 数据的 key |
success | Function | 否 | 成功回调 |
fail | Function | 否 | 失败回调 |
complete | Function | 否 | 执行结束后的回调(调用成功、失败都会执行) |
# 返回值:
参数名 | 类型 | 说明 |
---|---|---|
value | String | 数据的值 |
# fail 返回错误代码:
错误码 | 说明 |
---|---|
202 | 参数错误 |
1000 | 没有权限 |
# 示例
exchange.get({
package: 'com.example',
sign: '7a12ec1d66233f20a20141035b1f7937',
key: 'token',
success: function(ret) {
console.log(`handling success, value = ${ret.value}`)
},
fail: function(data, code) {
console.log(`handling fail, code = ${code}`)
}
})
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
# exchange.set (OBJECT)
发布数据到快应用平台,可发布到应用空间
(application)、应用开发商空间
(vendor)或全局空间
(global)
# 参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
key | String | 是 | 数据的 key |
value | String | 是 | 数据的值 |
scope | String | 否 | 数据发布的空间类型,支持 application、vendor 和 global,默认为 application |
success | Function | 否 | 成功回调 |
fail | Function | 否 | 失败回调 |
complete | Function | 否 | 执行结束后的回调(调用成功、失败都会执行) |
package | String | 否 | 配置需要写入数据到某快应用的应用空间 时某快应用的包名 ,仅在scope 参数不设置或设置为application 时生效,在scope 为vendor 或global 时必须设为空值 |
sign | String | 否 | 配置需要写入数据到某快应用的应用空间 时某快应用的签名 的 SHA-256,仅在scope 参数不设置或设置为application 时生效,在scope 为vendor 或global 时必须设为空值 |
# fail 返回错误代码:
错误码 | 说明 |
---|---|
202 | 参数错误 |
# 示例
exchange.set({
key: 'token',
value: '12347979',
success: function() {
console.log(`handling success`)
},
fail: function(data, code) {
console.log(`handling fail, code = ${code}`)
}
})
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
←
→