@ohos.geoLocationManager (位置服务)


@ohos.geoLocationManager (位置服务)

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

说明:

本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

申请权限

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

系统提供的定位权限有:

  • 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 geoLocationManager from '@ohos.geoLocationManager';
1

geoLocationManager.on('locationChange')

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

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

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

参数:

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

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.
3301100 The location switch is off.
3301200 Failed to obtain the geographical location.

示例

import geoLocationManager from '@ohos.geoLocationManager';
var requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
var locationChange = (location) => {
    console.log('locationChanger: data: ' + JSON.stringify(location));
};
try {
    geoLocationManager.on('locationChange', requestInfo, locationChange);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

1
2
3
4
5
6
7
8
9
10
11

geoLocationManager.off('locationChange')

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

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

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

参数:

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

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.
3301100 The location switch is off.
3301200 Failed to obtain the geographical location.

示例

import geoLocationManager from '@ohos.geoLocationManager';
var requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
var locationChange = (location) => {
    console.log('locationChanger: data: ' + JSON.stringify(location));
};
try {
    geoLocationManager.on('locationChange', requestInfo, locationChange);
    geoLocationManager.off('locationChange', locationChange);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6
7
8
9
10
11

geoLocationManager.on('locationEnabledChange')

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

订阅位置服务状态变化。

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

参数:

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

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.

示例

import geoLocationManager from '@ohos.geoLocationManager';
var locationEnabledChange = (state) => {
    console.log('locationEnabledChange: ' + JSON.stringify(state));
}
try {
    geoLocationManager.on('locationEnabledChange', locationEnabledChange);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6
7
8
9

geoLocationManager.off('locationEnabledChange')

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

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

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

参数

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

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.

示例

import geoLocationManager from '@ohos.geoLocationManager';
var locationEnabledChange = (state) => {
    console.log('locationEnabledChange: state: ' + JSON.stringify(state));
}
try {
    geoLocationManager.on('locationEnabledChange', locationEnabledChange);
    geoLocationManager.off('locationEnabledChange', locationEnabledChange);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6
7
8
9
10

geoLocationManager.on('cachedGnssLocationsChange')

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

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

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

参数

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

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.
3301100 The location switch is off.
3301200 Failed to obtain the geographical location.

示例

import geoLocationManager from '@ohos.geoLocationManager';
var cachedLocationsCb = (locations) => {
    console.log('cachedGnssLocationsChange: locations: ' + JSON.stringify(locations));
}
var requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true};
try {
    geoLocationManager.on('cachedGnssLocationsChange', requestInfo, cachedLocationsCb);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6
7
8
9
10

geoLocationManager.off('cachedGnssLocationsChange')

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

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

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

参数

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

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.
3301100 The location switch is off.
3301200 Failed to obtain the geographical location.

示例

import geoLocationManager from '@ohos.geoLocationManager';
var cachedLocationsCb = (locations) => {
    console.log('cachedGnssLocationsChange: locations: ' + JSON.stringify(locations));
}
var requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true};
try {
    geoLocationManager.on('cachedGnssLocationsChange', requestInfo, cachedLocationsCb);
    geoLocationManager.off('cachedGnssLocationsChange');
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6
7
8
9
10
11

geoLocationManager.on('satelliteStatusChange')

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

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

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

参数

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

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.
3301100 The location switch is off.

示例

import geoLocationManager from '@ohos.geoLocationManager';
var gnssStatusCb = (satelliteStatusInfo) => {
    console.log('satelliteStatusChange: ' + JSON.stringify(satelliteStatusInfo));
}

try {
    geoLocationManager.on('satelliteStatusChange', gnssStatusCb);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6
7
8
9
10

geoLocationManager.off('satelliteStatusChange')

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

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

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

参数

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

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.
3301100 The location switch is off.

示例

import geoLocationManager from '@ohos.geoLocationManager';
var gnssStatusCb = (satelliteStatusInfo) => {
    console.log('satelliteStatusChange: ' + JSON.stringify(satelliteStatusInfo));
}
try {
    geoLocationManager.on('satelliteStatusChange', gnssStatusCb);
    geoLocationManager.off('satelliteStatusChange', gnssStatusCb);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6
7
8
9
10

geoLocationManager.on('nmeaMessage')

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

订阅GNSS NMEA信息上报事件。

需要权限:ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION

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

参数

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

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.
3301100 The location switch is off.

示例

import geoLocationManager from '@ohos.geoLocationManager';
var nmeaCb = (str) => {
    console.log('nmeaMessage: ' + JSON.stringify(str));
}

try {
    geoLocationManager.on('nmeaMessage', nmeaCb );
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6
7
8
9
10

geoLocationManager.off('nmeaMessage')

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

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

需要权限:ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION

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

参数

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

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.
3301100 The location switch is off.

示例

import geoLocationManager from '@ohos.geoLocationManager';
var nmeaCb = (str) => {
    console.log('nmeaMessage: ' + JSON.stringify(str));
}

try {
    geoLocationManager.on('nmeaMessage', nmeaCb);
    geoLocationManager.off('nmeaMessage', nmeaCb);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6
7
8
9
10
11

geoLocationManager.on('gnssFenceStatusChange')

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

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

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

参数

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

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.
3301100 The location switch is off.
3301600 Failed to operate the geofence.

示例

import geoLocationManager from '@ohos.geoLocationManager';
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}};
  try {
      geoLocationManager.on('gnssFenceStatusChange', requestInfo, wantAgentObj);
  } catch (err) {
      console.error("errCode:" + err.code + ",errMessage:" + err.message);
  }
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

geoLocationManager.off('gnssFenceStatusChange')

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

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

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

参数

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

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.
3301100 The location switch is off.
3301600 Failed to operate the geofence.

示例

import geoLocationManager from '@ohos.geoLocationManager';
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}};
  try {
      geoLocationManager.on('gnssFenceStatusChange', requestInfo, wantAgentObj);
      geoLocationManager.off('gnssFenceStatusChange', requestInfo, wantAgentObj);
  } catch (err) {
      console.error("errCode:" + err.code + ",errMessage:" + err.message);
  }
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

geoLocationManager.on('countryCodeChange')

on(type: 'countryCodeChange', callback: Callback<CountryCode>): void;

订阅国家码信息变化事件。

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

参数

参数名 类型 必填 说明
type string 设置事件类型。type为“countryCodeChange”,表示订阅国家码信息变化事件。
callback Callback<CountryCode> 接收国家码信息上报。

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.
3301100 The location switch is off.
3301500 Failed to query the area information.

示例

import geoLocationManager from '@ohos.geoLocationManager';
var callback = (code) => {
    console.log('countryCodeChange: ' + JSON.stringify(code));
}

try {
    geoLocationManager.on('countryCodeChange', callback);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6
7
8
9
10

geoLocationManager.off('countryCodeChange')

off(type: 'countryCodeChange', callback?: Callback<CountryCode>): void;

取消订阅国家码变化事件。

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

参数

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

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.
3301100 The location switch is off.
3301500 Failed to query the area information.

示例

import geoLocationManager from '@ohos.geoLocationManager';
var callback = (code) => {
    console.log('countryCodeChange: ' + JSON.stringify(code));
}

try {
    geoLocationManager.on('countryCodeChange', callback);
    geoLocationManager.off('countryCodeChange', callback);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6
7
8
9
10
11

geoLocationManager.getCurrentLocation

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

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

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

参数

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

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.
3301100 The location switch is off.
3301200 Failed to obtain the geographical location.

示例

import geoLocationManager from '@ohos.geoLocationManager';
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));
    }
};

try {
    geoLocationManager.getCurrentLocation(requestInfo, locationChange);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

geoLocationManager.getCurrentLocation

getCurrentLocation(callback: AsyncCallback<Location>): void;

获取当前位置,通过callback方式异步返回结果。

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

参数

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

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.
3301100 The location switch is off.
3301200 Failed to obtain the geographical location.

示例

import geoLocationManager from '@ohos.geoLocationManager';
var locationChange = (err, location) => {
    if (err) {
        console.log('locationChanger: err=' + JSON.stringify(err));
    }
    if (location) {
        console.log('locationChanger: location=' + JSON.stringify(location));
    }
};

try {
    geoLocationManager.getCurrentLocation(locationChange);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

geoLocationManager.getCurrentLocation

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

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

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

参数

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

返回值

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

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.
3301100 The location switch is off.
3301200 Failed to obtain the geographical location.

示例

import geoLocationManager from '@ohos.geoLocationManager';
var requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0};
try {
    geoLocationManager.getCurrentLocation(requestInfo).then((result) => {
        console.log('current location: ' + JSON.stringify(result));
    })  
    .catch((error) => {
        console.log('promise, getCurrentLocation: error=' + JSON.stringify(error));
    });
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6
7
8
9
10
11
12

geoLocationManager.getLastLocation

getLastLocation(): Location

获取上一次位置。

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

返回值

参数名 类型 必填 说明
Location Location NA 位置信息。

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.
3301100 The location switch is off.
3301200 Failed to obtain the geographical location.

示例

import geoLocationManager from '@ohos.geoLocationManager';
try {
    var location = geoLocationManager.getLastLocation();
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6

geoLocationManager.isLocationEnabled

isLocationEnabled(): boolean

判断位置服务是否已经使能。

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

返回值

参数名 类型 必填 说明
boolean boolean NA 位置服务是否已经使能。

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.

示例

import geoLocationManager from '@ohos.geoLocationManager';
try {
    var locationEnabled = geoLocationManager.isLocationEnabled();
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6

geoLocationManager.requestEnableLocation

requestEnableLocation(callback: AsyncCallback<boolean>): void

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

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

参数

参数名 类型 必填 说明
callback AsyncCallback<boolean> callback返回true表示用户同意使能位置服务,false表示用户不同意使能位置服务。

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.
3301700 No response to the request.

示例

import geoLocationManager from '@ohos.geoLocationManager';
try {
    geoLocationManager.requestEnableLocation((err, data) => {
        if (err) {
            console.log('requestEnableLocation: err=' + JSON.stringify(err));
        }
        if (data) {
            console.log('requestEnableLocation: data=' + JSON.stringify(data));
        }
    });
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6
7
8
9
10
11
12
13

geoLocationManager.requestEnableLocation

requestEnableLocation(): Promise<boolean>

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

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

返回值

参数名 类型 必填 说明
Promise<boolean> boolean NA 返回true表示用户同意使能位置服务,false表示用户不同意使能位置服务。

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.
3301700 No response to the request.

示例

import geoLocationManager from '@ohos.geoLocationManager';
try {
    geoLocationManager.requestEnableLocation().then((result) => {
        console.log('promise, requestEnableLocation: ' + JSON.stringify(result));
    })  
    .catch((error) => {
        console.log('promise, requestEnableLocation: error=' + JSON.stringify(error));
    });
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6
7
8
9
10
11

geoLocationManager.enableLocation

enableLocation(callback: AsyncCallback<void>): void;

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

系统API:此接口为系统接口,三方应用不支持调用。

需要权限:ohos.permission.MANAGE_SECURE_SETTINGS

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

参数

参数名 类型 必填 说明
callback AsyncCallback<void> 用来接收错误码信息。

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.

示例

import geoLocationManager from '@ohos.geoLocationManager';
try {
    geoLocationManager.enableLocation((err, data) => {
        if (err) {
            console.log('enableLocation: err=' + JSON.stringify(err));
        }
    });
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6
7
8
9
10

geoLocationManager.enableLocation

enableLocation(): Promise<void>

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

系统API:此接口为系统接口,三方应用不支持调用。

需要权限:ohos.permission.MANAGE_SECURE_SETTINGS

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

返回值

参数名 类型 必填 说明
Promise<void> void NA 返回错误码信息。

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.

示例

import geoLocationManager from '@ohos.geoLocationManager';
try {
    geoLocationManager.enableLocation().then((result) => {
        console.log('promise, enableLocation succeed');
    })
    .catch((error) => {
        console.log('promise, enableLocation: error=' + JSON.stringify(error));
    });
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6
7
8
9
10
11

geoLocationManager.disableLocation

disableLocation(): void;

关闭位置服务。

系统API:此接口为系统接口,三方应用不支持调用。

需要权限:ohos.permission.MANAGE_SECURE_SETTINGS

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

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.

示例

import geoLocationManager from '@ohos.geoLocationManager';
try {
    geoLocationManager.disableLocation();
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6

geoLocationManager.getAddressesFromLocation

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

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

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

参数

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

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.
3301300 Reverse geocoding query failed.

示例

import geoLocationManager from '@ohos.geoLocationManager';
var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1};
try {
    geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => {
        if (err) {
            console.log('getAddressesFromLocation: err=' + JSON.stringify(err));
        }
        if (data) {
            console.log('getAddressesFromLocation: data=' + JSON.stringify(data));
        }
    });
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

geoLocationManager.getAddressesFromLocation

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

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

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

参数

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

返回值

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

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.
3301300 Reverse geocoding query failed.

示例

import geoLocationManager from '@ohos.geoLocationManager';
var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1};
try {
    geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest).then((data) => {
        console.log('getAddressesFromLocation: ' + JSON.stringify(data));
    })
    .catch((error) => {
        console.log('promise, getAddressesFromLocation: error=' + JSON.stringify(error));
    });
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6
7
8
9
10
11
12

geoLocationManager.getAddressesFromLocationName

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

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

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

参数

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

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.
3301400 Geocoding query failed.

示例

import geoLocationManager from '@ohos.geoLocationManager';
var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1};
try {
    geoLocationManager.getAddressesFromLocationName(geocodeRequest, (err, data) => {
        if (err) {
            console.log('getAddressesFromLocationName: err=' + JSON.stringify(err));
        }
        if (data) {
            console.log('getAddressesFromLocationName: data=' + JSON.stringify(data));
        }
    });
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

geoLocationManager.getAddressesFromLocationName

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

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

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

参数

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

返回值

参数名 类型 必填 说明
Promise<Array<GeoAddress>> Array<GeoAddress> NA 返回地理编码查询结果。

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.
3301400 Geocoding query failed.

示例

import geoLocationManager from '@ohos.geoLocationManager';
var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1};
try {
    geoLocationManager.getAddressesFromLocationName(geocodeRequest).then((result) => {
        console.log('getAddressesFromLocationName: ' + JSON.stringify(result));
    })
    .catch((error) => {
        console.log('promise, getAddressesFromLocationName: error=' + JSON.stringify(error));
    });
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6
7
8
9
10
11
12

geoLocationManager.isGeocoderAvailable

isGeocoderAvailable(): boolean;

判断(逆)地理编码服务状态。

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

返回值

参数名 类型 必填 说明
boolean boolean NA 返回(逆)地理编码服务是否可用。

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.

示例

import geoLocationManager from '@ohos.geoLocationManager';
try {
    var isAvailable = geoLocationManager.isGeocoderAvailable();
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6

geoLocationManager.getCachedGnssLocationsSize

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

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

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

参数

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

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.
3301100 The location switch is off.

示例

import geoLocationManager from '@ohos.geoLocationManager';
try {
    geoLocationManager.getCachedGnssLocationsSize((err, size) => {
        if (err) {
            console.log('getCachedGnssLocationsSize: err=' + JSON.stringify(err));
        }
        if (size) {
            console.log('getCachedGnssLocationsSize: size=' + JSON.stringify(size));
        }
    });
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6
7
8
9
10
11
12
13

geoLocationManager.getCachedGnssLocationsSize

getCachedGnssLocationsSize(): Promise<number>;

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

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

返回值

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

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.
3301100 The location switch is off.

示例

import geoLocationManager from '@ohos.geoLocationManager';
try {
    geoLocationManager.getCachedGnssLocationsSize().then((result) => {
        console.log('promise, getCachedGnssLocationsSize: ' + JSON.stringify(result));
    }) 
    .catch((error) => {
        console.log('promise, getCachedGnssLocationsSize: error=' + JSON.stringify(error));
    });
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6
7
8
9
10
11

geoLocationManager.flushCachedGnssLocations

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

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

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

参数

参数名 类型 必填 说明
callback AsyncCallback<void> 用来接收错误码信息。

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.
3301100 The location switch is off.
3301200 Failed to obtain the geographical location.

示例

import geoLocationManager from '@ohos.geoLocationManager';
try {
    geoLocationManager.flushCachedGnssLocations((err, result) => {
        if (err) {
            console.log('flushCachedGnssLocations: err=' + JSON.stringify(err));
        }
    });
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6
7
8
9
10

geoLocationManager.flushCachedGnssLocations

flushCachedGnssLocations(): Promise<void>;

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

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

返回值

参数名 类型 必填 说明
Promise<void> void NA 接收错误码。

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.
3301100 The location switch is off.
3301200 Failed to obtain the geographical location.

示例

import geoLocationManager from '@ohos.geoLocationManager';
try {
    geoLocationManager.flushCachedGnssLocations().then((result) => {
        console.log('promise, flushCachedGnssLocations success');
    })
    .catch((error) => {
        console.log('promise, flushCachedGnssLocations: error=' + JSON.stringify(error));
    });
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6
7
8
9
10
11

geoLocationManager.sendCommand

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

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

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

参数

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

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.

示例

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

geoLocationManager.sendCommand

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

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

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

参数

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

返回值

参数名 类型 必填 说明
Promise<void> void NA 接收错误码。

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.

示例

import geoLocationManager from '@ohos.geoLocationManager';
var requestInfo = {'scenario': 0x301, 'command': "command_1"};
try {
    geoLocationManager.sendCommand(requestInfo).then((result) => {
        console.log('promise, sendCommand success');
    })  
    .catch((error) => {
        console.log('promise, sendCommand: error=' + JSON.stringify(error));
    });
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6
7
8
9
10
11
12

geoLocationManager.getCountryCode

getCountryCode(callback: AsyncCallback<CountryCode>): void;

查询当前的国家码。

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

参数

参数名 类型 必填 说明
callback AsyncCallback<CountryCode> 用来接收国家码。

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.
3301500 Failed to query the area information.

示例

import geoLocationManager from '@ohos.geoLocationManager';
try {
    geoLocationManager.getCountryCode((err, result) => {
        if (err) {
            console.log('getCountryCode: err=' + JSON.stringify(err));
        }
        if (result) {
            console.log('getCountryCode: result=' + JSON.stringify(result));
        }
    });
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6
7
8
9
10
11
12
13

geoLocationManager.getCountryCode

getCountryCode(): Promise<CountryCode>;

查询当前的国家码。

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

返回值

参数名 类型 必填 说明
Promise<CountryCode> CountryCode NA 用来接收国家码。

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.
3301500 Failed to query the area information.

示例

import geoLocationManager from '@ohos.geoLocationManager';
try {
    geoLocationManager.getCountryCode()
    .then((result) => {
        console.log('promise, getCountryCode: result=' + JSON.stringify(result));
    })
    .catch((error) => {
        console.log('promise, getCountryCode: error=' + JSON.stringify(error));
    });
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6
7
8
9
10
11
12

geoLocationManager.enableLocationMock

enableLocationMock(): void;

使能位置模拟功能。

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

系统API:此接口为系统接口,三方应用不支持调用。

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.
3301100 The location switch is off.

示例

import geoLocationManager from '@ohos.geoLocationManager';
try {
    geoLocationManager.enableLocationMock();
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6

geoLocationManager.disableLocationMock

disableLocationMock(): void;

去使能位置模拟功能。

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

系统API:此接口为系统接口,三方应用不支持调用。

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.
3301100 The location switch is off.

示例

import geoLocationManager from '@ohos.geoLocationManager';
try {
    geoLocationManager.disableLocationMock();
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6

geoLocationManager.setMockedLocations

setMockedLocations(config: LocationMockConfig): void;

设置模拟的位置信息,后面会以该接口中携带的时间间隔上报模拟位置。

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

系统API:此接口为系统接口,三方应用不支持调用。

参数

参数名 类型 必填 说明
config LocationMockConfig 指示位置模拟的配置参数,包含模拟位置上报的时间间隔和模拟位置数组。

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.
3301100 The location switch is off.

示例

import geoLocationManager from '@ohos.geoLocationManager';
var locations = [
    {"latitude": 30.12, "longitude": 120.11, "altitude": 123, "accuracy": 1, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 1000000000, "additionSize": 0, "isFromMock": true},
    {"latitude": 31.13, "longitude": 121.11, "altitude": 123, "accuracy": 2, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 2000000000, "additionSize": 0, "isFromMock": true},
    {"latitude": 32.14, "longitude": 122.11, "altitude": 123, "accuracy": 3, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 3000000000, "additionSize": 0, "isFromMock": true},
    {"latitude": 33.15, "longitude": 123.11, "altitude": 123, "accuracy": 4, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 4000000000, "additionSize": 0, "isFromMock": true},
    {"latitude": 34.16, "longitude": 124.11, "altitude": 123, "accuracy": 5, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 5000000000, "additionSize": 0, "isFromMock": true}
];
var config = {"timeInterval": 5, "locations": locations};
try {
    geoLocationManager.setMockedLocations(config);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

geoLocationManager.enableReverseGeocodingMock

enableReverseGeocodingMock(): void;

使能逆地理编码模拟功能。

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

系统API:此接口为系统接口,三方应用不支持调用。

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.

示例

import geoLocationManager from '@ohos.geoLocationManager';
try {
    geoLocationManager.enableReverseGeocodingMock();
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6

geoLocationManager.disableReverseGeocodingMock

disableReverseGeocodingMock(): void;

去使能逆地理编码模拟功能。

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

系统API:此接口为系统接口,三方应用不支持调用。

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.

示例

import geoLocationManager from '@ohos.geoLocationManager';
try {
    geoLocationManager.disableReverseGeocodingMock();
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6

geoLocationManager.setReverseGeocodingMockInfo

setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>): void;

设置逆地理编码模拟功能的配置信息,包含了位置和地名的对应关系,后续进行逆地理编码查询时如果位置信息位于配置信息中,就返回对应的地名。

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

系统API:此接口为系统接口,三方应用不支持调用。

参数

参数名 类型 必填 说明
mockInfos Array<ReverseGeocodingMockInfo> 指示逆地理编码模拟功能的配置参数数组。逆地理编码模拟功能的配置参数包含了一个位置和一个地名。

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.

示例

import geoLocationManager from '@ohos.geoLocationManager';
var mockInfos = [
    {"location": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "maxItems": 1, "isFromMock": true}},
    {"location": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "maxItems": 1, "isFromMock": true}},
    {"location": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "maxItems": 1, "isFromMock": true}},
    {"location": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "maxItems": 1, "isFromMock": true}},
    {"location": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "maxItems": 1, "isFromMock": true}},
];
try {
    geoLocationManager.setReverseGeocodingMockInfo(mockInfos);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6
7
8
9
10
11
12
13

geoLocationManager.isLocationPrivacyConfirmed

isLocationPrivacyConfirmed(type: LocationPrivacyType): boolean;

查询用户是否同意定位服务隐私申明,是否同意启用定位服务。只有系统应用才能调用。

系统API:此接口为系统接口,三方应用不支持调用。

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

参数

参数名 类型 必填 说明
type LocationPrivacyType 指定隐私申明场景,例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。

返回值

参数名 类型 必填 说明
boolean boolean NA 表示用户是否同意定位服务隐私申明。

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.

示例

import geoLocationManager from '@ohos.geoLocationManager';
try {
    var isConfirmed = geoLocationManager.isLocationPrivacyConfirmed(1);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6

geoLocationManager.setLocationPrivacyConfirmStatus

setLocationPrivacyConfirmStatus(type: LocationPrivacyType, isConfirmed: boolean): void;

设置用户勾选定位服务隐私申明的状态,记录用户是否同意启用定位服务。只有系统应用才能调用。

系统API:此接口为系统接口,三方应用不支持调用。

需要权限:ohos.permission.MANAGE_SECURE_SETTINGS

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

参数

参数名 类型 必填 说明
type LocationPrivacyType 指定隐私申明场景,例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。
isConfirmed boolean 表示用户是否同意定位服务隐私申明。

错误码

以下错误码的详细介绍请参见位置服务子系统错误码

错误码ID 错误信息
3301000 Location service is unavailable.

示例

import geoLocationManager from '@ohos.geoLocationManager';
try {
    geoLocationManager.setLocationPrivacyConfirmStatus(1, true);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
1
2
3
4
5
6

LocationRequestPriority

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

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

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

LocationRequestScenario

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

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

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

ReverseGeoCodeRequest

逆地理编码请求接口。

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

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

GeoCodeRequest

地理编码请求接口。

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

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

GeoAddress

地理编码类型。

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

名称 类型 可读 可写 说明
latitude number 表示纬度信息,正值表示北纬,负值表示南纬。
longitude number 表示经度信息,正值表示东经,负值表是西经。
locale string 表示位置描述信息的语言,“zh”代表中文,“en”代表英文。
placeName string 表示地区信息。
countryCode string 表示国家码信息。
countryName string 表示国家信息。
administrativeArea string 表示省份区域信息。
subAdministrativeArea string 表示表示子区域信息。
locality string 表示城市信息。
subLocality string 表示子城市信息。
roadName string 表示路名信息。
subRoadName string 表示子路名信息。
premises string 表示门牌号信息。
postalCode string 表示邮政编码信息。
phoneNumber string 表示联系方式信息。
addressUrl string 表示位置信息附件的网址信息。
descriptions Array<string> 表示附加的描述信息。
descriptionsSize number 表示附加的描述信息数量。
isFromMock Boolean 表示地名信息是否来自于逆地理编码模拟功能。

LocationRequest

位置信息请求类型。

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

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

CurrentLocationRequest

当前位置信息请求类型。

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

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

SatelliteStatusInfo

卫星状态信息。

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

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

CachedGnssLocationsRequest

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

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

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

Geofence

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

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

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

GeofenceRequest

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

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

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

LocationPrivacyType

定位服务隐私协议类型。

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

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

LocationCommand

扩展命令结构体。

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

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

Location

位置信息类型。

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

名称 类型 可读 可写 说明
latitude number 表示纬度信息,正值表示北纬,负值表示南纬。
longitude number 表示经度信息,正值表示东经,负值表是西经。
altitude number 表示高度信息,单位米。
accuracy number 表示精度信息,单位米。
speed number 表示速度信息,单位米每秒。
timeStamp number 表示位置时间戳,UTC格式。
direction number 表示航向信息。
timeSinceBoot number 表示位置时间戳,开机时间格式。
additions Array<string> 附加信息。
additionSize number 附加信息数量。
isFromMock Boolean 表示位置信息是否来自于位置模拟功能。

ReverseGeocodingMockInfo

逆地理编码模拟功能的配置信息,包含一个位置信息和一个地名信息。

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

系统API:此接口为系统接口,三方应用不支持调用。

名称 类型 可读 可写 说明
location ReverseGeoCodeRequest 表示经纬度信息。
geoAddress GeoAddress 表示地名信息。

LocationMockConfig

位置模拟功能的配置参数,包含了模拟位置上报的时间间隔和模拟位置数组。

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

系统API:此接口为系统接口,三方应用不支持调用。

名称 类型 可读 可写 说明
timeInterval number 表示模拟位置上报的时间间隔,单位是秒。
locations Array<Location> 表示模拟位置数组。

CountryCode

国家码信息结构体,包含国家码字符串和国家码的来源信息。

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

名称 类型 可读 可写 说明
country string 表示国家码字符串。
type CountryCodeType 表示国家码信息来源。

CountryCodeType

国家码来源类型。

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

名称 说明
COUNTRY_CODE_FROM_LOCALE 1 从全球化模块的语言配置信息中获取到的国家码。
COUNTRY_CODE_FROM_SIM 2 从SIM卡中获取到的国家码。
COUNTRY_CODE_FROM_LOCATION 3 基于用户的位置信息,通过逆地理编码查询到的国家码。
COUNTRY_CODE_FROM_NETWORK 4 从蜂窝网络注册信息中获取到的国家码。