位置服务


位置服务

位置服务提供GNSS定位、网络定位、地理编码、逆地理编码、国家码和地理围栏等基本功能。

说明: 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 从API Version 9开始,该接口不再维护,推荐使用新接口geoLocationManager

申请权限

应用在使用系统能力前,需要检查是否已经获取用户授权访问设备位置信息。如未获得授权,可以向用户申请需要的位置权限,申请方式请参考下文。

系统提供的定位权限有:

  • ohos.permission.LOCATION

  • ohos.permission.APPROXIMATELY_LOCATION

  • ohos.permission.LOCATION_IN_BACKGROUND

访问设备的位置信息,必须申请权限,并且获得用户授权。

API9之前的版本,申请ohos.permission.LOCATION即可。

API9及之后的版本,需要申请ohos.permission.APPROXIMATELY_LOCATION或者同时申请ohos.permission.APPROXIMATELY_LOCATION和ohos.permission.LOCATION;无法单独申请ohos.permission.LOCATION。

使用的API版本 申请位置权限 申请结果 位置的精确度
小于9 ohos.permission.LOCATION 成功 获取到精准位置,精准度在米级别。
大于等于9 ohos.permission.LOCATION 失败 无法获取位置。
大于等于9 ohos.permission.APPROXIMATELY_LOCATION 成功 获取到模糊位置,精确度为5公里。
大于等于9 ohos.permission.APPROXIMATELY_LOCATION和ohos.permission.LOCATION 成功 获取到精准位置,精准度在米级别。

如果应用在后台运行时也需要访问设备位置,除需要将应用声明为允许后台运行外,还必须申请ohos.permission.LOCATION_IN_BACKGROUND权限,这样应用在切入后台之后,系统可以继续上报位置信息。

开发者可以在应用配置文件中声明所需要的权限,具体可参考授权申请指导

导入模块

import geolocation from '@ohos.geolocation';
1

geolocation.on('locationChange')(deprecated)

on(type: 'locationChange', request: LocationRequest, callback: Callback<Location>): void

开启位置变化订阅,并发起定位请求。定位结果按照LocationRequest的属性进行上报,

说明:
从API version 9开始废弃,建议使用geoLocationManager.on('locationChange')替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Core

参数:

参数名 类型 必填 说明
type string 设置事件类型。type为“locationChange”,表示位置变化。
request LocationRequest 设置位置请求参数。
callback Callback<Location> 接收位置变化状态变化监听。

示例

import geolocation from '@ohos.geolocation';
var requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
var locationChange = (location) => {
    console.log('locationChanger: data: ' + JSON.stringify(location));
};
geolocation.on('locationChange', requestInfo, locationChange);
1
2
3
4
5
6

geolocation.off('locationChange')(deprecated)

off(type: 'locationChange', callback?: Callback<Location>): void

关闭位置变化订阅,并删除对应的定位请求。

说明:
从API version 9开始废弃,建议使用geoLocationManager.off('locationChange')替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Core

参数:

参数名 类型 必填 说明
type string 设置事件类型。type为“locationChange”,表示位置变化。
callback Callback<Location> 需要取消订阅的回调函数。若无此参数,则取消当前类型的所有订阅。

示例

import geolocation from '@ohos.geolocation';
var requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
var locationChange = (location) => {
    console.log('locationChanger: data: ' + JSON.stringify(location));
};
geolocation.on('locationChange', requestInfo, locationChange);
geolocation.off('locationChange', locationChange);
1
2
3
4
5
6
7

geolocation.on('locationServiceState')(deprecated)

on(type: 'locationServiceState', callback: Callback<boolean>): void

订阅位置服务状态变化。

说明:
从API version 9开始废弃,建议使用geoLocationManager.on('locationEnabledChange')替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Core

参数:

参数名 类型 必填 说明
type string 设置事件类型。type为“locationServiceState”,表示位置服务状态。
callback Callback<boolean> 接收位置服务状态变化监听。

示例

import geolocation from '@ohos.geolocation';
var locationServiceState = (state) => {
    console.log('locationServiceState: ' + JSON.stringify(state));
}
geolocation.on('locationServiceState', locationServiceState);
1
2
3
4
5

geolocation.off('locationServiceState')(deprecated)

off(type: 'locationServiceState', callback?: Callback<boolean>): void;

取消订阅位置服务状态变化。

说明:
从API version 9开始废弃,建议使用geoLocationManager.off('locationEnabledChange')替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Core

参数

参数名 类型 必填 说明
type string 设置事件类型。type为“locationServiceState”,表示位置服务状态。
callback Callback<boolean> 需要取消订阅的回调函数。若无此参数,则取消当前类型的所有订阅。

示例

