地理位置
接口声明
{ "name": "system.geolocation" }
导入模块
import geolocation from '@system.geolocation' 或 const geolocation = require('@system.geolocation')
接口定义
geolocation.getLocation(OBJECT)
获取地理位置
权限要求
精确设备定位
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
timeout | Long | 否 | 设置超时时间,单位是 ms,默认值为 30000。在权限被系统拒绝或者定位设置不当的情况下,有可能永远不能返回结果,因而需要设置超时。超时后会使用 fail 回调 |
coorType 1050+ | String | 否 | 坐标系类型,可选值可通过 getSupportedCoordTypes 获取,默认为wgs84 |
success | Function | 是 | 成功回调 |
fail | Function | 否 | 失败回调,原因可能是用户拒绝 |
complete | Function | 否 | 执行结束后的回调 |
success 返回值:
参数名 | 类型 | 说明 |
---|---|---|
longitude | Number | 经度 |
latitude | Number | 纬度 |
accuracy 1040+ | Number | 精确度 |
time 1040+ | Number | 时间 |
fail 返回错误代码
错误码 | 说明 |
---|---|
201 | 用户拒绝,获取定位权限失败 |
204 | 超时返回 |
1000 1000+ | 系统位置开关关闭 |
示例:
geolocation.getLocation({
success: function(data) {
console.log(
`handling success: longitude = ${data.longitude}, latitude = ${
data.latitude
}`
)
},
fail: function(data, code) {
console.log(`handling fail, code = ${code}`)
}
})
geolocation.getLocationType(OBJECT) 1010+
获取系统当前支持的定位类型
权限要求
精确设备定位
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
success | Function | 是 | 成功回调 |
fail | Function | 否 | 失败回调 |
complete | Function | 否 | 执行结束后的回调 |
success 返回值:
参数名 | 类型 | 说明 |
---|---|---|
types | Array | 支持的类型['gps','network'] |
示例:
geolocation.getLocationType({
success: function(data) {
console.log(`handling success: locationType = ${data.types}`)
},
fail: function(data, code) {
console.log(`handling fail, code = ${code}`)
}
})
geolocation.subscribe(OBJECT)
监听地理位置。如果多次调用,仅最后一次调用生效
权限要求
精确设备定位
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
reserved 1050+ | Boolean | 否 | 是否持久化订阅,默认为false。机制:设置为true,页面跳转,不会自动取消订阅,需手动取消订阅 |
coorType 1050+ | String | 否 | 坐标系类型,可选值可通过 getSupportedCoordTypes 获取,默认为wgs84 |
callback | Function | 是 | 每次位置信息发生变化,都会被回调 |
fail | Function | 否 | 失败回调,原因可能是用户拒绝 |
callback 返回值:
参数名 | 类型 | 说明 |
---|---|---|
longitude | Number | 经度 |
latitude | Number | 纬度 |
accuracy 1040+ | Number | 精确度 |
time 1040+ | Number | 时间 |
fail 返回错误代码
错误码 | 说明 |
---|---|
201 | 用户拒绝,获取定位权限失败 |
1000 1000+ | 系统位置开关关闭 |
示例:
geolocation.subscribe({
callback: function(data) {
console.log(
`handling success: longitude = ${data.longitude}, latitude = ${
data.latitude
}`
)
},
fail: function(data, code) {
console.log(`handling fail, code = ${code}`)
}
})
geolocation.unsubscribe()
取消监听地理位置
参数:
无
示例:
geolocation.unsubscribe()
geolocation.getSupportedCoordTypes() 1050+
获取支持的坐标系类型
参数:
无
返回值:
字符串数组。当前支持的坐标系类型,如['wgs84']
示例:
var types = geolocation.getSupportedCoordTypes()
后台运行限制
manifest 中申请后可用。后台运行详细用法参见后台运行 脚本。