harmony 鸿蒙@ohos.geoLocationManager (位置服务)

2022-11-09 浏览 (2834)

@ohos.geoLocationManager (位置服务)

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

说明:

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

申请权限

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

系统提供的定位权限有:

  • ohos.permission.LOCATION

  • ohos.permission.APPROXIMATELY_LOCATION

  • ohos.permission.LOCATION_IN_BACKGROUND

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

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

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

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

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

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

导入模块

import geoLocationManager from '@ohos.geoLocationManager';

ReverseGeoCodeRequest

逆地理编码请求接口。

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

名称类型可读可写说明
localestring指定位置描述信息的语言,“zh”代表中文,“en”代表英文。
latitudenumber表示纬度信息,正值表示北纬,负值表示南纬。取值范围为-90到90。
longitudenumber表示经度信息,正值表示东经,负值表示西经。取值范围为-180到180。
maxItemsnumber指定返回位置信息的最大个数。取值范围为大于等于0,推荐该值小于10。

GeoCodeRequest

地理编码请求接口。

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

名称类型可读可写说明
localestring表示位置描述信息的语言,“zh”代表中文,“en”代表英文。
descriptionstring表示位置信息描述,如“上海市浦东新区xx路xx号”。
maxItemsnumber表示返回位置信息的最大个数。取值范围为大于等于0,推荐该值小于10。
minLatitudenumber表示最小纬度信息,与下面三个参数一起,表示一个经纬度范围。取值范围为-90到90。
minLongitudenumber表示最小经度信息。取值范围为-180到180。
maxLatitudenumber表示最大纬度信息。取值范围为-90到90。
maxLongitudenumber表示最大经度信息。取值范围为-180到180。

GeoAddress

地理编码类型。

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

名称类型可读可写说明
latitudenumber表示纬度信息,正值表示北纬,负值表示南纬。取值范围为-90到90。
longitudenumber表示经度信息,正值表示东经,负值表是西经。取值范围为-180到180。
localestring表示位置描述信息的语言,“zh”代表中文,“en”代表英文。
placeNamestring表示地区信息。
countryCodestring表示国家码信息。
countryNamestring表示国家信息。
administrativeAreastring表示省份区域信息。
subAdministrativeAreastring表示子区域信息。
localitystring表示城市信息。
subLocalitystring表示子城市信息。
roadNamestring表示路名信息。
subRoadNamestring表示子路名信息。
premisesstring表示门牌号信息。
postalCodestring表示邮政编码信息。
phoneNumberstring表示联系方式信息。
addressUrlstring表示位置信息附件的网址信息。
descriptionsArray<string>表示附加的描述信息。
descriptionsSizenumber表示附加的描述信息数量。取值范围为大于等于0,推荐该值小于10。
isFromMockBoolean表示地名信息是否来自于逆地理编码模拟功能。
系统API:此接口为系统接口。

LocationRequest

位置信息请求类型。

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

名称类型可读可写说明
priorityLocationRequestPriority表示优先级信息。当scenario取值为UNSET时,priority参数生效,否则priority参数不生效;当scenario和priority均取值为UNSET时,无法发起定位请求。取值范围见LocationRequestPriority的定义。
scenarioLocationRequestScenario表示场景信息。当scenario取值为UNSET时,priority参数生效,否则priority参数不生效;当scenario和priority均取值为UNSET时,无法发起定位请求。取值范围见LocationRequestScenario的定义。
timeIntervalnumber表示上报位置信息的时间间隔,单位是秒。默认值为1,取值范围为大于等于0。
distanceIntervalnumber表示上报位置信息的距离间隔。单位是米,默认值为0,取值范围为大于等于0。
maxAccuracynumber表示精度信息,单位是米。仅在精确位置功能场景下有效,模糊位置功能生效场景下该字段无意义。默认值为0,取值范围为大于等于0。

CurrentLocationRequest

当前位置信息请求类型。

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