import geolocation from '@ohos.geolocation';
var locationServiceState = (state) => {
    console.log('locationServiceState: state: ' + JSON.stringify(state));
}
geolocation.on('locationServiceState', locationServiceState);
geolocation.off('locationServiceState', locationServiceState);
1
2
3
4
5
6

geolocation.on('cachedGnssLocationsReporting')(deprecated)

on(type: 'cachedGnssLocationsReporting', request: CachedGnssLocationsRequest, callback: Callback<Array<Location>>): void;

订阅缓存GNSS定位结果上报事件。

说明:
从API version 8开始支持。 从API version 9开始废弃,建议使用geoLocationManager.on('cachedGnssLocationsChange')替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Gnss

参数

参数名 类型 必填 说明
type string 设置事件类型。type为“cachedGnssLocationsReporting”,表示GNSS缓存定位结果上报。
request CachedGnssLocationsRequest GNSS缓存功能配置参数
callback Callback<Array<Location>> 接收GNSS缓存位置上报。

示例

import geolocation from '@ohos.geolocation';
var cachedLocationsCb = (locations) => {
    console.log('cachedGnssLocationsReporting: locations: ' + JSON.stringify(locations));
}
var requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true};
geolocation.on('cachedGnssLocationsReporting', requestInfo, cachedLocationsCb);
1
2
3
4
5
6

geolocation.off('cachedGnssLocationsReporting')(deprecated)

off(type: 'cachedGnssLocationsReporting', callback?: Callback<Array<Location>>): void;

取消订阅缓存GNSS定位结果上报事件。

说明:
从API version 8开始支持。 从API version 9开始废弃,建议使用geoLocationManager.off('cachedGnssLocationsChange')替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Gnss

参数

参数名 类型 必填 说明
type string 设置事件类型。type为“cachedGnssLocationsReporting”,表示GNSS缓存定位结果上报。
callback Callback<Array<Location>> 需要取消订阅的回调函数。若无此参数,则取消当前类型的所有订阅。

示例

import geolocation from '@ohos.geolocation';
var cachedLocationsCb = (locations) => {
    console.log('cachedGnssLocationsReporting: locations: ' + JSON.stringify(locations));
}
var requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true};
geolocation.on('cachedGnssLocationsReporting', requestInfo, cachedLocationsCb);
geolocation.off('cachedGnssLocationsReporting');
1
2
3
4
5
6
7

geolocation.on('gnssStatusChange')(deprecated)

on(type: 'gnssStatusChange', callback: Callback<SatelliteStatusInfo>): void;

订阅GNSS卫星状态信息上报事件。

说明:
从API version 8开始支持。 从API version 9开始废弃,建议使用geoLocationManager.on('satelliteStatusChange')替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Gnss

参数

参数名 类型 必填 说明
type string 设置事件类型。type为“gnssStatusChange”,表示订阅GNSS卫星状态信息上报。
callback Callback<SatelliteStatusInfo> 接收GNSS卫星状态信息上报。

示例

import geolocation from '@ohos.geolocation';
var gnssStatusCb = (satelliteStatusInfo) => {
    console.log('gnssStatusChange: ' + JSON.stringify(satelliteStatusInfo));
}
geolocation.on('gnssStatusChange', gnssStatusCb);
1
2
3
4
5

geolocation.off('gnssStatusChange')(deprecated)

off(type: 'gnssStatusChange', callback?: Callback<SatelliteStatusInfo>): void;

取消订阅GNSS卫星状态信息上报事件。

说明:
从API version 8开始支持。 从API version 9开始废弃,建议使用geoLocationManager.off('satelliteStatusChange')替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Gnss

参数

参数名 类型 必填 说明
type string 设置事件类型。type为“gnssStatusChange”,表示订阅GNSS卫星状态信息上报。
callback Callback<SatelliteStatusInfo> 需要取消订阅的回调函数。若无此参数,则取消当前类型的所有订阅。

示例

import geolocation from '@ohos.geolocation';
var gnssStatusCb = (satelliteStatusInfo) => {
    console.log('gnssStatusChange: ' + JSON.stringify(satelliteStatusInfo));
}
geolocation.on('gnssStatusChange', gnssStatusCb);
geolocation.off('gnssStatusChange', gnssStatusCb);
1
2
3
4
5
6

geolocation.on('nmeaMessageChange')(deprecated)

on(type: 'nmeaMessageChange', callback: Callback<string>): void;

订阅GNSS NMEA信息上报事件。

说明:
从API version 8开始支持。 从API version 9开始废弃,建议使用geoLocationManager.on('nmeaMessage')替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Gnss

参数

参数名 类型 必填 说明
type string 设置事件类型。type为“nmeaMessageChange”,表示订阅GNSS NMEA信息上报。
callback Callback<string> 接收GNSS NMEA信息上报。

