@ohos.geoLocationManager (Geolocation Manager)

The geoLocationManager module provides a wide array of location services, including GNSS positioning, network positioning, geocoding, reverse geocoding, and geofencing.

NOTE

The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Applying for Permissions

Before using basic location capabilities, check whether your application has been granted the permission to access the device location information. If not, your application needs to obtain the permission from the user as described below.

The system provides the following location permissions:

ohos.permission.LOCATION
ohos.permission.APPROXIMATELY_LOCATION
ohos.permission.LOCATION_IN_BACKGROUND

If your application needs to access the device location information, it must first apply for required permissions. Specifically speaking:

API versions earlier than 9: Apply for ohos.permission.LOCATION.

API version 9 and later: Apply for ohos.permission.APPROXIMATELY_LOCATION, or apply for ohos.permission.APPROXIMATELY_LOCATION and ohos.permission.LOCATION. Note that ohos.permission.LOCATION cannot be applied for separately.

API Version	Location Permission	Permission Application Result	Location Accuracy
Earlier than 9	ohos.permission.LOCATION	Successful	Location accurate to meters.
9 and later	ohos.permission.LOCATION	Failed	No location obtained.
9 and later	ohos.permission.APPROXIMATELY_LOCATION	Successful	Location accurate to 5 kilometers.
9 and later	ohos.permission.APPROXIMATELY_LOCATION and ohos.permission.LOCATION	Successful	Location accurate to meters.

If your application needs to access the device location information when running in the background, it must be configured to be able to run in the background and be granted the ohos.permission.LOCATION_IN_BACKGROUND permission. In this way, the system continues to report device location information after your application moves to the background.

You can declare the required permission in your application's configuration file. For details, see Access Control (Permission) Development.

Modules to Import

import geoLocationManager from '@ohos.geoLocationManager';

ReverseGeoCodeRequest

Defines a reverse geocoding request.

System capability: SystemCapability.Location.Location.Geocoder

Name	Type	Readable	Writable	Description
locale	string	Yes	Yes	Language used for the location description. zh indicates Chinese, and en indicates English.
latitude	number	Yes	Yes	Latitude information. A positive value indicates north latitude, and a negative value indicates south latitude. The value ranges from -90 to 90.
longitude	number	Yes	Yes	Longitude information. A positive value indicates east longitude , and a negative value indicates west longitude . The value ranges from -180 to 180.
maxItems	number	Yes	Yes	Maximum number of location records to be returned. The value must be greater than or equal to 0. A value smaller than 10 is recommended.

GeoCodeRequest

Defines a geocoding request.

System capability: SystemCapability.Location.Location.Geocoder

Name	Type	Readable	Writable	Description
locale	string	Yes	Yes	Language used for the location description. zh indicates Chinese, and en indicates English.
description	string	Yes	Yes	Location description, for example, No. xx, xx Road, Pudong New District, Shanghai.
maxItems	number	Yes	Yes	Maximum number of location records to be returned. The value must be greater than or equal to 0. A value smaller than 10 is recommended.
minLatitude	number	Yes	Yes	Minimum latitude. This parameter is used with minLongitude, maxLatitude, and maxLongitude to specify the latitude and longitude ranges. The value ranges from -90 to 90.
minLongitude	number	Yes	Yes	Minimum longitude. The value ranges from -180 to 180.
maxLatitude	number	Yes	Yes	Maximum latitude. The value ranges from -90 to 90.
maxLongitude	number	Yes	Yes	Maximum longitude. The value ranges from -180 to 180.

GeoAddress

Defines a geographic location.

System capability: SystemCapability.Location.Location.Geocoder

Name	Type	Readable	Writable	Description
latitude	number	Yes	No	Latitude information. A positive value indicates north latitude, and a negative value indicates south latitude. The value ranges from -90 to 90.
longitude	number	Yes	No	Longitude information. A positive value indicates east longitude , and a negative value indicates west longitude . The value ranges from -180 to 180.
locale	string	Yes	No	Language used for the location description. zh indicates Chinese, and en indicates English.
placeName	string	Yes	No	Landmark of the location.
countryCode	string	Yes	No	Country code.
countryName	string	Yes	No	Country name.
administrativeArea	string	Yes	No	Administrative region name.
subAdministrativeArea	string	Yes	No	Sub-administrative region name.
locality	string	Yes	No	Locality information.
subLocality	string	Yes	No	Sub-locality information.
roadName	string	Yes	No	Road name.
subRoadName	string	Yes	No	Auxiliary road information.
premises	string	Yes	No	House information.
postalCode	string	Yes	No	Postal code.
phoneNumber	string	Yes	No	Phone number.
addressUrl	string	Yes	No	Website URL.
descriptions	Array<string>	Yes	No	Additional descriptions.
descriptionsSize	number	Yes	No	Total number of additional descriptions. The value must be greater than or equal to 0. A value smaller than 10 is recommended.
isFromMock	Boolean	Yes	No	Whether the geographic address is obtained from the mock reverse geocoding function. System API: This is a system API.

