tt.getLocation 收藏我的收藏
收藏我的收藏
基础库 1.0.0 开始支持本方法,这是一个异步方法。
获取设备当前的地理位置。
| 前提条件 | 该 API 需要用户授权方可调用,详细信息可参考用户授权。位置精度和调用耗时会因设备而异。 | 
| 业务背景 | 无 | 
| 使用限制 | 无 | 
| 注意事项 | 
 | 
| 相关教程 | 无 | 
语法
tt.getLocation(options)
参数说明
options 为 object 类型,属性如下:
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 | 
|---|---|---|---|---|---|
| type | string | "wgs84" | 否 | 指定坐标系类型,可以是 "wgs84" 或 "gcj02" | 1.0.0 | 
| success | function | 否 | 接口调用成功的回调函数 | 1.0.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 1.0.0 | |
| complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 1.0.0 | 
回调成功
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最低支持版本 | 
|---|---|---|---|
| errMsg | string | "getLocation:ok" | 1.0.0 | 
| altitude | number | 高度,单位 m | 1.0.0 | 
| accuracy | number | 位置的精确度,反应与真实位置之间的接近程度,可以理解成10即与真实位置相差10m,越小越精确 | 1.0.0 | 
| verticalAccuracy | number | 垂直精度,单位 m(Android 需要系统 8.0 及以上机型并且开启 GPS,否则返回 0) | 1.0.0 | 
| horizontalAccuracy | number | 水平精度,单位 m | 1.0.0 | 
| speed | number | 速度,单位 m/s | 1.0.0 | 
| city | string | 定位到的城市信息(因整体性能考虑,不开放返回 iOS 端的城市数据,可基于经纬度自行测算) | 1.0.0 | 
| latitude | string | 纬度,范围为-90 ~ 90,正数表示北,负数表示南 | 1.0.0 | 
| longitude | string | 经度,范围为-180 ~180,正数表示东,负数表示西 | 1.0.0 | 
回调失败
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最低支持版本 | 
|---|---|---|---|
| errMsg | string | "getLocation:fail" + 详细错误信息 | 1.0.0 | 
错误码
| errNo | errMsg | 说明 | 最低支持版本 | 
|---|---|---|---|
| 21301 | locate fail, $errMsg | 小游戏框架内部错误,有需要请创建工单咨询 | 1.0.0 | 
| 10403 | internal error | 小游戏框架内部错误,有需要请创建工单咨询 | 1.0.0 | 
| 10401 | Internal error: locationManagerPlugin is nil | 小游戏框架内部错误,有需要请创建工单咨询 | 1.0.0 | 
| 10501 | app in background | 1.0.0 | |
| 10200 | system auth deny | 1.0.0 | |
| 21201 | Unable to access your location | 小游戏框架内部错误,有需要请创建工单咨询 | 1.0.0 | 
| 20000 | /s | 小游戏框架内部错误,有需要请创建工单咨询 | 1.0.0 | 
| 21301 | locate fail, invalid lat lng | 小游戏框架内部错误,有需要请创建工单咨询 | 1.0.0 | 
| 21301 | locate fail, user permission denied | 1.0.0 | 
扫码体验
请使用字节宿主APP扫码
代码示例
tt.getLocation({ success(res) { console.log(`经度${res.longitude},维度${res.latitude}`); }, fail(res) { console.log(`getLocation调用失败`); }, });