名称类型可读可写说明
priorityLocationRequestPriority表示优先级信息。当scenario取值为UNSET时,priority参数生效,否则priority参数不生效;当scenario和priority均取值为UNSET时,无法发起定位请求。取值范围见LocationRequestPriority的定义。
scenarioLocationRequestScenario表示场景信息。当scenario取值为UNSET时,priority参数生效,否则priority参数不生效;当scenario和priority均取值为UNSET时,无法发起定位请求。取值范围见LocationRequestScenario的定义。
maxAccuracynumber表示精度信息,单位是米。仅在精确位置功能场景下有效,模糊位置功能生效场景下该字段无意义。默认值为0,取值范围为大于等于0。
timeoutMsnumber表示超时时间,单位是毫秒,最小为1000毫秒。取值范围为大于等于1000。

SatelliteStatusInfo

卫星状态信息。

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

名称类型可读可写说明
satellitesNumbernumber表示卫星个数。取值范围为大于等于0。
satelliteIdsArray<number>表示每个卫星的ID,数组类型。取值范围为大于等于0。
carrierToNoiseDensitysArray<number>表示载波噪声功率谱密度比,即cn0。取值范围为大于0。
altitudesArray<number>表示卫星高度角信息。单位是“度”,取值范围为-90到90。
azimuthsArray<number>表示方位角。单位是“度”,取值范围为0到360。
carrierFrequenciesArray<number>表示载波频率。单位是Hz,取值范围为大于等于0。

CachedGnssLocationsRequest

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

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

名称类型可读可写说明
reportingPeriodSecnumber表示GNSS缓存位置上报的周期,单位是毫秒。取值范围为大于0。
wakeUpCacheQueueFullbooleantrue表示GNSS芯片底层缓存队列满之后会主动唤醒AP芯片,并把缓存位置上报给应用。
false表示GNSS芯片底层缓存队列满之后不会主动唤醒AP芯片,会把缓存位置直接丢弃。

Geofence

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

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

名称类型可读可写说明
latitudenumber表示纬度。取值范围为-90到90。
longitudenumber表示经度。取值范围为-180到180。
radiusnumber表示圆形围栏的半径。单位是米,取值范围为大于0。
expirationnumber围栏存活的时间,单位是毫秒。取值范围为大于0。

GeofenceRequest

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

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

名称类型可读可写说明
scenarioLocationRequestScenario表示定位场景。
geofenceGeofence表示围栏信息。

LocationCommand

扩展命令结构体。

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

名称类型可读可写说明
scenarioLocationRequestScenario表示定位场景。
commandstring扩展命令字符串。

Location

位置信息类型。

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

名称类型可读可写说明
latitudenumber表示纬度信息,正值表示北纬,负值表示南纬。取值范围为-90到90。
longitudenumber表示经度信息,正值表示东经,负值表是西经。取值范围为-180到180。
altitudenumber表示高度信息,单位米。
accuracynumber表示精度信息,单位米。
speednumber表示速度信息,单位米每秒。
timeStampnumber表示位置时间戳,UTC格式。
directionnumber表示航向信息。单位是“度”,取值范围为0到360。
timeSinceBootnumber表示位置时间戳,开机时间格式。
additionsArray<string>附加信息。
additionSizenumber附加信息数量。取值范围为大于等于0。
isFromMockBoolean表示位置信息是否来自于位置模拟功能。
系统API:此接口为系统接口。

ReverseGeocodingMockInfo

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

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

系统API:此接口为系统接口。

名称类型可读可写说明
locationReverseGeoCodeRequest表示经纬度信息。
geoAddressGeoAddress表示地名信息。

LocationMockConfig

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

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

系统API:此接口为系统接口。

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

CountryCode

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

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

名称类型可读可写说明
countrystring表示国家码字符串。
typeCountryCodeType表示国家码信息来源。

LocatingRequiredDataConfig10+

获取定位所需数据时的配置参数。

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

系统API:此接口为系统接口。

名称类型可读可写说明
typeLocatingRequiredDataType表示请求获取数据的类型。
needStartScanboolean表示是否需要发起扫描。
scanIntervalnumber表示扫描的时间间隔。单位是毫秒,默认值是10000毫秒,取值范围为大于0。
scanTimeoutnumber表示单次扫描的超时时间。单位是毫秒,默认值是10000毫秒,取值范围为大于0小于600000。