LocationRequest

Defines a location request.

System capability: SystemCapability.Location.Location.Core

Name	Type	Readable	Writable	Description
priority	LocationRequestPriority	Yes	Yes	Priority of the location request. For details about the value range, see LocationRequestPriority.
scenario	LocationRequestScenario	Yes	Yes	Scenario of the location request. For details about the value range, see LocationRequestScenario.
timeInterval	number	Yes	Yes	Time interval at which location information is reported, in seconds. The value must be greater than 0.
distanceInterval	number	Yes	Yes	Distance interval at which location information is reported. The value must be greater than 0, in meters.
maxAccuracy	number	Yes	Yes	Location accuracy. This parameter is valid only when the precise location function is enabled, and is invalid when the approximate location function is enabled. The value must be greater than 0.

CurrentLocationRequest

Defines the current location request.

System capability: SystemCapability.Location.Location.Core

Name	Type	Readable	Writable	Description
priority	LocationRequestPriority	Yes	Yes	Priority of the location request. For details about the value range, see LocationRequestPriority.
scenario	LocationRequestScenario	Yes	Yes	Scenario of the location request. For details about the value range, see LocationRequestScenario.
maxAccuracy	number	Yes	Yes	Location accuracy, in meters. This parameter is valid only when the precise location function is enabled, and is invalid when the approximate location function is enabled. The value must be greater than 0.
timeoutMs	number	Yes	Yes	Timeout duration, in milliseconds. The minimum value is 1000. The value must be greater than or equal to 1000.

SatelliteStatusInfo

Defines the satellite status information.

System capability: SystemCapability.Location.Location.Gnss

Name	Type	Readable	Writable	Description
satellitesNumber	number	Yes	No	Number of satellites. The value must be greater than or equal to 0.
satelliteIds	Array<number>	Yes	No	Array of satellite IDs. The value must be greater than or equal to 0.
carrierToNoiseDensitys	Array<number>	Yes	No	Carrier-to-noise density ratio, that is, cn0. The value must be greater than 0.
altitudes	Array<number>	Yes	No	Satellite altitude angle information. The value ranges from -90 to 90, in degrees.
azimuths	Array<number>	Yes	No	Azimuth information. The value ranges from 0 to 360, in degrees.
carrierFrequencies	Array<number>	Yes	No	Carrier frequency. The value must be greater than or equal to 0, in Hz.

CachedGnssLocationsRequest

Represents a request for reporting cached GNSS locations.

System capability: SystemCapability.Location.Location.Gnss

Name	Type	Readable	Writable	Description
reportingPeriodSec	number	Yes	Yes	Interval for reporting the cached GNSS locations, in milliseconds. The value must be greater than 0.
wakeUpCacheQueueFull	boolean	Yes	Yes	true: reports the cached GNSS locations to the application when the cache queue is full. false: discards the cached GNSS locations when the cache queue is full.

Geofence

Defines a GNSS geofence. Currently, only circular geofences are supported.

System capability: SystemCapability.Location.Location.Geofence

Name	Type	Readable	Writable	Description
latitude	number	Yes	Yes	Latitude information. The value ranges from -90 to 90.
longitude	number	Yes	Yes	Longitude information. The value ranges from -180 to 180.
radius	number	Yes	Yes	Radius of a circular geofence. The value must be greater than 0, in meters.
expiration	number	Yes	Yes	Expiration period of a geofence, in milliseconds. The value must be greater than 0.

GeofenceRequest

Represents a GNSS geofencing request.

System capability: SystemCapability.Location.Location.Geofence

Name	Type	Readable	Writable	Description
scenario	LocationRequestScenario	Yes	Yes	Location scenario.
geofence	Geofence	Yes	Yes	Geofence information.

LocationCommand

Defines an extended command.