示例

import geolocation from '@ohos.geolocation';
var nmeaCb = (str) => {
    console.log('nmeaMessageChange: ' + JSON.stringify(str));
}
geolocation.on('nmeaMessageChange', nmeaCb );
1
2
3
4
5

geolocation.off('nmeaMessageChange')(deprecated)

off(type: 'nmeaMessageChange', callback?: Callback<string>): void;

取消订阅GNSS NMEA信息上报事件。

说明:
从API version 8开始支持。 从API version 9开始废弃,建议使用geoLocationManager.off('nmeaMessage')替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Gnss

参数

参数名 类型 必填 说明
type string 设置事件类型。type为“nmeaMessageChange”,表示订阅GNSS NMEA信息上报。
callback Callback<string> 需要取消订阅的回调函数。若无此参数,则取消当前类型的所有订阅。

示例

import geolocation from '@ohos.geolocation';
var nmeaCb = (str) => {
    console.log('nmeaMessageChange: ' + JSON.stringify(str));
}
geolocation.on('nmeaMessageChange', nmeaCb);
geolocation.off('nmeaMessageChange', nmeaCb);
1
2
3
4
5
6

geolocation.on('fenceStatusChange')(deprecated)

on(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void;

添加一个围栏,并订阅地理围栏事件。

说明:
从API version 8开始支持。 从API version 9开始废弃,建议使用geoLocationManager.on('gnssFenceStatusChange')替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Geofence

参数

参数名 类型 必填 说明
type string 设置事件类型。type为“fenceStatusChange”,表示订阅围栏事件上报。
request GeofenceRequest 围栏的配置参数。
want WantAgent 用于接收地理围栏事件上报(进出围栏)。

示例

import geolocation from '@ohos.geolocation';
import wantAgent from '@ohos.wantAgent';

let wantAgentInfo = {
    wants: [
        {
            bundleName: "com.example.myapplication",
            abilityName: "com.example.myapplication.MainAbility",
            action: "action1",
        }
    ],
    operationType: wantAgent.OperationType.START_ABILITY,
    requestCode: 0,
    wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG],
};

wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
  var requestInfo = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}};
  geolocation.on('fenceStatusChange', requestInfo, wantAgentObj);
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

geolocation.off('fenceStatusChange')(deprecated)

off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void;

删除一个围栏,并取消订阅该围栏事件。

说明:
从API version 8开始支持。 从API version 9开始废弃,建议使用geoLocationManager.off('gnssFenceStatusChange')替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Geofence

参数

参数名 类型 必填 说明
type string 设置事件类型。type为“fenceStatusChange”,表示订阅围栏事件上报。
request GeofenceRequest 围栏的配置参数。
want WantAgent 用于接收地理围栏事件上报(进出围栏)。

示例

import geolocation from '@ohos.geolocation';
import wantAgent from '@ohos.wantAgent';

let wantAgentInfo = {
    wants: [
        {
            bundleName: "com.example.myapplication",
            abilityName: "com.example.myapplication.MainAbility",
            action: "action1",
        }
    ],
    operationType: wantAgent.OperationType.START_ABILITY,
    requestCode: 0,
    wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
};

wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
  var requestInfo = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}};
  geolocation.on('fenceStatusChange', requestInfo, wantAgentObj);
  geolocation.off('fenceStatusChange', requestInfo, wantAgentObj);
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

geolocation.getCurrentLocation(deprecated)

getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback<Location>): void

获取当前位置,使用callback回调异步返回结果。

说明:
从API version 9开始废弃,建议使用geoLocationManager.getCurrentLocation替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Core

参数

参数名 类型 必填 说明
request CurrentLocationRequest 设置位置请求参数。
callback AsyncCallback<Location> 用来接收位置信息的回调。

示例

import geolocation from '@ohos.geolocation';
var requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0};
var locationChange = (err, location) => {
    if (err) {
        console.log('locationChanger: err=' + JSON.stringify(err));
    }
    if (location) {
        console.log('locationChanger: location=' + JSON.stringify(location));
    }
};
geolocation.getCurrentLocation(requestInfo, locationChange);
1
2
3
4
5
6
7
8
9
10
11

geolocation.getCurrentLocation(deprecated)

getCurrentLocation(callback: AsyncCallback<Location>): void

获取当前位置,使用callback回调异步返回结果。

说明:
从API version 9开始废弃,建议使用geoLocationManager.getCurrentLocation替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Core

参数

参数名 类型 必填 说明
callback AsyncCallback<Location> 用来接收位置信息的回调。

示例

