@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。

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

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

导入模块

import geoLocationManager from '@ohos.geoLocationManager';

ReverseGeoCodeRequest

逆地理编码请求接口。

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

GeoCodeRequest

地理编码请求接口。

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

GeoAddress

地理编码类型。

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

LocationRequest

位置信息请求类型。

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

CurrentLocationRequest

当前位置信息请求类型。

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

SatelliteStatusInfo

卫星状态信息。

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

CachedGnssLocationsRequest

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

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

Geofence

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

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

GeofenceRequest

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

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

LocationCommand

扩展命令结构体。

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

Location

位置信息类型。

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

ReverseGeocodingMockInfo

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

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

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

LocationMockConfig

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

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

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

CountryCode

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

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

LocationRequestPriority

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

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

LocationRequestScenario

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

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

LocationPrivacyType

定位服务隐私协议类型。

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

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

CountryCodeType

国家码来源类型。

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

geoLocationManager.on('locationChange')

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

开启位置变化订阅，并发起定位请求。

需要权限：ohos.permission.APPROXIMATELY_LOCATION

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

参数：

错误码：

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
let requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
let 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);
}

geoLocationManager.off('locationChange')

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

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

需要权限：ohos.permission.APPROXIMATELY_LOCATION

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

参数：

错误码：

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
let requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
let 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);
}

geoLocationManager.on('locationEnabledChange')

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

订阅位置服务状态变化。

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

参数：

错误码：

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
let locationEnabledChange = (state) => {
    console.log('locationEnabledChange: ' + JSON.stringify(state));
}
try {
    geoLocationManager.on('locationEnabledChange', locationEnabledChange);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

geoLocationManager.off('locationEnabledChange')

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

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

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

参数：

错误码：

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

示例

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

geoLocationManager.on('cachedGnssLocationsChange')

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

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

需要权限：ohos.permission.APPROXIMATELY_LOCATION

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

参数：

错误码：

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
let cachedLocationsCb = (locations) => {
    console.log('cachedGnssLocationsChange: locations: ' + JSON.stringify(locations));
}
let requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true};
try {
    geoLocationManager.on('cachedGnssLocationsChange', requestInfo, cachedLocationsCb);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

geoLocationManager.off('cachedGnssLocationsChange')

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

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

需要权限：ohos.permission.APPROXIMATELY_LOCATION

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

参数：

错误码：

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
let cachedLocationsCb = (locations) => {
    console.log('cachedGnssLocationsChange: locations: ' + JSON.stringify(locations));
}
let requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true};
try {
    geoLocationManager.on('cachedGnssLocationsChange', requestInfo, cachedLocationsCb);
    geoLocationManager.off('cachedGnssLocationsChange');
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

geoLocationManager.on('satelliteStatusChange')

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

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

需要权限：ohos.permission.APPROXIMATELY_LOCATION

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

参数：

错误码：

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

示例

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

try {
    geoLocationManager.on('satelliteStatusChange', gnssStatusCb);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

geoLocationManager.off('satelliteStatusChange')

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

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

需要权限：ohos.permission.APPROXIMATELY_LOCATION

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

参数：

错误码：

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

示例

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

geoLocationManager.on('nmeaMessage')

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

订阅GNSS NMEA信息上报事件。

需要权限：ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION

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

参数：

错误码：

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

示例

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

try {
    geoLocationManager.on('nmeaMessage', nmeaCb );
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

geoLocationManager.off('nmeaMessage')

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

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

需要权限：ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION

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

参数：

错误码：

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

示例

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

geoLocationManager.on('gnssFenceStatusChange')

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

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

需要权限：ohos.permission.APPROXIMATELY_LOCATION

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

参数：

错误码：

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
import wantAgent from '@ohos.app.ability.wantAgent';

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

wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
  let 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);
  }
});

geoLocationManager.off('gnssFenceStatusChange')

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

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

需要权限：ohos.permission.APPROXIMATELY_LOCATION

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

参数：

错误码：

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
import wantAgent from '@ohos.app.ability.wantAgent';

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

wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
  let 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);
  }
});

geoLocationManager.on('countryCodeChange')

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

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

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

参数：

错误码：

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

示例

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

try {
    geoLocationManager.on('countryCodeChange', callback);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

geoLocationManager.off('countryCodeChange')

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

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

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

参数：

错误码：

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

示例

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

geoLocationManager.getCurrentLocation

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

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

需要权限：ohos.permission.APPROXIMATELY_LOCATION

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

参数：

错误码：

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
let requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0};
let 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);
}

geoLocationManager.getCurrentLocation

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

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

需要权限：ohos.permission.APPROXIMATELY_LOCATION

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

参数：

错误码：

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

示例

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

geoLocationManager.getCurrentLocation

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

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

需要权限：ohos.permission.APPROXIMATELY_LOCATION

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