System capability: SystemCapability.Location.Location.Core

Name	Type	Readable	Writable	Description
scenario	LocationRequestScenario	Yes	Yes	Location scenario.
command	string	Yes	Yes	Extended command, in the string format.

Location

Defines a location.

System capability: SystemCapability.Location.Location.Core

Name	Type	Readable	Writable	Description
latitude	number	Yes	No	Latitude information. A positive value indicates north latitude, and a negative value indicates south latitude. The value ranges from -90 to 90.
longitude	number	Yes	No	Longitude information. A positive value indicates east longitude , and a negative value indicates west longitude . The value ranges from -180 to 180.
altitude	number	Yes	No	Location altitude, in meters.
accuracy	number	Yes	No	Location accuracy, in meters.
speed	number	Yes	No	Speed, in m/s.
timeStamp	number	Yes	No	Location timestamp in the UTC format.
direction	number	Yes	No	Direction information. The value ranges from 0 to 360, in degrees.
timeSinceBoot	number	Yes	No	Location timestamp since boot.
additions	Array<string>	Yes	No	Additional description.
additionSize	number	Yes	No	Number of additional descriptions. The value must be greater than or equal to 0.
isFromMock	Boolean	Yes	No	Whether the location information is from the mock location function. System API: This is a system API.

ReverseGeocodingMockInfo

Represents information of the mock reverse geocoding function.

System capability: SystemCapability.Location.Location.Core

System API: This is a system API and cannot be called by third-party applications.

Name	Type	Readable	Writable	Description
location	ReverseGeoCodeRequest	Yes	Yes	Latitude and longitude information.
geoAddress	GeoAddress	Yes	Yes	Geographic address.

LocationMockConfig

Represents the mock location configuration.

System capability: SystemCapability.Location.Location.Core

System API: This is a system API and cannot be called by third-party applications.

Name	Type	Readable	Writable	Description
timeInterval	number	Yes	Yes	Interval at which mock locations are reported, in seconds.
locations	Array<Location>	Yes	Yes	Array of mocked locations.

CountryCode

Represents country code information.

System capability: SystemCapability.Location.Location.Core

Name	Type	Readable	Writable	Description
country	string	Yes	No	Country code.
type	CountryCodeType	Yes	No	Country code source.

LocationRequestPriority

Sets the priority of the location request.

System capability: SystemCapability.Location.Location.Core

Name	Value	Description
UNSET	0x200	Priority unspecified. If this option is used, LocationRequestPriority is invalid.
ACCURACY	0x201	Location accuracy preferred. This policy mainly uses the GNSS positioning technology. In an open area, the technology can achieve the meter-level location accuracy, depending on the hardware performance of the device. However, in a shielded environment, the location accuracy may significantly decrease.
LOW_POWER	0x202	Power efficiency preferred. This policy mainly uses the base station positioning, WLAN positioning, and Bluetooth positioning technologies to obtain device location in both indoor and outdoor scenarios. The location accuracy depends on the distribution of surrounding base stations, visible WLANs, and Bluetooth devices and therefore may fluctuate greatly. This policy is recommended and can reduce power consumption when your application does not require high location accuracy or when base stations, visible WLANs, and Bluetooth devices are densely distributed.
FIRST_FIX	0x203	Fast location preferred. Use this option if you want to obtain a location as fast as possible. This policy uses the GNSS positioning, base station positioning, WLAN positioning, and Bluetooth positioning technologies simultaneously to obtain the device location in both the indoor and outdoor scenarios. When all positioning technologies provide a location result, the system provides the most accurate location result for your application. It can lead to significant hardware resource consumption and power consumption.

LocationRequestScenario

Sets the scenario of the location request.

System capability: SystemCapability.Location.Location.Core

