提交 9ed79a44 编写于 作者: L liu-binjun

bugfix:Document delivery of error code requirements

Signed-off-by: Nliu-binjun <liubinjun@huawei.com>
上级 9f610cea
...@@ -13,11 +13,692 @@ import geoLocationManager from '@ohos.geoLocationManager'; ...@@ -13,11 +13,692 @@ import geoLocationManager from '@ohos.geoLocationManager';
``` ```
## geoLocationManager.on('locationChange')
on(type: 'locationChange', request: LocationRequest, callback: Callback&lt;Location&gt;): void
开启位置变化订阅,并发起定位请求。定位结果按照[LocationRequest](#locationrequest)的属性进行上报,
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.on(type: 'locationChange', request: LocationRequest, callback: Callback&lt;Location&gt;): void<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“locationChange”,表示位置变化。 |
| request | [LocationRequest](#locationrequest) | 是 | 设置位置请求参数。 |
| callback | Callback&lt;[Location](#location)&gt; | 是 | 接收位置变化状态变化监听。 |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
var requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
var locationChange = (location) => {
console.log('locationChanger: data: ' + JSON.stringify(location));
};
geoLocationManager.on('locationChange', requestInfo, locationChange);
```
## geoLocationManager.off('locationChange')
off(type: 'locationChange', callback?: Callback&lt;Location&gt;): void
关闭位置变化订阅,并删除对应的定位请求。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.off(type: 'locationChange', callback?: Callback&lt;Location&gt;): void<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“locationChange”,表示位置变化。 |
| callback | Callback&lt;[Location](#location)&gt; | 否 | 需要取消订阅的回调函数。若无此参数,则取消当前类型的所有订阅。 |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
var requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
var locationChange = (location) => {
console.log('locationChanger: data: ' + JSON.stringify(location));
};
geoLocationManager.on('locationChange', requestInfo, locationChange);
geoLocationManager.off('locationChange', locationChange);
```
## geoLocationManager.on('locationEnabledChange')
on(type: 'locationEnabledChange', callback: Callback&lt;boolean&gt;): void
订阅位置服务状态变化。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.on(type: 'locationEnabledChange', callback: Callback<boolean>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“locationEnabledChange”,表示位置服务状态。 |
| callback | Callback&lt;boolean&gt; | 是 | 接收位置服务状态变化监听。 |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
var locationEnabledChange = (state) => {
console.log('locationEnabledChange: ' + JSON.stringify(state));
}
geoLocationManager.on('locationEnabledChange', locationEnabledChange);
```
## geoLocationManager.off('locationEnabledChange')
off(type: 'locationEnabledChange', callback?: Callback&lt;boolean&gt;): void;
取消订阅位置服务状态变化。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.off(type: 'locationEnabledChange', callback: Callback<boolean>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“locationEnabledChange”,表示位置服务状态。 |
| callback | Callback&lt;boolean&gt; | 否 | 需要取消订阅的回调函数。若无此参数,则取消当前类型的所有订阅。 |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
var locationEnabledChange = (state) => {
console.log('locationEnabledChange: state: ' + JSON.stringify(state));
}
geoLocationManager.on('locationEnabledChange', locationEnabledChange);
geoLocationManager.off('locationEnabledChange', locationEnabledChange);
```
## geoLocationManager.on('cachedGnssLocationsChange')<sup>8+</sup>
on(type: 'cachedGnssLocationsChange', request: CachedGnssLocationsRequest, callback: Callback&lt;Array&lt;Location&gt;&gt;): void;
订阅缓存GNSS定位结果上报事件。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.on(type: 'cachedGnssLocationsChange', request: CachedGnssLocationsRequest, callback: Callback<Array<Location>>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“cachedGnssLocationsChange”,表示GNSS缓存定位结果上报。 |
| request | [CachedGnssLocationsRequest](#cachedgnsslocationsrequest) | 是 | GNSS缓存功能配置参数 |
| callback | Callback&lt;boolean&gt; | 是 | 接收GNSS缓存位置上报。 |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
var cachedLocationsCb = (locations) => {
console.log('cachedGnssLocationsChange: locations: ' + JSON.stringify(locations));
}
var requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true};
geoLocationManager.on('cachedGnssLocationsChange', requestInfo, cachedLocationsCb);
```
## geoLocationManager.off('cachedGnssLocationsChange')<sup>8+</sup>
off(type: 'cachedGnssLocationsChange', callback?: Callback&lt;Array&lt;Location&gt;&gt;): void;
取消订阅缓存GNSS定位结果上报事件。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.off(type: 'cachedGnssLocationsChange', callback?: Callback<Array<Location>>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“cachedGnssLocationsChange”,表示GNSS缓存定位结果上报。 |
| callback | Callback&lt;boolean&gt; | 否 | 需要取消订阅的回调函数。若无此参数,则取消当前类型的所有订阅。 |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
var cachedLocationsCb = (locations) => {
console.log('cachedGnssLocationsChange: locations: ' + JSON.stringify(locations));
}
var requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true};
geoLocationManager.on('cachedGnssLocationsChange', requestInfo, cachedLocationsCb);
geoLocationManager.off('cachedGnssLocationsChange');
```
## geoLocationManager.on('satelliteStatusChange')<sup>8+</sup>
on(type: 'satelliteStatusChange', callback: Callback&lt;SatelliteStatusInfo&gt;): void;
订阅GNSS卫星状态信息上报事件。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.on(type: 'satelliteStatusChange', callback: Callback<SatelliteStatusInfo>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“satelliteStatusChange”,表示订阅GNSS卫星状态信息上报。 |
| callback | Callback&lt;[SatelliteStatusInfo](#satellitestatusinfo)&gt; | 是 | 接收GNSS卫星状态信息上报。 |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
var gnssStatusCb = (satelliteStatusInfo) => {
console.log('satelliteStatusChange: ' + JSON.stringify(satelliteStatusInfo));
}
geoLocationManager.on('satelliteStatusChange', gnssStatusCb);
```
## geoLocationManager.off('satelliteStatusChange')<sup>8+</sup>
off(type: 'satelliteStatusChange', callback?: Callback&lt;SatelliteStatusInfo&gt;): void;
取消订阅GNSS卫星状态信息上报事件。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.off(type: 'satelliteStatusChange', callback?: Callback<SatelliteStatusInfo>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“satelliteStatusChange”,表示订阅GNSS卫星状态信息上报。 |
| callback | Callback&lt;[SatelliteStatusInfo](#satellitestatusinfo)&gt; | 否 | 需要取消订阅的回调函数。若无此参数,则取消当前类型的所有订阅。 |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
var gnssStatusCb = (satelliteStatusInfo) => {
console.log('satelliteStatusChange: ' + JSON.stringify(satelliteStatusInfo));
}
geoLocationManager.on('satelliteStatusChange', gnssStatusCb);
geoLocationManager.off('satelliteStatusChange', gnssStatusCb);
```
## geoLocationManager.on('nmeaMessage')<sup>8+</sup>
on(type: 'nmeaMessage', callback: Callback&lt;string&gt;): void;
订阅GNSS NMEA信息上报事件。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.on(type: 'nmeaMessage', callback: Callback<string>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“nmeaMessage”,表示订阅GNSS&nbsp;NMEA信息上报。 |
| callback | Callback&lt;string&gt; | 是 | 接收GNSS&nbsp;NMEA信息上报。 |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
var nmeaCb = (str) => {
console.log('nmeaMessage: ' + JSON.stringify(str));
}
geoLocationManager.on('nmeaMessage', nmeaCb );
```
## geoLocationManager.off('nmeaMessage')<sup>8+</sup>
off(type: 'nmeaMessage', callback?: Callback&lt;string&gt;): void;
取消订阅GNSS NMEA信息上报事件。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.off(type: 'nmeaMessage', callback?: Callback<string>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“nmeaMessage”,表示订阅GNSS&nbsp;NMEA信息上报。 |
| callback | Callback&lt;string&gt; | 否 | 需要取消订阅的回调函数。若无此参数,则取消当前类型的所有订阅。 |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
var nmeaCb = (str) => {
console.log('nmeaMessage: ' + JSON.stringify(str));
}
geoLocationManager.on('nmeaMessage', nmeaCb);
geoLocationManager.off('nmeaMessage', nmeaCb);
```
## geoLocationManager.on('gnssFenceStatusChange')<sup>8+</sup>
on(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void;
添加一个围栏,并订阅地理围栏事件。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.on(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geofence
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“gnssFenceStatusChange”,表示订阅围栏事件上报。 |
| request | [GeofenceRequest](#geofencerequest) | 是 | 围栏的配置参数。 |
| want | WantAgent | 是 | 用于接收地理围栏事件上报(进出围栏)。 |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
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}};
geoLocationManager.on('gnssFenceStatusChange', requestInfo, wantAgentObj);
});
```
## geoLocationManager.off('gnssFenceStatusChange')<sup>8+</sup>
off(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void;
删除一个围栏,并取消订阅该围栏事件。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.off(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geofence
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“gnssFenceStatusChange”,表示订阅围栏事件上报。 |
| request | [GeofenceRequest](#geofencerequest) | 是 | 围栏的配置参数。 |
| want | WantAgent | 是 | 用于接收地理围栏事件上报(进出围栏)。 |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
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}};
geoLocationManager.on('gnssFenceStatusChange', requestInfo, wantAgentObj);
geoLocationManager.off('gnssFenceStatusChange', requestInfo, wantAgentObj);
});
```
## geoLocationManager.on('countryCodeChange') ## geoLocationManager.on('countryCodeChange')
on(type: 'countryCodeChange', callback: Callback&lt;CountryCode&gt;): void; on(type: 'countryCodeChange', callback: Callback&lt;CountryCode&gt;): void;
订阅国家码信息变化事件。
**系统能力**:SystemCapability.Location.Location.Core
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“countryCodeChange”,表示订阅国家码信息变化事件。 |
| callback | Callback&lt;[CountryCode](#countrycode)&gt; | 是 | 接收国家码信息上报。 |
**错误码**
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
|3301100 | The location switch is off. |
|3301500 | Failed to query the area information. |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
var callback = (code) => {
console.log('countryCodeChange: ' + JSON.stringify(code));
}
geoLocationManager.on('countryCodeChange', callback);
```
## geoLocationManager.off('countryCodeChange')
off(type: 'countryCodeChange', callback?: Callback&lt;CountryCode&gt;): void;
取消订阅国家码变化事件。
**系统能力**:SystemCapability.Location.Location.Core
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“countryCodeChange”,表示取消订阅国家码信息变化事件。 |
| callback | Callback&lt;[CountryCode](#countrycode)&gt; | 否 | 需要取消订阅的回调函数。若无此参数,则取消当前类型的所有订阅。 |
**错误码**
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
|3301100 | The location switch is off. |
|3301500 | Failed to query the area information. |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
var callback = (code) => {
console.log('countryCodeChange: ' + JSON.stringify(code));
}
geoLocationManager.on('countryCodeChange', callback);
geoLocationManager.off('countryCodeChange', callback);
```
## geoLocationManager.getCurrentLocation
getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback&lt;Location&gt;): void
获取当前位置,使用callback回调异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback&lt;Location&gt;): void<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| request | [CurrentLocationRequest](#currentlocationrequest) | 否 | 设置位置请求参数。 |
| callback | AsyncCallback&lt;[Location](#location)&gt; | 是 | 用来接收位置信息的回调。 |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
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));
}
};
geoLocationManager.getCurrentLocation(requestInfo, locationChange);
geoLocationManager.getCurrentLocation(locationChange);
```
## geoLocationManager.getCurrentLocation
getCurrentLocation(request?: CurrentLocationRequest): Promise&lt;Location&gt;
获取当前位置,使用Promise方式异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getCurrentLocation(request?: CurrentLocationRequest): Promise&lt;Location&gt;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| request | [CurrentLocationRequest](#currentlocationrequest) | 否 | 设置位置请求参数。 |
**返回值**
| 参数名 | 说明 |
| -------- | -------- |
| Promise&lt;[Location](#location)&gt; | 返回位置信息。 |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
var requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0};
geoLocationManager.getCurrentLocation(requestInfo).then((result) => {
console.log('current location: ' + JSON.stringify(result));
});
```
## geoLocationManager.getLastLocation
getLastLocation(callback: AsyncCallback&lt;Location&gt;): void
获取上一次位置,使用callback回调异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getLastLocation(): Location;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;[Location](#location)&gt; | 是 | 用来接收上次位置的回调。 |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.getLastLocation((err, data) => {
if (err) {
console.log('getLastLocation: err=' + JSON.stringify(err));
}
if (data) {
console.log('getLastLocation: data=' + JSON.stringify(data));
}
});
```
## geoLocationManager.getLastLocation
getLastLocation(): Promise&lt;Location&gt;
获取上一次位置,使用Promise方式异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getLastLocation(): Location;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core
**返回值**
| 参数名 | 说明 |
| -------- | -------- |
| Promise&lt;[Location](#location)&gt; | 返回上次位置信息。 |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.getLastLocation().then((result) => {
console.log('getLastLocation: result: ' + JSON.stringify(result));
});
```
## geoLocationManager.isLocationEnabled
isLocationEnabled(callback: AsyncCallback&lt;boolean&gt;): void
判断位置服务是否已经打开,使用callback回调异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.isLocationEnabled(): boolean;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 用来接收位置服务状态的回调。 |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.isLocationEnabled((err, data) => {
if (err) {
console.log('isLocationEnabled: err=' + JSON.stringify(err));
}
if (data) {
console.log('isLocationEnabled: data=' + JSON.stringify(data));
}
});
```
## geoLocationManager.requestEnableLocation
requestEnableLocation(callback: AsyncCallback&lt;boolean&gt;): void
请求打开位置服务,使用callback回调异步返回结果。
订阅国家码信息变化事件。 > **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.requestEnableLocation(callback: AsyncCallback<boolean>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -25,68 +706,53 @@ on(type: 'countryCodeChange', callback: Callback&lt;CountryCode&gt;): void; ...@@ -25,68 +706,53 @@ on(type: 'countryCodeChange', callback: Callback&lt;CountryCode&gt;): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“countryCodeChange”,表示订阅国家码信息变化事件。 | | callback | AsyncCallback&lt;boolean&gt; | 是 | 用来接收位置服务状态的回调。 |
| callback | Callback&lt;[CountryCode](#countrycode)&gt; | 是 | 接收国家码信息上报。 |
**错误码**
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
|3301100 | The location switch is off. |
|3301500 | Failed to query the area information. |
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
var callback = (code) => { geoLocationManager.requestEnableLocation((err, data) => {
console.log('countryCodeChange: ' + JSON.stringify(code)); if (err) {
} console.log('requestEnableLocation: err=' + JSON.stringify(err));
geoLocationManager.on('countryCodeChange', callback); }
if (data) {
console.log('requestEnableLocation: data=' + JSON.stringify(data));
}
});
``` ```
## geoLocationManager.off('countryCodeChange') ## geoLocationManager.requestEnableLocation
off(type: 'countryCodeChange', callback?: Callback&lt;CountryCode&gt;): void;
取消订阅国家码变化事件。 requestEnableLocation(): Promise&lt;boolean&gt;
**系统能力**:SystemCapability.Location.Location.Core 请求打开位置服务,使用Promise方式异步返回结果。
**参数** > **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.requestEnableLocation(): Promise<boolean>;<sup>9+</sup>](#)替代。
| 参数名 | 类型 | 必填 | 说明 | **需要权限**:ohos.permission.LOCATION
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“countryCodeChange”,表示取消订阅国家码信息变化事件。 |
| callback | Callback&lt;[CountryCode](#countrycode)&gt; | 否 | 需要取消订阅的回调函数。若无此参数,则取消当前类型的所有订阅。 |
**错误码** **系统能力**:SystemCapability.Location.Location.Core
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md) **返回值**
| 错误码ID | 错误信息 | | 参数名 | 说明 |
| -------- | ---------------------------------------- | | -------- | -------- |
|3301000 | Location service is unavailable. | | Promise&lt;boolean&gt; | 返回位置服务是否可用。 |
|3301100 | The location switch is off. |
|3301500 | Failed to query the area information. |
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
var callback = (code) => { geoLocationManager.requestEnableLocation().then((result) => {
console.log('countryCodeChange: ' + JSON.stringify(code)); console.log('promise, requestEnableLocation: ' + JSON.stringify(result));
} });
geoLocationManager.on('countryCodeChange', callback);
geoLocationManager.off('countryCodeChange', callback);
``` ```
## geoLocationManager.enableLocation ## geoLocationManager.enableLocation
enableLocation(callback: AsyncCallback&lt;void&gt;): void; enableLocation(callback: AsyncCallback&lt;void&gt;): void;
...@@ -165,9 +831,9 @@ enableLocation(): Promise&lt;void&gt; ...@@ -165,9 +831,9 @@ enableLocation(): Promise&lt;void&gt;
## geoLocationManager.disableLocation ## geoLocationManager.disableLocation
disableLocation(callback: AsyncCallback&lt;void&gt;): void; disableLocation(): void;
关闭位置服务,使用callback回调异步返回结果 关闭位置服务。
**系统API**:此接口为系统接口,三方应用不支持调用。 **系统API**:此接口为系统接口,三方应用不支持调用。
...@@ -177,9 +843,7 @@ disableLocation(callback: AsyncCallback&lt;void&gt;): void; ...@@ -177,9 +843,7 @@ disableLocation(callback: AsyncCallback&lt;void&gt;): void;
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 用来接收错误码的回调。 |
**错误码** **错误码**
...@@ -201,134 +865,320 @@ disableLocation(callback: AsyncCallback&lt;void&gt;): void; ...@@ -201,134 +865,320 @@ disableLocation(callback: AsyncCallback&lt;void&gt;): void;
``` ```
## geoLocationManager.disableLocation
disableLocation(): Promise&lt;void&gt; ## geoLocationManager.getAddressesFromLocation
关闭位置服务,使用Promise方式异步返回结果。 getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback&lt;Array&lt;GeoAddress&gt;&gt;): void
**系统API**:此接口为系统接口,三方应用不支持调用 调用逆地理编码服务,将坐标转换为地理描述,使用callback回调异步返回结果
**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGS > **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void;<sup>9+</sup>](#)替代。
**系统能力**:SystemCapability.Location.Location.Core **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geocoder
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| request | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 设置逆地理编码请求的相关参数。 |
| callback | AsyncCallback&lt;Array&lt;[GeoAddress](#geoaddress)&gt;&gt; | 是 | 设置接收逆地理编码请求的回调参数。 |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1};
geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => {
if (err) {
console.log('getAddressesFromLocation: err=' + JSON.stringify(err));
}
if (data) {
console.log('getAddressesFromLocation: data=' + JSON.stringify(data));
}
});
```
## geoLocationManager.getAddressesFromLocation
getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise&lt;Array&lt;GeoAddress&gt;&gt;;
调用逆地理编码服务,将坐标转换为地理描述,使用Promise方式异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise<Array<GeoAddress>>;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geocoder
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| request | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 设置逆地理编码请求的相关参数。 |
**返回值** **返回值**
| 参数名 | 说明 | | 参数名 | 说明 |
| -------- | -------- | | -------- | -------- |
| Promise&lt;void&gt; | 返回错误码。 | | Promise&lt;Array&lt;[GeoAddress](#geoaddress)&gt;&gt; | 返回地理描述信息。 |
**错误码** **示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1};
geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest).then((data) => {
console.log('getAddressesFromLocation: ' + JSON.stringify(data));
});
```
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)
| 错误码ID | 错误信息 | ## geoLocationManager.getAddressesFromLocationName
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback&lt;Array&lt;GeoAddress&gt;&gt;): void
调用地理编码服务,将地理描述转换为具体坐标,使用callback回调异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geocoder
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| request | [GeoCodeRequest](#geocoderequest) | 是 | 设置地理编码请求的相关参数。 |
| callback | AsyncCallback&lt;Array&lt;[GeoAddress](#geoaddress)&gt;&gt; | 是 | 设置接收地理编码请求的回调参数。 |
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.disableLocation().then((result) => { var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1};
console.log('promise, disableLocation succeed'); geoLocationManager.getAddressesFromLocationName(geocodeRequest, (err, data) => {
}) if (err) {
.catch((error) => { console.log('getAddressesFromLocationName: err=' + JSON.stringify(err));
console.log('promise, disableLocation: error=' + JSON.stringify(error)); }
if (data) {
console.log('getAddressesFromLocationName: data=' + JSON.stringify(data));
}
}); });
``` ```
## geoLocationManager.isLocationPrivacyConfirmed ## geoLocationManager.getAddressesFromLocationName
isLocationPrivacyConfirmed(type : LocationPrivacyType, callback: AsyncCallback&lt;boolean&gt;): void; getAddressesFromLocationName(request: GeoCodeRequest): Promise&lt;Array&lt;GeoAddress&gt;&gt;
查询用户是否同意定位服务隐私申明,是否同意启用定位服务。只有系统应用才能调用 调用地理编码服务,将地理描述转换为具体坐标,使用Promise方式异步返回结果
**系统API**:此接口为系统接口,三方应用不支持调用。 > **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getAddressesFromLocationName(request: GeoCodeRequest): Promise<Array<GeoAddress>>;<sup>9+</sup>](#)替代。
**系统能力**:SystemCapability.Location.Location.Core **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geocoder
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | [LocationPrivacyType](#locationprivacytype)| 是 | 指定隐私申明场景,例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | | request | [GeoCodeRequest](#geocoderequest) | 是 | 设置地理编码请求的相关参数。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 表示用户是否同意定位服务隐私申明。 |
**错误码** **返回值**
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md) | 参数名 | 说明 |
| -------- | -------- |
| Promise&lt;Array&lt;[GeoAddress](#geoaddress)&gt;&gt; | 设置接收地理编码请求的回调参数。 |
| 错误码ID | 错误信息 | **示例**
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | ```ts
import geoLocationManager from '@ohos.geoLocationManager';
var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1};
geoLocationManager.getAddressesFromLocationName(geocodeRequest).then((result) => {
console.log('getAddressesFromLocationName: ' + JSON.stringify(result));
});
```
## geoLocationManager.isGeocoderAvailable
isGeocoderAvailable(callback: AsyncCallback&lt;boolean&gt;): void
判断(逆)地理编码服务状态,使用callback回调异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.isGeocoderAvailable(): boolean;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geocoder
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 用来接收地理编码服务状态的回调。 |
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.isLocationPrivacyConfirmed(1, (err, result) => { geoLocationManager.isGeocoderAvailable((err, data) => {
if (err) { if (err) {
console.log('isLocationPrivacyConfirmed: err=' + JSON.stringify(err)); console.log('isGeocoderAvailable: err=' + JSON.stringify(err));
} }
if (result) { if (data) {
console.log('isLocationPrivacyConfirmed: result=' + JSON.stringify(result)); console.log('isGeocoderAvailable: data=' + JSON.stringify(data));
} }
}); });
``` ```
## geoLocationManager.isLocationPrivacyConfirmed ## geoLocationManager.getCachedGnssLocationsSize<sup>8+</sup>
isLocationPrivacyConfirmed(type : LocationPrivacyType,): Promise&lt;boolean&gt;; getCachedGnssLocationsSize(callback: AsyncCallback&lt;number&gt;): void;
查询用户是否同意定位服务隐私申明,是否同意启用定位服务。只有系统应用才能调用 获取GNSS芯片缓存位置的个数
**系统API**:此接口为系统接口,三方应用不支持调用。 > **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getCachedGnssLocationsSize(callback: AsyncCallback<number>): void;<sup>9+</sup>](#)替代。
**系统能力**:SystemCapability.Location.Location.Core **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | [LocationPrivacyType](#locationprivacytype) | 是 | 指定隐私申明场景,例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | | callback | AsyncCallback&lt;number&gt; | 是 | 用来接收GNSS芯片缓存位置个数的回调。 |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.getCachedGnssLocationsSize((err, size) => {
if (err) {
console.log('getCachedGnssLocationsSize: err=' + JSON.stringify(err));
}
if (size) {
console.log('getCachedGnssLocationsSize: size=' + JSON.stringify(size));
}
});
```
## geoLocationManager.getCachedGnssLocationsSize<sup>8+</sup>
getCachedGnssLocationsSize(): Promise&lt;number&gt;;
获取GNSS芯片缓存位置的个数。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getCachedGnssLocationsSize(): Promise<number>;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss
**返回值** **返回值**
| 参数名 | 说明 | | 参数名 | 说明 |
| -------- | -------- | | -------- | -------- |
| Promise&lt;boolean&gt; | 表示用户是否同意定位服务隐私申明。 | | Promise&lt;number&gt; | 返回GNSS缓存位置的个数。 |
**错误码** **示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.getCachedGnssLocationsSize().then((result) => {
console.log('promise, getCachedGnssLocationsSize: ' + JSON.stringify(result));
});
```
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)
| 错误码ID | 错误信息 | ## geoLocationManager.flushCachedGnssLocations<sup>8+</sup>
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | flushCachedGnssLocations(callback: AsyncCallback&lt;boolean&gt;): void;
读取并清空GNSS芯片所有缓存位置。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.flushCachedGnssLocations(callback: AsyncCallback<void>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 用来接收清空GNSS芯片缓存位置操作的结果。 |
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.isLocationPrivacyConfirmed(1).then((result) => { geoLocationManager.flushCachedGnssLocations((err, result) => {
console.log('promise, isLocationPrivacyConfirmed: ' + JSON.stringify(result)); if (err) {
console.log('flushCachedGnssLocations: err=' + JSON.stringify(err));
}
if (result) {
console.log('flushCachedGnssLocations: result=' + JSON.stringify(result));
}
}); });
``` ```
## geoLocationManager.setLocationPrivacyConfirmStatus ## geoLocationManager.flushCachedGnssLocations<sup>8+</sup>
setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed: boolean, callback: AsyncCallback&lt;void&gt;): void; flushCachedGnssLocations(): Promise&lt;boolean&gt;;
设置用户勾选定位服务隐私申明的状态,记录用户是否同意启用定位服务。只有系统应用才能调用 读取并清空GNSS芯片所有缓存位置
**系统API**:此接口为系统接口,三方应用不支持调用。 > **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.flushCachedGnssLocations(): Promise<void>;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGS **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss
**返回值**
| 参数名 | 说明 |
| -------- | -------- |
| Promise&lt;boolean&gt; | 清空所有GNSS缓存位置是否成功。 |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.flushCachedGnssLocations().then((result) => {
console.log('promise, flushCachedGnssLocations: ' + JSON.stringify(result));
});
```
## geoLocationManager.sendCommand<sup>8+</sup>
sendCommand(command: LocationCommand, callback: AsyncCallback&lt;boolean&gt;): void;
给位置服务子系统的各个部件发送扩展命令。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.sendCommand(command: LocationCommand, callback: AsyncCallback<void>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -336,39 +1186,35 @@ setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed: boolean ...@@ -336,39 +1186,35 @@ setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed: boolean
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | [LocationPrivacyType](#locationprivacytype) | 是 | 指定隐私申明场景,例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | | command | [LocationCommand](#locationcommand) | 是 | 指定目标场景,和将要发送的命令(字符串)。 |
| isConfirmed | boolean | 是 | 表示用户是否同意定位服务隐私申明。 | | callback | AsyncCallback&lt;boolean&gt; | 是 | 用来接收命令发送的结果。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 接收错误码信息。 |
**错误码**
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.setLocationPrivacyConfirmStatus(1, true, (err, result) => { var requestInfo = {'scenario': 0x301, 'command': "command_1"};
geoLocationManager.sendCommand(requestInfo, (err, result) => {
if (err) { if (err) {
console.log('setLocationPrivacyConfirmStatus: err=' + JSON.stringify(err)); console.log('sendCommand: err=' + JSON.stringify(err));
}
if (result) {
console.log('sendCommand: result=' + JSON.stringify(result));
} }
}); });
``` ```
## geoLocationManager.setLocationPrivacyConfirmStatus ## geoLocationManager.sendCommand<sup>8+</sup>
setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed : boolean): Promise&lt;void&gt;; sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
设置用户勾选定位服务隐私申明的状态,记录用户是否同意启用定位服务。只有系统应用才能调用 给位置服务子系统的各个部件发送扩展命令
**系统API**:此接口为系统接口,三方应用不支持调用。 > **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.sendCommand(command: LocationCommand): Promise<void>;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGS **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -376,32 +1222,21 @@ setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed : boolea ...@@ -376,32 +1222,21 @@ setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed : boolea
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | [LocationPrivacyType](#locationprivacytype) | 是 | 指定隐私申明场景,例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | | command | [LocationCommand](#locationcommand) | 是 | 指定目标场景,和将要发送的命令(字符串)。 |
| isConfirmed | boolean | 是 | 表示用户是否同意定位服务隐私申明。 |
**返回值** **返回值**
| 参数名 | 说明 | | 参数名 | 说明 |
| -------- | -------- | | -------- | -------- |
| Promise&lt;void&gt; | 接收错误码。 | | Promise&lt;boolean&gt; | 表示命令发送成功或失败。 |
**错误码**
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.setLocationPrivacyConfirmStatus(1, true).then((result) => { var requestInfo = {'scenario': 0x301, 'command': "command_1"};
console.log('promise, setLocationPrivacyConfirmStatus succeed'); geoLocationManager.sendCommand(requestInfo).then((result) => {
}) console.log('promise, sendCommand: ' + JSON.stringify(result));
.catch((error) => {
console.log('promise, disableLocation: error=' + JSON.stringify(error));
}); });
``` ```
...@@ -521,50 +1356,6 @@ enableLocationMock(callback: AsyncCallback&lt;void&gt;): void; ...@@ -521,50 +1356,6 @@ enableLocationMock(callback: AsyncCallback&lt;void&gt;): void;
}); });
``` ```
## geoLocationManager.enableLocationMock
enableLocationMock(): Promise&lt;void&gt;;
使能位置模拟功能。
**系统能力**:SystemCapability.Location.Location.Core
**系统API**:此接口为系统接口,三方应用不支持调用。
**参数**
**返回值**
| 参数名 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 用来接收执行结果,如果执行成功就返回nullptr,否则就返回错误信息。 |
**错误码**
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
|3301100 | The location switch is off.|
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.enableLocationMock()
.then((result) => {
console.log('promise, enableLocationMock: succeed');
})
.catch((error) => {
if (error) {
console.log('promise, enableLocationMock: error=' + JSON.stringify(error));
}
});
```
## geoLocationManager.disableLocationMock ## geoLocationManager.disableLocationMock
...@@ -603,51 +1394,6 @@ disableLocationMock(callback: AsyncCallback&lt;void&gt;): void; ...@@ -603,51 +1394,6 @@ disableLocationMock(callback: AsyncCallback&lt;void&gt;): void;
``` ```
## geoLocationManager.disableLocationMock
disableLocationMock(): Promise&lt;void&gt;;
去使能位置模拟功能。
**系统能力**:SystemCapability.Location.Location.Core
**系统API**:此接口为系统接口,三方应用不支持调用。
**参数**
**返回值**
| 参数名 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 用来接收执行结果,如果执行成功就返回nullptr,否则就返回错误信息。 |
**错误码**
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
|3301100 | The location switch is off.|
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.disableLocationMock()
.then((result) => {
console.log('promise, disableLocationMock succeed');
})
.catch((error) => {
if (error) {
console.log('promise, disableLocationMock: error=' + JSON.stringify(error));
}
});
```
## geoLocationManager.setMockedLocations ## geoLocationManager.setMockedLocations
setMockedLocations(config: LocationMockConfig, callback: AsyncCallback&lt;void&gt;): void; setMockedLocations(config: LocationMockConfig, callback: AsyncCallback&lt;void&gt;): void;
...@@ -693,60 +1439,6 @@ setMockedLocations(config: LocationMockConfig, callback: AsyncCallback&lt;void&g ...@@ -693,60 +1439,6 @@ setMockedLocations(config: LocationMockConfig, callback: AsyncCallback&lt;void&g
}); });
``` ```
## geoLocationManager.setMockedLocations
setMockedLocations(config: LocationMockConfig): Promise&lt;void&gt;;
设置模拟的位置信息,后面会以该接口中携带的时间间隔上报模拟位置。
**系统能力**:SystemCapability.Location.Location.Core
**系统API**:此接口为系统接口,三方应用不支持调用。
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| config | [LocationMockConfig](#locationmockconfig) | 是 | 指示位置模拟的配置参数,包含模拟位置上报的时间间隔和模拟位置数组。 |
**返回值**
| 参数名 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 用来接收执行结果,如果执行成功就返回nullptr,否则就返回错误信息。 |
**错误码**
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
|3301100 | The location switch is off.|
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
var locations = [
{"latitude": 30.12, "longitude": 120.11, "altitude": 123, "accuracy": 1, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 1000000000, "additionSize": 0, "isFromMock": true},
{"latitude": 31.13, "longitude": 121.11, "altitude": 123, "accuracy": 2, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 2000000000, "additionSize": 0, "isFromMock": true},
{"latitude": 32.14, "longitude": 122.11, "altitude": 123, "accuracy": 3, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 3000000000, "additionSize": 0, "isFromMock": true},
{"latitude": 33.15, "longitude": 123.11, "altitude": 123, "accuracy": 4, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 4000000000, "additionSize": 0, "isFromMock": true},
{"latitude": 34.16, "longitude": 124.11, "altitude": 123, "accuracy": 5, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 5000000000, "additionSize": 0, "isFromMock": true}
];
var config = {"timeInterval": 5, "locations":locations};
geoLocationManager.setMockedLocations(config)
.then((result) => {
console.log('promise, setMockedLocations succeed');
})
.catch((error) => {
if (error) {
console.log('promise, setMockedLocations: error=' + JSON.stringify(error));
}
});
```
## geoLocationManager.enableReverseGeocodingMock ## geoLocationManager.enableReverseGeocodingMock
...@@ -784,50 +1476,6 @@ enableReverseGeocodingMock(callback: AsyncCallback&lt;void&gt;): void; ...@@ -784,50 +1476,6 @@ enableReverseGeocodingMock(callback: AsyncCallback&lt;void&gt;): void;
``` ```
## geoLocationManager.enableReverseGeocodingMock
enableReverseGeocodingMock(): Promise&lt;void&gt;;
使能逆地理编码模拟功能。
**系统能力**:SystemCapability.Location.Location.Core
**系统API**:此接口为系统接口,三方应用不支持调用。
**参数**
**返回值**
| 参数名 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 用来接收执行结果,如果执行成功就返回nullptr,否则就返回错误信息。 |
**错误码**
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.enableReverseGeocodingMock()
.then((result) => {
console.log('promise, enableReverseGeocodingMock succeed');
})
.catch((error) => {
if (error) {
console.log('promise, enableReverseGeocodingMock: error=' + JSON.stringify(error));
}
});
```
## geoLocationManager.disableReverseGeocodingMock ## geoLocationManager.disableReverseGeocodingMock
disableReverseGeocodingMock(callback: AsyncCallback&lt;void&gt;): void; disableReverseGeocodingMock(callback: AsyncCallback&lt;void&gt;): void;
...@@ -864,11 +1512,11 @@ disableReverseGeocodingMock(callback: AsyncCallback&lt;void&gt;): void; ...@@ -864,11 +1512,11 @@ disableReverseGeocodingMock(callback: AsyncCallback&lt;void&gt;): void;
``` ```
## geoLocationManager.disableReverseGeocodingMock ## geoLocationManager.setReverseGeocodingMockInfo
disableReverseGeocodingMock(): Promise&lt;void&gt;; setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;, callback: AsyncCallback&lt;void&gt;): void;
去使能逆地理编码模拟功能 设置逆地理编码模拟功能的配置信息,包含了位置和地名的对应关系,后续进行逆地理编码查询时如果位置信息位于配置信息中,就返回对应的地名
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -876,13 +1524,10 @@ disableReverseGeocodingMock(): Promise&lt;void&gt;; ...@@ -876,13 +1524,10 @@ disableReverseGeocodingMock(): Promise&lt;void&gt;;
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
**返回值** | mockInfos | Array&lt;[ReverseGeocodingMockInfo](#reversegeocodingmockinfo)&gt; | 是 | 指示逆地理编码模拟功能的配置参数数组。逆地理编码模拟功能的配置参数包含了一个位置和一个地名。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 用来接收执行结果,如果执行成功就返回nullptr,否则就返回错误信息。 |
| 参数名 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 用来接收执行结果,如果执行成功就返回nullptr,否则就返回错误信息。 |
**错误码** **错误码**
...@@ -896,34 +1541,42 @@ disableReverseGeocodingMock(): Promise&lt;void&gt;; ...@@ -896,34 +1541,42 @@ disableReverseGeocodingMock(): Promise&lt;void&gt;;
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.disableReverseGeocodingMock() var mockInfos = [
.then((result) => { {"location": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "maxItems": 1, "isFromMock": true}},
console.log('promise, disableReverseGeocodingMock succeed'); {"location": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "maxItems": 1, "isFromMock": true}},
}) {"location": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "maxItems": 1, "isFromMock": true}},
.catch((error) => { {"location": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "maxItems": 1, "isFromMock": true}},
if (error) { {"location": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "maxItems": 1, "isFromMock": true}},
console.log('promise, disableReverseGeocodingMock: error=' + JSON.stringify(error)); ];
geoLocationManager.setReverseGeocodingMockInfo(mockInfos, (err, data) => {
if (err) {
console.log('promise, setReverseGeocodingMockInfo, err:' + JSON.stringify(err));
} }
}); });
``` ```
## geoLocationManager.setReverseGeocodingMockInfo ## geoLocationManager.isLocationPrivacyConfirmed
setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;, callback: AsyncCallback&lt;void&gt;): void;
设置逆地理编码模拟功能的配置信息,包含了位置和地名的对应关系,后续进行逆地理编码查询时如果位置信息位于配置信息中,就返回对应的地名。 isLocationPrivacyConfirmed(type: LocationPrivacyType): boolean;
**系统能力**:SystemCapability.Location.Location.Core 查询用户是否同意定位服务隐私申明,是否同意启用定位服务。只有系统应用才能调用。
**系统API**:此接口为系统接口,三方应用不支持调用。 **系统API**:此接口为系统接口,三方应用不支持调用。
**系统能力**:SystemCapability.Location.Location.Core
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| mockInfos | Array&lt;[ReverseGeocodingMockInfo](#reversegeocodingmockinfo)&gt; | 是 | 指示逆地理编码模拟功能的配置参数数组。逆地理编码模拟功能的配置参数包含了一个位置和一个地名。 | | type | [LocationPrivacyType](#locationprivacytype)| 是 | 指定隐私申明场景,例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 用来接收执行结果,如果执行成功就返回nullptr,否则就返回错误信息。 |
**返回值**
| 类型 | 说明 |
| ------ | ---------------- |
| boolean | 表示用户是否同意定位服务隐私申明。。 |
**错误码** **错误码**
...@@ -937,42 +1590,36 @@ setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;, ca ...@@ -937,42 +1590,36 @@ setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;, ca
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
var mockInfos = [ geoLocationManager.isLocationPrivacyConfirmed(1, (err, result) => {
{"location": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "maxItems": 1, "isFromMock": true}},
{"location": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "maxItems": 1, "isFromMock": true}},
{"location": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "maxItems": 1, "isFromMock": true}},
{"location": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "maxItems": 1, "isFromMock": true}},
{"location": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "maxItems": 1, "isFromMock": true}},
];
geoLocationManager.setReverseGeocodingMockInfo(mockInfos, (err, data) => {
if (err) { if (err) {
console.log('promise, setReverseGeocodingMockInfo, err:' + JSON.stringify(err)); console.log('isLocationPrivacyConfirmed: err=' + JSON.stringify(err));
}
if (result) {
console.log('isLocationPrivacyConfirmed: result=' + JSON.stringify(result));
} }
}); });
``` ```
## geoLocationManager.setReverseGeocodingMockInfo ## geoLocationManager.setLocationPrivacyConfirmStatus
setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;): Promise&lt;void&gt;;
设置逆地理编码模拟功能的配置信息,包含了位置和地名的对应关系,后续进行逆地理编码查询时如果位置信息位于配置信息中,就返回对应的地名。 setLocationPrivacyConfirmStatus(type: LocationPrivacyType, isConfirmed: boolean): void;
**系统能力**:SystemCapability.Location.Location.Core 设置用户勾选定位服务隐私申明的状态,记录用户是否同意启用定位服务。只有系统应用才能调用。
**系统API**:此接口为系统接口,三方应用不支持调用。 **系统API**:此接口为系统接口,三方应用不支持调用。
**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGS
**系统能力**:SystemCapability.Location.Location.Core
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| mockInfos | Array&lt;[ReverseGeocodingMockInfo](#reversegeocodingmockinfo)&gt; | 是 | 指示逆地理编码模拟功能的配置信息数组。逆地理编码模拟功能的配置信息包含了一个位置和一个地名。 | | type | [LocationPrivacyType](#locationprivacytype) | 是 | 指定隐私申明场景,例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 |
| isConfirmed | boolean | 是 | 表示用户是否同意定位服务隐私申明。 |
**返回值** | callback | AsyncCallback&lt;void&gt; | 是 | 接收错误码信息。 |
| 参数名 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 用来接收执行结果,如果执行成功就返回nullptr,否则就返回错误信息。 |
**错误码** **错误码**
...@@ -986,20 +1633,9 @@ setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;): P ...@@ -986,20 +1633,9 @@ setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;): P
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
var mockInfos = [ geoLocationManager.setLocationPrivacyConfirmStatus(1, true, (err, result) => {
{"location": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "maxItems": 1, "isFromMock": true}}, if (err) {
{"location": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "maxItems": 1, "isFromMock": true}}, console.log('setLocationPrivacyConfirmStatus: err=' + JSON.stringify(err));
{"location": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "maxItems": 1, "isFromMock": true}},
{"location": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "maxItems": 1, "isFromMock": true}},
{"location": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "maxItems": 1, "isFromMock": true}},
];
geoLocationManager.setReverseGeocodingMockInfo(mockInfos)
.then((result) => {
console.log('promise, setReverseGeocodingMockInfo succeed');
})
.catch((error) => {
if (error) {
console.log('promise, setReverseGeocodingMockInfo: error=' + JSON.stringify(error));
} }
}); });
``` ```
......
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 从API Version 9开始,该接口不再维护,推荐使用新接口[`@ohos.geoLocationManager`](js-apis-geoLocationManager.md)。
## 导入模块 ## 导入模块
...@@ -18,6 +18,9 @@ on(type: 'locationChange', request: LocationRequest, callback: Callback&lt;Locat ...@@ -18,6 +18,9 @@ on(type: 'locationChange', request: LocationRequest, callback: Callback&lt;Locat
开启位置变化订阅,并发起定位请求。定位结果按照[LocationRequest](#locationrequest)的属性进行上报, 开启位置变化订阅,并发起定位请求。定位结果按照[LocationRequest](#locationrequest)的属性进行上报,
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.on(type: 'locationChange', request: LocationRequest, callback: Callback&lt;Location&gt;): void<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -50,6 +53,9 @@ off(type: 'locationChange', callback?: Callback&lt;Location&gt;): void ...@@ -50,6 +53,9 @@ off(type: 'locationChange', callback?: Callback&lt;Location&gt;): void
关闭位置变化订阅,并删除对应的定位请求。 关闭位置变化订阅,并删除对应的定位请求。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.off(type: 'locationChange', callback?: Callback&lt;Location&gt;): void<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -81,6 +87,9 @@ on(type: 'locationServiceState', callback: Callback&lt;boolean&gt;): void ...@@ -81,6 +87,9 @@ on(type: 'locationServiceState', callback: Callback&lt;boolean&gt;): void
订阅位置服务状态变化。 订阅位置服务状态变化。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.on(type: 'locationEnabledChange', callback: Callback<boolean>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -110,6 +119,9 @@ off(type: 'locationServiceState', callback?: Callback&lt;boolean&gt;): void; ...@@ -110,6 +119,9 @@ off(type: 'locationServiceState', callback?: Callback&lt;boolean&gt;): void;
取消订阅位置服务状态变化。 取消订阅位置服务状态变化。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.off(type: 'locationEnabledChange', callback: Callback<boolean>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -140,6 +152,9 @@ on(type: 'cachedGnssLocationsReporting', request: CachedGnssLocationsRequest, ca ...@@ -140,6 +152,9 @@ on(type: 'cachedGnssLocationsReporting', request: CachedGnssLocationsRequest, ca
订阅缓存GNSS定位结果上报事件。 订阅缓存GNSS定位结果上报事件。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.on(type: 'cachedGnssLocationsChange', request: CachedGnssLocationsRequest, callback: Callback<Array<Location>>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss **系统能力**:SystemCapability.Location.Location.Gnss
...@@ -171,6 +186,9 @@ off(type: 'cachedGnssLocationsReporting', callback?: Callback&lt;Array&lt;Locati ...@@ -171,6 +186,9 @@ off(type: 'cachedGnssLocationsReporting', callback?: Callback&lt;Array&lt;Locati
取消订阅缓存GNSS定位结果上报事件。 取消订阅缓存GNSS定位结果上报事件。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.off(type: 'cachedGnssLocationsChange', callback?: Callback<Array<Location>>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss **系统能力**:SystemCapability.Location.Location.Gnss
...@@ -202,6 +220,9 @@ on(type: 'gnssStatusChange', callback: Callback&lt;SatelliteStatusInfo&gt;): voi ...@@ -202,6 +220,9 @@ on(type: 'gnssStatusChange', callback: Callback&lt;SatelliteStatusInfo&gt;): voi
订阅GNSS卫星状态信息上报事件。 订阅GNSS卫星状态信息上报事件。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.on(type: 'satelliteStatusChange', callback: Callback<SatelliteStatusInfo>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss **系统能力**:SystemCapability.Location.Location.Gnss
...@@ -231,6 +252,9 @@ off(type: 'gnssStatusChange', callback?: Callback&lt;SatelliteStatusInfo&gt;): v ...@@ -231,6 +252,9 @@ off(type: 'gnssStatusChange', callback?: Callback&lt;SatelliteStatusInfo&gt;): v
取消订阅GNSS卫星状态信息上报事件。 取消订阅GNSS卫星状态信息上报事件。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.off(type: 'satelliteStatusChange', callback?: Callback<SatelliteStatusInfo>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss **系统能力**:SystemCapability.Location.Location.Gnss
...@@ -260,6 +284,9 @@ on(type: 'nmeaMessageChange', callback: Callback&lt;string&gt;): void; ...@@ -260,6 +284,9 @@ on(type: 'nmeaMessageChange', callback: Callback&lt;string&gt;): void;
订阅GNSS NMEA信息上报事件。 订阅GNSS NMEA信息上报事件。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.on(type: 'nmeaMessage', callback: Callback<string>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss **系统能力**:SystemCapability.Location.Location.Gnss
...@@ -289,6 +316,9 @@ off(type: 'nmeaMessageChange', callback?: Callback&lt;string&gt;): void; ...@@ -289,6 +316,9 @@ off(type: 'nmeaMessageChange', callback?: Callback&lt;string&gt;): void;
取消订阅GNSS NMEA信息上报事件。 取消订阅GNSS NMEA信息上报事件。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.off(type: 'nmeaMessage', callback?: Callback<string>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss **系统能力**:SystemCapability.Location.Location.Gnss
...@@ -319,6 +349,9 @@ on(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void; ...@@ -319,6 +349,9 @@ on(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void;
添加一个围栏,并订阅地理围栏事件。 添加一个围栏,并订阅地理围栏事件。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.on(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geofence **系统能力**:SystemCapability.Location.Location.Geofence
...@@ -364,6 +397,9 @@ off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void; ...@@ -364,6 +397,9 @@ off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void;
删除一个围栏,并取消订阅该围栏事件。 删除一个围栏,并取消订阅该围栏事件。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.off(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geofence **系统能力**:SystemCapability.Location.Location.Geofence
...@@ -407,9 +443,11 @@ off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void; ...@@ -407,9 +443,11 @@ off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void;
getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback&lt;Location&gt;): void getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback&lt;Location&gt;): void
获取当前位置,使用callback回调异步返回结果。 获取当前位置,使用callback回调异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback&lt;Location&gt;): void<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -443,9 +481,11 @@ getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback&lt;L ...@@ -443,9 +481,11 @@ getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback&lt;L
getCurrentLocation(request?: CurrentLocationRequest): Promise&lt;Location&gt; getCurrentLocation(request?: CurrentLocationRequest): Promise&lt;Location&gt;
获取当前位置,使用Promise方式异步返回结果。 获取当前位置,使用Promise方式异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getCurrentLocation(request?: CurrentLocationRequest): Promise&lt;Location&gt;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -480,6 +520,9 @@ getLastLocation(callback: AsyncCallback&lt;Location&gt;): void ...@@ -480,6 +520,9 @@ getLastLocation(callback: AsyncCallback&lt;Location&gt;): void
获取上一次位置,使用callback回调异步返回结果。 获取上一次位置,使用callback回调异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getLastLocation(): Location;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -512,6 +555,9 @@ getLastLocation(): Promise&lt;Location&gt; ...@@ -512,6 +555,9 @@ getLastLocation(): Promise&lt;Location&gt;
获取上一次位置,使用Promise方式异步返回结果。 获取上一次位置,使用Promise方式异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getLastLocation(): Location;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -537,9 +583,11 @@ getLastLocation(): Promise&lt;Location&gt; ...@@ -537,9 +583,11 @@ getLastLocation(): Promise&lt;Location&gt;
isLocationEnabled(callback: AsyncCallback&lt;boolean&gt;): void isLocationEnabled(callback: AsyncCallback&lt;boolean&gt;): void
判断位置服务是否已经打开,使用callback回调异步返回结果。 判断位置服务是否已经打开,使用callback回调异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.isLocationEnabled(): boolean;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -571,6 +619,9 @@ isLocationEnabled(): Promise&lt;boolean&gt; ...@@ -571,6 +619,9 @@ isLocationEnabled(): Promise&lt;boolean&gt;
判断位置服务是否已经开启,使用Promise方式异步返回结果。 判断位置服务是否已经开启,使用Promise方式异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.isLocationEnabled(): boolean;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -595,9 +646,11 @@ isLocationEnabled(): Promise&lt;boolean&gt; ...@@ -595,9 +646,11 @@ isLocationEnabled(): Promise&lt;boolean&gt;
requestEnableLocation(callback: AsyncCallback&lt;boolean&gt;): void requestEnableLocation(callback: AsyncCallback&lt;boolean&gt;): void
请求打开位置服务,使用callback回调异步返回结果。 请求打开位置服务,使用callback回调异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.requestEnableLocation(callback: AsyncCallback<boolean>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -629,6 +682,9 @@ requestEnableLocation(): Promise&lt;boolean&gt; ...@@ -629,6 +682,9 @@ requestEnableLocation(): Promise&lt;boolean&gt;
请求打开位置服务,使用Promise方式异步返回结果。 请求打开位置服务,使用Promise方式异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.requestEnableLocation(): Promise<boolean>;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -649,132 +705,15 @@ requestEnableLocation(): Promise&lt;boolean&gt; ...@@ -649,132 +705,15 @@ requestEnableLocation(): Promise&lt;boolean&gt;
``` ```
## geolocation.enableLocation
enableLocation(callback: AsyncCallback&lt;boolean&gt;): void;
打开位置服务,使用callback回调异步返回结果。
**系统API**:此接口为系统接口,三方应用不支持调用。
**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGS
**系统能力**:SystemCapability.Location.Location.Core
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 用来接收位置服务状态的回调。 |
**示例**
```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&lt;boolean&gt;
打开位置服务,使用Promise方式异步返回结果。
**系统API**:此接口为系统接口,三方应用不支持调用。
**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGS
**系统能力**:SystemCapability.Location.Location.Core
**返回值**
| 参数名 | 说明 |
| -------- | -------- |
| Promise&lt;boolean&gt; | 返回位置服务是否可用。 |
**示例**
```ts
import geolocation from '@ohos.geolocation';
geolocation.enableLocation().then((result) => {
console.log('promise, enableLocation: ' + JSON.stringify(result));
});
```
## geolocation.disableLocation
disableLocation(callback: AsyncCallback&lt;boolean&gt;): void;
关闭位置服务,使用callback回调异步返回结果。
**系统API**:此接口为系统接口,三方应用不支持调用。
**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGS
**系统能力**:SystemCapability.Location.Location.Core
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 用来接收位置服务状态的回调。 |
**示例**
```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&lt;boolean&gt;
关闭位置服务,使用Promise方式异步返回结果。
**系统API**:此接口为系统接口,三方应用不支持调用。
**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGS
**系统能力**:SystemCapability.Location.Location.Core
**返回值**
| 参数名 | 说明 |
| -------- | -------- |
| Promise&lt;boolean&gt; | 返回位置服务是否可用。 |
**示例**
```ts
import geolocation from '@ohos.geolocation';
geolocation.disableLocation().then((result) => {
console.log('promise, disableLocation: ' + JSON.stringify(result));
});
```
## geolocation.isGeoServiceAvailable ## geolocation.isGeoServiceAvailable
isGeoServiceAvailable(callback: AsyncCallback&lt;boolean&gt;): void isGeoServiceAvailable(callback: AsyncCallback&lt;boolean&gt;): void
判断(逆)地理编码服务状态,使用callback回调异步返回结果。 判断(逆)地理编码服务状态,使用callback回调异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.isGeocoderAvailable(): boolean;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geocoder **系统能力**:SystemCapability.Location.Location.Geocoder
...@@ -806,6 +745,9 @@ isGeoServiceAvailable(): Promise&lt;boolean&gt; ...@@ -806,6 +745,9 @@ isGeoServiceAvailable(): Promise&lt;boolean&gt;
判断(逆)地理编码服务状态,使用Promise方式异步返回结果。 判断(逆)地理编码服务状态,使用Promise方式异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.isGeocoderAvailable(): boolean;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geocoder **系统能力**:SystemCapability.Location.Location.Geocoder
...@@ -832,6 +774,9 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback ...@@ -832,6 +774,9 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback
调用逆地理编码服务,将坐标转换为地理描述,使用callback回调异步返回结果。 调用逆地理编码服务,将坐标转换为地理描述,使用callback回调异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geocoder **系统能力**:SystemCapability.Location.Location.Geocoder
...@@ -865,6 +810,9 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise&lt;Array&lt;Ge ...@@ -865,6 +810,9 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise&lt;Array&lt;Ge
调用逆地理编码服务,将坐标转换为地理描述,使用Promise方式异步返回结果。 调用逆地理编码服务,将坐标转换为地理描述,使用Promise方式异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise<Array<GeoAddress>>;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geocoder **系统能力**:SystemCapability.Location.Location.Geocoder
...@@ -898,6 +846,9 @@ getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback&lt ...@@ -898,6 +846,9 @@ getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback&lt
调用地理编码服务,将地理描述转换为具体坐标,使用callback回调异步返回结果。 调用地理编码服务,将地理描述转换为具体坐标,使用callback回调异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geocoder **系统能力**:SystemCapability.Location.Location.Geocoder
...@@ -931,6 +882,9 @@ getAddressesFromLocationName(request: GeoCodeRequest): Promise&lt;Array&lt;GeoAd ...@@ -931,6 +882,9 @@ getAddressesFromLocationName(request: GeoCodeRequest): Promise&lt;Array&lt;GeoAd
调用地理编码服务,将地理描述转换为具体坐标,使用Promise方式异步返回结果。 调用地理编码服务,将地理描述转换为具体坐标,使用Promise方式异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getAddressesFromLocationName(request: GeoCodeRequest): Promise<Array<GeoAddress>>;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geocoder **系统能力**:SystemCapability.Location.Location.Geocoder
...@@ -964,6 +918,9 @@ getCachedGnssLocationsSize(callback: AsyncCallback&lt;number&gt;): void; ...@@ -964,6 +918,9 @@ getCachedGnssLocationsSize(callback: AsyncCallback&lt;number&gt;): void;
获取GNSS芯片缓存位置的个数。 获取GNSS芯片缓存位置的个数。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getCachedGnssLocationsSize(callback: AsyncCallback<number>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss **系统能力**:SystemCapability.Location.Location.Gnss
...@@ -995,6 +952,9 @@ getCachedGnssLocationsSize(): Promise&lt;number&gt;; ...@@ -995,6 +952,9 @@ getCachedGnssLocationsSize(): Promise&lt;number&gt;;
获取GNSS芯片缓存位置的个数。 获取GNSS芯片缓存位置的个数。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getCachedGnssLocationsSize(): Promise<number>;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss **系统能力**:SystemCapability.Location.Location.Gnss
...@@ -1021,6 +981,9 @@ flushCachedGnssLocations(callback: AsyncCallback&lt;boolean&gt;): void; ...@@ -1021,6 +981,9 @@ flushCachedGnssLocations(callback: AsyncCallback&lt;boolean&gt;): void;
读取并清空GNSS芯片所有缓存位置。 读取并清空GNSS芯片所有缓存位置。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.flushCachedGnssLocations(callback: AsyncCallback<void>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss **系统能力**:SystemCapability.Location.Location.Gnss
...@@ -1052,6 +1015,9 @@ flushCachedGnssLocations(): Promise&lt;boolean&gt;; ...@@ -1052,6 +1015,9 @@ flushCachedGnssLocations(): Promise&lt;boolean&gt;;
读取并清空GNSS芯片所有缓存位置。 读取并清空GNSS芯片所有缓存位置。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.flushCachedGnssLocations(): Promise<void>;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss **系统能力**:SystemCapability.Location.Location.Gnss
...@@ -1078,6 +1044,9 @@ sendCommand(command: LocationCommand, callback: AsyncCallback&lt;boolean&gt;): v ...@@ -1078,6 +1044,9 @@ sendCommand(command: LocationCommand, callback: AsyncCallback&lt;boolean&gt;): v
给位置服务子系统的各个部件发送扩展命令。 给位置服务子系统的各个部件发送扩展命令。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.sendCommand(command: LocationCommand, callback: AsyncCallback<void>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -1111,6 +1080,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;; ...@@ -1111,6 +1080,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
给位置服务子系统的各个部件发送扩展命令。 给位置服务子系统的各个部件发送扩展命令。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.sendCommand(command: LocationCommand): Promise<void>;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -1138,11 +1110,13 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;; ...@@ -1138,11 +1110,13 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
``` ```
## LocationRequestPriority ## LocationRequestPriority
位置请求中位置信息优先级设置。 位置请求中位置信息优先级设置。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.LocationRequestPriority;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -1159,6 +1133,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;; ...@@ -1159,6 +1133,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
位置请求中定位场景设置。 位置请求中定位场景设置。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.LocationRequestScenario;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -1177,6 +1154,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;; ...@@ -1177,6 +1154,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
位置服务中的错误码信息。 位置服务中的错误码信息。
> **说明:**<br/>
> 从API version 9开始废弃。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -1196,6 +1176,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;; ...@@ -1196,6 +1176,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
逆地理编码请求接口。 逆地理编码请求接口。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.ReverseGeoCodeRequest;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geocoder **系统能力**:SystemCapability.Location.Location.Geocoder
...@@ -1212,6 +1195,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;; ...@@ -1212,6 +1195,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
地理编码请求接口。 地理编码请求接口。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.GeoCodeRequest;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geocoder **系统能力**:SystemCapability.Location.Location.Geocoder
...@@ -1231,6 +1217,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;; ...@@ -1231,6 +1217,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
地理编码类型。 地理编码类型。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.GeoAddress;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geocoder **系统能力**:SystemCapability.Location.Location.Geocoder
...@@ -1261,6 +1250,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;; ...@@ -1261,6 +1250,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
位置信息请求类型。 位置信息请求类型。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.LocationRequest;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -1278,6 +1270,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;; ...@@ -1278,6 +1270,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
当前位置信息请求类型。 当前位置信息请求类型。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.CurrentLocationRequest;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -1294,6 +1289,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;; ...@@ -1294,6 +1289,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
卫星状态信息。 卫星状态信息。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.SatelliteStatusInfo;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss **系统能力**:SystemCapability.Location.Location.Gnss
...@@ -1312,6 +1310,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;; ...@@ -1312,6 +1310,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
请求订阅GNSS缓存位置上报功能接口的配置参数。 请求订阅GNSS缓存位置上报功能接口的配置参数。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.CachedGnssLocationsRequest;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss **系统能力**:SystemCapability.Location.Location.Gnss
...@@ -1326,6 +1327,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;; ...@@ -1326,6 +1327,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
GNSS围栏的配置参数。目前只支持圆形围栏。 GNSS围栏的配置参数。目前只支持圆形围栏。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.Geofence;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geofence **系统能力**:SystemCapability.Location.Location.Geofence
...@@ -1342,6 +1346,9 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 ...@@ -1342,6 +1346,9 @@ GNSS围栏的配置参数。目前只支持圆形围栏。
请求添加GNSS围栏消息中携带的参数,包括定位优先级、定位场景和围栏信息。 请求添加GNSS围栏消息中携带的参数,包括定位优先级、定位场景和围栏信息。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.GeofenceRequest;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geofence **系统能力**:SystemCapability.Location.Location.Geofence
...@@ -1357,6 +1364,9 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 ...@@ -1357,6 +1364,9 @@ GNSS围栏的配置参数。目前只支持圆形围栏。
定位服务隐私协议类型。 定位服务隐私协议类型。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.LocationPrivacyType;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -1372,6 +1382,9 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 ...@@ -1372,6 +1382,9 @@ GNSS围栏的配置参数。目前只支持圆形围栏。
扩展命令结构体。 扩展命令结构体。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.LocationCommand;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -1386,6 +1399,9 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 ...@@ -1386,6 +1399,9 @@ GNSS围栏的配置参数。目前只支持圆形围栏。
位置信息类型。 位置信息类型。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.Location;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
......
# 地理位置 # 地理位置
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> - 从API Version 7 开始,该接口不再维护,推荐使用新接口[`@ohos.geolocation`](js-apis-geolocation.md)。 > - 从API Version 9开始,该接口不再维护,推荐使用新接口[`@ohos.geoLocationManager`](js-apis-geoLocationManager.md)。
> >
> - 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > - 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...@@ -25,6 +25,9 @@ getLocation(Object): void ...@@ -25,6 +25,9 @@ getLocation(Object): void
获取设备的地理位置。 获取设备的地理位置。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getCurrentLocation<sup>9+</sup>](#)替代。
**系统能力:** SystemCapability.Location.Location.Lite **系统能力:** SystemCapability.Location.Location.Lite
**参数:** **参数:**
...@@ -81,6 +84,9 @@ getLocationType(Object): void ...@@ -81,6 +84,9 @@ getLocationType(Object): void
获取当前设备支持的定位类型。 获取当前设备支持的定位类型。
> **说明:**<br/>
> 从API version 9开始废弃。
**系统能力:** SystemCapability.Location.Location.Lite **系统能力:** SystemCapability.Location.Location.Lite
**参数:** **参数:**
...@@ -121,6 +127,9 @@ subscribe(Object): void ...@@ -121,6 +127,9 @@ subscribe(Object): void
订阅设备的地理位置信息。多次调用的话,只有最后一次的调用生效。 订阅设备的地理位置信息。多次调用的话,只有最后一次的调用生效。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.on(type: 'locationChange', request: LocationRequest, callback: Callback<Location>): void;<sup>9+</sup>](#)替代。
**系统能力:** SystemCapability.Location.Location.Lite **系统能力:** SystemCapability.Location.Location.Lite
**参数:** **参数:**
...@@ -173,6 +182,9 @@ unsubscribe(): void ...@@ -173,6 +182,9 @@ unsubscribe(): void
取消订阅设备的地理位置信息。 取消订阅设备的地理位置信息。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.off(type: 'locationChange', callback?: Callback<Location>): void;](#)替代。
**系统能力:** SystemCapability.Location.Location.Lite **系统能力:** SystemCapability.Location.Location.Lite
**示例:** **示例:**
...@@ -192,6 +204,9 @@ getSupportedCoordTypes(): Array&lt;string&gt; ...@@ -192,6 +204,9 @@ getSupportedCoordTypes(): Array&lt;string&gt;
获取设备支持的坐标系类型。 获取设备支持的坐标系类型。
> **说明:**<br/>
> 从API version 9开始废弃。
**系统能力:** SystemCapability.Location.Location.Lite **系统能力:** SystemCapability.Location.Location.Lite
**返回值:** **返回值:**
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册