upLocationModule 定位模块
模块概述
为H5页面提供获取当前位置功能,目前只支持国内定位。
方法列表
- getLocation(获取当前位置)
公共数据
所有数据均以JSON结构返回,由代码,信息和数据三部分组成
{
"retCode": "000000", //接口状态标识码,错误标识码以16开头
"retInfo": "操作成功",//接口信息说明
"retData": null //业务数据
}
具体定义:返回数据通用
模块变更记录
V3.0.0
删除getLocation接口返回参数中的altitude字段
V3.2.0
- 定位模块未定义的retCode编码按照通用数据规定变为990001,操作失败retCode变为000001,非法参数错误retCode变为000002
- 方法变更:
- getLocation(获取当前位置)正确返回数据中latitude,longitude变更为Number类型
方法说明
getLocation(获取当前位置)
getLocation()
适用性
容器 | cordova | APICloud | Nebula |
---|---|---|---|
支持情况 | 是 | 是 | 是 |
APP版本 | 6.5.0及以上 | 5.3.0及以上 | 6.12.0 及以上 |
params 输入参数
无
错误返回 retCode说明
retCode编码 | retInfo说明 |
---|---|
160001 | 获取定位权限失败 |
160002 | 手机定位未开启 |
正确返回 retData说明
属性名 | 数据类型 | 说明 |
---|---|---|
latitude | Number | 纬度 |
longitude | Number | 经度 |
country | String | 国家 |
province | String | 省/直辖市 |
city | String | 市 |
district | String | 区 |
citycode | String | 城市编码 |
adcode | String | 区域编码 |
street | String | 街道名称 |
number | String | 门牌号 |
POIName | String | 兴趣点名称 |
AOIName | String | 所属兴趣点名称 |
provider | String | 来源 |
示例
upLocationModule.getLocation().then((result) => {
console.log('result',result);
},(err)=>{
console.log('err',err);
})
成功返回的retData
"retData": {
"latitude":34.234533,
"longitude":123.123123,
"country":"中国",
"province":"山东",
"city":"青岛",
"district":"李沧区",
"citycode":"0532",
"adcode":"0532",
"street":"海尔路",
"number":"52",
"POIName":"海尔信息产业园",
"AOIName":"海尔信息产业园",
"provider":"amap"
}
注意
如果当前终端网络异常,可能会导致定位失败,也可能会导致接口返回的位置信息的某些字段为空;所以调用接口前,建议先判断一下当前网络状态。