Appearance
获取当前位置信息 - getLocationInfo
简介
- 此API是一个异步任务,需使用async await / promise结构 获取回调值
- 该API用于获取当前用户所在的位置信息,包括但不限于省份、城市、区级行政区、经纬度等信息
环境适配说明
| 环境名称 | 是否支持 | jssdk文件最低版本号 | npm包最低版本号 |
|---|---|---|---|
| 湘易办APP-小程序 | ✅ | 1.1.4 | 0.0.4 |
| 湘易办APP-小程序-webview | ✅ | 1.1.8 | 0.0.4 |
| 湘易办APP-webview | ✅ | 2.0.0 | 0.0.4 |
| 三方H5 | ❌ | -- | -- |
| 三方小程序-H5 | ✅ | -- | 0.0.24 |
参数
无
返回值
仅列出返回体内的子参数,整体是一个
Object对象
| 参数名 | 子参数名 | 类型 | 描述 |
|---|---|---|---|
| location | Object | 定位信息 | |
| address | String | 详细位置信息 | |
| district | String | 区级名称 | |
| city | String | 市级名称 | |
| province | String | 省级名称 | |
| country | String | 国家名称 | |
| adCode | String | 邮政编码 | |
| cityCode | String | 城市编码 | |
| latitude | Float | 纬度信息 | |
| longitude | Float | 经度信息 | |
| isSuccess | Boolean | 获取定位信息成功(true成功 false 失败) |
示例
javascript
const res = await this.$xybAgent.getLocationInfo();
if (res?.isSuccess) {
// 执行业务代码
}javascript
this.$xybAgent.getLocationInfo().then(res => {
if (res?.isSuccess) {
// 执行业务代码
}
})