LocatingRequiredData10+

表示定位业务所需的数据,包含WiFi或蓝牙扫描结果,APP拿到这些数据之后可以用于网络定位等业务。

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

系统API:此接口为系统接口。

名称类型可读可写说明
wifiDataWifiScanInfo表示WiFi扫描结果。
bluetoothDataBluetoothScanInfo表示蓝牙扫描结果。

WifiScanInfo10+

WiFi扫描信息,包含扫描到的WiFi热点的ssid、bssid和rssi等信息。

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

系统API:此接口为系统接口。

名称类型可读可写说明
ssidstringWiFi热点的SSID,编码格式为UTF-8。
bssidstringWiFi热点的BSSID。
rssinumberWiFi热点的信号强度(dBm)。
frequencynumberWiFi热点的频率。
timestampnumber时间戳。

BluetoothScanInfo10+

蓝牙扫描信息。

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

系统API:此接口为系统接口。

名称类型可读可写说明
deviceNamestring蓝牙设备名称。
macAddressstring蓝牙设备的MAC地址。
rssinumber蓝牙设备的信号强度(dBm)。
timestampnumber时间戳。

LocationRequestPriority

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

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

名称说明
UNSET0x200表示未设置优先级,表示LocationRequestPriority无效。
ACCURACY0x201表示精度优先。
定位精度优先策略主要以GNSS定位技术为主,在开阔场景下可以提供米级的定位精度,具体性能指标依赖用户设备的定位硬件能力,但在室内等强遮蔽定位场景下,无法提供准确的位置服务。
LOW_POWER0x202表示低功耗优先。
低功耗定位优先策略主要使用基站定位和WLAN、蓝牙定位技术,也可以同时提供室内和户外场景下的位置服务,因为其依赖周边基站、可见WLAN、蓝牙设备的分布情况,定位结果的精度波动范围较大,如果对定位结果精度要求不高,或者使用场景多在有基站、可见WLAN、蓝牙设备高密度分布的情况下,推荐使用,可以有效节省设备功耗。
FIRST_FIX0x203表示快速获取位置优先,如果应用希望快速拿到一个位置,可以将优先级设置为该字段。
快速定位优先策略会同时使用GNSS定位、基站定位和WLAN、蓝牙定位技术,以便室内和户外场景下,通过此策略都可以获得位置结果,当各种定位技术都有提供位置结果时,系统会选择其中精度较好的结果返回给应用。因为对各种定位技术同时使用,对设备的硬件资源消耗较大,功耗也较大。

LocationRequestScenario

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

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

名称说明
UNSET0x300表示未设置场景信息。
表示LocationRequestScenario字段无效。
NAVIGATION0x301表示导航场景。
适用于在户外定位设备实时位置的场景,如车载、步行导航。
在此场景下,为保证系统提供位置结果精度最优,主要使用GNSS定位技术提供定位服务
此场景默认以最小1秒间隔上报定位结果。
TRAJECTORY_TRACKING0x302表示运动轨迹记录场景。
适用于记录用户位置轨迹的场景,如运动类应用记录轨迹功能。主要使用GNSS定位技术提供定位服务。
此场景默认以最小1秒间隔上报定位结果。
CAR_HAILING0x303表示打车场景。
适用于用户出行打车时定位当前位置的场景,如网约车类应用。
此场景默认以最小1秒间隔上报定位结果。
DAILY_LIFE_SERVICE0x304表示日常服务使用场景。
适用于不需要定位用户精确位置的使用场景,如新闻资讯、网购、点餐类应用,做推荐、推送时定位用户大致位置即可。
此场景默认以最小1秒间隔上报定位结果。
NO_POWER0x305表示无功耗功场景,这种场景下不会主动触发定位,会在其他应用定位时,才给当前应用返回位置。

LocationPrivacyType

定位服务隐私协议类型。

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

系统API:此接口为系统接口。

名称说明
OTHERS0其他场景。预留字段。
STARTUP1开机向导场景下的隐私协议。在开机时弹出协议,提醒用户阅读并选择是否授权。
CORE_LOCATION2开启网络定位时弹出的隐私协议。

