全部产品

移除 AP 数据

更新时间:2020-04-13 16:06:04

此接口用于从统一存储中删除数据。

removeAPDataStorage 接口的使用方法

  1. AlipayJSBridge.call('removeAPDataStorage', {
  2. type: "common",
  3. business: "customBusinessKey",
  4. key: "customKey",
  5. }, function(result) {
  6. alert(JSON.stringify(result));
  7. });

代码示例

  1. <button id="J_saveDataBtn" class="btn">保存数据</button>
  2. <button id="J_getDataBtn" class="btn">查看数据</button>
  3. <button id="J_removeDataBtn" class="btn">删除数据</button>
  4. <script>
  5. function ready(callback) {
  6. // 如果 jsbridge 已经注入则直接调用
  7. if (window.AlipayJSBridge) {
  8. callback && callback();
  9. } else {
  10. // 如果没有注入则监听注入的事件
  11. document.addEventListener('AlipayJSBridgeReady', callback, false);
  12. }
  13. }
  14. ready(function() {
  15. document.querySelector('#J_saveDataBtn').addEventListener('click', function(e) {
  16. AlipayJSBridge.call('setAPDataStorage', {
  17. type: "common",
  18. business: "customBusinessKey",
  19. key: "customKey",
  20. value: "customValue"
  21. }, function(result) {
  22. alert(JSON.stringify(result));
  23. });
  24. }, false);
  25. document.querySelector('#J_getDataBtn').addEventListener('click', function(e) {
  26. AlipayJSBridge.call('getAPDataStorage', {
  27. type: "common",
  28. business: "customBusinessKey",
  29. key: "customKey"
  30. }, function(result) {
  31. alert(JSON.stringify(result));
  32. });
  33. }, false);
  34. document.querySelector('#J_removeDataBtn').addEventListener('click', function(e) {
  35. AlipayJSBridge.call('removeAPDataStorage', {
  36. type: "common",
  37. business: "customBusinessKey",
  38. key: "customKey"
  39. }, function(result) {
  40. alert(JSON.stringify(result));
  41. });
  42. }, false);
  43. }, false);
  44. </script>

API

  1. AlipayJSBridge.call('removeAPDataStorage', {
  2. type, business, key
  3. });

入参

名称 类型 描述 必选 默认值
type string (user/common) 用户维度存储还是公共存储,默认值为:common N “common”
business string 自定义的业务标识,可与相应的客户端存取代码约定,默认值为:NebulaBiz。
(在 Android 中,该业务标识与创建 APSharedPreferences 时所传入的 GROUD_ID 对应)
N “”
key string 自定义数据的 key Y “”

出参

回调函数带入的参数 result: {success}

名称 类型 描述
success bool 删除是否成功