application.md 5.8 KB
Newer Older
D
DCloud_LXH 已提交
1
### uni.onPageNotFound(CALLBACK)
Q
qiang 已提交
2 3 4

监听应用要打开的页面不存在事件。该事件与 `App.onPageNotFound` 的回调时机一致

study夏羽's avatar
study夏羽 已提交
5 6 7
|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序|
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
|x|x|√|x|√|x|√|√|√|
Q
qiang 已提交
8 9 10

#### 参数

D
DCloud_LXH 已提交
11
**CALLBACK**
Q
qiang 已提交
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28

要打开的页面不存在事件的回调函数

#### 参数

|属性|类型|说明|
|:-:|:-:|:-:|
|path|String|不存在页面的路径 (代码包路径)|
|query|Object|打开不存在页面的 query 参数|
|isEntryPage|Boolean|是否本次启动的首个页面(例如从分享等入口进来,首个页面是开发者配置的分享页面)	|

**注意**
- 开发者可以在回调中进行页面重定向,但必须在回调中同步处理,异步处理(例如 `setTimeout` 异步执行)无效。
- 若开发者没有调用 `uni.onPageNotFound` 绑定监听,也没有声明 `App.onPageNotFound`,当跳转页面不存在时,将推入客户端原生的页面不存在提示页面。
- 如果回调中又重定向到另一个不存在的页面,将推入客户端原生的页面不存在提示页面,并且不再第二次回调。
- 在除了 `App.vue` 的其他时机中调用 `uni.onPageNotFound` 的话,需要用uni.offPageNotFound取消监听,否则会出现监听多次的情况

D
DCloud_LXH 已提交
29
### uni.onError(CALLBACK)
Q
qiang 已提交
30 31 32

监听小程序错误事件。如脚本错误或 `API` 调用报错等。该事件与 `App.onError` 的回调时机与参数一致。

study夏羽's avatar
study夏羽 已提交
33 34 35
|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序|
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
|x|x|√|x|√|√|√|√|√|
Q
qiang 已提交
36 37 38

#### 参数

D
DCloud_LXH 已提交
39
**CALLBACK**
Q
qiang 已提交
40 41 42 43 44 45 46 47

应用错误事件的回调函数

#### 参数
**string error**

错误信息,包含堆栈

D
DCloud_LXH 已提交
48
### uni.onAppShow(CALLBACK)
Q
qiang 已提交
49 50 51

监听应用切前台事件。该事件与 `App.onShow` 的回调参数一致。

study夏羽's avatar
study夏羽 已提交
52 53 54
|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序|
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
|x|x|√|√|√|√|√|√|x|
Q
qiang 已提交
55 56 57 58 59 60 61 62

**支付宝小程序使用说明:**

- 由于开发者工具版本限制,目前本 API 暂不支持在开发者工具调试和真机调试,仅支持真机预览。开发者请调至 预览 模式,在支付宝客户端扫码查看效果。
- 请勿使用 API 监听匿名函数,否则将无法关闭监听。

#### 参数

D
DCloud_LXH 已提交
63
**CALLBACK**
Q
qiang 已提交
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82

应用切前台事件的回调函数

#### 参数

|属性|类型|说明|平台差异说明|
|:-:|:-:|:-:|:-:|
|path|String|应用切前台的路径 (代码包路径)||
|scene|Number|应用切前台的场景值||
|query|Object	|应用切前台的 query 参数||
|shareTicket|String	|shareTicket|微信小程序|
|referrerInfo|String|来源信息||
|entryType|String|页面展现的来源标识,可取的值为: 'user'、'schema'、'sys',对应代表的意义如下表。|百度小程序 2.10.7+|
|appURL|String|展现时的调起协议,仅当entryType值为 schema 时存在。|百度小程序 2.10.7+|
|entryDataHash|String|群入口信息,通过群应用商店打开、群分享卡片打开的小程序可获得。|qq小程序|

**referrerInfo 的结构**

|属性|类型|说明|平台差异说明|
D
DCloud_LXH 已提交
83
|:-:|:-:|:-:|:-:|
Q
qiang 已提交
84 85 86
|appId|String|来源小程序的appId||
|extraData|Object|来源小程序传过来的数据|微信小程序和qq小程序 scene=1037或1038时支持|

D
DCloud_LXH 已提交
87
### uni.onAppHide(CALLBACK)
Q
qiang 已提交
88 89 90

监听应用切后台事件。该事件与 `App.onHide` 的回调参数一致。

study夏羽's avatar
study夏羽 已提交
91 92 93
|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序|
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
|x|x|√|√|√|√|√|√|x|
Q
qiang 已提交
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109

**支付宝小程序使用说明:**

- 由于开发者工具版本限制,目前本 API 暂不支持在开发者工具调试和真机调试,仅支持真机预览。开发者请调至 预览 模式,在支付宝客户端扫码查看效果。
- 请勿使用 API 监听匿名函数,否则将无法关闭监听。

#### 参数

**function callback**

应用切后台事件的回调函数

### uni.offPageNotFound(function callback)

取消监听应用要打开的页面不存在事件。

study夏羽's avatar
study夏羽 已提交
110 111 112
|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序|
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
|x|x|√|x|√|x|√|√|x|
Q
qiang 已提交
113 114 115 116 117 118 119 120 121 122 123

#### 参数

**function callback**

应用要打开的页面不存在事件的回调函数

### uni.offError(function callback)

取消监听应用错误事件。

study夏羽's avatar
study夏羽 已提交
124 125 126
|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序|
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
|x|x|√|x|√|√|√|√|x|
Q
qiang 已提交
127 128 129 130 131 132 133 134 135 136 137

#### 参数

**function callback**

应用错误事件的回调函数

### uni.offAppShow(function callback)

取消监听小程序切前台事件。

study夏羽's avatar
study夏羽 已提交
138 139 140
|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序|
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
|x|x|√|√|√|√|√|√|x|
Q
qiang 已提交
141 142 143 144 145 146 147 148 149 150 151

#### 参数

**function callback**

应用切前台事件的回调函数

### uni.offAppHide(function callback)

取消监听小程序切后台事件。

study夏羽's avatar
study夏羽 已提交
152 153 154
|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序|
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
|x|x|√|√|√|√|√|√|x|
Q
qiang 已提交
155 156 157 158 159 160

#### 参数

**function callback**

应用切后台事件的回调函数