Name	Value	Description
UNSET	0x300	Scenario unspecified. If this option is used, LocationRequestScenario is invalid.
NAVIGATION	0x301	Navigation scenario. This option is applicable when your application needs to obtain the real-time location of a mobile device outdoors, such as navigation for driving or walking. In this scenario, GNSS positioning is used to provide location services to ensure the optimal location accuracy of the system. The location result is reported at a minimum interval of 1 second by default.
TRAJECTORY_TRACKING	0x302	Trajectory tracking scenario. This option is applicable when your application needs to record user trajectories, for example, the track recording function of sports applications. In this scenario, the GNSS positioning technology is mainly used to ensure the location accuracy. The location result is reported at a minimum interval of 1 second by default.
CAR_HAILING	0x303	Ride hailing scenario. This option is applicable when your application needs to obtain the current location of a user who is hailing a taxi. The location result is reported at a minimum interval of 1 second by default.
DAILY_LIFE_SERVICE	0x304	Daily life service scenario. This option is applicable when your application only needs the approximate user location for recommendations and push notifications in scenarios such as when the user is browsing news, shopping online, and ordering food. The location result is reported at a minimum interval of 1 second by default.
NO_POWER	0x305	Power efficiency scenario. This option is applicable when your application does not proactively start the location service. When responding to another application requesting the same location service, the system marks a copy of the location result to your application. In this way, your application will not consume extra power for obtaining the user location.

LocationPrivacyType

Defines the privacy statement type.

System capability: SystemCapability.Location.Location.Core

System API: This is a system API and cannot be called by third-party applications.

Name	Value	Description
OTHERS	0	Other scenarios. Reserved field.
STARTUP	1	Privacy statement displayed in the startup wizard.
CORE_LOCATION	2	Privacy statement displayed when enabling the location service.

CountryCodeType

Represents the country code source type.

System capability: SystemCapability.Location.Location.Core

Name	Value	Description
COUNTRY_CODE_FROM_LOCALE	1	Country code obtained from the language configuration of the globalization module.
COUNTRY_CODE_FROM_SIM	2	Country code obtained from the SIM card.
COUNTRY_CODE_FROM_LOCATION	3	Country code obtained using the reverse geocoding function based on the user's location information.
COUNTRY_CODE_FROM_NETWORK	4	Country code obtained from the cellular network registration information.

geoLocationManager.on('locationChange')

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

Registers a listener for location changes with a location request initiated.

Required permissions: ohos.permission.APPROXIMATELY_LOCATION

System capability: SystemCapability.Location.Location.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value locationChange indicates a location change event.
request	LocationRequest	Yes	Location request.
callback	Callback<Location>	Yes	Callback used to return the location change event.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.
3301100	The location switch is off.
3301200	Failed to obtain the geographical location.

Example

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

Unregisters the listener for location changes with the corresponding location request deleted.

Required permissions: ohos.permission.APPROXIMATELY_LOCATION

System capability: SystemCapability.Location.Location.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value locationChange indicates a location change event.
callback	Callback<Location>	No	Callback to unregister. If this parameter is not specified, all callbacks of the specified event type are unregistered.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.
3301100	The location switch is off.
3301200	Failed to obtain the geographical location.

Example

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

Registers a listener for location service status change events.

System capability: SystemCapability.Location.Location.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value locationEnabledChange indicates a location service status change event.
callback	Callback<boolean>	Yes	Callback used to return the location service status change event.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.

Example

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;

Unregisters the listener for location service status change events.

System capability: SystemCapability.Location.Location.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value locationEnabledChange indicates a location service status change event.
callback	Callback<boolean>	No	Callback to unregister. If this parameter is not specified, all callbacks of the specified event type are unregistered.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.

Example

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;

Registers a listener for cached GNSS location reports.

Required permissions: ohos.permission.APPROXIMATELY_LOCATION

System capability: SystemCapability.Location.Location.Gnss

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value cachedGnssLocationsChange indicates reporting of cached GNSS locations.
request	CachedGnssLocationsRequest	Yes	Request for reporting cached GNSS location.
callback	Callback<boolean>	Yes	Callback used to return cached GNSS locations.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.
3301100	The location switch is off.
3301200	Failed to obtain the geographical location.

Example

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;

Unregisters the listener for cached GNSS location reports.

Required permissions: ohos.permission.APPROXIMATELY_LOCATION

System capability: SystemCapability.Location.Location.Gnss

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value cachedGnssLocationsChange indicates reporting of cached GNSS locations.
callback	Callback<boolean>	No	Callback to unregister. If this parameter is not specified, all callbacks of the specified event type are unregistered.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.
3301100	The location switch is off.
3301200	Failed to obtain the geographical location.

Example

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;

Registers a listener for GNSS satellite status change events.

Required permissions: ohos.permission.APPROXIMATELY_LOCATION

System capability: SystemCapability.Location.Location.Gnss

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value satelliteStatusChange indicates a GNSS satellite status change event.
callback	Callback<SatelliteStatusInfo>	Yes	Callback used to return GNSS satellite status changes.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.
3301100	The location switch is off.

