快應(yīng)用 交換數(shù)據(jù)

2020-08-10 14:22 更新

接口聲明

提供了一個不同快應(yīng)用間數(shù)據(jù)交互的方式??鞈?yīng)用可以利用它發(fā)布數(shù)據(jù),或從其他快應(yīng)用獲取數(shù)據(jù)。 數(shù)據(jù)交互有兩個數(shù)據(jù)空間,分別是應(yīng)用空間(application)和全局空間(global)。 application:數(shù)據(jù)發(fā)布在應(yīng)用空間,讀取時需同時指定發(fā)布方的包名和簽名,并且需要發(fā)布方授權(quán)。 global:數(shù)據(jù)發(fā)布在全局空間,多個應(yīng)用的寫操作會相互覆蓋,讀取時不能指定發(fā)布方的包名和簽名,不需要發(fā)布方授權(quán)。 

備注:global 數(shù)據(jù)僅支持 set、get 操作,remove、clear、grantPermission、revokePermission 等操作均不支持

{ "name": "service.exchange" }

導(dǎo)入模塊

import exchange from '@service.exchange' 
或 
const exchange = require('@service.exchange')

接口定義

exchange.get (OBJECT)

讀取數(shù)據(jù)

參數(shù)

參數(shù)名類型必填說明
packageString數(shù)據(jù)發(fā)布方的包名,scope 為 application 時必須提供,為 global 時必須為空
signString數(shù)據(jù)發(fā)布方簽名的 SHA-256,scope 為 application 時必須提供,為 global 時必須為空
scopeString數(shù)據(jù)發(fā)布的空間類型,支持 application 和 global,默認(rèn)為 application
keyString數(shù)據(jù)的 key
successFunction成功回調(diào)
failFunction失敗回調(diào)
completeFunction執(zhí)行結(jié)束后的回調(diào)(調(diào)用成功、失敗都會執(zhí)行)

返回值:

參數(shù)名類型說明
valueString數(shù)據(jù)的值
fail 返回錯誤代碼:
錯誤碼說明
202參數(shù)錯誤
1000沒有權(quán)限

示例

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}`)
  }
})

exchange.set (OBJECT)

發(fā)布數(shù)據(jù)到快應(yīng)用平臺

參數(shù)

參數(shù)名類型必填說明
keyString數(shù)據(jù)的 key
valueString數(shù)據(jù)的值
scopeString數(shù)據(jù)發(fā)布的空間類型,支持 application,global,默認(rèn)為 application
successFunction成功回調(diào)
failFunction失敗回調(diào)
completeFunction執(zhí)行結(jié)束后的回調(diào)(調(diào)用成功、失敗都會執(zhí)行)
fail 返回錯誤代碼:
錯誤碼說明
202參數(shù)錯誤

示例

exchange.set({
  key: 'token',
  value: '12347979',
  success: function() {
    console.log(`handling success`)
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

exchange.remove (OBJECT)

從快應(yīng)用平臺刪除數(shù)據(jù)

參數(shù)

參數(shù)名類型必填說明
keyString數(shù)據(jù)的 key
successFunction成功回調(diào)
failFunction失敗回調(diào)
completeFunction執(zhí)行結(jié)束后的回調(diào)( 調(diào)用成功、失敗都會執(zhí)行 )
fail 返回錯誤代碼:
錯誤碼說明
202參數(shù)錯誤

示例

exchange.remove({
  key: 'token',
  success: function() {
    console.log(`handling success`)
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

exchange.clear (OBJECT)

從快應(yīng)用平臺清除數(shù)據(jù)

參數(shù)

參數(shù)名類型必填說明
successFunction成功回調(diào)
failFunction失敗回調(diào)
completeFunction執(zhí)行結(jié)束后的回調(diào)( 調(diào)用成功、失敗都會執(zhí)行 )

示例

exchange.clear({
  success: function() {
    console.log(`handling success`)
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

exchange.grantPermission (OBJECT)

授權(quán)應(yīng)用獲取數(shù)據(jù)。同簽名的應(yīng)用不用授權(quán),默認(rèn)有讀取權(quán)限

參數(shù)

參數(shù)名類型必填說明
packageString授權(quán)應(yīng)用的包名
signString授權(quán)應(yīng)用的簽名 SHA-256
keyString數(shù)據(jù)的 key。如果為空,則授權(quán)當(dāng)前所有 key 的讀取權(quán)限
successFunction成功回調(diào)
failFunction失敗回調(diào)
completeFunction執(zhí)行結(jié)束后的回調(diào)(調(diào)用成功、失敗都會執(zhí)行)

應(yīng)用的簽名的 SHA-256 可通過 快應(yīng)用調(diào)試器 進(jìn)行獲取。

fail 返回錯誤代碼:
錯誤碼說明
202參數(shù)錯誤

示例

exchange.grantPermission({
  sign: '7a12ec1d66233f20a20141035b1f7937',
  package: 'com.example',
  success: function() {
    console.log(`handling success`)
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

exchange.revokePermission (OBJECT)

取消授權(quán)應(yīng)用獲取數(shù)據(jù)。不能取消同簽名應(yīng)用的讀取授權(quán)

參數(shù)

參數(shù)名類型必填說明
packageString取消授權(quán)的應(yīng)用包名
keyString數(shù)據(jù)的 key。如果為空,則取消當(dāng)前所有 key 的授權(quán)
successFunction成功回調(diào)
failFunction失敗回調(diào)
completeFunction執(zhí)行結(jié)束后的回調(diào)( 調(diào)用成功、失敗都會執(zhí)行 )
fail 返回錯誤代碼:
錯誤碼說明
202參數(shù)錯誤

示例

exchange.revokePermission({
  package: 'com.example',
  success: function() {
    console.log(`handling success`)
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

后臺運行限制

無限制。

后臺運行詳細(xì)用法參見 后臺運行腳本。


以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號