CountryCodeType

国家码来源类型。

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

名称说明
COUNTRY_CODE_FROM_LOCALE1从全球化模块的语言配置信息中获取到的国家码。
COUNTRY_CODE_FROM_SIM2从SIM卡中获取到的国家码。
COUNTRY_CODE_FROM_LOCATION3基于用户的位置信息,通过逆地理编码查询到的国家码。
COUNTRY_CODE_FROM_NETWORK4从蜂窝网络注册信息中获取到的国家码。

LocatingRequiredDataType10+

定位业务所需数据的类型。

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

系统API:此接口为系统接口。

名称说明
WIFI1表示WiFi扫描信息。
BLUETOOTH2表示蓝牙扫描信息。

geoLocationManager.on('locationChange')

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

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

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

参数:

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

错误码

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

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
import BusinessError from "@ohos.base";
let requestInfo:geoLocationManager.LocationRequest = {'priority': geoLocationManager.LocationRequestPriority.FIRST_FIX, 'scenario': geoLocationManager.LocationRequestScenario.UNSET, 'timeInterval': 1, 'distanceInterval': 0, 'maxAccuracy': 0};
let locationChange = (location:geoLocationManager.Location):void => {
    console.log('locationChanger: data: ' + JSON.stringify(location));
};
try {
    geoLocationManager.on('locationChange', requestInfo, locationChange);
} catch (err) {
    console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message);
}

geoLocationManager.off('locationChange')

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

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

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

参数:

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

错误码

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

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
import BusinessError from "@ohos.base";
let requestInfo:geoLocationManager.LocationRequest = {'priority': geoLocationManager.LocationRequestPriority.FIRST_FIX, 'scenario': geoLocationManager.LocationRequestScenario.UNSET, 'timeInterval': 1, 'distanceInterval': 0, 'maxAccuracy': 0};
let locationChange = (location:geoLocationManager.Location):void => {
  console.log('locationChanger: data: ' + JSON.stringify(location));
};
try {
    geoLocationManager.on('locationChange', requestInfo, locationChange);
    geoLocationManager.off('locationChange', locationChange);
} catch (err) {
    console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message);
}

geoLocationManager.on('locationEnabledChange')

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

订阅位置服务状态变化。

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

参数:

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

错误码

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

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

示例

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

geoLocationManager.off('locationEnabledChange')

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

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

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

参数

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

错误码

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

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

示例

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

geoLocationManager.on('cachedGnssLocationsChange')

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

订阅缓存GNSS定位结果上报事件。该接口功能由gnss定位芯片提供(仅部分型号支持),如果设备无此芯片或使用的芯片型号不支持该功能,则返回错误码801(Capability not supported)。

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

参数

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

错误码

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

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

示例

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

geoLocationManager.off('cachedGnssLocationsChange')

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

取消订阅缓存GNSS定位结果上报事件。该接口功能由gnss定位芯片提供(仅部分型号支持),如果设备无此芯片或使用的芯片型号不支持该功能,则返回错误码801(Capability not supported)。

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

参数

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

错误码

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

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

示例

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

geoLocationManager.on('satelliteStatusChange')

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

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

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

参数

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

错误码

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

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

示例

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

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

geoLocationManager.off('satelliteStatusChange')

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

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

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

参数

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

错误码

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

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
import BusinessError from "@ohos.base";
let gnssStatusCb = (satelliteStatusInfo:geoLocationManager.SatelliteStatusInfo):void => {
    console.log('satelliteStatusChange: ' + JSON.stringify(satelliteStatusInfo));
}
try {
    geoLocationManager.on('satelliteStatusChange', gnssStatusCb);
    geoLocationManager.off('satelliteStatusChange', gnssStatusCb);
} catch (err) {
    console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message);
}

geoLocationManager.on('nmeaMessage')

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

订阅GNSS NMEA信息上报事件。

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

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

参数

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

错误码

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

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

示例

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

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

geoLocationManager.off('nmeaMessage')

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

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

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

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

参数

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

错误码

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

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

示例

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

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

geoLocationManager.on('gnssFenceStatusChange')

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

