HarmonyOS API：@ohos.geolocation (位置服务)

版本：v3.1 Beta

@ohos.geolocation (位置服务)

更新时间: 2023-02-17 09:19

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

说明

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

申请权限

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

系统提供的定位权限有：

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

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

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

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

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

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

导入模块

import geolocation from '@ohos.geolocation';

geolocation.on('locationChange')

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

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

需要权限：ohos.permission.LOCATION

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

参数：

示例

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

geolocation.off('locationChange')

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

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

需要权限：ohos.permission.LOCATION

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

参数：

示例

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

geolocation.on('locationServiceState')

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

订阅位置服务状态变化。

需要权限：ohos.permission.LOCATION

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

参数：

示例

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

geolocation.off('locationServiceState')

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

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

需要权限：ohos.permission.LOCATION

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

参数：

示例

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

geolocation.on('gnssStatusChange')⁸⁺

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

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

需要权限：ohos.permission.LOCATION

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

参数：

示例

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

geolocation.off('gnssStatusChange')⁸⁺

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

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

需要权限：ohos.permission.LOCATION

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

参数：

示例

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

geolocation.on('nmeaMessageChange')⁸⁺

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

订阅GNSS NMEA信息上报事件。

需要权限：ohos.permission.LOCATION

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

参数：

示例

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

geolocation.off('nmeaMessageChange')⁸⁺

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

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

需要权限：ohos.permission.LOCATION

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

参数：

示例

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

geolocation.getCurrentLocation

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

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

需要权限：ohos.permission.LOCATION

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

参数：

示例

import geolocation from '@ohos.geolocation';
var requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0};
var locationChange = (err, location) => {
    if (err) {
        console.log('locationChanger: err=' + JSON.stringify(err));
    }
    if (location) {
        console.log('locationChanger: location=' + JSON.stringify(location));
    }
};
geolocation.getCurrentLocation(requestInfo, locationChange);

geolocation.getCurrentLocation

getCurrentLocation(callback: AsyncCallback<Location>): void

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

需要权限：ohos.permission.LOCATION

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

参数：

示例

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

geolocation.getCurrentLocation

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

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

需要权限：ohos.permission.LOCATION

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

参数：

返回值：

示例

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

geolocation.getLastLocation

getLastLocation(callback: AsyncCallback<Location>): void

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

需要权限：ohos.permission.LOCATION

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

参数：

示例

import geolocation from '@ohos.geolocation';
geolocation.getLastLocation((err, data) => {
    if (err) {
        console.log('getLastLocation: err=' + JSON.stringify(err));
    }
    if (data) {
        console.log('getLastLocation: data=' + JSON.stringify(data));
    }
});

geolocation.getLastLocation

getLastLocation(): Promise<Location>

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

需要权限：ohos.permission.LOCATION

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

返回值：

示例

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

geolocation.isLocationEnabled

isLocationEnabled(callback: AsyncCallback<boolean>): void

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

需要权限：ohos.permission.LOCATION

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

参数：

示例

import geolocation from '@ohos.geolocation';
geolocation.isLocationEnabled((err, data) => {
    if (err) {
        console.log('isLocationEnabled: err=' + JSON.stringify(err));
    }
    if (data) {
        console.log('isLocationEnabled: data=' + JSON.stringify(data));
    }
});

geolocation.isLocationEnabled

isLocationEnabled(): Promise<boolean>

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

需要权限：ohos.permission.LOCATION

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

返回值：

示例

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

LocationRequestPriority

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

需要权限：ohos.permission.LOCATION

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

LocationRequestScenario

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

需要权限：ohos.permission.LOCATION

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

GeoLocationErrorCode

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

需要权限：ohos.permission.LOCATION

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

LocationRequest

位置信息请求类型。

需要权限：ohos.permission.LOCATION

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

CurrentLocationRequest

当前位置信息请求类型。

需要权限：ohos.permission.LOCATION

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

SatelliteStatusInfo⁸⁺

卫星状态信息。

需要权限：ohos.permission.LOCATION

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

Location

位置信息类型。

需要权限：ohos.permission.LOCATION

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

文章转载自：​​https://developer.harmonyos.com/cn/docs/documentation/doc-references-V3/js-apis-geolocation-0000001477981493-V3?catalogVersion=V3#ZH-CN_TOPIC_0000001477981493__申请权限​​