messaging.html 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  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>Messaging 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.messaging">messaging</a></h1>
  15. <p>Messaging模块管理设备通讯功能,可用于短信、彩信、邮件发送等。通过plus.messaging可获取设备通讯管理对象。另外也可以直接通过html中的href直接快速发送短信、拨打电话、发送邮件等。</p>
  16. <h2>常量:</h2>
  17. <ul>
  18. <li>
  19. <a href="#plus.messaging.TYPE_SMS">TYPE_SMS</a>: 简单短信类型常量</li>
  20. <li>
  21. <a href="#plus.messaging.TYPE_MMS">TYPE_MMS</a>: 彩信类型常量</li>
  22. <li>
  23. <a href="#plus.messaging.TYPE_EMAIL">TYPE_EMAIL</a>: 邮件类型常量</li>
  24. </ul>
  25. <h2>方法:</h2>
  26. <ul>
  27. <li>
  28. <a href="#plus.messaging.createMessage">createMessage</a>: 创建消息对象</li>
  29. <li>
  30. <a href="#plus.messaging.sendMessage">sendMessage</a>: 发送消息</li>
  31. </ul>
  32. <h2>对象:</h2>
  33. <ul>
  34. <li>
  35. <a href="#plus.messaging.Message">Message</a>: 消息对象</li>
  36. <li>
  37. <a href="#plus.messaging.BodyType">BodyType</a>: 消息体内容类型</li>
  38. </ul>
  39. <h2>回调方法:</h2>
  40. <ul>
  41. <li>
  42. <a href="#plus.messaging.MessageSendSuccessCallback">MessageSendSuccessCallback</a>: 消息发送成功的回调函数</li>
  43. <li>
  44. <a href="#plus.messaging.MessageErrorCallback">MessageErrorCallback</a>: 消息发送失败的回调函数</li>
  45. </ul>
  46. <h2>权限:</h2>
  47. <p>5+功能模块(permissions)</p>
  48. <pre class="prettyprint linenums">
  49. {
  50. // ...
  51. "permissions":{
  52. // ...
  53. "Messaging": {
  54. "description": "短信彩信邮件消息"
  55. }
  56. }
  57. }
  58. </pre>
  59. <h1><a name="plus.messaging.Message">Message</a></h1>
  60. <p>消息对象</p>
  61. <h2>属性:</h2>
  62. <ul>
  63. <li>
  64. <a href="#plus.messaging.Message.to">to</a>: 收件人信息</li>
  65. <li>
  66. <a href="#plus.messaging.Message.cc">cc</a>: 抄送人信息</li>
  67. <li>
  68. <a href="#plus.messaging.Message.bcc">bcc</a>: 暗送人信息</li>
  69. <li>
  70. <a href="#plus.messaging.Message.from">from</a>: 发件人信息</li>
  71. <li>
  72. <a href="#plus.messaging.Message.subject">subject</a>: 发送消息主题</li>
  73. <li>
  74. <a href="#plus.messaging.Message.body">body</a>: 发送消息内容</li>
  75. <li>
  76. <a href="#plus.messaging.Message.bodyType">bodyType</a>: 发送消息内容类型</li>
  77. <li>
  78. <a href="#plus.messaging.Message.silent">silent</a>: 是否采用静默方式发送消息</li>
  79. </ul>
  80. <h2>方法:</h2>
  81. <ul><li>
  82. <a href="#plus.messaging.Message.addAttachment">addAttachment</a>: 添加附件</li></ul>
  83. <h1><a name="plus.messaging.BodyType">BodyType</a></h1>
  84. <p>消息体内容类型</p>
  85. <h2>说明:</h2>
  86. <p class="des">用于设定消息的消息体内容。</p>
  87. <h1><a name="plus.messaging.MessageSendSuccessCallback">MessageSendSuccessCallback</a></h1>
  88. <p>消息发送成功的回调函数</p>
  89. <pre class="prettyprint linenums">
  90. void onSuccess() {
  91. // Send message success code.
  92. }
  93. </pre>
  94. <h2>参数:</h2>
  95. <p>无</p>
  96. <h2>返回值:</h2>
  97. <font class="type">void</font>
  98. : 无<h1><a name="plus.messaging.MessageErrorCallback">MessageErrorCallback</a></h1>
  99. <p>消息发送失败的回调函数</p>
  100. <pre class="prettyprint linenums">
  101. void onError( error ) {
  102. // Error code.
  103. }
  104. </pre>
  105. <h2>参数:</h2>
  106. <ul><li>error:
  107. <em>(
  108. <font class="type">DOMException</font>
  109. )
  110. 必选 </em>失败信息<br>
  111. </li></ul>
  112. <h2>返回值:</h2>
  113. <font class="type">void</font>
  114. : 无<br><br>
  115. </div></body>
  116. </html>