交换数据

接口声明

在manifest.json文件的 features属性中增加如下配置。

{"name": "service.exchange"}

导入模块

在调用接口页面的<script>部分增加如下配置。

import exchange from '@service.exchange'

或

var exchange = require('@service.exchange')

使用限制

接口定义

交互数据提供了一个不同快应用间数据交互的方式。快应用可以利用它发布数据，或从其他快应用获取数据。 数据交互有两个数据空间，分别是应用空间（application）和全局空间（global）。

• application：数据发布在应用空间，读取时需同时指定发布方的包名和签名，并且需要发布方授权。
• global：数据发布在全局空间，多个应用的写操作会相互覆盖，读取时不能指定发布方的包名和签名，不需要发布方授权。

global 数据仅支持 set、get 操作，remove、clear、grantPermission、revokePermission 等操作均不支持。

[h2]exchange.get(OBJECT)

描述

读取数据。

OBJECT参数

success返回值：

fail返回错误码：

示例代码

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

[h2]exchange.set(OBJECT)

描述

发布数据到快应用平台。

OBJECT参数

fail返回错误码：

示例代码

exchange.set({
    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}`)
    }
})

[h2]exchange.remove(OBJECT)

描述

从快应用平台删除数据。

OBJECT参数

示例代码

exchange.remove({
    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}`)
    }
})

[h2]exchange.clear(OBJECT)

描述

从快应用平台清除数据。

OBJECT参数

示例代码

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

[h2]exchange.grantPermission(OBJECT)

描述

授权应用获取数据。同签名的应用不用授权，默认有读取权限。

OBJECT参数

fail返回错误码：

示例代码

exchange.grantPermission({
    package: 'com.fastapp.sample',
    sign: '6d3e6a3dcbdadb0aa94f64e33a36b01254cb6ef7e14be282d885cd95aeb952e0',    
    writable: true,
    success: function() {
        console.log(`handling success`)
    },
    fail: function(data, code) {
        console.log(`handling fail, code = ${code}`)
    }
})

[h2]exchange.revokePermission(OBJECT)

描述

取消授权应用获取数据。不能取消同签名应用的读取授权。

OBJECT参数

fail返回错误码：

示例代码

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

Demo

<template>
  <div class="container">

    <div class="item-container">
      <div class="item-content">
        <div class="item-content-detail">
          <text class="txt">key:</text>
          <input class="input" placeholder=" please input key"  value={{exchangeKey}} onchange="keyFn" />
        </div>
        <div class="item-content-detail">
          <text class="txt">value:</text>
          <input class="input" placeholder="please input value"  value={{exchangeValue}} onchange="valueFn" />
        </div>

      </div>


      <!-- Set data -->
      <input type="button" class="btn" onclick="setAppExchange"  value="setAppExchange" />
      <input type="button" class="btn" onclick="setGlobalExchange"  value="setGlobalExchange" />
      <!-- Read data -->
      <input type="button" class="btn" onclick="getAppExchange"  value="getAppExchange key:{{exchangeKey}}" />
      <input type="button" class="btn" onclick="getGlobalExchange"  value="getGlobalExchange key:{{exchangeKey}}" />>
      <!-- To grant authorization -->
      <input type="button" class="btn" onclick="grantPermission"  value="grantPermission" />
      <input type="button" class="btn" onclick="revokePermission"  value="revokePermission" />
      <!-- Delete operation -->
      <input type="button" class="btn" onclick="clearExchange"  value="clearExchange" />
      <input type="button" class="btn" onclick="removeExchange"  value="removeExchange" />
    </div>
  </div>
</template>

<style>
  .container{
  flex: 1;
  flex-direction: column;
}
  .item-container {
    margin-bottom: 50px;
    margin-right: 60px;
    margin-left: 60px;
    flex-direction: column;
  }

  .item-content {
    flex-direction: column;
    background-color: #ffffff;
    padding-left: 30px;
    padding-right: 30px;
    padding-top: 15px;
    padding-bottom: 15px;
    margin-bottom: 100px;
  }

  .item-content-detail {
    align-items: center;
  }

  .input {
    flex: 1;
    font-size: 30px;
    padding-left: 20px;
  }

  .txt {
    width: 100px;
    padding-top: 15px;
    padding-bottom: 15px;
    text-align: right;
  }
.btn {
  height: 80px;
  text-align: center;
  border-radius: 5px;
  margin-right: 60px;
  margin-left: 60px;
  margin-bottom: 50px;
  color: #ffffff;
  font-size: 30px;
  background-color: #0faeff;
}
</style>