添加一个围栏,并订阅地理围栏事件。该接口功能由gnss定位芯片提供(仅部分型号支持),如果设备无此芯片或使用的芯片型号不支持该功能,则返回错误码801(Capability not supported)。

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

参数

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

错误码

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

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
import wantAgent from '@ohos.app.ability.wantAgent';
import BusinessError from "@ohos.base";

let wantAgentInfo:wantAgent.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:geoLocationManager.GeofenceRequest = {'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}};
  try {
      geoLocationManager.on('gnssFenceStatusChange', requestInfo, wantAgentObj);
  } catch (err) {
      console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message);
  }
});

geoLocationManager.off('gnssFenceStatusChange')

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

删除一个围栏,并取消订阅该围栏事件。该接口功能由gnss定位芯片提供(仅部分型号支持),如果设备无此芯片或使用的芯片型号不支持该功能,则返回错误码801(Capability not supported)。

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

参数

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

错误码

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

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
import wantAgent from '@ohos.app.ability.wantAgent';
import BusinessError from "@ohos.base";

let wantAgentInfo:wantAgent.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:geoLocationManager.GeofenceRequest = {'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 as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message);
  }
});

geoLocationManager.on('countryCodeChange')

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

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

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

参数

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

错误码

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

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

示例

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

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

geoLocationManager.off('countryCodeChange')

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

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

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

参数

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

错误码

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

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

示例

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

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

geoLocationManager.on('locatingRequiredDataChange')10+

on(type: 'locatingRequiredDataChange', config: LocatingRequiredDataConfig, callback: Callback<Array<LocatingRequiredData>>): void;

订阅定位业务所需数据的变化,主要包含WiFi和蓝牙扫描信息;根据入参决定是否启动WiFi和蓝牙扫描。

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

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

系统API:此接口为系统接口。

参数

参数名类型必填说明
typestring设置事件类型。type为“locatingRequiredDataChange”,表示订阅定位业务所需数据的变化。
configLocatingRequiredDataConfig表示获取定位所需数据时的配置参数。
callbackCallback<Array<LocatingRequiredData>>接收定位业务所需数据的上报。

错误码

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

错误码ID错误信息
3301800Failed to start WiFi or Bluetooth scanning.

示例

import geoLocationManager from '@ohos.geoLocationManager';
import BusinessError from "@ohos.base";
let callback = (code:Array<geoLocationManager.LocatingRequiredData>):void => {
    console.log('locatingRequiredDataChange: ' + JSON.stringify(code));
}
let config:geoLocationManager.LocatingRequiredDataConfig = {'type': 1, 'needStartScan': true, 'scanInterval': 10000};
try {
    geoLocationManager.on('locatingRequiredDataChange', config, callback);
} catch (err) {
    console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message);
}

geoLocationManager.off('locatingRequiredDataChange')10+

off(type: 'locatingRequiredDataChange', callback?: Callback<Array<LocatingRequiredData>>): void;

取消订阅定位业务所需数据的变化,并停止WiFi和蓝牙扫描。

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

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

系统API:此接口为系统接口。

参数

参数名类型必填说明
typestring设置事件类型。type为“locatingRequiredDataChange”,表示取消订阅定位业务所需数据的变化。
callbackCallback<Array<LocatingRequiredData>>需要取消订阅的回调函数。若无此参数,则取消当前类型的所有订阅。

错误码

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
import BusinessError from "@ohos.base";
let callback = (code:Array<geoLocationManager.LocatingRequiredData>):void => {
    console.log('locatingRequiredDataChange: ' + JSON.stringify(code));
}
let config:geoLocationManager.LocatingRequiredDataConfig = {'type': 1, 'needStartScan': true, 'scanInterval': 10000};
try {
    geoLocationManager.on('locatingRequiredDataChange', config, callback);
    geoLocationManager.off('locatingRequiredDataChange', callback);
} catch (err) {
    console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message);
}

geoLocationManager.getCurrentLocation

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

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

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

参数

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