import geolocation from '@ohos.geolocation';
var locationChange = (err, location) => {
    if (err) {
        console.log('locationChanger: err=' + JSON.stringify(err));
    }
    if (location) {
        console.log('locationChanger: location=' + JSON.stringify(location));
    }
};
geolocation.getCurrentLocation(locationChange);
1
2
3
4
5
6
7
8
9
10

geolocation.getCurrentLocation(deprecated)

getCurrentLocation(request?: CurrentLocationRequest): Promise<Location>

获取当前位置,使用Promise方式异步返回结果。

说明:
从API version 9开始废弃,建议使用geoLocationManager.getCurrentLocation替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Core

参数

参数名 类型 必填 说明
request CurrentLocationRequest 设置位置请求参数。

返回值

参数名 类型 必填 说明
Promise<Location> Location NA 返回位置信息。

示例

import geolocation from '@ohos.geolocation';
var requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0};
geolocation.getCurrentLocation(requestInfo).then((result) => {
    console.log('current location: ' + JSON.stringify(result));
});
1
2
3
4
5

geolocation.getLastLocation(deprecated)

getLastLocation(callback: AsyncCallback<Location>): void

获取上一次位置,使用callback回调异步返回结果。

说明:
从API version 9开始废弃,建议使用geoLocationManager.getLastLocation替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Core

参数

参数名 类型 必填 说明
callback AsyncCallback<Location> 用来接收上次位置的回调。

示例

import geolocation from '@ohos.geolocation';
geolocation.getLastLocation((err, data) => {
    if (err) {
        console.log('getLastLocation: err=' + JSON.stringify(err));
    }
    if (data) {
        console.log('getLastLocation: data=' + JSON.stringify(data));
    }
});
1
2
3
4
5
6
7
8
9

geolocation.getLastLocation(deprecated)

getLastLocation(): Promise<Location>

获取上一次位置,使用Promise方式异步返回结果。

说明:
从API version 9开始废弃,建议使用geoLocationManager.getLastLocation替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Core

返回值

参数名 类型 必填 说明
Promise<Location> Location NA 返回上次位置信息。

示例

import geolocation from '@ohos.geolocation';
geolocation.getLastLocation().then((result) => {
    console.log('getLastLocation: result: ' + JSON.stringify(result));
});
1
2
3
4

geolocation.isLocationEnabled(deprecated)

isLocationEnabled(callback: AsyncCallback<boolean>): void

判断位置服务是否已经打开,使用callback回调异步返回结果。

说明:
从API version 9开始废弃,建议使用geoLocationManager.isLocationEnabled替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Core

参数

参数名 类型 必填 说明
callback AsyncCallback<boolean> 用来接收位置服务状态的回调。

示例

import geolocation from '@ohos.geolocation';
geolocation.isLocationEnabled((err, data) => {
    if (err) {
        console.log('isLocationEnabled: err=' + JSON.stringify(err));
    }
    if (data) {
        console.log('isLocationEnabled: data=' + JSON.stringify(data));
    }
});
1
2
3
4
5
6
7
8
9

geolocation.isLocationEnabled(deprecated)

isLocationEnabled(): Promise<boolean>

判断位置服务是否已经开启,使用Promise方式异步返回结果。

说明:
从API version 9开始废弃,建议使用geoLocationManager.isLocationEnabled替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Core

返回值

参数名 类型 必填 说明
Promise<boolean> boolean NA 返回位置服务是否可用的状态。

示例

import geolocation from '@ohos.geolocation';
geolocation.isLocationEnabled().then((result) => {
    console.log('promise, isLocationEnabled: ' + JSON.stringify(result));
});
1
2
3
4

geolocation.requestEnableLocation(deprecated)

requestEnableLocation(callback: AsyncCallback<boolean>): void

请求打开位置服务,使用callback回调异步返回结果。

说明:
从API version 9开始废弃,建议使用geoLocationManager.requestEnableLocation替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Core

参数

参数名 类型 必填 说明
callback AsyncCallback<boolean> 用来接收位置服务状态的回调。

示例

import geolocation from '@ohos.geolocation';
geolocation.requestEnableLocation((err, data) => {
    if (err) {
        console.log('requestEnableLocation: err=' + JSON.stringify(err));
    }
    if (data) {
        console.log('requestEnableLocation: data=' + JSON.stringify(data));
    }
});
1
2
3
4
5
6
7
8
9

geolocation.requestEnableLocation(deprecated)

requestEnableLocation(): Promise<boolean>

请求打开位置服务,使用Promise方式异步返回结果。

说明:
从API version 9开始废弃,建议使用geoLocationManager.requestEnableLocation替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Core

返回值

参数名 类型 必填 说明
Promise<boolean> boolean NA 返回位置服务是否可用。

示例