Example

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;

Unregisters the listener for GNSS satellite status change events.

Required permissions: ohos.permission.APPROXIMATELY_LOCATION

System capability: SystemCapability.Location.Location.Gnss

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value satelliteStatusChange indicates a GNSS satellite status change event.
callback	Callback<SatelliteStatusInfo>	No	Callback to unregister. If this parameter is not specified, all callbacks of the specified event type are unregistered.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.
3301100	The location switch is off.

Example

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;

Registers a listener for GNSS NMEA message change events.

Permission required: ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION

System capability: SystemCapability.Location.Location.Gnss

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value nmeaMessage indicates a GNSS NMEA message change event.
callback	Callback<string>	Yes	Callback used to return GNSS NMEA message changes.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.
3301100	The location switch is off.

Example

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;

Unregisters the listener for GNSS NMEA message change events.

Permission required: ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION

System capability: SystemCapability.Location.Location.Gnss

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value nmeaMessage indicates a GNSS NMEA message change event.
callback	Callback<string>	No	Callback to unregister. If this parameter is not specified, all callbacks of the specified event type are unregistered.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.
3301100	The location switch is off.

Example

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;

Registers a listener for status change events of the specified geofence.

Required permissions: ohos.permission.APPROXIMATELY_LOCATION

System capability: SystemCapability.Location.Location.Geofence

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value gnssFenceStatusChange indicates a geofence status change event.
request	GeofenceRequest	Yes	Geofencing request.
want	WantAgent	Yes	WantAgent used to return geofence (entrance or exit) events.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.
3301100	The location switch is off.
3301600	Failed to operate the geofence.

Example

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;

Unregisters the listener for status change events of the specified geofence.

Required permissions: ohos.permission.APPROXIMATELY_LOCATION

System capability: SystemCapability.Location.Location.Geofence

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value gnssFenceStatusChange indicates a geofence status change event.
request	GeofenceRequest	Yes	Geofencing request.
want	WantAgent	Yes	WantAgent used to return geofence (entrance or exit) events.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.
3301100	The location switch is off.
3301600	Failed to operate the geofence.

Example

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;

Registers a listener for country code change events.

System capability: SystemCapability.Location.Location.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value countryCodeChange indicates a country code change event.
callback	Callback<CountryCode>	Yes	Callback used to return the country code change event.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.
3301500	Failed to query the area information.

Example

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;

Unregisters the listener for country code change events.

System capability: SystemCapability.Location.Location.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value countryCodeChange indicates a country code change event.
callback	Callback<CountryCode>	No	Callback to unregister. If this parameter is not specified, all callbacks of the specified event type are unregistered.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.
3301500	Failed to query the area information.

Example

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

Obtains the current location. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.APPROXIMATELY_LOCATION

System capability: SystemCapability.Location.Location.Core

Parameters

Name	Type	Mandatory	Description
request	CurrentLocationRequest	Yes	Location request.
callback	AsyncCallback<Location>	Yes	Callback used to return the current location.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.
3301100	The location switch is off.
3301200	Failed to obtain the geographical location.

Example

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;

Obtains the current location. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.APPROXIMATELY_LOCATION

System capability: SystemCapability.Location.Location.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<Location>	Yes	Callback used to return the current location.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.
3301100	The location switch is off.
3301200	Failed to obtain the geographical location.

Example

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>

Obtains the current location. This API uses a promise to return the result.

Required permissions: ohos.permission.APPROXIMATELY_LOCATION

System capability: SystemCapability.Location.Location.Core

Parameters

Name	Type	Mandatory	Description
request	CurrentLocationRequest	No	Location request.

Return value

Name	Type	Mandatory	Description
Promise<Location>	Location	NA	Promise used to return the current location.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.
3301100	The location switch is off.
3301200	Failed to obtain the geographical location.

Example

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

Obtains the last location.

Required permissions: ohos.permission.APPROXIMATELY_LOCATION

System capability: SystemCapability.Location.Location.Core

Return value

Name	Type	Mandatory	Description
Location	Location	NA	Location information.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.
3301100	The location switch is off.
3301200	Failed to obtain the geographical location.

Example

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

geoLocationManager.isLocationEnabled

isLocationEnabled(): boolean

Checks whether the location service is enabled.

System capability: SystemCapability.Location.Location.Core

Return value

Name	Type	Mandatory	Description
boolean	boolean	NA	Result indicating whether the location service is enabled.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.