错误码

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

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
import BusinessError from "@ohos.base";
let requestInfo:geoLocationManager.CurrentLocationRequest = {'priority': geoLocationManager.LocationRequestPriority.FIRST_FIX, 'scenario': geoLocationManager.LocationRequestScenario.UNSET,'maxAccuracy': 0};
let locationChange = (err:BusinessError.BusinessError, location:geoLocationManager.Location):void => {
    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 as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message);
}

geoLocationManager.getCurrentLocation

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

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

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

参数

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

错误码

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

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
import BusinessError from "@ohos.base";
let locationChange = (err:BusinessError.BusinessError, location:geoLocationManager.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 as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message);
}

geoLocationManager.getCurrentLocation

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

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

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

参数

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

返回值

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

错误码

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

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
import BusinessError from "@ohos.base";
let requestInfo:geoLocationManager.CurrentLocationRequest = {'priority': geoLocationManager.LocationRequestPriority.FIRST_FIX, 'scenario': geoLocationManager.LocationRequestScenario.UNSET,'maxAccuracy': 0};
try {
    geoLocationManager.getCurrentLocation(requestInfo).then((result) => {
        console.log('current location: ' + JSON.stringify(result));
    })  
    .catch((error:number) => {
        console.log('promise, getCurrentLocation: error=' + JSON.stringify(error));
    });
} catch (err) {
    console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message);
}

geoLocationManager.getLastLocation

getLastLocation(): Location

获取上一次位置。

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

返回值

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

错误码

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

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

示例

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

geoLocationManager.isLocationEnabled

isLocationEnabled(): boolean

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

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

返回值

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

错误码

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

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

示例

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

geoLocationManager.enableLocation

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

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

系统API:此接口为系统接口。

需要权限:ohos.permission.MANAGE_SECURE_SETTINGS

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

参数

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

错误码

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

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
import BusinessError from "@ohos.base";
try {
    geoLocationManager.enableLocation((err, data) => {
        if (err) {
            console.log('enableLocation: err=' + JSON.stringify(err));
        }
    });
} catch (err) {
    console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message);
}

geoLocationManager.enableLocation

enableLocation(): Promise<void>

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

系统API:此接口为系统接口。

需要权限:ohos.permission.MANAGE_SECURE_SETTINGS

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

返回值

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

错误码

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

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
import BusinessError from "@ohos.base";
try {
    geoLocationManager.enableLocation().then((result) => {
        console.log('promise, enableLocation succeed');
    })
    .catch((error:number) => {
        console.log('promise, enableLocation: error=' + JSON.stringify(error));
    });
} catch (err) {
    console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message);
}

geoLocationManager.disableLocation

disableLocation(): void;

关闭位置服务。

系统API:此接口为系统接口。

需要权限:ohos.permission.MANAGE_SECURE_SETTINGS

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

错误码

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

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

示例

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

geoLocationManager.getAddressesFromLocation

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

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

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

参数

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

错误码

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

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
import BusinessError from "@ohos.base";
let reverseGeocodeRequest:geoLocationManager.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 as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message);
}

geoLocationManager.getAddressesFromLocation

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

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

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

参数

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

返回值

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

错误码

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

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
import BusinessError from "@ohos.base";
let reverseGeocodeRequest:geoLocationManager.ReverseGeoCodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1};
try {
    geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest).then((data) => {
        console.log('getAddressesFromLocation: ' + JSON.stringify(data));
    })
    .catch((error:number) => {
        console.log('promise, getAddressesFromLocation: error=' + JSON.stringify(error));
    });
} catch (err) {
    console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message);
}

geoLocationManager.getAddressesFromLocationName

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

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

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

参数

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

错误码

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

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
import BusinessError from "@ohos.base";
let geocodeRequest:geoLocationManager.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 as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message);
}

geoLocationManager.getAddressesFromLocationName

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

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

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

参数

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

返回值

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

错误码

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

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
import BusinessError from "@ohos.base";
let geocodeRequest:geoLocationManager.GeoCodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1};
try {
    geoLocationManager.getAddressesFromLocationName(geocodeRequest).then((result) => {
        console.log('getAddressesFromLocationName: ' + JSON.stringify(result));
    })
    .catch((error:number) => {
        console.log('promise, getAddressesFromLocationName: error=' + JSON.stringify(error));
    });
} catch (err) {
    console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message);
}