<script>
  import exchange from '@service.exchange'
  import prompt from '@system.prompt'

  export default {
    data: {
      exchangeKey: '',
      exchangeValue: '',
    },
    onInit: function () {
      this.$page.setTitleBar({ text: 'exchange' })
    },
    keyFn: function (e) {
      this.exchangeKey = e.text
    },
    valueFn: function (e) {
      this.exchangeValue = e.text
    },
    setAppExchange: function () {
      var that = this
      if (this.exchangeKey && this.exchangeValue) {
        exchange.set({
          key: this.exchangeKey,
          value: this.exchangeValue,
          scope: 'application',
          success: function (ret) {
            prompt.showToast({
              message: '{key:' + that.exchangeKey + ',value:' + that.exchangeValue + '}',
            })
            console.log("message"+ that.exchangeKey + ',value:' + that.exchangeValue )
          },
          fail: function (erromsg, errocode) {
            prompt.showToast({ message: 'set fail --- ' + errocode + ':' + erromsg })
            console.info('set fail --- ' + errocode + ':' + erromsg)
          },
          complete: function () {
            prompt.showToast({ message: 'set complete' })
            console.info('set complete  ')
          }
        })
      } else {
        prompt.showToast({
          message: 'Please enter the key and value values'
        })
      }
    },
    setGlobalExchange: function () {
      var that = this
      if (this.exchangeKey && this.exchangeValue) {
        exchange.set({
          key: this.exchangeKey,
          value: this.exchangeValue,
          scope: 'global',
          success: function (ret) {
            prompt.showToast({
              message: '{key:' + that.exchangeKey + ',value:' + that.exchangeValue + '}',
            })
          },
          fail: function (erromsg, errocode) {
            prompt.showToast({ message: 'set fail --- ' + errocode + ':' + erromsg })
            console.info('set fail --- ' + errocode + ':' + erromsg)
          },
          complete: function () {
            prompt.showToast({ message: 'set complete' })
            console.info('set complete  ')
          }
        })
      } else {
        prompt.showToast({
          message: 'Please enter the key and value values'
        })
      }
    },
    getAppExchange: function () {
      exchange.get({
        package: 'com.fastapp.sample.global',
        scope: 'application',
        sign: '6d3e6a3dcbdadb0aa94f64e33a36b01254cb6ef7e14be282d885cd95aeb952e0',
        key: this.exchangeKey,
        success: function (ret) {
          console.info('exchange.get(): ', JSON.stringify(ret))
          prompt.showToast({
            message: 'value: ' + ret,
          })
        },
        fail: function (erromsg, errocode) {
          prompt.showToast({ message: 'get fail --- ' + errocode + ':' + erromsg })
          console.info('get fail --- ' + errocode + ':' + erromsg)
        },
        complete: function () {
          console.info('get complete  ')
        }
      })
    },
    getGlobalExchange: function () {
      var that = this
      exchange.get({
        package: '',
        sign: '',
        scope: 'global',
        key: this.exchangeKey,
        success: function (ret) {
          console.info('storage.get(): ', JSON.stringify(ret))
          that.storageShow = ret
          prompt.showToast({
            message: 'value: ' + ret,
          })
        },
        fail: function (erromsg, errocode) {
          prompt.showToast({ message: 'get fail --- ' + errocode + ':' + erromsg })
          console.info('get fail --- ' + errocode + ':' + erromsg)
        },
        complete: function () {
          console.info('get complete  ')
        }
      })
    },
    grantPermission: function () {
      exchange.grantPermission({
        package: 'com.exchang.demo',
        sign: '6f65a2a4fbb1941436f2bfeb23b1c0c4003f30de2b9c4d31a4d188b1de7d0893',
        key: this.exchangeKey,
        success: function (ret) {
          console.info('exchange.grantPermission(): ', JSON.stringify(ret))
          prompt.showToast({
            message: 'value: ' + ret,
          })
        },
        fail: function (erromsg, errocode) {
          prompt.showToast({ message: 'grantPermission fail --- ' + errocode + ':' + erromsg })
          console.info('grantPermission fail --- ' + errocode + ':' + erromsg)
        },
        complete: function () {
          console.info('grantPermission complete  ')
        }
      })
    },
    revokePermission: function () {
      exchange.revokePermission({
        package: 'com.fastapp.sample.global',
        key: this.exchangeKey,
        success: function (ret) {
          console.info('exchange.revokePermission(): ', JSON.stringify(ret))
          prompt.showToast({
            message: 'value: ' + ret,
          })
        },
        fail: function (erromsg, errocode) {
          prompt.showToast({ message: 'revokePermission fail --- ' + errocode + ':' + erromsg })
          console.info('revokePermission fail --- ' + errocode + ':' + erromsg)
        },
        complete: function () {
          console.info('revokePermission complete  ')
        }
      })
    },

    clearExchange: function () {
      exchange.clear({
        success: function () {
          prompt.showToast({
            message: 'success',
          })
        },
        fail: function (erromsg, errocode) {
          prompt.showToast({ message: 'clear fail --- ' + errocode + ':' + erromsg })
          console.info('clear fail --- ' + errocode + ':' + erromsg)
        },
        complete: function () {
          prompt.showToast({ message: 'clear complete' })
          console.info('clear complete  ')
        }
      })
    },
    removeExchange: function () {
      if (this.exchangeKey) {
        exchange.remove({
          key: this.exchangeKey,
          success: function () {
            prompt.showToast({
              message: 'success',
            })
          },
          fail: function (erromsg, errocode) {
            prompt.showToast({ message: 'get fail --- ' + errocode + ':' + erromsg })
            console.info('get fail --- ' + errocode + ':' + erromsg)
          },
          complete: function () {
            console.info('get complete  ')
          }
        })
      } else {
        prompt.showToast({ message: 'key is null' })
      }
    }
  }
</script>

效果图如下：

版本更新说明