import geolocation from '@ohos.geolocation';
geolocation.requestEnableLocation().then((result) => {
    console.log('promise, requestEnableLocation: ' + JSON.stringify(result));
});
1
2
3
4

geolocation.isGeoServiceAvailable(deprecated)

isGeoServiceAvailable(callback: AsyncCallback<boolean>): void

判断(逆)地理编码服务状态,使用callback回调异步返回结果。

说明:
从API version 9开始废弃,建议使用geoLocationManager.isGeocoderAvailable替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Geocoder

参数

参数名 类型 必填 说明
callback AsyncCallback<boolean> 用来接收地理编码服务状态的回调。

示例

import geolocation from '@ohos.geolocation';
geolocation.isGeoServiceAvailable((err, data) => {
    if (err) {
        console.log('isGeoServiceAvailable: err=' + JSON.stringify(err));
    }
    if (data) {
        console.log('isGeoServiceAvailable: data=' + JSON.stringify(data));
    }
});
1
2
3
4
5
6
7
8
9

geolocation.isGeoServiceAvailable(deprecated)

isGeoServiceAvailable(): Promise<boolean>

判断(逆)地理编码服务状态,使用Promise方式异步返回结果。

说明:
从API version 9开始废弃,建议使用geoLocationManager.isGeocoderAvailable替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Geocoder

返回值

参数名 类型 必填 说明
Promise<boolean> boolean NA 返回地理编码服务是否可用的状态。

示例

import geolocation from '@ohos.geolocation';
geolocation.isGeoServiceAvailable().then((result) => {
    console.log('promise, isGeoServiceAvailable: ' + JSON.stringify(result));
});
1
2
3
4

geolocation.getAddressesFromLocation(deprecated)

getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void

调用逆地理编码服务,将坐标转换为地理描述,使用callback回调异步返回结果。

说明:
从API version 9开始废弃,建议使用geoLocationManager.getAddressesFromLocation替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Geocoder

参数

参数名 类型 必填 说明
request ReverseGeoCodeRequest 设置逆地理编码请求的相关参数。
callback AsyncCallback<Array<GeoAddress>> 设置接收逆地理编码请求的回调参数。

示例

import geolocation from '@ohos.geolocation';
var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1};
geolocation.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => {
    if (err) {
        console.log('getAddressesFromLocation: err=' + JSON.stringify(err));
    }
    if (data) {
        console.log('getAddressesFromLocation: data=' + JSON.stringify(data));
    }
});
1
2
3
4
5
6
7
8
9
10

geolocation.getAddressesFromLocation(deprecated)

getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise<Array<GeoAddress>>;

调用逆地理编码服务,将坐标转换为地理描述,使用Promise方式异步返回结果。

说明:
从API version 9开始废弃,建议使用geoLocationManager.getAddressesFromLocation替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Geocoder

参数

参数名 类型 必填 说明
request ReverseGeoCodeRequest 设置逆地理编码请求的相关参数。

返回值

参数名 类型 必填 说明
Promise<Array<GeoAddress>> Array<GeoAddress> NA 返回地理描述信息。

示例

import geolocation from '@ohos.geolocation';
var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1};
geolocation.getAddressesFromLocation(reverseGeocodeRequest).then((data) => {
    console.log('getAddressesFromLocation: ' + JSON.stringify(data));
});
1
2
3
4
5

geolocation.getAddressesFromLocationName(deprecated)

getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void

调用地理编码服务,将地理描述转换为具体坐标,使用callback回调异步返回结果。

说明:
从API version 9开始废弃,建议使用geoLocationManager.getAddressesFromLocationName替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Geocoder

参数

参数名 类型 必填 说明
request GeoCodeRequest 设置地理编码请求的相关参数。
callback AsyncCallback<Array<GeoAddress>> 设置接收地理编码请求的回调参数。

示例

import geolocation from '@ohos.geolocation';
var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1};
geolocation.getAddressesFromLocationName(geocodeRequest, (err, data) => {
    if (err) {
        console.log('getAddressesFromLocationName: err=' + JSON.stringify(err));
    }
    if (data) {
        console.log('getAddressesFromLocationName: data=' + JSON.stringify(data));
    }
});
1
2
3
4
5
6
7
8
9
10

geolocation.getAddressesFromLocationName(deprecated)

getAddressesFromLocationName(request: GeoCodeRequest): Promise<Array<GeoAddress>>

调用地理编码服务,将地理描述转换为具体坐标,使用Promise方式异步返回结果。

说明:
从API version 9开始废弃,建议使用geoLocationManager.getAddressesFromLocationName替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Geocoder

参数

参数名 类型 必填 说明
request GeoCodeRequest 设置地理编码请求的相关参数。

返回值

