proximity
- : 获取当前设备的接近距离信息
- watchProximity: 监听设备接近距离的变化
- : 关闭监听设备接近距离变化
回调方法:
- ProximitySuccessCallback: 获取设备接近距离信息成功的回调函数
- : 获取设备接近距离信息失败的回调函数
权限:
5+功能模块(permissions)
getCurrentProximity
获取当前设备的接近距离信息
说明:
获取当前接近设备的距离信息,距离值单位为厘米。如果感应器无法获取准确的距离值,则在接近设备时返回0,否则返回Infinity。 获取成功则调用successCB回调函数返接近回距离值。获取失败则调用errorCB回调函数错误信息。
参数:
- successCB: (ProximitySuccessCallback)必选 获取距离信息成功回调函数
- errorCB: ()可选 获取距离信息失败回调函数
返回值:
void: 无
- Android- 2.2+(支持): 支持
- iOS- 4.3+(支持): 支持
示例:
watchProximity
监听设备接近距离的变化
说明:
watchProximity将监听设备的接近距离信息变化事件,当接近距离发生变化时通过changeCB回调函数返回距离值。监听距离变化事件失败则通过errorCB回调函数返回错误信息。
参数:
- changeCB: (ProximitySuccessCallback)必选 设备接近距离变化时的回调函数
- errorCB: ()可选 监听设备接近距离变化事件失败的回调函数
返回值:
Number: 用于标识接近距离变化事件监听器,可通过clearWatch方法取消监听。
平台支持:
- Android- 2.2+(支持): 支持
- iOS- 4.3+(支持): 支持
clearWatch
参数:
- watchId: (Number)必选 需要取消的距离监听器标识,调用watchProximity方法的返回值。
返回值:
void: 无
平台支持:
- Android- 2.2+(支持): 支持
- iOS- 4.3+(支持): 支持
ProximitySuccessCallback
获取设备接近距离信息成功的回调函数
参数:
返回值:
void: 无
ProximityErrorCallback
获取设备接近距离信息失败的回调函数
void onError( error ) {
// Get distance error code.
}
- error: (DOMException)必选 失败信息