From 7a59aa6489a00c46ca021d3bf86b3a3a7523cc86 Mon Sep 17 00:00:00 2001 From: Anne_LXM Date: Mon, 19 Sep 2022 16:31:23 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0on=E3=80=81off=E4=B9=8B?= =?UTF-8?q?=E7=B1=BBapi?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/api/key.md | 192 ++++++++++++++++-------------- docs/api/system/accelerometer.md | 190 ++++++++++++++++------------- docs/api/system/capture-screen.md | 82 ++++++------- docs/api/system/compass.md | 164 ++++++++++++------------- docs/api/system/memory.md | 117 +++++++++--------- 5 files changed, 399 insertions(+), 346 deletions(-) diff --git a/docs/api/key.md b/docs/api/key.md index 39d1ef088..fd7932d10 100644 --- a/docs/api/key.md +++ b/docs/api/key.md @@ -1,87 +1,105 @@ -### uni.hideKeyboard() - -隐藏软键盘 - -隐藏已经显示的软键盘，如果软键盘没有显示则不做任何操作。 - -**平台差异说明** - -|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| -|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|√|x|√|√|√|√| - - -### uni.onKeyboardHeightChange(CALLBACK) @onkeyboardheightchange - -监听键盘高度变化 - -**平台差异说明** - -|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| -|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| -|HBuilderX 2.2.3+|x|基础库2.7+|x|x|x|√|√|√| - -**CALLBACK 返回参数** - -|参数|类型|说明| -|:-|:-|:-| -|height|Number|键盘高度| - -**示例代码** - -```js -uni.onKeyboardHeightChange(res => { - console.log(res.height) -}) -``` - -### uni.offKeyboardHeightChange(CALLBACK) @offkeyboardheightchange - -取消监听键盘高度变化事件 - -**平台差异说明** - -|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| -|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| -|HBuilderX 3.1.0+|x|基础库2.9.2+|x|x|x|x|x|√| - -**示例代码** - -```js -uni.offKeyboardHeightChange(callback) -``` - -### uni.getSelectedTextRange(OBJECT) @getselectedtextrange - -在input、textarea等focus之后，获取输入框的光标位置。注意：只有在focus的时候调用此接口才有效。目前仅支持 vue 页面，nvue 可以直接使用 weex 的 [getSelectionRange](https://weex.apache.org/zh/docs/components/input.html#getSelectionRange)。 - -**平台差异说明** - -|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| -|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| -|HBuilderX 2.8.12+|HBuilderX 2.8.12+|基础库 2.7.0+|x|x|x|x|√|x| - -**OBJECT 参数说明：** - -| 参数名 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | --- | --- | --- | -| success | Function | | 否 | 接口调用成功的回调函数 | -| fail | Function | | 否 | 接口调用失败的回调函数 | -| complete | Function | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -**success 返回参数说明：** - -| 属性 | 类型 | 说明 | -| --- | --- | --- | -| start | Number | 输入框光标起始位置 | -| end | Number | 输入框光标结束位置 | - -**示例代码** - -```js -uni.getSelectedTextRange({ - success: res => { - console.log('getSelectedTextRange res', res.start, res.end) - } -}) -``` +### uni.hideKeyboard() + +隐藏软键盘 + +隐藏已经显示的软键盘，如果软键盘没有显示则不做任何操作。 + +**平台差异说明** + +|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|√|√|√|x|√|√|√|√| + + +### uni.onKeyboardHeightChange(CALLBACK) @onkeyboardheightchange + +监听键盘高度变化 + +**平台差异说明** + +|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|HBuilderX 2.2.3+|x|基础库2.7+|x|x|x|√|√|√| + +**参数** + +function listener + +键盘高度变化事件的监听函数 + +**参数** + +Object res + +|参数|类型|说明| +|:-|:-|:-| +|height|Number|键盘高度| + +**示例代码** + +```js +uni.onKeyboardHeightChange(res => { + console.log(res.height) +}) +``` + +### uni.offKeyboardHeightChange(CALLBACK) @offkeyboardheightchange + +取消监听键盘高度变化事件 + +**平台差异说明** + +|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|HBuilderX 3.1.0+|x|基础库2.9.2+|x|x|x|x|x|√| + +**参数** + +function listener + +onKeyboardHeightChange 传入的监听函数。不传此参数则移除所有监听函数。 + + +**示例代码** + +```js +const listener = function (res) { console.log(res) } + +uni.onKeyboardHeightChange(listener) +uni.offKeyboardHeightChange(listener) // 需传入与监听时同一个的函数对象 +``` + +### uni.getSelectedTextRange(OBJECT) @getselectedtextrange + +在input、textarea等focus之后，获取输入框的光标位置。注意：只有在focus的时候调用此接口才有效。目前仅支持 vue 页面，nvue 可以直接使用 weex 的 [getSelectionRange](https://weex.apache.org/zh/docs/components/input.html#getSelectionRange)。 + +**平台差异说明** + +|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|HBuilderX 2.8.12+|HBuilderX 2.8.12+|基础库 2.7.0+|x|x|x|x|√|x| + +**OBJECT 参数说明：** + +| 参数名 | 类型 | 默认值 | 必填 | 说明 | +| --- | --- | --- | --- | --- | +| success | Function | | 否 | 接口调用成功的回调函数 | +| fail | Function | | 否 | 接口调用失败的回调函数 | +| complete | Function | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | + +**success 返回参数说明：** + +| 属性 | 类型 | 说明 | +| --- | --- | --- | +| start | Number | 输入框光标起始位置 | +| end | Number | 输入框光标结束位置 | + +**示例代码** + +```js +uni.getSelectedTextRange({ + success: res => { + console.log('getSelectedTextRange res', res.start, res.end) + } +}) +``` diff --git a/docs/api/system/accelerometer.md b/docs/api/system/accelerometer.md index e4e356adf..83725dc4c 100644 --- a/docs/api/system/accelerometer.md +++ b/docs/api/system/accelerometer.md @@ -1,83 +1,107 @@ -### uni.onAccelerometerChange(CALLBACK) -监听加速度数据，频率：5次/秒，接口调用后会自动开始监听，可使用 ``uni.offAccelerometer`` 取消监听。 - -**CALLBACK 返回参数** - -|参数|类型|说明| -|:-|:-|:-| -|x|Number|X 轴| -|y|Number|Y 轴| -|z|Number|Z 轴| - -**Tips** - -- H5端获取加速度信息，需要部署在 **https** 服务上，本地预览（localhost）仍然可以使用 http 协议。 - -**示例** - -```javascript -uni.onAccelerometerChange(function (res) { - console.log(res.x); - console.log(res.y); - console.log(res.z); -}); -``` - -### uni.offAccelerometerChange(CALLBACK) -取消监听加速度数据。 - -**平台差异说明** - -|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| -|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| -|HBuilderX 2.9.6+|HBuilderX 2.9.6+|基础库 2.9.3+|x|x|x|x|√|√| - -### uni.startAccelerometer(OBJECT) -开始监听加速度数据。 - -**平台差异说明** - -|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| -|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|x|√|√|√|√|√| - -**OBJECT 参数说明** - -|参数名|类型|默认|必填|说明|平台差异说明| -|:-|:-|:-|:-|:-|:-| -|interval|String|normal|否|监听加速度数据回调函数的执行频率|微信小程序、百度小程序、QQ小程序、快手小程序、京东小程序| -|success|Function||否|接口调用成功的回调|| -|fail|Function||否|接口调用失败的回调函数|| -|complete|Function||否|接口调用结束的回调函数（调用成功、失败都会执行）| | - -`interval` 的合法值 - -|值|说明| -|:-|:-| -|game|适用于更新游戏的回调频率，在 20ms/次 左右| -|ui|适用于更新 UI 的回调频率，在 60ms/次 左右| -|normal|普通的回调频率，在 200ms/次 左右| - - -**示例** - -```javascript -uni.startAccelerometer(); -``` - -### uni.stopAccelerometer(OBJECT) -停止监听加速度数据。 - -**OBJECT 参数说明** - -|参数名|类型|必填|说明| -|:-|:-|:-|:-| -|success|Function|否|接口调用成功的回调| -|fail|Function|否|接口调用失败的回调函数| -|complete|Function|否|接口调用结束的回调函数（调用成功、失败都会执行）| - -**示例** - -```javascript -uni.stopAccelerometer(); -``` +### uni.onAccelerometerChange(CALLBACK) +监听加速度数据，频率：5次/秒，接口调用后会自动开始监听，可使用 ``uni.offAccelerometer`` 取消监听。 + +**参数** + +function listener + +加速度数据事件的监听函数 + +**参数** + +Object res + +|参数|类型|说明| +|:-|:-|:-| +|x|Number|X 轴| +|y|Number|Y 轴| +|z|Number|Z 轴| + +**Tips** + +- H5端获取加速度信息，需要部署在 **https** 服务上，本地预览（localhost）仍然可以使用 http 协议。 + +**示例** + +```javascript +uni.onAccelerometerChange(function (res) { + console.log(res.x); + console.log(res.y); + console.log(res.z); +}); +``` + +### uni.offAccelerometerChange(CALLBACK) +取消监听加速度数据。 + +**平台差异说明** + +|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|HBuilderX 2.9.6+|HBuilderX 2.9.6+|基础库 2.9.3+|x|x|x|x|√|√| + +**参数** + +function listener + +onAccelerometerChange 传入的监听函数。不传此参数则移除所有监听函数。 + +**示例** + +```javascript +const listener = function (res) { console.log(res) } + +uni.onAccelerometerChange(listener) +uni.offAccelerometerChange(listener) // 需传入与监听时同一个的函数对象 +``` + + +### uni.startAccelerometer(OBJECT) +开始监听加速度数据。 + +**平台差异说明** + +|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|√|√|x|√|√|√|√|√| + +**OBJECT 参数说明** + +|参数名|类型|默认|必填|说明|平台差异说明| +|:-|:-|:-|:-|:-|:-| +|interval|String|normal|否|监听加速度数据回调函数的执行频率|微信小程序、百度小程序、QQ小程序、快手小程序、京东小程序| +|success|Function||否|接口调用成功的回调|| +|fail|Function||否|接口调用失败的回调函数|| +|complete|Function||否|接口调用结束的回调函数（调用成功、失败都会执行）| | + +`interval` 的合法值 + +|值|说明| +|:-|:-| +|game|适用于更新游戏的回调频率，在 20ms/次 左右| +|ui|适用于更新 UI 的回调频率，在 60ms/次 左右| +|normal|普通的回调频率，在 200ms/次 左右| + + +**示例** + +```javascript +uni.startAccelerometer(); +``` + +### uni.stopAccelerometer(OBJECT) +停止监听加速度数据。 + +**OBJECT 参数说明** + +|参数名|类型|必填|说明| +|:-|:-|:-|:-| +|success|Function|否|接口调用成功的回调| +|fail|Function|否|接口调用失败的回调函数| +|complete|Function|否|接口调用结束的回调函数（调用成功、失败都会执行）| + +**示例** + +```javascript +uni.stopAccelerometer(); +``` diff --git a/docs/api/system/capture-screen.md b/docs/api/system/capture-screen.md index c613d98ec..351e9976b 100644 --- a/docs/api/system/capture-screen.md +++ b/docs/api/system/capture-screen.md @@ -1,41 +1,41 @@ -### uni.onUserCaptureScreen(CALLBACK) - -监听用户主动截屏事件，用户使用系统截屏按键截屏时触发此事件。 - -**平台差异说明** - -|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| -|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| -|x|x|√|√|√|√|√|√|√| - -注：App没有内置截屏相关功能，可以在插件市场搜索相关插件，[详见](https://ext.dcloud.net.cn/search?q=%E6%88%AA%E5%B1%8F) - -**CALLBACK返回参数：** - -无 - -**代码示例** - -```javascript -uni.onUserCaptureScreen(function() { - console.log('用户截屏了') -}); -``` - -### uni.offUserCaptureScreen(function callback) - -用户主动截屏事件。取消事件监听。 - - -**平台差异说明** - -|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| -|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| -|x|x|√|√|√|√|x|√|√| - - -**参数** - -|属性 | 类型|说明| -|-- |-- |-- | -|回调函数| Function|用户主动截屏事件的回调函数| \ No newline at end of file +### uni.onUserCaptureScreen(CALLBACK) + +监听用户主动截屏事件，用户使用系统截屏按键截屏时触发此事件。 + +**平台差异说明** + +|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|x|x|√|√|√|√|√|√|√| + +注：App没有内置截屏相关功能，可以在插件市场搜索相关插件，[详见](https://ext.dcloud.net.cn/search?q=%E6%88%AA%E5%B1%8F) + +**CALLBACK返回参数：** + +无 + +**代码示例** + +```javascript +uni.onUserCaptureScreen(function() { + console.log('用户截屏了') +}); +``` + +### uni.offUserCaptureScreen(function callback) + +用户主动截屏事件。取消事件监听。 + + +**平台差异说明** + +|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|x|x|√|√|√|√|x|√|√| + + +**参数** + +|属性 | 类型|说明| +|-- |-- |-- | +|回调函数| Function|用户主动截屏事件的回调函数| diff --git a/docs/api/system/compass.md b/docs/api/system/compass.md index 5663e9cea..61ba99e28 100644 --- a/docs/api/system/compass.md +++ b/docs/api/system/compass.md @@ -1,82 +1,82 @@ -### uni.onCompassChange(CALLBACK) -监听罗盘数据，频率：5次/秒，接口调用后会自动开始监听，可使用 ``uni.offCompassChange`` 取消监听。 - -**CALLBACK 返回参数** - -|参数|类型|说明| -|:-|:-|:-| -|direction|Number|面对的方向度数| - -**Tips** -- H5端获取罗盘信息，需要部署在 **https** 服务上，本地预览（localhost）仍然可以使用 http 协议。 - -**示例** - -```javascript -const callback = function (res) { - console.log(res.direction); -} -uni.onCompassChange(callback); -``` - -### uni.offCompassChange(CALLBACK) -取消监听罗盘数据。 - -**平台差异说明** - -|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| -|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| -|HBuilderX 2.9.6+|HBuilderX 2.9.6+|基础库 2.9.3+|x|x|x|x|√|x| - -**示例** -```javascript -const callback = function (res) { - console.log(res.direction); -} -uni.onCompassChange(callback); -// 和 onCompassChange 传入同一个函数即可 -uni.offCompassChange(callback); -``` - -**Tips** -- `CALLBACK`为调用`uni.onCompassChange`时传入的`CALLBACK` - -### uni.startCompass(OBJECT) -开始监听罗盘数据。 - -**平台差异说明** - -|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| -|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|x|√|√|√|√|x| - -**OBJECT 参数说明** - -|参数名|类型|必填|说明| -|:-|:-|:-|:-| -|success|Function|否|接口调用成功的回调| -|fail|Function|否|接口调用失败的回调函数| -|complete|Function|否|接口调用结束的回调函数（调用成功、失败都会执行）| - -**示例** - -```javascript -uni.startCompass(); -``` - -### uni.stopCompass(OBJECT) -停止监听罗盘数据。 - -**OBJECT 参数说明** - -|参数名|类型|必填|说明| -|:-|:-|:-|:-| -|success|Function|否|接口调用成功的回调| -|fail|Function|否|接口调用失败的回调函数| -|complete|Function|否|接口调用结束的回调函数（调用成功、失败都会执行）| - -**示例** - -```javascript -uni.stopCompass(); -``` +### uni.onCompassChange(CALLBACK) +监听罗盘数据，频率：5次/秒，接口调用后会自动开始监听，可使用 ``uni.offCompassChange`` 取消监听。 + +**CALLBACK 返回参数** + +|参数|类型|说明| +|:-|:-|:-| +|direction|Number|面对的方向度数| + +**Tips** +- H5端获取罗盘信息，需要部署在 **https** 服务上，本地预览（localhost）仍然可以使用 http 协议。 + +**示例** + +```javascript +const callback = function (res) { + console.log(res.direction); +} +uni.onCompassChange(callback); +``` + +### uni.offCompassChange(CALLBACK) +取消监听罗盘数据。 + +**平台差异说明** + +|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|HBuilderX 2.9.6+|HBuilderX 2.9.6+|基础库 2.9.3+|x|x|x|x|√|x| + +**示例** +```javascript +const callback = function (res) { + console.log(res.direction); +} +uni.onCompassChange(callback); +// 和 onCompassChange 传入同一个函数即可 +uni.offCompassChange(callback); +``` + +**Tips** +- `CALLBACK`为调用`uni.onCompassChange`时传入的`CALLBACK` + +### uni.startCompass(OBJECT) +开始监听罗盘数据。 + +**平台差异说明** + +|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|√|√|x|√|√|√|√|x| + +**OBJECT 参数说明** + +|参数名|类型|必填|说明| +|:-|:-|:-|:-| +|success|Function|否|接口调用成功的回调| +|fail|Function|否|接口调用失败的回调函数| +|complete|Function|否|接口调用结束的回调函数（调用成功、失败都会执行）| + +**示例** + +```javascript +uni.startCompass(); +``` + +### uni.stopCompass(OBJECT) +停止监听罗盘数据。 + +**OBJECT 参数说明** + +|参数名|类型|必填|说明| +|:-|:-|:-|:-| +|success|Function|否|接口调用成功的回调| +|fail|Function|否|接口调用失败的回调函数| +|complete|Function|否|接口调用结束的回调函数（调用成功、失败都会执行）| + +**示例** + +```javascript +uni.stopCompass(); +``` diff --git a/docs/api/system/memory.md b/docs/api/system/memory.md index e91e3abe7..5ba2fec5f 100644 --- a/docs/api/system/memory.md +++ b/docs/api/system/memory.md @@ -1,53 +1,64 @@ -### uni.onMemoryWarning(CALLBACK) - -监听内存不足告警事件。 - -当 iOS/Android 向小程序进程发出内存警告时，触发该事件。Android 下有告警等级划分，iOS 无等级划分。 - -**平台差异说明** - -|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| -|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| -|x|x|√|√|√|x|√|√|√| - -**CALLBACK返回参数：** - -|参数名|类型|说明| -|---|---|---| -|level|Number|仅 Android 有该字段，对应系统内存告警等级宏定义| - -**level 的合法值** - -|值|说明| -|---|---| -|5|TRIM_MEMORY_RUNNING_MODERATE| -|10|TRIM_MEMORY_RUNNING_LOW| -|15|TRIM_MEMORY_RUNNING_CRITICAL| - -**代码示例** - -```javascript -uni.onMemoryWarning(function () { - console.log('onMemoryWarningReceive') -}) -``` - -### uni.offMemoryWarning(CALLBACK) - -取消监听内存不足告警事件。不传入 callback 则取消所有监听。 - - -**平台差异说明** - -|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| -|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| -|x|x|√|√|√|x|x|√|√| - - -**参数** - -|属性 | 类型|说明| -|-- |-- |-- | -| 回调函数| Function|内存不足告警事件的回调函数| - - +### uni.onMemoryWarning(CALLBACK) + +监听内存不足告警事件。 + +当 iOS/Android 向小程序进程发出内存警告时，触发该事件。Android 下有告警等级划分，iOS 无等级划分。 + +**平台差异说明** + +|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|x|x|√|√|√|x|√|√|√| + +**CALLBACK返回参数：** + +|参数名|类型|说明| +|---|---|---| +|level|Number|仅 Android 有该字段，对应系统内存告警等级宏定义| + +**level 的合法值** + +|值|说明| +|---|---| +|5|TRIM_MEMORY_RUNNING_MODERATE| +|10|TRIM_MEMORY_RUNNING_LOW| +|15|TRIM_MEMORY_RUNNING_CRITICAL| + +**代码示例** + +```javascript +const callback = function (res) { + console.log(res,'onMemoryWarningReceive'); +} +uni.onMemoryWarning(callback); +``` + +### uni.offMemoryWarning(CALLBACK) + +取消监听内存不足告警事件。不传入 callback 则取消所有监听。 + + +**平台差异说明** + +|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|x|x|√|√|√|x|x|√|√| + + +|属性 | 类型|说明| +|-- |-- |-- | +| 回调函数| Function|内存不足告警事件的回调函数| + +**代码示例** + +```javascript +const callback = function (res) { + console.log(res); +} +uni.onMemoryWarning(callback); +// 和 onMemoryWarning 传入同一个函数即可 +uni.offMemoryWarning(callback); +``` +**Tips** +- `CALLBACK`为调用`uni.onMemoryWarning`时传入的`CALLBACK` + -- GitLab