参数名 类型 必填 说明
Promise<Array<GeoAddress>> Array<GeoAddress> NA 设置接收地理编码请求的回调参数。

示例

import geolocation from '@ohos.geolocation';
var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1};
geolocation.getAddressesFromLocationName(geocodeRequest).then((result) => {
    console.log('getAddressesFromLocationName: ' + JSON.stringify(result));
});
1
2
3
4
5

geolocation.getCachedGnssLocationsSize(deprecated)

getCachedGnssLocationsSize(callback: AsyncCallback<number>): void;

获取GNSS芯片缓存位置的个数。

说明:
从API version 8开始支持。 从API version 9开始废弃,建议使用geoLocationManager.getCachedGnssLocationsSize替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Gnss

参数

参数名 类型 必填 说明
callback AsyncCallback<number> 用来接收GNSS芯片缓存位置个数的回调。

示例

import geolocation from '@ohos.geolocation';
geolocation.getCachedGnssLocationsSize((err, size) => {
    if (err) {
        console.log('getCachedGnssLocationsSize: err=' + JSON.stringify(err));
    }
    if (size) {
        console.log('getCachedGnssLocationsSize: size=' + JSON.stringify(size));
    }
});
1
2
3
4
5
6
7
8
9

geolocation.getCachedGnssLocationsSize(deprecated)

getCachedGnssLocationsSize(): Promise<number>;

获取GNSS芯片缓存位置的个数。

说明:
从API version 8开始支持。 从API version 9开始废弃,建议使用geoLocationManager.getCachedGnssLocationsSize替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Gnss

返回值

参数名 类型 必填 说明
Promise<number> number NA 返回GNSS缓存位置的个数。

示例

import geolocation from '@ohos.geolocation';
geolocation.getCachedGnssLocationsSize().then((result) => {
    console.log('promise, getCachedGnssLocationsSize: ' + JSON.stringify(result));
});
1
2
3
4

geolocation.flushCachedGnssLocations(deprecated)

flushCachedGnssLocations(callback: AsyncCallback<boolean>): void;

读取并清空GNSS芯片所有缓存位置。

说明:
从API version 8开始支持。 从API version 9开始废弃,建议使用geoLocationManager.flushCachedGnssLocations替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Gnss

参数

参数名 类型 必填 说明
callback AsyncCallback<boolean> 用来接收清空GNSS芯片缓存位置操作的结果。

示例

import geolocation from '@ohos.geolocation';
geolocation.flushCachedGnssLocations((err, result) => {
    if (err) {
        console.log('flushCachedGnssLocations: err=' + JSON.stringify(err));
    }
    if (result) {
        console.log('flushCachedGnssLocations: result=' + JSON.stringify(result));
    }
});
1
2
3
4
5
6
7
8
9

geolocation.flushCachedGnssLocations(deprecated)

flushCachedGnssLocations(): Promise<boolean>;

读取并清空GNSS芯片所有缓存位置。

说明:
从API version 8开始支持。 从API version 9开始废弃,建议使用geoLocationManager.flushCachedGnssLocations替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Gnss

返回值

参数名 类型 必填 说明
Promise<boolean> boolean NA 清空所有GNSS缓存位置是否成功。

示例

import geolocation from '@ohos.geolocation';
geolocation.flushCachedGnssLocations().then((result) => {
    console.log('promise, flushCachedGnssLocations: ' + JSON.stringify(result));
});
1
2
3
4

geolocation.sendCommand(deprecated)

sendCommand(command: LocationCommand, callback: AsyncCallback<boolean>): void;

给位置服务子系统的各个部件发送扩展命令。

说明:
从API version 8开始支持。 从API version 9开始废弃,建议使用geoLocationManager.sendCommand替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Core

参数

参数名 类型 必填 说明
command LocationCommand 指定目标场景,和将要发送的命令(字符串)。
callback AsyncCallback<boolean> 用来接收命令发送的结果。

示例

import geolocation from '@ohos.geolocation';
var requestInfo = {'scenario': 0x301, 'command': "command_1"};
geolocation.sendCommand(requestInfo, (err, result) => {
    if (err) {
        console.log('sendCommand: err=' + JSON.stringify(err));
    }
    if (result) {
        console.log('sendCommand: result=' + JSON.stringify(result));
    }
});
1
2
3
4
5
6
7
8
9
10

geolocation.sendCommand(deprecated)

sendCommand(command: LocationCommand): Promise<boolean>;

给位置服务子系统的各个部件发送扩展命令。

说明:
从API version 8开始支持。 从API version 9开始废弃,建议使用geoLocationManager.sendCommand替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Core

参数

参数名 类型 必填 说明
command LocationCommand 指定目标场景,和将要发送的命令(字符串)。

返回值