Example

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;

Enables the location service. This API uses an asynchronous callback to return the result.

System API: This is a system API and cannot be called by third-party applications.

Required permissions: ohos.permission.MANAGE_SECURE_SETTINGS

System capability: SystemCapability.Location.Location.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the error message.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.

Example

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>

Enables the location service. This API uses a promise to return the result.

System API: This is a system API and cannot be called by third-party applications.

Required permissions: ohos.permission.MANAGE_SECURE_SETTINGS

System capability: SystemCapability.Location.Location.Core

Return value

Name	Type	Mandatory	Description
Promise<void>	void	NA	Promise used to return the error message.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.

Example

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;

Disables the location service.

System API: This is a system API and cannot be called by third-party applications.

Required permissions: ohos.permission.MANAGE_SECURE_SETTINGS

System capability: SystemCapability.Location.Location.Core

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.

Example

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

Converts coordinates into geographic descriptions through reverse geocoding. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Location.Location.Geocoder

Parameters

Name	Type	Mandatory	Description
request	ReverseGeoCodeRequest	Yes	Reverse geocoding request.
callback	AsyncCallback<Array<GeoAddress>>	Yes	Callback used to return the reverse geocoding result.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.
3301300	Reverse geocoding query failed.

Example

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

Converts coordinates into geographic descriptions through reverse geocoding. This API uses a promise to return the result.

System capability: SystemCapability.Location.Location.Geocoder

Parameters

Name	Type	Mandatory	Description
request	ReverseGeoCodeRequest	Yes	Reverse geocoding request.

Return value

Name	Type	Mandatory	Description
Promise<Array<GeoAddress>>	Array<GeoAddress>	NA	Promise used to return the reverse geocoding result.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.
3301300	Reverse geocoding query failed.

Example

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

Converts geographic descriptions into coordinates through geocoding. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Location.Location.Geocoder

Parameters

Name	Type	Mandatory	Description
request	GeoCodeRequest	Yes	Geocoding request.
callback	AsyncCallback<Array<GeoAddress>>	Yes	Callback used to return the geocoding result.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.
3301400	Geocoding query failed.

Example

