# 位置服务 位置服务提供GNSS定位、网络定位、地理编码、逆地理编码、国家码和地理围栏等基本功能。 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 ## 导入模块 ```ts import geolocation from '@ohos.geolocation'; ``` ## geolocation.on('locationChange') on(type: 'locationChange', request: LocationRequest, callback: Callback<Location>): void 开启位置变化订阅，并发起定位请求。定位结果按照[LocationRequest](#locationrequest)的属性进行上报， **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 设置事件类型。type为“locationChange”，表示位置变化。 | | request | [LocationRequest](#locationrequest) | 是 | 设置位置请求参数。 | | callback | Callback<[Location](#location)> | 是 | 接收位置变化状态变化监听。 | **示例** ```ts 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 **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 设置事件类型。type为“locationChange”，表示位置变化。 | | callback | Callback<[Location](#location)> | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 | **示例** ```ts 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 **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 设置事件类型。type为“locationServiceState”，表示位置服务状态。 | | callback | Callback<boolean> | 是 | 接收位置服务状态变化监听。 | **示例** ```ts 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 **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 设置事件类型。type为“locationServiceState”，表示位置服务状态。 | | callback | Callback<boolean> | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 | **示例** ```ts 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('cachedGnssLocationsReporting')8+ on(type: 'cachedGnssLocationsReporting', request: CachedGnssLocationsRequest, callback: Callback<Array<Location>>): void; 订阅缓存GNSS定位结果上报事件。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Gnss **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 设置事件类型。type为“cachedGnssLocationsReporting”，表示GNSS缓存定位结果上报。 | | request | [CachedGnssLocationsRequest](#cachedgnsslocationsrequest) | 是 | GNSS缓存功能配置参数 | | callback | Callback<boolean> | 是 | 接收GNSS缓存位置上报。 | **示例** ```ts import geolocation from '@ohos.geolocation'; var cachedLocationsCb = (locations) => { console.log('cachedGnssLocationsReporting: locations: ' + JSON.stringify(locations)); } var requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true}; geolocation.on('cachedGnssLocationsReporting', requestInfo, cachedLocationsCb); ``` ## geolocation.off('cachedGnssLocationsReporting')8+ off(type: 'cachedGnssLocationsReporting', callback?: Callback<Array<Location>>): void; 取消订阅缓存GNSS定位结果上报事件。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Gnss **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 设置事件类型。type为“cachedGnssLocationsReporting”，表示GNSS缓存定位结果上报。 | | callback | Callback<boolean> | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 | **示例** ```ts import geolocation from '@ohos.geolocation'; var cachedLocationsCb = (locations) => { console.log('cachedGnssLocationsReporting: locations: ' + JSON.stringify(locations)); } var requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true}; geolocation.on('cachedGnssLocationsReporting', requestInfo, cachedLocationsCb); geolocation.off('cachedGnssLocationsReporting'); ``` ## geolocation.on('gnssStatusChange')8+ on(type: 'gnssStatusChange', callback: Callback<SatelliteStatusInfo>): void; 订阅GNSS卫星状态信息上报事件。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Gnss **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 设置事件类型。type为“gnssStatusChange”，表示订阅GNSS卫星状态信息上报。 | | callback | Callback<[SatelliteStatusInfo](#satellitestatusinfo)> | 是 | 接收GNSS卫星状态信息上报。 | **示例** ```ts import geolocation from '@ohos.geolocation'; var gnssStatusCb = (satelliteStatusInfo) => { console.log('gnssStatusChange: ' + JSON.stringify(satelliteStatusInfo)); } geolocation.on('gnssStatusChange', gnssStatusCb); ``` ## geolocation.off('gnssStatusChange')8+ off(type: 'gnssStatusChange', callback?: Callback<SatelliteStatusInfo>): void; 取消订阅GNSS卫星状态信息上报事件。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Gnss **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 设置事件类型。type为“gnssStatusChange”，表示订阅GNSS卫星状态信息上报。 | | callback | Callback<[SatelliteStatusInfo](#satellitestatusinfo)> | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 | **示例** ```ts 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')8+ on(type: 'nmeaMessageChange', callback: Callback<string>): void; 订阅GNSS NMEA信息上报事件。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Gnss **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 设置事件类型。type为“nmeaMessageChange”，表示订阅GNSS NMEA信息上报。 | | callback | Callback<string> | 是 | 接收GNSS NMEA信息上报。 | **示例** ```ts import geolocation from '@ohos.geolocation'; var nmeaCb = (str) => { console.log('nmeaMessageChange: ' + JSON.stringify(str)); } geolocation.on('nmeaMessageChange', nmeaCb ); ``` ## geolocation.off('nmeaMessageChange')8+ off(type: 'nmeaMessageChange', callback?: Callback<string>): void; 取消订阅GNSS NMEA信息上报事件。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Gnss **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 设置事件类型。type为“nmeaMessageChange”，表示订阅GNSS NMEA信息上报。 | | callback | Callback<string> | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 | **示例** ```ts import geolocation from '@ohos.geolocation'; var nmeaCb = (str) => { console.log('nmeaMessageChange: ' + JSON.stringify(str)); } geolocation.on('nmeaMessageChange', nmeaCb); geolocation.off('nmeaMessageChange', nmeaCb); ``` ## geolocation.on('fenceStatusChange')8+ on(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void; 添加一个围栏，并订阅地理围栏事件。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geofence **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 设置事件类型。type为“fenceStatusChange”，表示订阅围栏事件上报。 | | request | [GeofenceRequest](#geofencerequest) | 是 | 围栏的配置参数。 | | want | WantAgent | 是 | 用于接收地理围栏事件上报（进出围栏）。 | **示例** ```ts import geolocation from '@ohos.geolocation'; import wantAgent from '@ohos.wantAgent'; let wantAgentInfo = { wants: [ { bundleName: "com.example.myapplication", abilityName: "com.example.myapplication.MainAbility", action: "action1", } ], operationType: wantAgent.OperationType.START_ABILITY, requestCode: 0, wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG], }; wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { var requestInfo = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}}; geolocation.on('fenceStatusChange', requestInfo, wantAgentObj); }); ``` ## geolocation.off('fenceStatusChange')8+ off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void; 删除一个围栏，并取消订阅该围栏事件。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geofence **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 设置事件类型。type为“fenceStatusChange”，表示订阅围栏事件上报。 | | request | [GeofenceRequest](#geofencerequest) | 是 | 围栏的配置参数。 | | want | WantAgent | 是 | 用于接收地理围栏事件上报（进出围栏）。 | **示例** ```ts import geolocation from '@ohos.geolocation'; import wantAgent from '@ohos.wantAgent'; let wantAgentInfo = { wants: [ { bundleName: "com.example.myapplication", abilityName: "com.example.myapplication.MainAbility", action: "action1", } ], operationType: wantAgent.OperationType.START_ABILITY, requestCode: 0, wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] }; wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { var requestInfo = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}}; geolocation.on('fenceStatusChange', requestInfo, wantAgentObj); geolocation.off('fenceStatusChange', requestInfo, wantAgentObj); }); ``` ## geolocation.getCurrentLocation getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback<Location>): void 获取当前位置，使用callback回调异步返回结果。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | request | [CurrentLocationRequest](#currentlocationrequest) | 否 | 设置位置请求参数。 | | callback | AsyncCallback<[Location](#location)> | 是 | 用来接收位置信息的回调。 | **示例** ```ts 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(locationChange); ``` ## geolocation.getCurrentLocation getCurrentLocation(request?: CurrentLocationRequest): Promise<Location> 获取当前位置，使用Promise方式异步返回结果。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | request | [CurrentLocationRequest](#currentlocationrequest) | 否 | 设置位置请求参数。 | **返回值**： | 参数名 | 说明 | | -------- | -------- | | Promise<[Location](#location)> | 返回位置信息。 | **示例** ```ts 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 **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | callback | AsyncCallback<[Location](#location)> | 是 | 用来接收上次位置的回调。 | **示例** ```ts 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 **返回值**： | 参数名 | 说明 | | -------- | -------- | | Promise<[Location](#location)> | 返回上次位置信息。 | **示例** ```ts 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 **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | callback | AsyncCallback<boolean> | 是 | 用来接收位置服务状态的回调。 | **示例** ```ts 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 **返回值**： | 参数名 | 说明 | | -------- | -------- | | Promise<boolean> | 返回位置服务是否可用的状态。 | **示例** ```ts import geolocation from '@ohos.geolocation'; geolocation.isLocationEnabled().then((result) => { console.log('promise, isLocationEnabled: ' + JSON.stringify(result)); }); ``` ## geolocation.requestEnableLocation requestEnableLocation(callback: AsyncCallback<boolean>): void 请求打开位置服务，使用callback回调异步返回结果。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | callback | AsyncCallback<boolean> | 是 | 用来接收位置服务状态的回调。 | **示例** ```ts import geolocation from '@ohos.geolocation'; geolocation.requestEnableLocation((err, data) => { if (err) { console.log('requestEnableLocation: err=' + JSON.stringify(err)); } if (data) { console.log('requestEnableLocation: data=' + JSON.stringify(data)); } }); ``` ## geolocation.requestEnableLocation requestEnableLocation(): Promise<boolean> 请求打开位置服务，使用Promise方式异步返回结果。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core **返回值**： | 参数名 | 说明 | | -------- | -------- | | Promise<boolean> | 返回位置服务是否可用。 | **示例** ```ts import geolocation from '@ohos.geolocation'; geolocation.requestEnableLocation().then((result) => { console.log('promise, requestEnableLocation: ' + JSON.stringify(result)); }); ``` ## geolocation.enableLocation enableLocation(callback: AsyncCallback<boolean>): void; 打开位置服务，使用callback回调异步返回结果。 **系统API**：此接口为系统接口，三方应用不支持调用。 **需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS **系统能力**：SystemCapability.Location.Location.Core **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | callback | AsyncCallback<boolean> | 是 | 用来接收位置服务状态的回调。 | **示例** ```ts import geolocation from '@ohos.geolocation'; geolocation.enableLocation((err, data) => { if (err) { console.log('enableLocation: err=' + JSON.stringify(err)); } if (data) { console.log('enableLocation: data=' + JSON.stringify(data)); } }); ``` ## geolocation.enableLocation enableLocation(): Promise<boolean> 打开位置服务，使用Promise方式异步返回结果。 **系统API**：此接口为系统接口，三方应用不支持调用。 **需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS **系统能力**：SystemCapability.Location.Location.Core **返回值**： | 参数名 | 说明 | | -------- | -------- | | Promise<boolean> | 返回位置服务是否可用。 | **示例** ```ts import geolocation from '@ohos.geolocation'; geolocation.enableLocation().then((result) => { console.log('promise, enableLocation: ' + JSON.stringify(result)); }); ``` ## geolocation.disableLocation disableLocation(callback: AsyncCallback<boolean>): void; 关闭位置服务，使用callback回调异步返回结果。 **系统API**：此接口为系统接口，三方应用不支持调用。 **需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS **系统能力**：SystemCapability.Location.Location.Core **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | callback | AsyncCallback<boolean> | 是 | 用来接收位置服务状态的回调。 | **示例** ```ts import geolocation from '@ohos.geolocation'; geolocation.disableLocation((err, data) => { if (err) { console.log('disableLocation: err=' + JSON.stringify(err)); } if (data) { console.log('disableLocation: data=' + JSON.stringify(data)); } }); ``` ## geolocation.disableLocation disableLocation(): Promise<boolean> 关闭位置服务，使用Promise方式异步返回结果。 **系统API**：此接口为系统接口，三方应用不支持调用。 **需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS **系统能力**：SystemCapability.Location.Location.Core **返回值**： | 参数名 | 说明 | | -------- | -------- | | Promise<boolean> | 返回位置服务是否可用。 | **示例** ```ts import geolocation from '@ohos.geolocation'; geolocation.disableLocation().then((result) => { console.log('promise, disableLocation: ' + JSON.stringify(result)); }); ``` ## geolocation.isGeoServiceAvailable isGeoServiceAvailable(callback: AsyncCallback<boolean>): void 判断（逆）地理编码服务状态，使用callback回调异步返回结果。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geocoder **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | callback | AsyncCallback<boolean> | 是 | 用来接收地理编码服务状态的回调。 | **示例** ```ts import geolocation from '@ohos.geolocation'; geolocation.isGeoServiceAvailable((err, data) => { if (err) { console.log('isGeoServiceAvailable: err=' + JSON.stringify(err)); } if (data) { console.log('isGeoServiceAvailable: data=' + JSON.stringify(data)); } }); ``` ## geolocation.isGeoServiceAvailable isGeoServiceAvailable(): Promise<boolean> 判断（逆）地理编码服务状态，使用Promise方式异步返回结果。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geocoder **返回值**： | 参数名 | 说明 | | -------- | -------- | | Promise<boolean> | 返回地理编码服务是否可用的状态。 | **示例** ```ts import geolocation from '@ohos.geolocation'; geolocation.isGeoServiceAvailable().then((result) => { console.log('promise, isGeoServiceAvailable: ' + JSON.stringify(result)); }); ``` ## geolocation.getAddressesFromLocation getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void 调用逆地理编码服务，将坐标转换为地理描述，使用callback回调异步返回结果。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geocoder **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | request | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 设置逆地理编码请求的相关参数。 | | callback | AsyncCallback<Array<[GeoAddress](#geoaddress)>> | 是 | 设置接收逆地理编码请求的回调参数。 | **示例** ```ts import geolocation from '@ohos.geolocation'; var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; geolocation.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => { if (err) { console.log('getAddressesFromLocation: err=' + JSON.stringify(err)); } if (data) { console.log('getAddressesFromLocation: data=' + JSON.stringify(data)); } }); ``` ## geolocation.getAddressesFromLocation getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise<Array<GeoAddress>>; 调用逆地理编码服务，将坐标转换为地理描述，使用Promise方式异步返回结果。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geocoder **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | request | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 设置逆地理编码请求的相关参数。 | **返回值**： | 参数名 | 说明 | | -------- | -------- | | Promise<Array<[GeoAddress](#geoaddress)>> | 返回地理描述信息。 | **示例** ```ts import geolocation from '@ohos.geolocation'; var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; geolocation.getAddressesFromLocation(reverseGeocodeRequest).then((data) => { console.log('getAddressesFromLocation: ' + JSON.stringify(data)); }); ``` ## geolocation.getAddressesFromLocationName getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void 调用地理编码服务，将地理描述转换为具体坐标，使用callback回调异步返回结果。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geocoder **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | request | [GeoCodeRequest](#geocoderequest) | 是 | 设置地理编码请求的相关参数。 | | callback | AsyncCallback<Array<[GeoAddress](#geoaddress)>> | 是 | 设置接收地理编码请求的回调参数。 | **示例** ```ts import geolocation from '@ohos.geolocation'; var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1}; geolocation.getAddressesFromLocationName(geocodeRequest, (err, data) => { if (err) { console.log('getAddressesFromLocationName: err=' + JSON.stringify(err)); } if (data) { console.log('getAddressesFromLocationName: data=' + JSON.stringify(data)); } }); ``` ## geolocation.getAddressesFromLocationName getAddressesFromLocationName(request: GeoCodeRequest): Promise<Array<GeoAddress>> 调用地理编码服务，将地理描述转换为具体坐标，使用Promise方式异步返回结果。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geocoder **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | request | [GeoCodeRequest](#geocoderequest) | 是 | 设置地理编码请求的相关参数。 | **返回值**： | 参数名 | 说明 | | -------- | -------- | | Promise<Array<[GeoAddress](#geoaddress)>> | 设置接收地理编码请求的回调参数。 | **示例** ```ts import geolocation from '@ohos.geolocation'; var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1}; geolocation.getAddressesFromLocationName(geocodeRequest).then((result) => { console.log('getAddressesFromLocationName: ' + JSON.stringify(result)); }); ``` ## geolocation.getCachedGnssLocationsSize8+ getCachedGnssLocationsSize(callback: AsyncCallback<number>): void; 获取GNSS芯片缓存位置的个数。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Gnss **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | callback | AsyncCallback<number> | 是 | 用来接收GNSS芯片缓存位置个数的回调。 | **示例** ```ts import geolocation from '@ohos.geolocation'; geolocation.getCachedGnssLocationsSize((err, size) => { if (err) { console.log('getCachedGnssLocationsSize: err=' + JSON.stringify(err)); } if (size) { console.log('getCachedGnssLocationsSize: size=' + JSON.stringify(size)); } }); ``` ## geolocation.getCachedGnssLocationsSize8+ getCachedGnssLocationsSize(): Promise<number>; 获取GNSS芯片缓存位置的个数。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Gnss **返回值**： | 参数名 | 说明 | | -------- | -------- | | Promise<number> | 返回GNSS缓存位置的个数。 | **示例** ```ts import geolocation from '@ohos.geolocation'; geolocation.getCachedGnssLocationsSize().then((result) => { console.log('promise, getCachedGnssLocationsSize: ' + JSON.stringify(result)); }); ``` ## geolocation.flushCachedGnssLocations8+ flushCachedGnssLocations(callback: AsyncCallback<boolean>): void; 读取并清空GNSS芯片所有缓存位置。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Gnss **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | callback | AsyncCallback<boolean> | 是 | 用来接收清空GNSS芯片缓存位置操作的结果。 | **示例** ```ts import geolocation from '@ohos.geolocation'; geolocation.flushCachedGnssLocations((err, result) => { if (err) { console.log('flushCachedGnssLocations: err=' + JSON.stringify(err)); } if (result) { console.log('flushCachedGnssLocations: result=' + JSON.stringify(result)); } }); ``` ## geolocation.flushCachedGnssLocations8+ flushCachedGnssLocations(): Promise<boolean>; 读取并清空GNSS芯片所有缓存位置。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Gnss **返回值**： | 参数名 | 说明 | | -------- | -------- | | Promise<boolean> | 清空所有GNSS缓存位置是否成功。 | **示例** ```ts import geolocation from '@ohos.geolocation'; geolocation.flushCachedGnssLocations().then((result) => { console.log('promise, flushCachedGnssLocations: ' + JSON.stringify(result)); }); ``` ## geolocation.sendCommand8+ sendCommand(command: LocationCommand, callback: AsyncCallback<boolean>): void; 给位置服务子系统的各个部件发送扩展命令。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | command | [LocationCommand](#locationcommand) | 是 | 指定目标场景，和将要发送的命令（字符串）。 | | callback | AsyncCallback<boolean> | 是 | 用来接收命令发送的结果。 | **示例** ```ts import geolocation from '@ohos.geolocation'; var requestInfo = {'scenario': 0x301, 'command': "command_1"}; geolocation.sendCommand(requestInfo, (err, result) => { if (err) { console.log('sendCommand: err=' + JSON.stringify(err)); } if (result) { console.log('sendCommand: result=' + JSON.stringify(result)); } }); ``` ## geolocation.sendCommand8+ sendCommand(command: LocationCommand): Promise<boolean>; 给位置服务子系统的各个部件发送扩展命令。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | command | [LocationCommand](#locationcommand) | 是 | 指定目标场景，和将要发送的命令（字符串）。 | **返回值**： | 参数名 | 说明 | | -------- | -------- | | Promise<boolean> | 表示命令发送成功或失败。 | **示例** ```ts import geolocation from '@ohos.geolocation'; var requestInfo = {'scenario': 0x301, 'command': "command_1"}; geolocation.sendCommand(requestInfo).then((result) => { console.log('promise, sendCommand: ' + JSON.stringify(result)); }); ``` ## LocationRequestPriority 位置请求中位置信息优先级设置。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core | 名称 | 默认值 | 说明 | | -------- | -------- | -------- | | UNSET | 0x200 | 表示未设置优先级。 | | ACCURACY | 0x201 | 表示精度优先。 | | LOW_POWER | 0x202 | 表示低功耗优先。 | | FIRST_FIX | 0x203 | 表示快速获取位置优先，如果应用希望快速拿到1个位置，可以将优先级设置为该字段。 | ## LocationRequestScenario 位置请求中定位场景设置。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core | 名称 | 默认值 | 说明 | | -------- | -------- | -------- | | UNSET | 0x300 | 表示未设置场景信息。 | | NAVIGATION | 0x301 | 表示导航场景。 | | TRAJECTORY_TRACKING | 0x302 | 表示运动轨迹记录场景。 | | CAR_HAILING | 0x303 | 表示打车场景。 | | DAILY_LIFE_SERVICE | 0x304 | 表示日常服务使用场景。 | | NO_POWER | 0x305 | 表示无功耗功场景，这种场景下不会主动触发定位，会在其他应用定位时，才给当前应用返回位置。 | ## GeoLocationErrorCode 位置服务中的错误码信息。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core | 名称 | 默认值 | 说明 | | -------- | -------- | -------- | | INPUT_PARAMS_ERROR7+ | 101 | 表示输入参数错误。 | | REVERSE_GEOCODE_ERROR7+ | 102 | 表示逆地理编码接口调用失败。 | | GEOCODE_ERROR7+ | 103 | 表示地理编码接口调用失败。 | | LOCATOR_ERROR7+ | 104 | 表示定位失败。 | | LOCATION_SWITCH_ERROR7+ | 105 | 表示定位开关。 | | LAST_KNOWN_LOCATION_ERROR7+ | 106 | 表示获取上次位置失败。 | | LOCATION_REQUEST_TIMEOUT_ERROR7+ | 107 | 表示单次定位，没有在指定时间内返回位置。 | ## ReverseGeoCodeRequest 逆地理编码请求接口。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geocoder | 名称 | 参数类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | locale | string | 否 | 指定位置描述信息的语言，“zh”代表中文，“en”代表英文。 | | latitude | number | 是 | 表示纬度信息，正值表示北纬，负值表示南纬。 | | longitude | number | 是 | 表示经度信息，正值表示东经，负值表示西经。 | | maxItems | number | 否 | 指定返回位置信息的最大个数。 | ## GeoCodeRequest 地理编码请求接口。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geocoder | 名称 | 参数类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | locale | string | 否 | 表示位置描述信息的语言，“zh”代表中文，“en”代表英文。 | | description | number | 是 | 表示位置信息描述，如“上海市浦东新区xx路xx号”。 | | maxItems | number | 否 | 表示返回位置信息的最大个数。 | | minLatitude | number | 否 | 表示最小纬度信息，与下面三个参数一起，表示一个经纬度范围。 | | minLongitude | number | 否 | 表示最小经度信息。 | | maxLatitude | number | 否 | 表示最大纬度信息。 | | maxLongitude | number | 否 | 表示最大经度信息。 | ## GeoAddress 地理编码类型。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geocoder | 名称 | 参数类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | latitude7+ | number | 否 | 表示纬度信息，正值表示北纬，负值表示南纬。 | | longitude7+ | number | 否 | 表示经度信息，正值表示东经，负值表是西经。 | | locale7+ | string | 否 | 表示位置描述信息的语言，“zh”代表中文，“en”代表英文。 | | placeName7+ | string | 否 | 表示地区信息。 | | countryCode7+ | string | 否 | 表示国家码信息。 | | countryName7+ | string | 否 | 表示国家信息。 | | administrativeArea7+ | string | 否 | 表示省份区域信息。 | | subAdministrativeArea7+ | string | 否 | 表示表示子区域信息。 | | locality7+ | string | 否 | 表示城市信息。 | | subLocality7+ | string | 否 | 表示子城市信息。 | | roadName7+ | string | 否 | 表示路名信息。 | | subRoadName7+ | string | 否 | 表示子路名信息。 | | premises7+ | string | 否 | 表示门牌号信息。 | | postalCode7+ | string | 否 | 表示邮政编码信息。 | | phoneNumber7+ | string | 否 | 表示联系方式信息。 | | addressUrl7+ | string | 否 | 表示位置信息附件的网址信息。 | | descriptions7+ | Array<string> | 否 | 表示附加的描述信息。 | | descriptionsSize7+ | number | 否 | 表示附加的描述信息数量。 | ## LocationRequest 位置信息请求类型。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core | 名称 | 参数类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | priority | [LocationRequestPriority](#locationrequestpriority) | 否 | 表示优先级信息。 | | scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 表示场景信息。 | | timeInterval | number | 否 | 表示上报位置信息的时间间隔。 | | distanceInterval | number | 否 | 表示上报位置信息的距离间隔。 | | maxAccuracy | number | 否 | 表示精度信息。仅在精确位置功能场景下有效，模糊位置功能生效场景下该字段无意义。 | ## CurrentLocationRequest 当前位置信息请求类型。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core | 名称 | 参数类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | priority | [LocationRequestPriority](#locationrequestpriority) | 否 | 表示优先级信息。 | | scenario | [LocationRequestScenario](#locationrequestscenario) | 否 | 表示场景信息。 | | maxAccuracy | number | 否 | 表示精度信息，单位是米。仅在精确位置功能场景下有效，模糊位置功能生效场景下该字段无意义。 | | timeoutMs | number | 否 | 表示超时时间，单位是毫秒，最小为1000毫秒。 | ## SatelliteStatusInfo8+ 卫星状态信息。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Gnss | 名称 | 参数类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | satellitesNumber | number | 是 | 表示卫星个数。 | | satelliteIds | Array<number> | 是 | 表示每个卫星的ID，数组类型。 | | carrierToNoiseDensitys | Array<number> | 是 | 表示载波噪声功率谱密度比，即cn0。 | | altitudes | Array<number> | 是 | 表示高程信息。 | | azimuths | Array<number> | 是 | 表示方位角。 | | carrierFrequencies | Array<number> | 是 | 表示载波频率。 | ## CachedGnssLocationsRequest8+ 请求订阅GNSS缓存位置上报功能接口的配置参数。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Gnss | 名称 | 参数类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | reportingPeriodSec | number | 是 | 表示GNSS缓存位置上报的周期，单位是毫秒。 | | wakeUpCacheQueueFull | boolean | 是 | true表示GNSS芯片底层缓存队列满之后会主动唤醒AP芯片，并把缓存位置上报给应用。
false表示GNSS芯片底层缓存队列满之后不会主动唤醒AP芯片，会把缓存位置直接丢弃。 | ## Geofence8+ GNSS围栏的配置参数。目前只支持圆形围栏。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geofence | 名称 | 参数类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | latitude | number | 是 | 表示纬度。 | | longitude | number | 是 | 表示经度。 | | radius | number | 是 | 表示圆形围栏的半径。 | | expiration | number | 是 | 围栏存活的时间，单位是毫秒。 | ## GeofenceRequest8+ 请求添加GNSS围栏消息中携带的参数，包括定位优先级、定位场景和围栏信息。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geofence | 名称 | 参数类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | priority | [LocationRequestPriority](#locationrequestpriority) | 是 | 表示位置信息优先级。 | | scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 表示定位场景。 | | geofence | [Geofence](#geofence)| 是 | 表示围栏信息。 | ## LocationPrivacyType8+ 定位服务隐私协议类型。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core | 名称 | 默认值 | 说明 | | -------- | -------- | -------- | | OTHERS | 0 | 其他场景。 | | STARTUP | 1 | 开机向导场景下的隐私协议。 | | CORE_LOCATION | 2 | 开启网络定位时弹出的隐私协议。 | ## LocationCommand8+ 扩展命令结构体。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core | 名称 | 参数类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 表示定位场景。 | | command | string | 是 | 扩展命令字符串。 | ## Location 位置信息类型。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core | 名称 | 参数类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | latitude7+ | number | 是 | 表示纬度信息，正值表示北纬，负值表示南纬。 | | longitude7+ | number | 是 | 表示经度信息，正值表示东经，负值表是西经。 | | altitude7+ | number | 是 | 表示高度信息，单位米。 | | accuracy7+ | number | 是 | 表示精度信息，单位米。 | | speed7+ | number | 是 | 表示速度信息，单位米每秒。 | | timeStamp7+ | number | 是 | 表示位置时间戳，UTC格式。 | | direction7+ | number | 是 | 表示航向信息。 | | timeSinceBoot7+ | number | 是 | 表示位置时间戳，开机时间格式。 | | additions7+ | Array<string> | 否 | 附加信息。 | | additionSize7+ | number | 否 | 附加信息数量。 |