此接口处理的数据在PC终端使用时,可能会被其它应用读取,所以建议请勿使用此接口存储敏感数据。
交互数据提供了一个不同快应用间数据交互的方式。小程序快应用可以利用它发布数据,或从其他快应用获取数据。 数据交互有两个数据空间,分别是应用空间(application)和全局空间(global)。
global 数据仅支持 set、get 操作,remove、clear、grantPermission、revokePermission 等操作均不支持。
接口 | 描述 |
|---|---|
读取数据。 | |
发布数据到小程序快应用平台。 | |
从小程序快应用平台删除数据。 | |
从小程序快应用平台清除数据。 | |
授权应用获取数据。同签名的应用不用授权,默认有读取权限。 | |
取消授权应用获取数据。不能取消同签名应用的读取授权。 |
描述
读取数据。
OBJECT参数
属性名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
package | string | 否 | 数据发布方的包名,scope 为 application 时必须提供,为 global 时必须为空。 |
sign | string | 否 | 使用 SHA-256 加密的数据发布方签名,scope 为 application 时必须提供,为 global 时必须为空。 |
scope | string | 否 | 数据发布的空间类型,支持 application 和 global,默认为 application。 |
key | string | 是 | 数据的 key。 |
success | function | 否 | 成功回调。 |
fail | function | 否 | 失败回调。 |
complete | function | 否 | 执行结束后的回调(调用成功、失败都会执行)。 |
success返回值:
参数名 | 类型 | 说明 |
|---|---|---|
value | string | 数据的值。 |
fail返回错误码:
错误码 | 说明 |
|---|---|
202 | 参数错误。 |
1000 | 没有权限。 |
示例代码
qa.exchangeGet({
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}`)
}
}) 描述
发布数据到小程序快应用平台。
OBJECT参数
属性名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
key | string | 是 | 数据的 key。 |
value | string | 是 | 数据的值。 |
scope | string | 否 | 数据发布的空间类型,支持 application 和 global,默认为 application。 |
success | function | 否 | 成功回调。 |
fail | function | 否 | 失败回调。 |
complete | function | 否 | 执行结束后的回调(调用成功、失败都会执行)。 |
package | string | 否 | 数据发布方的包名。当scope为application,为其他应用修改数据时,必须提供。scope为global时,必须为空。 |
sign | string | 否 | 数据发布方签名的 SHA-256。当scope为application,为其他应用修改数据时,必须提供。scope为global时,必须为空。 |
fail返回错误码:
错误码 | 说明 |
|---|---|
202 | 参数错误。 |
示例代码
qa.exchangeSet({
package: 'com.fastapp.sample',
sign: '6d3e6a3dcbdadb0aa94f64e33a36b01254cb6ef7e14be282d885cd95aeb952e0',
key: 'token',
value: '12347979',
success: function() {
console.log(`handling success`)
},
fail: function(data, code) {
console.log(`handling fail, code = ${code}`)
}
}) 描述
从小程序快应用平台删除数据。
仅能删除application类型的数据,global类型的无法删除。
OBJECT参数
属性名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
key | string | 是 | 数据的 key。 |
success | function | 否 | 成功回调。 |
fail | function | 否 | 失败回调。 |
complete | function | 否 | 执行结束后的回调(调用成功、失败都会执行)。 |
package | string | 否 | 数据发布方的包名。从其他应用中删除数据时,该参数必填。 |
sign | string | 否 | 数据发布方签名的 SHA-256。从其他应用中删除数据时,该参数必填。 |
示例代码
qa.exchangeRemove({
package: 'com.fastapp.sample',
sign: '6d3e6a3dcbdadb0aa94f64e33a36b01254cb6ef7e14be282d885cd95aeb952e0',
key: 'token',
success: function(ret) {
console.log(`handling success, value = ${ret.value}`)
},
fail: function(data, code) {
console.log(`handling fail, code = ${code}`)
}
}) 描述
从小程序快应用平台清除数据。
仅能清除application类型的内部数据,application类型的外部数据和global类型数据无法清除。
OBJECT参数
属性名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
success | function | 否 | 成功回调。 |
fail | function | 否 | 失败回调。 |
complete | function | 否 | 执行结束后的回调(调用成功、失败都会执行)。 |
示例代码
qa.exchangeClear({
success: function() {
console.log(`handling success`)
},
fail: function(data, code) {
console.log(`handling fail, code = ${code}`)
}
}) 描述
授权应用获取数据。同签名的应用不用授权,默认有读取权限。
OBJECT参数
属性名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
package | string | 是 | 授权应用的包名。 |
sign | string | 是 | 授权应用的签名(SHA-256)。 |
key | string | 否 | 数据的 key。如果为空,则授权当前所有 key 的读取权限。 |
success | function | 否 | 成功回调。 |
fail | function | 否 | 失败回调。 |
complete | function | 否 | 执行结束后的回调(调用成功、失败都会执行)。 |
writable | boolean | 否 | 配置授权应用是否可修改/删除数据,默认值为 false。
|
fail返回错误码:
错误码 | 说明 |
|---|---|
202 | 参数错误。 |
示例代码
qa.exchangeGrantPermission({
package: 'com.fastapp.sample',
sign: '6d3e6a3dcbdadb0aa94f64e33a36b01254cb6ef7e14be282d885cd95aeb952e0',
writable: true,
success: function() {
console.log(`handling success`)
},
fail: function(data, code) {
console.log(`handling fail, code = ${code}`)
}
}) 描述
取消授权应用获取数据。不能取消同签名应用的读取授权。
OBJECT参数
属性名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
package | string | 是 | 取消授权的应用包名。 |
key | string | 否 | 数据的 key。如果为空,则取消当前所有 key 的权限。 |
success | function | 否 | 成功回调。 |
fail | function | 否 | 失败回调。 |
complete | function | 否 | 执行结束后的回调(调用成功、失败都会执行)。 |
fail返回错误码:
错误码 | 说明 |
|---|---|
202 | 参数错误。 |
示例代码
qa.exchangeRevokePermission({
package: 'com.example',
success: function() {
console.log(`handling success`)
},
fail: function(data, code) {
console.log(`handling fail, code = ${code}`)
}
})