events.html 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  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>Events 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.Events">Events</a></h1>
  15. <p>Events模块管理客户端事件,包括系统事件,如扩展API加载完毕、程序前后台切换等。</p>
  16. <h2>常量:</h2>
  17. <ul>
  18. <li>
  19. <a href="#plus.Events.%22plusready%22">"plusready"</a>: 扩展API加载完成事件</li>
  20. <li>
  21. <a href="#plus.Events.%22pause%22">"pause"</a>: 运行环境从前台切换到后台事件</li>
  22. <li>
  23. <a href="#plus.Events.%22resume%22">"resume"</a>: 运行环境从后台切换到前台事件</li>
  24. <li>
  25. <a href="#plus.Events.%22netchange%22">"netchange"</a>: 设备网络状态变化事件</li>
  26. <li>
  27. <a href="#plus.Events.%22newintent%22">"newintent"</a>: 新意图事件</li>
  28. <li>
  29. <a href="#plus.Events.%22plusscrollbottom%22">"plusscrollbottom"</a>: 页面滚动到底部事件</li>
  30. <li>
  31. <a href="#plus.Events.%22error%22">"error"</a>: 页面加载错误事件</li>
  32. <li>
  33. <a href="#plus.Events.%22background%22">"background"</a>: 应用切换到后台运行事件</li>
  34. <li>
  35. <a href="#plus.Events.%22foreground%22">"foreground"</a>: 应用切换到前台运行事件</li>
  36. <li>
  37. <a href="#plus.Events.%22trimmemory%22">"trimmemory"</a>: 应用需要清理内存事件</li>
  38. <li>
  39. <a href="#plus.Events.%22splashclosed%22">"splashclosed"</a>: 应用启动界面已关闭事件</li>
  40. </ul>
  41. <h2>方法:</h2>
  42. <ul><li>
  43. <a href="#plus.Events.addEventListener">addEventListener</a>: 添加事件监听函数</li></ul>
  44. <h2>回调方法:</h2>
  45. <ul>
  46. <li>
  47. <a href="#plus.Events.EventTrigCallback">EventTrigCallback</a>: 事件触发回调函数</li>
  48. <li>
  49. <a href="#plus.Events.ErrorEventTrigCallback">ErrorEventTrigCallback</a>: 页面加载错误事件回调函数</li>
  50. </ul>
  51. <h1><a name="plus.Events.EventTrigCallback">EventTrigCallback</a></h1>
  52. <p>事件触发回调函数</p>
  53. <pre class="prettyprint linenums">
  54. void onTrig(){
  55. // Event trig code
  56. }
  57. </pre>
  58. <h2>说明:</h2>
  59. <p class="des">
  60. 指定事件触发时的回调函数,在指定的事件已经发生时调用。
  61. </p>
  62. <h2>参数:</h2>
  63. <p>无</p>
  64. <h2>返回值:</h2>
  65. <font class="type">void</font>
  66. : 无<h1><a name="plus.Events.ErrorEventTrigCallback">ErrorEventTrigCallback</a></h1>
  67. <p>页面加载错误事件回调函数</p>
  68. <pre class="prettyprint linenums">
  69. void onErrorTrig(Event event){
  70. // Event trig code
  71. var url = event.url; // 加载错误的页面路径,API中传入的url值
  72. var href = event.href; // 加载错误的页面完整路径,通常以“file://”开头的路径
  73. }
  74. </pre>
  75. <h2>说明:</h2>
  76. <p class="des">
  77. 当Webview窗口加载页面失败后打开错误页面时触发此事件。
  78. </p>
  79. <h2>参数:</h2>
  80. <ul><li>event:
  81. <em>(
  82. <font class="type">Event</font>
  83. )
  84. 可选 </em>加载页面失败信息<br>
  85. 可通过event.url(String类型)获取加载页面的url值,如“./test/html”;
  86. 可通过event.href(String类型)加载错误的页面完整路径,包括完整的协议头,如Android平台“file:///storage/sdcard0/Android/data/io.dcloud.HBuilder/.HBuilder/apps/HBuilder/www/test.html”,iOS平台“file:///var/mobile/Containers/Data/Application/757966CF-345C-4348-B07F-EEF83CF9A369/Library/Pandora/apps/HBuilder/www/test.html”。
  87. </li></ul>
  88. <h2>返回值:</h2>
  89. <font class="type">void</font>
  90. : 无<br><br>
  91. </div></body>
  92. </html>