# proximity

Proximity模块管理设备距离传感器，可获取当前设备的接近距离信息，通过plus.proximity可获取设备距离传感管理对象。

## 方法：

- getCurrentProximity: 获取当前设备的接近距离信息
- watchProximity: 监听设备接近距离的变化
- clearWatch: 关闭监听设备接近距离变化

## 回调方法：

- ProximitySuccessCallback: 获取设备接近距离信息成功的回调函数
- ProximityErrorCallback: 获取设备接近距离信息失败的回调函数

## 权限：

5+功能模块（permissions）

    {
    // ...
    "permissions":{
    	// ...
    	"Proximity": {
    		"description": "距离感应器"
    	}
    }
    }

# ProximitySuccessCallback

获取设备接近距离信息成功的回调函数

    void onSuccess( distance ) {
    	// Get distance success code.
    }

## 参数：

- distance: ( Number ) 必选 设备接近距离
  设备接近距离传感器获取的距离值，单位为厘米。如果感应器无法获取准确的距离值，则在接近设备时返回0，否则返回Infinity。

## 返回值：

void : 无

# ProximityErrorCallback

获取设备接近距离信息失败的回调函数

    void onError( error ) {
    	// Get distance error code.
    }

## 参数：

- error: ( DOMException ) 必选 失败信息

## 返回值：

void : 无