参数名 类型 必填 说明
Promise<boolean> boolean NA 表示命令发送成功或失败。

示例

import geolocation from '@ohos.geolocation';
var requestInfo = {'scenario': 0x301, 'command': "command_1"};
geolocation.sendCommand(requestInfo).then((result) => {
    console.log('promise, sendCommand: ' + JSON.stringify(result));
});
1
2
3
4
5

LocationRequestPriority(deprecated)

位置请求中位置信息优先级设置。

说明:
从API version 9开始废弃,建议使用geoLocationManager.LocationRequestPriority替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Core

名称 说明
UNSET 0x200 表示未设置优先级。
ACCURACY 0x201 表示精度优先。
LOW_POWER 0x202 表示低功耗优先。
FIRST_FIX 0x203 表示快速获取位置优先,如果应用希望快速拿到1个位置,可以将优先级设置为该字段。

LocationRequestScenario(deprecated)

位置请求中定位场景设置。

说明:
从API version 9开始废弃,建议使用geoLocationManager.LocationRequestScenario替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Core

名称 说明
UNSET 0x300 表示未设置场景信息。
NAVIGATION 0x301 表示导航场景。
TRAJECTORY_TRACKING 0x302 表示运动轨迹记录场景。
CAR_HAILING 0x303 表示打车场景。
DAILY_LIFE_SERVICE 0x304 表示日常服务使用场景。
NO_POWER 0x305 表示无功耗功场景,这种场景下不会主动触发定位,会在其他应用定位时,才给当前应用返回位置。

GeoLocationErrorCode(deprecated)

位置服务中的错误码信息。

说明:
从API version 9开始废弃。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Core

名称 说明
INPUT_PARAMS_ERROR7+ 101 表示输入参数错误。
REVERSE_GEOCODE_ERROR7+ 102 表示逆地理编码接口调用失败。
GEOCODE_ERROR7+ 103 表示地理编码接口调用失败。
LOCATOR_ERROR7+ 104 表示定位失败。
LOCATION_SWITCH_ERROR7+ 105 表示定位开关。
LAST_KNOWN_LOCATION_ERROR7+ 106 表示获取上次位置失败。
LOCATION_REQUEST_TIMEOUT_ERROR7+ 107 表示单次定位,没有在指定时间内返回位置。

ReverseGeoCodeRequest(deprecated)

逆地理编码请求接口。

说明:
从API version 9开始废弃,建议使用geoLocationManager.ReverseGeoCodeRequest替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Geocoder

名称 类型 可读 可写 说明
locale string 指定位置描述信息的语言,“zh”代表中文,“en”代表英文。
latitude number 表示纬度信息,正值表示北纬,负值表示南纬。
longitude number 表示经度信息,正值表示东经,负值表示西经。
maxItems number 指定返回位置信息的最大个数。

GeoCodeRequest(deprecated)

地理编码请求接口。

说明:
从API version 9开始废弃,建议使用geoLocationManager.GeoCodeRequest替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Geocoder

名称 类型 可读 可写 说明
locale string 表示位置描述信息的语言,“zh”代表中文,“en”代表英文。
description string 表示位置信息描述,如“上海市浦东新区xx路xx号”。
maxItems number 表示返回位置信息的最大个数。
minLatitude number 表示最小纬度信息,与下面三个参数一起,表示一个经纬度范围。
minLongitude number 表示最小经度信息。
maxLatitude number 表示最大纬度信息。
maxLongitude number 表示最大经度信息。

GeoAddress(deprecated)

地理编码类型。

说明:
从API version 9开始废弃,建议使用geoLocationManager.GeoAddress替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Geocoder

名称 类型 可读 可写 说明
latitude7+ number 表示纬度信息,正值表示北纬,负值表示南纬。
longitude7+ number 表示经度信息,正值表示东经,负值表是西经。
locale7+ string 表示位置描述信息的语言,“zh”代表中文,“en”代表英文。
placeName7+ string 表示地区信息。
countryCode7+ string 表示国家码信息。
countryName7+ string 表示国家信息。
administrativeArea7+ string 表示省份区域信息。
subAdministrativeArea7+ string 表示表示子区域信息。
locality7+ string 表示城市信息。
subLocality7+ string 表示子城市信息。
roadName7+ string 表示路名信息。
subRoadName7+ string 表示子路名信息。
premises7+ string 表示门牌号信息。
postalCode7+ string 表示邮政编码信息。
phoneNumber7+ string 表示联系方式信息。
addressUrl7+ string 表示位置信息附件的网址信息。
descriptions7+ Array<string> 表示附加的描述信息。
descriptionsSize7+ number 表示附加的描述信息数量。

LocationRequest(deprecated)

位置信息请求类型。