geoLocationManager.isGeocoderAvailable

isGeocoderAvailable(): boolean;

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

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

返回值

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

错误码

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

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

示例

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

geoLocationManager.getCachedGnssLocationsSize

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

获取GNSS芯片缓存位置的个数。该接口功能由gnss定位芯片提供(仅部分型号支持),如果设备无此芯片或使用的芯片型号不支持该功能,则返回错误码801(Capability not supported)。

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

参数

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

错误码

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

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
import BusinessError from "@ohos.base";
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 as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message);
}

geoLocationManager.getCachedGnssLocationsSize

getCachedGnssLocationsSize(): Promise<number>;

获取GNSS芯片缓存位置的个数。该接口功能由gnss定位芯片提供(仅部分型号支持),如果设备无此芯片或使用的芯片型号不支持该功能,则返回错误码801(Capability not supported)。

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

返回值

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

错误码

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

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
import BusinessError from "@ohos.base";
try {
    geoLocationManager.getCachedGnssLocationsSize().then((result) => {
        console.log('promise, getCachedGnssLocationsSize: ' + JSON.stringify(result));
    }) 
    .catch((error:number) => {
        console.log('promise, getCachedGnssLocationsSize: error=' + JSON.stringify(error));
    });
} catch (err) {
    console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message);
}

geoLocationManager.flushCachedGnssLocations

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

读取并清空GNSS芯片所有缓存位置。该接口功能由gnss定位芯片提供(仅部分型号支持),如果设备无此芯片或使用的芯片型号不支持该功能,则返回错误码801(Capability not supported)。

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

参数

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

错误码

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

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
import BusinessError from "@ohos.base";
try {
    geoLocationManager.flushCachedGnssLocations((err, result) => {
        if (err) {
            console.log('flushCachedGnssLocations: err=' + JSON.stringify(err));
        }
    });
} catch (err) {
    console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message);
}

geoLocationManager.flushCachedGnssLocations

flushCachedGnssLocations(): Promise<void>;

读取并清空GNSS芯片所有缓存位置。该接口功能由gnss定位芯片提供(仅部分型号支持),如果设备无此芯片或使用的芯片型号不支持该功能,则返回错误码801(Capability not supported)。

需要权限:ohos.permission.APPROXIMATELY_LOCATION

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

返回值

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

错误码

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

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
import BusinessError from "@ohos.base";
try {
    geoLocationManager.flushCachedGnssLocations().then((result) => {
        console.log('promise, flushCachedGnssLocations success');
    })
    .catch((error:number) => {
        console.log('promise, flushCachedGnssLocations: error=' + JSON.stringify(error));
    });
} catch (err) {
    console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message);
}

geoLocationManager.sendCommand

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

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

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

参数

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

错误码

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

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
import BusinessError from "@ohos.base";
let requestInfo:geoLocationManager.LocationCommand = {'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 as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message);
}

geoLocationManager.sendCommand

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

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

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

参数

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

返回值

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

错误码

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

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
import BusinessError from "@ohos.base";
let requestInfo:geoLocationManager.LocationCommand = {'scenario': 0x301, 'command': "command_1"};
try {
    geoLocationManager.sendCommand(requestInfo).then((result) => {
        console.log('promise, sendCommand success');
    })  
    .catch((error:number) => {
        console.log('promise, sendCommand: error=' + JSON.stringify(error));
    });
} catch (err) {
    console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message);
}

geoLocationManager.getCountryCode

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

查询当前的国家码。

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

参数

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

错误码

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

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
import BusinessError from "@ohos.base";
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 as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message);
}

geoLocationManager.getCountryCode

getCountryCode(): Promise<CountryCode>;

查询当前的国家码。

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

返回值

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

错误码

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

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
import BusinessError from "@ohos.base";
try {
    geoLocationManager.getCountryCode()
    .then((result) => {
        console.log('promise, getCountryCode: result=' + JSON.stringify(result));
    })
    .catch((error:number) => {
        console.log('promise, getCountryCode: error=' + JSON.stringify(error));
    });
} catch (err) {
    console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message);
}

