cache.html 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. <!DOCTYPE HTML>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0, user-scalable=no">
  6. <meta name="HandheldFriendly" content="true">
  7. <meta name="MobileOptimized" content="320">
  8. <title>Cache Document</title>
  9. <link rel="stylesheet" type="text/css" href="res/doc.css" charset="utf-8">
  10. <link rel="stylesheet" type="text/css" href="res/prettify.sons.css" charset="utf-8">
  11. <script type="text/javascript" src="res/doc.js" charset="utf-8"></script><script type="text/javascript" src="res/prettify.js" charset="utf-8"></script>
  12. </head>
  13. <body><div id="content" class="content">
  14. <h1><a name="plus.cache">cache</a></h1>
  15. <p>Cache模块用于管理应用缓存,通过plus.cache获取缓存管理对象。</p>
  16. <h2>方法:</h2>
  17. <ul>
  18. <li>
  19. <a href="#plus.cache.clear">clear</a>: 清除应用的缓存数据</li>
  20. <li>
  21. <a href="#plus.cache.calculate">calculate</a>: 计算应用已使用的缓存数据大小</li>
  22. <li>
  23. <a href="#plus.cache.setMaxSize">setMaxSize</a>: 设置应用的可使用的最大缓存大小</li>
  24. </ul>
  25. <h2>回调方法:</h2>
  26. <ul>
  27. <li>
  28. <a href="#plus.cache.CacheClearCallback">CacheClearCallback</a>: 清除应用缓存完成回调</li>
  29. <li>
  30. <a href="#plus.cache.CacheCalculateCallback">CacheCalculateCallback</a>: 计算应用使用缓存容量回调</li>
  31. </ul>
  32. <h2>权限:</h2>
  33. <p>5+功能模块(permissions)</p>
  34. <pre class="prettyprint linenums">
  35. {
  36. // ...
  37. "permissions":{
  38. // ...
  39. "Cache": {
  40. "description": "应用缓存"
  41. }
  42. }
  43. }
  44. </pre>
  45. <h1><a name="plus.cache.CacheClearCallback">CacheClearCallback</a></h1>
  46. <p>清除应用缓存完成回调</p>
  47. <pre class="prettyprint linenums">
  48. void onCompleted() {
  49. // Clear cache completed code.
  50. }
  51. </pre>
  52. <h2>说明:</h2>
  53. <p class="des">清除应用缓存回调函数,调用plus.cache.clear清除缓存操作时作为参数传入,在清除缓存操作完成时触发回调。</p>
  54. <h2>参数:</h2>
  55. <ul></ul>
  56. <h2>返回值:</h2>
  57. <font class="type">void</font>
  58. : 无<h1><a name="plus.cache.CacheCalculateCallback">CacheCalculateCallback</a></h1>
  59. <p>计算应用使用缓存容量回调</p>
  60. <pre class="prettyprint linenums">
  61. void onCompleted( size ) {
  62. // Calculate cache complete code.
  63. }
  64. </pre>
  65. <h2>说明:</h2>
  66. <p class="des">计算应用当前使用缓存容量回调函数,调用plus.cache.calculate计算缓存容量操作时作为参数传入,在计算缓存容量大小完成时触发回调。</p>
  67. <h2>参数:</h2>
  68. <ul><li>size:
  69. <em>(
  70. <font class="type">Number</font>
  71. )
  72. 必选 </em>应用当前使用缓存的大小,单位为byte<br>
  73. </li></ul>
  74. <h2>返回值:</h2>
  75. <font class="type">void</font>
  76. : 无<br><br>
  77. </div></body>
  78. </html>