Events模块管理客户端事件,包括系统事件,如扩展API加载完毕、程序前后台切换等。
常量:
方法:
回调方法:
"plusready"
扩展API加载完成事件
说明:
String 类型
为了保证HTML5扩展API的有效调用,页面加载扩展API完成后会触发此事件。 通常应该在页面开始加载时监听此事件,当此事件触发后,就可以安全的调用HTML5扩展API。 如果应用使用多页面,每个都会收到此事件。 注意:uni-app不需要关心此事件,框架已经封装确保5+ API能够有效调用。
示例:
uni-app使用plus注意事项
"pause"
运行环境从前台切换到后台事件
说明:
String 类型
当程序从前台切换到后台时会触发此事件。 若应用需要处理从前台切换到后台的事件行为,可通过注册“pause”事件监听。 注意:此事件可能早于"plusready"事件触发,如果在回调事件中需要调用5+API,建议在plusready回调事件触发后再监听。
示例:
uni-app使用plus注意事项
"resume"
运行环境从后台切换到前台事件
说明:
String 类型
当程序从后台切换到前台时会触发此事件。 若应用需要处理从后台切换到前台的事件行为,可通过注册“resume”事件监听。 注意:此事件可能早于"plusready"事件触发,如果在回调事件中需要调用5+API,建议在plusready回调事件触发后再监听。
示例:
uni-app使用plus注意事项
"netchange"
设备网络状态变化事件
说明:
String 类型
设备的网络状态发生时会触发此事件。 若应用需要根据网络状态变化进行业务处理,可通过注册“netchange”事件监听。 注意:此事件可能早于"plusready"事件触发,如果在回调事件中需要调用5+API,建议在plusready回调事件触发后再监听。
示例:
uni-app使用plus注意事项
"newintent"
新意图事件
说明:
String 类型
程序切换到后台后被第三方程序激活到前台时触发此事件。 若应用需要根据第三方程序调用时进行业务处理(如判断传入的参数打开指定页面),可通过注册“newintent”事件监听。 注意:此事件可能早于"plusready"事件触发,如果在回调事件中需要调用5+API,建议在plusready回调事件触发后再监听。
示例:
uni-app使用plus注意事项
"plusscrollbottom"
页面滚动到底部事件
说明:
String 类型
当滚动Webview窗口页面到底部时触发此事件。
示例:
uni-app使用plus注意事项
"error"
页面加载错误事件
说明:
String 类型
当Webview窗口加载页面失败后打开错误页面时触发此事件。 注意:此事件仅在错误页面中才触发。
示例:
uni-app使用plus注意事项
"background"
应用切换到后台运行事件
说明:
String 类型
在多应用运行环境(如流应用)中,启动一个新应用时,之前运行的应用将会自动切换到后台运行。 切换到后台运行的应用将会触发此事件。 注意:此事件可能早于"plusready"事件触发,如果在回调事件中需要调用5+API,建议在plusready回调事件触发后再监听。
示例:
uni-app使用plus注意事项
"foreground"
应用切换到前台运行事件
说明:
String 类型
在多应用运行环境(如流应用)中,应用切换到后台运行后再次被启动时,不会创建新的应用实例,而是将后台应用激活到前台运行。 此时切换到前台运行的应用将会触发foreground事件。 回调函数原型为void onForeground(e){}其中e.active表明激活应用到前台来源,可取值:"default"-默认激活方式,通常表示通过应用列表启动激活,或者关闭前一个应用后自动激活等;"stream"-通过流应用api(plus.stream.open)激活;"scheme"-通过urlscheme方式触发激活; "push"-通过点击系统通知方式触发激活; "barcode"-通过二维码扫描激活; "myapp"-通过应用收藏列表([流应用]独立App中"我的"列表)触发激活。
示例:
uni-app使用plus注意事项
"trimmemory"
应用需要清理内存事件
说明:
String 类型
在多应用运行环境(如流应用)中,可同时运行多个应用,当运行过多应用时会导致内存占用过多的情况,此时切换到后台运行的应用会收到清理内存事件。 此时应用应该释放资源来减少内存的使用(如关闭非必要的Webview窗口等)。
示例:
uni-app使用plus注意事项
"splashclosed"
应用启动界面已关闭事件
说明:
String 类型
应用启动后关闭启动界面时触发,不管是应用自动关闭还是调用plus.navigator.closeSplashscreen方法,都会触发此事件。
示例:
uni-app使用plus注意事项
"keyboardchange"
软键盘变化事件
说明:
String 类型
但软键盘打开或关闭时触发,并在回到参数event中height属性表示软键盘的高度。 height属性值大于0表示打开软键盘,height属性值为0表示关闭软键盘。
示例:
uni-app使用plus注意事项
"uistylechange"
系统外观样式变化事件
说明:
String 类型
系统外观样式切换(设置或关闭暗黑模式)时触发。 可通过plus.navigator.getUiStyle()获取当前设置的外观样式。 HBuilderX2.6.3+版本支持,iOS平台适配暗黑模式参考:iOS13适配暗黑模式/夜间模式/深色模式/暗黑主题(DarkMode) - DCloud问答。
示例:
uni-app使用plus注意事项
addEventListener
添加事件监听函数
说明:
通过Html中标准document对象的addEventListener方法添加扩展事件监听器,当指定事件发生时,将触发对应额监听回调函数。
参数:
- event: ( DOMString ) 必选 要添加监听的事件类型,可取上面列出的所有事件常量
- callback: ( EventTrigCallback ) 必选 扩展API加载完毕触发的回调函数
- capture: ( Boolean ) 可选 事件流捕获顺序,可忽略
返回值:
void : 无
EventTrigCallback
事件触发回调函数
说明:
指定事件触发时的回调函数,在指定的事件已经发生时调用。
参数:
无
返回值:
void : 无
ErrorEventTrigCallback
页面加载错误事件回调函数
说明:
当Webview窗口加载页面失败后打开错误页面时触发此事件。
参数:
返回值:
void : 无