proximity.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>Proximity 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.proximity">proximity</a></h1>
  15. <p>Proximity模块管理设备距离传感器,可获取当前设备的接近距离信息,通过plus.proximity可获取设备距离传感管理对象。</p>
  16. <h2>方法:</h2>
  17. <ul>
  18. <li>
  19. <a href="#plus.proximity.getCurrentProximity">getCurrentProximity</a>: 获取当前设备的接近距离信息</li>
  20. <li>
  21. <a href="#plus.proximity.watchProximity">watchProximity</a>: 监听设备接近距离的变化</li>
  22. <li>
  23. <a href="#plus.proximity.clearWatch">clearWatch</a>: 关闭监听设备接近距离变化</li>
  24. </ul>
  25. <h2>回调方法:</h2>
  26. <ul>
  27. <li>
  28. <a href="#plus.proximity.ProximitySuccessCallback">ProximitySuccessCallback</a>: 获取设备接近距离信息成功的回调函数</li>
  29. <li>
  30. <a href="#plus.proximity.ProximityErrorCallback">ProximityErrorCallback</a>: 获取设备接近距离信息失败的回调函数</li>
  31. </ul>
  32. <h2>权限:</h2>
  33. <p>5+功能模块(permissions)</p>
  34. <pre class="prettyprint linenums">
  35. {
  36. // ...
  37. "permissions":{
  38. // ...
  39. "Proximity": {
  40. "description": "距离感应器"
  41. }
  42. }
  43. }
  44. </pre>
  45. <h1><a name="plus.proximity.ProximitySuccessCallback">ProximitySuccessCallback</a></h1>
  46. <p>获取设备接近距离信息成功的回调函数</p>
  47. <pre class="prettyprint linenums">
  48. void onSuccess( distance ) {
  49. // Get distance success code.
  50. }
  51. </pre>
  52. <h2>参数:</h2>
  53. <ul><li>distance:
  54. <em>(
  55. <font class="type">Number</font>
  56. )
  57. 必选 </em>设备接近距离<br>设备接近距离传感器获取的距离值,单位为厘米。如果感应器无法获取准确的距离值,则在接近设备时返回0,否则返回Infinity。</li></ul>
  58. <h2>返回值:</h2>
  59. <font class="type">void</font>
  60. : 无<h1><a name="plus.proximity.ProximityErrorCallback">ProximityErrorCallback</a></h1>
  61. <p>获取设备接近距离信息失败的回调函数</p>
  62. <pre class="prettyprint linenums">
  63. void onError( error ) {
  64. // Get distance error code.
  65. }
  66. </pre>
  67. <h2>参数:</h2>
  68. <ul><li>error:
  69. <em>(
  70. <font class="type">DOMException</font>
  71. )
  72. 必选 </em>失败信息<br>
  73. </li></ul>
  74. <h2>返回值:</h2>
  75. <font class="type">void</font>
  76. : 无<br><br>
  77. </div></body>
  78. </html>