参数：

返回值：

错误码：

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

示例

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

geoLocationManager.getLastLocation

getLastLocation(): Location

获取上一次位置。

需要权限：ohos.permission.APPROXIMATELY_LOCATION

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

返回值：

错误码：

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
try {
    let location = geoLocationManager.getLastLocation();
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

geoLocationManager.isLocationEnabled

isLocationEnabled(): boolean

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

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

返回值：

错误码：

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
try {
    let locationEnabled = geoLocationManager.isLocationEnabled();
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

geoLocationManager.enableLocation

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

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

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

需要权限：ohos.permission.MANAGE_SECURE_SETTINGS

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

参数：

错误码：

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

示例

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);
}

geoLocationManager.enableLocation

enableLocation(): Promise<void>

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

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

需要权限：ohos.permission.MANAGE_SECURE_SETTINGS

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

返回值：

错误码：

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

示例

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);
}

geoLocationManager.disableLocation

disableLocation(): void;

关闭位置服务。

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

需要权限：ohos.permission.MANAGE_SECURE_SETTINGS

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

错误码：

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

示例

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

geoLocationManager.getAddressesFromLocation

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

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

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

参数：

错误码：

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

示例

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

geoLocationManager.getAddressesFromLocation

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

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

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

参数：

返回值：

错误码：

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

示例

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

geoLocationManager.getAddressesFromLocationName

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

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

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

参数：

错误码：

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

示例

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

geoLocationManager.getAddressesFromLocationName

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

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

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

参数：

返回值：

错误码：

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

示例

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

geoLocationManager.isGeocoderAvailable

isGeocoderAvailable(): boolean;

判断（逆）地理编码服务状态。

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

返回值：

错误码：

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
try {
    let isAvailable = geoLocationManager.isGeocoderAvailable();
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

geoLocationManager.getCachedGnssLocationsSize

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

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

需要权限：ohos.permission.APPROXIMATELY_LOCATION

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

参数：

错误码：

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

示例

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);
}

geoLocationManager.getCachedGnssLocationsSize

getCachedGnssLocationsSize(): Promise<number>;

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

需要权限：ohos.permission.APPROXIMATELY_LOCATION

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

返回值：

错误码：

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

示例

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);
}

geoLocationManager.flushCachedGnssLocations

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

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

需要权限：ohos.permission.APPROXIMATELY_LOCATION

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

参数：

错误码：

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

示例

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);
}

geoLocationManager.flushCachedGnssLocations

flushCachedGnssLocations(): Promise<void>;

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

需要权限：ohos.permission.APPROXIMATELY_LOCATION

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

返回值：

错误码：

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

示例

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);
}

geoLocationManager.sendCommand

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

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

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

参数：

错误码：

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

示例

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

geoLocationManager.sendCommand

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

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

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

参数：

返回值：

错误码：

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

示例

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

geoLocationManager.getCountryCode

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

查询当前的国家码。

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

参数：

错误码：

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

示例

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);
}

geoLocationManager.getCountryCode

getCountryCode(): Promise<CountryCode>;

查询当前的国家码。

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

返回值：

错误码：

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

示例

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);
}

geoLocationManager.enableLocationMock

enableLocationMock(): void;

使能位置模拟功能。

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

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

错误码：

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

示例

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

geoLocationManager.disableLocationMock

disableLocationMock(): void;

去使能位置模拟功能。

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

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

错误码：

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

示例

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

geoLocationManager.setMockedLocations

setMockedLocations(config: LocationMockConfig): void;

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

该接口需要在调用geoLocationManager.enableLocationMock之后才能调用。

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

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

参数：

错误码：

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
let 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}
];
let config = {"timeInterval": 5, "locations": locations};
try {
    geoLocationManager.enableLocationMock();
    geoLocationManager.setMockedLocations(config);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

geoLocationManager.enableReverseGeocodingMock

enableReverseGeocodingMock(): void;

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

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

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

错误码：

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

示例

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

geoLocationManager.disableReverseGeocodingMock

disableReverseGeocodingMock(): void;

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

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

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

错误码：

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

示例

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

geoLocationManager.setReverseGeocodingMockInfo

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

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

该接口需要在调用geoLocationManager.enableReverseGeocodingMock之后才能调用。

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

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

参数：

错误码：

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
let 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.enableReverseGeocodingMock();
    geoLocationManager.setReverseGeocodingMockInfo(mockInfos);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

geoLocationManager.isLocationPrivacyConfirmed

isLocationPrivacyConfirmed(type: LocationPrivacyType): boolean;

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

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

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

参数：

返回值：

错误码：

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

示例

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

geoLocationManager.setLocationPrivacyConfirmStatus

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

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

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

需要权限：ohos.permission.MANAGE_SECURE_SETTINGS

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

参数：

错误码：

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

示例

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