geoLocationManager.enableLocationMock

enableLocationMock(): void;

使能位置模拟功能。

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

系统API:此接口为系统接口。

错误码

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

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

示例

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

geoLocationManager.disableLocationMock

disableLocationMock(): void;

去使能位置模拟功能。

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

系统API:此接口为系统接口。

错误码

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

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

示例

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

geoLocationManager.setMockedLocations

setMockedLocations(config: LocationMockConfig): void;

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

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

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

系统API:此接口为系统接口。

参数

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

错误码

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

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

示例

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

geoLocationManager.enableReverseGeocodingMock

enableReverseGeocodingMock(): void;

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

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

系统API:此接口为系统接口。

错误码

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

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

示例

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

geoLocationManager.disableReverseGeocodingMock

disableReverseGeocodingMock(): void;

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

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

系统API:此接口为系统接口。

错误码

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

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

示例

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

geoLocationManager.setReverseGeocodingMockInfo

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

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

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

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

系统API:此接口为系统接口。

参数

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

错误码

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

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

示例

import geoLocationManager from '@ohos.geoLocationManager';
import BusinessError from "@ohos.base";
let mockInfos:Array<geoLocationManager.ReverseGeocodingMockInfo> = [
    {"location": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "isFromMock": true}},
    {"location": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "isFromMock": true}},
    {"location": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "isFromMock": true}},
    {"location": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "isFromMock": true}},
    {"location": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "isFromMock": true}},
];
try {
    geoLocationManager.enableReverseGeocodingMock();
    geoLocationManager.setReverseGeocodingMockInfo(mockInfos);
} catch (err) {
    console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message);
}

geoLocationManager.isLocationPrivacyConfirmed

isLocationPrivacyConfirmed(type: LocationPrivacyType): boolean;

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

系统API:此接口为系统接口。

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

参数

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

返回值

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

错误码

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

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

示例

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

geoLocationManager.setLocationPrivacyConfirmStatus

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

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

系统API:此接口为系统接口。

需要权限:ohos.permission.MANAGE_SECURE_SETTINGS

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

参数

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

错误码

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

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

示例

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

geoLocationManager.getLocatingRequiredData10+

getLocatingRequiredData(config: LocatingRequiredDataConfig): Promise<Array<LocatingRequiredData>>;

单次获取定位业务所需数据,包含WiFi蓝牙扫描信息,使用Promise方式异步返回结果。

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

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

系统API:此接口为系统接口。

参数

参数名类型必填说明
configLocatingRequiredDataConfig表示获取定位所需数据时的配置参数。

返回值

参数名类型必填说明
Promise<Array<LocatingRequiredData>>LocatingRequiredDataNA用来接收定位业务所需数据,包含WiFi蓝牙扫描信息。

错误码

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

错误码ID错误信息
3301800Failed to start WiFi or Bluetooth scanning.

示例

import geoLocationManager from '@ohos.geoLocationManager';
import BusinessError from "@ohos.base";
let config:geoLocationManager.LocatingRequiredDataConfig = {'type': 1, 'needStartScan': true, 'scanInterval': 10000};
try {
    geoLocationManager.getLocatingRequiredData(config).then((result) => {
        console.log('getLocatingRequiredData return: ' + JSON.stringify(result));
    })  
    .catch((error:number) => {
        console.log('promise, getLocatingRequiredData: error=' + JSON.stringify(error));
    });
} catch (err) {
    console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message);
}

你可能感兴趣的鸿蒙文章

harmony 鸿蒙接口

harmony 鸿蒙系统公共事件定义(待停用)

harmony 鸿蒙系统公共事件定义

harmony 鸿蒙开发说明

harmony 鸿蒙企业设备管理概述(仅对系统应用开放)

harmony 鸿蒙BundleStatusCallback

harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager模块)

harmony 鸿蒙@ohos.distributedBundle (分布式包管理)

harmony 鸿蒙@ohos.bundle (Bundle模块)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)

  • 所属分类: 后端技术
  • 本文标签: 软件 鸿蒙
  • 版权声明: 本文链接 https://seaxiang.com/blog/6309e1a9fb394f86994384f10a9504fb