说明:
从API version 9开始废弃,建议使用geoLocationManager.LocationRequest替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Core

名称 类型 可读 可写 说明
priority LocationRequestPriority 表示优先级信息。
scenario LocationRequestScenario 表示场景信息。
timeInterval number 表示上报位置信息的时间间隔。
distanceInterval number 表示上报位置信息的距离间隔。
maxAccuracy number 表示精度信息。仅在精确位置功能场景下有效,模糊位置功能生效场景下该字段无意义。

CurrentLocationRequest(deprecated)

当前位置信息请求类型。

说明:
从API version 9开始废弃,建议使用geoLocationManager.CurrentLocationRequest替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Core

名称 类型 可读 可写 说明
priority LocationRequestPriority 表示优先级信息。
scenario LocationRequestScenario 表示场景信息。
maxAccuracy number 表示精度信息,单位是米。仅在精确位置功能场景下有效,模糊位置功能生效场景下该字段无意义。
timeoutMs number 表示超时时间,单位是毫秒,最小为1000毫秒。

SatelliteStatusInfo(deprecated)

卫星状态信息。

说明:
从API version 8开始支持。 从API version 9开始废弃,建议使用geoLocationManager.SatelliteStatusInfo替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Gnss

名称 类型 可读 可写 说明
satellitesNumber number 表示卫星个数。
satelliteIds Array<number> 表示每个卫星的ID,数组类型。
carrierToNoiseDensitys Array<number> 表示载波噪声功率谱密度比,即cn0。
altitudes Array<number> 表示高程信息。
azimuths Array<number> 表示方位角。
carrierFrequencies Array<number> 表示载波频率。

CachedGnssLocationsRequest(deprecated)

请求订阅GNSS缓存位置上报功能接口的配置参数。

说明:
从API version 8开始支持。 从API version 9开始废弃,建议使用geoLocationManager.CachedGnssLocationsRequest替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Gnss

名称 类型 可读 可写 说明
reportingPeriodSec number 表示GNSS缓存位置上报的周期,单位是毫秒。
wakeUpCacheQueueFull boolean true表示GNSS芯片底层缓存队列满之后会主动唤醒AP芯片,并把缓存位置上报给应用。
false表示GNSS芯片底层缓存队列满之后不会主动唤醒AP芯片,会把缓存位置直接丢弃。

Geofence(deprecated)

GNSS围栏的配置参数。目前只支持圆形围栏。

说明:
从API version 8开始支持。 从API version 9开始废弃,建议使用geoLocationManager.Geofence替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Geofence

名称 类型 可读 可写 说明
latitude number 表示纬度。
longitude number 表示经度。
radius number 表示圆形围栏的半径。
expiration number 围栏存活的时间,单位是毫秒。

GeofenceRequest(deprecated)

请求添加GNSS围栏消息中携带的参数,包括定位优先级、定位场景和围栏信息。

说明:
从API version 8开始支持。 从API version 9开始废弃,建议使用geoLocationManager.GeofenceRequest替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Geofence

名称 类型 可读 可写 说明
priority LocationRequestPriority 表示位置信息优先级。
scenario LocationRequestScenario 表示定位场景。
geofence Geofence 表示围栏信息。

LocationPrivacyType(deprecated)

定位服务隐私协议类型。

说明:
从API version 8开始支持。 从API version 9开始废弃,建议使用geoLocationManager.LocationPrivacyType替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Core

名称 说明
OTHERS 0 其他场景。
STARTUP 1 开机向导场景下的隐私协议。
CORE_LOCATION 2 开启网络定位时弹出的隐私协议。

LocationCommand(deprecated)

扩展命令结构体。

说明:
从API version 8开始支持。 从API version 9开始废弃,建议使用geoLocationManager.LocationCommand替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Core

名称 类型 可读 可写 说明
scenario LocationRequestScenario 表示定位场景。
command string 扩展命令字符串。

Location(deprecated)

位置信息类型。

说明:
从API version 9开始废弃,建议使用geoLocationManager.Location替代。

需要权限:ohos.permission.LOCATION

系统能力:SystemCapability.Location.Location.Core

名称 类型 可读 可写 说明
latitude7+ number 表示纬度信息,正值表示北纬,负值表示南纬。
longitude7+ number 表示经度信息,正值表示东经,负值表是西经。
altitude7+ number 表示高度信息,单位米。
accuracy7+ number 表示精度信息,单位米。
speed7+ number 表示速度信息,单位米每秒。
timeStamp7+ number 表示位置时间戳,UTC格式。
direction7+ number 表示航向信息。
timeSinceBoot7+ number 表示位置时间戳,开机时间格式。
additions7+ Array<string> 附加信息。
additionSize7+ number 附加信息数量。