import geoLocationManager from '@ohos.geoLocationManager';
let geocodeRequest = {"description": "No. xx, xx Road, Pudong District, Shanghai", "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>>

Converts geographic descriptions into coordinates through geocoding. This API uses a promise to return the result.

System capability: SystemCapability.Location.Location.Geocoder

Parameters

Name	Type	Mandatory	Description
request	GeoCodeRequest	Yes	Geocoding request.

Return value

Name	Type	Mandatory	Description
Promise<Array<GeoAddress>>	Array<GeoAddress>	NA	Promise used to return the geocoding result.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.
3301400	Geocoding query failed.

Example

import geoLocationManager from '@ohos.geoLocationManager';
let geocodeRequest = {"description": "No. xx, xx Road, Pudong District, Shanghai", "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;

Obtains the (reverse) geocoding service status.

System capability: SystemCapability.Location.Location.Geocoder

Return value

Name	Type	Mandatory	Description
boolean	boolean	NA	Result indicating whether the (reverse) geocoding service is available.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.

Example

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;

Obtains the number of cached GNSS locations.

Required permissions: ohos.permission.APPROXIMATELY_LOCATION

System capability: SystemCapability.Location.Location.Gnss

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<number>	Yes	Callback used to return the number of cached GNSS locations.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.
3301100	The location switch is off.

Example

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

Obtains the number of cached GNSS locations.

Required permissions: ohos.permission.APPROXIMATELY_LOCATION

System capability: SystemCapability.Location.Location.Gnss

Return value

Name	Type	Mandatory	Description
Promise<number>	number	NA	Promise used to return the number of cached GNSS locations.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.
3301100	The location switch is off.

Example

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;

Obtains all cached GNSS locations and clears the GNSS cache queue.

Required permissions: ohos.permission.APPROXIMATELY_LOCATION

System capability: SystemCapability.Location.Location.Gnss

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the error message.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.
3301100	The location switch is off.
3301200	Failed to obtain the geographical location.

Example

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

Obtains all cached GNSS locations and clears the GNSS cache queue.

Required permissions: ohos.permission.APPROXIMATELY_LOCATION

System capability: SystemCapability.Location.Location.Gnss

Return value

Name	Type	Mandatory	Description
Promise<void>	void	NA	Promise used to return the error code.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.
3301100	The location switch is off.
3301200	Failed to obtain the geographical location.

Example

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;

Sends an extended command to the location subsystem.

System capability: SystemCapability.Location.Location.Core

Parameters

Name	Type	Mandatory	Description
command	LocationCommand	Yes	Extended command (string) to be sent.
callback	AsyncCallback<void>	Yes	Callback used to return the error code.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.

Example

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

Sends an extended command to the location subsystem.

System capability: SystemCapability.Location.Location.Core

Parameters

Name	Type	Mandatory	Description
command	LocationCommand	Yes	Extended command (string) to be sent.

Return value

Name	Type	Mandatory	Description
Promise<void>	void	NA	Promise used to return the error code.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.

Example

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;

Obtains the current country code.

System capability: SystemCapability.Location.Location.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<CountryCode>	Yes	Callback used to return the country code.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.
3301500	Failed to query the area information.

Example

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

Obtains the current country code.

System capability: SystemCapability.Location.Location.Core

Return value

Name	Type	Mandatory	Description
Promise<CountryCode>	CountryCode	NA	Promise used to return the country code.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.
3301500	Failed to query the area information.

Example

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;

Enables the mock location function.

System capability: SystemCapability.Location.Location.Core

System API: This is a system API and cannot be called by third-party applications.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.
3301100	The location switch is off.

Example

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

geoLocationManager.disableLocationMock

disableLocationMock(): void;

Disables the mock location function.

System capability: SystemCapability.Location.Location.Core

System API: This is a system API and cannot be called by third-party applications.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.
3301100	The location switch is off.

Example

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

geoLocationManager.setMockedLocations

setMockedLocations(config: LocationMockConfig): void;

Sets the mock location information. The mock locations will be reported at the interval specified in this API.

This API can be invoked only after geoLocationManager.enableLocationMock is called.

System capability: SystemCapability.Location.Location.Core

System API: This is a system API and cannot be called by third-party applications.

Parameters

Name	Type	Mandatory	Description
config	LocationMockConfig	Yes	Mock location information, including the interval for reporting the mock locations and the array of the mock locations.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.
3301100	The location switch is off.

Example

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;

Enables the mock reverse geocoding function.

System capability: SystemCapability.Location.Location.Core

System API: This is a system API and cannot be called by third-party applications.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.

Example

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

geoLocationManager.disableReverseGeocodingMock

disableReverseGeocodingMock(): void;

Disables the mock geocoding function.

System capability: SystemCapability.Location.Location.Core

System API: This is a system API and cannot be called by third-party applications.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.

Example

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;

Sets information of the mock reverse geocoding function, including the mapping between a location and geographic name. If the location is contained in the configurations during reverse geocoding query, the corresponding geographic name will be returned.

This API can be invoked only after geoLocationManager.enableReverseGeocodingMock is called.

System capability: SystemCapability.Location.Location.Core

System API: This is a system API and cannot be called by third-party applications.

Parameters

Name	Type	Mandatory	Description
mockInfos	Array<ReverseGeocodingMockInfo>	Yes	Array of information of the mock reverse geocoding function, including a location and a geographic address.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.

Example

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;

Checks whether a user agrees with the privacy statement of the location service. This API can only be called by system applications.

System API: This is a system API and cannot be called by third-party applications.

System capability: SystemCapability.Location.Location.Core

Parameters

Name	Type	Mandatory	Description
type	LocationPrivacyType	Yes	Privacy statement type, for example, privacy statement displayed in the startup wizard or privacy statement displayed when the location service is enabled.

Return value

Name	Type	Mandatory	Description
boolean	boolean	NA	Whether the user agrees with the privacy statement.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.

Example

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;

Sets the user confirmation status for the privacy statement of the location service. This API can only be called by system applications.

System API: This is a system API and cannot be called by third-party applications.

Required permissions: ohos.permission.MANAGE_SECURE_SETTINGS

System capability: SystemCapability.Location.Location.Core

Parameters

Name	Type	Mandatory	Description
type	LocationPrivacyType	Yes	Privacy statement type, for example, privacy statement displayed in the startup wizard or privacy statement displayed when the location service is enabled.
isConfirmed	boolean	Yes	Whether the user agrees with the privacy statement.

Error codes

For details about the following error codes, see Location Error Codes.

ID	Error Message
3301000	Location service is unavailable.

Example

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