• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.geoLocationManager (位置服务)(系统接口)
2
3位置服务提供GNSS定位、网络定位、地理编码、逆地理编码、国家码和地理围栏等基本功能。
4
5> **说明:**
6>
7> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
8> 当前页面仅包含本模块的系统接口,其他公开接口参见[@ohos.geoLocationManager (位置服务)](js-apis-geoLocationManager.md)。
9> 本模块能力仅支持WGS-84坐标系。
10
11## 申请权限
12
13应用在使用系统能力前,需要检查是否已经获取用户授权访问设备位置信息。如未获得授权,可以向用户申请需要的位置权限,申请方式请参考下文。
14
15系统提供的定位权限有:
16- ohos.permission.LOCATION
17
18- ohos.permission.APPROXIMATELY_LOCATION
19
20- ohos.permission.LOCATION_IN_BACKGROUND
21
22访问设备的位置信息,必须申请权限,并且获得用户授权。
23
24API9之前的版本,申请ohos.permission.LOCATION即可。
25
26API9及之后的版本,需要申请ohos.permission.APPROXIMATELY_LOCATION或者同时申请ohos.permission.APPROXIMATELY_LOCATIONohos.permission.LOCATION;无法单独申请ohos.permission.LOCATION27
28| 使用的API版本 | 申请位置权限 | 申请结果 | 位置的精确度 |
29| -------- | -------- | -------- | -------- |
30| 小于9 | ohos.permission.LOCATION | 成功 | 获取到精准位置,精准度在米级别。 |
31| 大于等于9 | ohos.permission.LOCATION | 失败 | 无法获取位置。 |
32| 大于等于9 | ohos.permission.APPROXIMATELY_LOCATION | 成功 | 获取到模糊位置,精确度为5公里。 |
33| 大于等于9 | ohos.permission.APPROXIMATELY_LOCATIONohos.permission.LOCATION | 成功 | 获取到精准位置,精准度在米级别。 |
34
35如果应用在后台运行时也需要访问设备位置,需要申请LOCATION类型的长时任务,这样应用在切入后台之后,系统可以继续上报位置信息。长时任务申请可参考[长时任务](../../task-management/continuous-task.md)。
36
37应用如需使用ohos.permission.LOCATION_IN_BACKGROUND权限,需要在设置界面由用户手动授予,具体授权方式可参考[ohos.permission.LOCATION_IN_BACKGROUND权限说明](../../security/AccessToken/permissions-for-all-user.md#ohospermissionlocation_in_background)。
38
39开发者可以在应用配置文件中声明所需要的权限,具体可参考[向用户申请授权](../../security/AccessToken/request-user-authorization.md)。
40
41
42## 导入模块
43
44```ts
45import { geoLocationManager } from '@kit.LocationKit';
46```
47
48## GeoAddress
49
50地理编码地址信息。
51
52**系统能力**:SystemCapability.Location.Location.Geocoder
53
54| 名称 | 类型 | 只读 | 可选 | 说明 |
55| -------- | -------- | -------- | -------- | -------- |
56| isFromMock | Boolean | 否 | 是 | true:地名信息来自于逆地理编码模拟功能。<br/>false:地名信息不是来自于逆地理编码模拟功能。<br/>**系统API**:此接口为系统接口。 |
57
58
59## Location
60
61位置信息。
62
63**系统能力**:SystemCapability.Location.Location.Core
64
65| 名称 | 类型 | 只读 | 可选 | 说明 |
66| -------- | -------- | -------- | -------- | -------- |
67| isFromMock | Boolean | 否 | 是 | true:位置信息来自于位置模拟功能。<br/>false:位置信息不是来自于位置模拟功能。<br/>**系统API**:此接口为系统接口。 |
68
69
70## ReverseGeocodingMockInfo
71
72逆地理编码模拟功能的配置信息,包含一个位置信息和一个地名信息。
73
74**系统能力**:SystemCapability.Location.Location.Core
75
76**系统API**:此接口为系统接口。
77
78| 名称 | 类型 | 只读 | 可选 | 说明 |
79| -------- | -------- | -------- | -------- | -------- |
80| location |  [ReverseGeoCodeRequest](js-apis-geoLocationManager.md#reversegeocoderequest) | 否 | 否 | 表示经纬度信息。 **系统API**:此接口为系统接口。|
81| geoAddress |  [GeoAddress](#geoaddress) | 否 | 否 |表示地名信息。 **系统API**:此接口为系统接口。|
82
83
84## LocationMockConfig
85
86位置模拟功能的配置参数,包含了模拟位置上报的时间间隔和模拟位置数组。
87
88**系统能力**:SystemCapability.Location.Location.Core
89
90**系统API**:此接口为系统接口。
91
92| 名称 | 类型 | 只读 | 可选 | 说明 |
93| -------- | -------- | -------- | -------- | -------- |
94| timeInterval | number | 否 | 否 | 表示模拟位置上报的时间间隔,单位是秒。 **系统API**:此接口为系统接口。|
95| locations | Array&lt;[Location](#location)&gt; | 否 | 否 | 表示模拟位置数组。 **系统API**:此接口为系统接口。|
96
97## LocatingRequiredDataConfig<sup>10+</sup>
98
99获取定位所需数据时的配置参数。
100
101**系统能力**:SystemCapability.Location.Location.Core
102
103**系统API**:此接口为系统接口。
104
105| 名称 | 类型 | 只读 | 可选 | 说明 |
106| -------- | -------- | -------- | -------- | -------- |
107| type | [LocatingRequiredDataType](#locatingrequireddatatype10) | 否 | 否 | 表示请求获取数据的类型。 **系统API**:此接口为系统接口。|
108| needStartScan |  boolean | 否 | 否 | true:需要发起扫描。<br/>false:不需要发起扫描。 **系统API**:此接口为系统接口。|
109| scanInterval |  number | 否 | 是 | 表示扫描的时间间隔。单位是毫秒,默认值是10000毫秒,取值范围为大于0。 **系统API**:此接口为系统接口。|
110| scanTimeout |  number | 否 | 是 | 表示单次扫描的超时时间。单位是毫秒,默认值是10000毫秒,取值范围为大于0小于600000。 **系统API**:此接口为系统接口。|
111
112
113## ContinuousLocationRequest<sup>12+</sup>
114
115持续定位的请求参数。
116
117**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
118
119**系统能力**:SystemCapability.Location.Location.Core
120
121| 名称 | 类型 | 只读 | 可选 | 说明 |
122| -------- | -------- | -------- | -------- | -------- |
123| sportsType<sup>18+</sup> | [SportsType](#sportstype18) | 否 | 是 | 表示运动类型。<br/>**原子化服务API:** 从API version 18开始,该接口支持在原子化服务中使用。**系统API**:此接口为系统接口。|
124
125
126## LocatingRequiredData<sup>10+</sup>
127
128表示定位业务所需的数据,包含WiFi或蓝牙扫描结果,APP拿到这些数据之后可以用于网络定位等业务。
129
130**系统能力**:SystemCapability.Location.Location.Core
131
132**系统API**:此接口为系统接口。
133
134| 名称 | 类型 | 只读 | 可选 | 说明 |
135| -------- | -------- | -------- | -------- | -------- |
136| wifiData | [WifiScanInfo](#wifiscaninfo10) | 否 | 是 | 表示WiFi扫描结果。 **系统API**:此接口为系统接口。|
137| bluetoothData |  [BluetoothScanInfo](#bluetoothscaninfo10) | 否 | 是 | 表示蓝牙扫描结果。 **系统API**:此接口为系统接口。|
138
139
140## WifiScanInfo<sup>10+</sup>
141
142WiFi扫描信息,包含扫描到的WiFi热点的ssid、bssid和rssi等信息。
143
144**系统能力**:SystemCapability.Location.Location.Core
145
146**系统API**:此接口为系统接口。
147
148| 名称 | 类型 | 只读 | 可选 | 说明 |
149| -------- | -------- | -------- | -------- | -------- |
150| ssid | string | 否 | 否 | WiFi热点的SSID,编码格式为UTF-8。 **系统API**:此接口为系统接口。|
151| bssid | string | 否 | 否 | WiFi热点的BSSID。 **系统API**:此接口为系统接口。|
152| rssi | number | 否 | 否 | WiFi热点的信号强度(dBm)。 **系统API**:此接口为系统接口。|
153| frequency | number | 否 | 否 | WiFi热点的频率。单位是赫兹。 **系统API**:此接口为系统接口。|
154| timestamp | number | 否 | 否 | 时间戳。 **系统API**:此接口为系统接口。|
155
156
157## BluetoothScanInfo<sup>10+</sup>
158
159蓝牙扫描信息。
160
161**系统能力**:SystemCapability.Location.Location.Core
162
163**系统API**:此接口为系统接口。
164
165| 名称 | 类型 | 只读 | 可选 | 说明 |
166| -------- | -------- | -------- | -------- | -------- |
167| deviceName | string | 否 | 否 | 蓝牙设备名称。 **系统API**:此接口为系统接口。|
168| macAddress | string | 否 | 否 | 蓝牙设备的MAC地址。 **系统API**:此接口为系统接口。|
169| rssi | number | 否 | 否 | 蓝牙设备的信号强度(dBm)。 **系统API**:此接口为系统接口。|
170| timestamp | number | 否 | 否 | 时间戳。 **系统API**:此接口为系统接口。|
171
172## LocationPrivacyType
173
174定位服务隐私协议类型。
175
176**系统能力**:SystemCapability.Location.Location.Core
177
178**系统API**:此接口为系统接口。
179
180| 名称 | 值 | 说明 |
181| -------- | -------- | -------- |
182| OTHERS | 0 | 其他场景。预留字段。 **系统API**:此接口为系统接口。|
183| STARTUP | 1 | 开机向导场景下的隐私协议。在开机时弹出协议,提醒用户阅读并选择是否授权。 **系统API**:此接口为系统接口。|
184| CORE_LOCATION | 2 | 开启网络定位时弹出的隐私协议。 **系统API**:此接口为系统接口。|
185
186## LocatingRequiredDataType<sup>10+</sup>
187
188定位业务所需数据的类型。
189
190**系统能力**:SystemCapability.Location.Location.Core
191
192**系统API**:此接口为系统接口。
193
194| 名称 | 值 | 说明 |
195| -------- | -------- | -------- |
196| WIFI  | 1 | 表示WiFi扫描信息。 **系统API**:此接口为系统接口。|
197| BLUETOOTH | 2 | 表示蓝牙扫描信息。 **系统API**:此接口为系统接口。|
198
199
200## LocationIconStatus<sup>12+</sup>
201
202定位图标状态。
203
204**系统能力**:SystemCapability.Location.Location.Core
205
206**系统API**:此接口为系统接口。
207
208| 名称 | 值 | 说明 |
209| -------- | -------- | -------- |
210| LOCATING_NOT_STARTED  | 0 | 表示当前无定位业务,无需显示定位图标。 **系统API**:此接口为系统接口。|
211| LOCATING_STARTED | 1 | 表示当前在进行普通定位业务,需要显示普通定位图标。 **系统API**:此接口为系统接口。|
212| HD_LOCATING_STARTED | 2 | 表示当前正在进行高精度定位业务,需要显示高精度定位图标。 **系统API**:此接口为系统接口。|
213
214
215## SportsType<sup>18+</sup>
216
217运动类型。
218
219**原子化服务API:** 从API version 18开始,该接口支持在原子化服务中使用。
220
221**系统能力**:SystemCapability.Location.Location.Core
222
223| 名称 | 值 | 说明 |
224| -------- | -------- | -------- |
225| RUNNING   | 1 |  表示跑步。 |
226| WALKING    | 2 | 表示步行。 |
227| CYCLING     | 3 | 表示骑行。 |
228
229
230## geoLocationManager.on('locatingRequiredDataChange')<sup>10+</sup>
231
232on(type: 'locatingRequiredDataChange', config: LocatingRequiredDataConfig, callback: Callback&lt;Array&lt;LocatingRequiredData&gt;&gt;): void
233
234订阅定位业务所需数据的变化,主要包含WiFi和蓝牙扫描信息;根据入参决定是否启动WiFi和蓝牙扫描。使用callback异步回调。
235
236**需要权限**:ohos.permission.LOCATIONohos.permission.APPROXIMATELY_LOCATION
237
238**系统能力**:SystemCapability.Location.Location.Core
239
240**系统API**:此接口为系统接口。
241
242**参数**:
243
244  | 参数名 | 类型 | 必填 | 说明 |
245  | -------- | -------- | -------- | -------- |
246  | type | string | 是 | 设置事件类型。type为“locatingRequiredDataChange”,表示订阅定位业务所需数据的变化。 |
247  | config | [LocatingRequiredDataConfig](#locatingrequireddataconfig10) | 是 | 表示获取定位所需数据时的配置参数。 |
248  | callback | Callback&lt;Array&lt;[LocatingRequiredData](#locatingrequireddata10)&gt;&gt; | 是 | 回调函数,返回定位业务所需数据。 |
249
250**错误码**:
251
252以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
253
254| 错误码ID | 错误信息 |
255| -------- | ---------------------------------------- |
256|201 | Permission verification failed. The application does not have the permission required to call the API.                 |
257|202 | Permission verification failed. A non-system application calls a system API. |
258|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.                 |
259|801 | Capability not supported. Failed to call ${geoLocationManager.on('locatingRequiredDataChange')} due to limited device capabilities.          |
260|3301800 | Failed to start WiFi or Bluetooth scanning.                            |
261
262**示例**
263
264  ```ts
265  import { geoLocationManager } from '@kit.LocationKit';
266  let callback = (code:Array<geoLocationManager.LocatingRequiredData>):void => {
267      console.info('locatingRequiredDataChange: ' + JSON.stringify(code));
268  }
269  let config:geoLocationManager.LocatingRequiredDataConfig = {'type': 1, 'needStartScan': true, 'scanInterval': 10000};
270  try {
271      geoLocationManager.on('locatingRequiredDataChange', config, callback);
272  } catch (err) {
273      console.error("errCode:" + err.code + ", message:"  + err.message);
274  }
275  ```
276
277
278## geoLocationManager.off('locatingRequiredDataChange')<sup>10+</sup>
279
280off(type: 'locatingRequiredDataChange', callback?: Callback&lt;Array&lt;LocatingRequiredData&gt;&gt;): void
281
282取消订阅定位业务所需数据的变化,并停止WiFi和蓝牙扫描。
283
284**需要权限**:ohos.permission.LOCATIONohos.permission.APPROXIMATELY_LOCATION
285
286**系统能力**:SystemCapability.Location.Location.Core
287
288**系统API**:此接口为系统接口。
289
290**参数**:
291
292  | 参数名 | 类型 | 必填 | 说明 |
293  | -------- | -------- | -------- | -------- |
294  | type | string | 是 | 设置事件类型。type为“locatingRequiredDataChange”,表示取消订阅定位业务所需数据的变化。 |
295  | callback | Callback&lt;Array&lt;[LocatingRequiredData](#locatingrequireddata10)&gt;&gt; | 否 | 需要取消订阅的回调函数。该回调函数需要与on接口传入的回调函数保持一致。若无此参数,则取消当前类型的所有订阅。 |
296
297**错误码**:
298
299错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
300
301| 错误码ID | 错误信息 |
302| -------- | ---------------------------------------- |
303|201 | Permission verification failed. The application does not have the permission required to call the API.                 |
304|202 | Permission verification failed. A non-system application calls a system API. |
305|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.                 |
306|801 | Capability not supported. Failed to call ${geoLocationManager.off('locatingRequiredDataChange')} due to limited device capabilities.          |
307
308**示例**
309
310  ```ts
311  import { geoLocationManager } from '@kit.LocationKit';
312  let callback = (code:Array<geoLocationManager.LocatingRequiredData>):void => {
313      console.info('locatingRequiredDataChange: ' + JSON.stringify(code));
314  }
315  let config:geoLocationManager.LocatingRequiredDataConfig = {'type': 1, 'needStartScan': true, 'scanInterval': 10000};
316  try {
317      geoLocationManager.on('locatingRequiredDataChange', config, callback);
318      geoLocationManager.off('locatingRequiredDataChange', callback);
319  } catch (err) {
320      console.error("errCode:" + err.code + ", message:"  + err.message);
321  }
322  ```
323
324## geoLocationManager.enableLocation
325
326enableLocation(callback: AsyncCallback&lt;void&gt;): void
327
328打开位置服务,使用callback异步回调。
329
330**系统API**:此接口为系统接口。
331
332**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGSohos.permission.CONTROL_LOCATION_SWITCH
333
334**系统能力**:SystemCapability.Location.Location.Core
335
336**参数**:
337
338  | 参数名 | 类型 | 必填 | 说明 |
339  | -------- | -------- | -------- | -------- |
340  | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数,当打开位置服务成功,err为undefined,否则为错误对象。 |
341
342**错误码**:
343
344以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
345
346| 错误码ID | 错误信息 |
347| -------- | ---------------------------------------- |
348|201 | Permission verification failed. The application does not have the permission required to call the API.                 |
349|202 | Permission verification failed. A non-system application calls a system API. |
350|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.                 |
351|801 | Capability not supported. Failed to call ${geoLocationManager.enableLocation} due to limited device capabilities.          |
352|3301000 | The location service is unavailable.                                              |
353
354**示例**
355
356  ```ts
357  import { geoLocationManager } from '@kit.LocationKit';
358  try {
359      geoLocationManager.enableLocation((err) => {
360          if (err) {
361              console.error('enableLocation: err=' + JSON.stringify(err));
362          }
363      });
364  } catch (err) {
365      console.error("errCode:" + err.code + ", message:"  + err.message);
366  }
367  ```
368
369
370## geoLocationManager.enableLocation
371
372enableLocation(): Promise&lt;void&gt;
373
374打开位置服务,使用Promise异步回调。
375
376**系统API**:此接口为系统接口。
377
378**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGSohos.permission.CONTROL_LOCATION_SWITCH
379
380**系统能力**:SystemCapability.Location.Location.Core
381
382**返回值**:
383
384  | 类型 | 说明 |
385  | -------- | -------- |
386  | Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象 |
387
388**错误码**:
389
390以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
391
392| 错误码ID | 错误信息 |
393| -------- | ---------------------------------------- |
394|201 | Permission verification failed. The application does not have the permission required to call the API.                 |
395|202 | Permission verification failed. A non-system application calls a system API. |
396|801 | Capability not supported. Failed to call ${geoLocationManager.enableLocation} due to limited device capabilities.          |
397|3301000 | The location service is unavailable.                                            |
398
399**示例**
400
401  ```ts
402  import { geoLocationManager } from '@kit.LocationKit';
403  import { BusinessError } from '@kit.BasicServicesKit';
404  try {
405      geoLocationManager.enableLocation().then(() => {
406          console.info('promise, enableLocation succeed');
407      })
408      .catch((error:BusinessError) => {
409          console.error('promise, enableLocation: error=' + JSON.stringify(error));
410      });
411  } catch (err) {
412      console.error("errCode:" + err.code + ", message:"  + err.message);
413  }
414  ```
415
416## geoLocationManager.disableLocation
417
418disableLocation(): void
419
420关闭位置服务。
421
422**系统API**:此接口为系统接口。
423
424**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGSohos.permission.CONTROL_LOCATION_SWITCH
425
426**系统能力**:SystemCapability.Location.Location.Core
427
428**错误码**:
429
430以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
431
432| 错误码ID | 错误信息 |
433| -------- | ---------------------------------------- |
434|201 | Permission verification failed. The application does not have the permission required to call the API.                 |
435|202 | Permission verification failed. A non-system application calls a system API. |
436|801 | Capability not supported. Failed to call ${geoLocationManager.disableLocation} due to limited device capabilities.          |
437|3301000 | The location service is unavailable.                                            |
438
439**示例**
440
441  ```ts
442  import { geoLocationManager } from '@kit.LocationKit';
443  try {
444      geoLocationManager.disableLocation();
445  } catch (err) {
446      console.error("errCode:" + err.code + ", message:"  + err.message);
447  }
448  ```
449
450## geoLocationManager.enableLocationMock
451
452enableLocationMock(): void
453
454使能位置模拟功能。
455
456**系统能力**:SystemCapability.Location.Location.Core
457
458**系统API**:此接口为系统接口。
459
460**需要权限**: ohos.permission.MOCK_LOCATION
461
462**错误码**:
463
464以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
465
466| 错误码ID | 错误信息 |
467| -------- | ---------------------------------------- |
468|201 | Permission verification failed. The application does not have the permission required to call the API.                 |
469|202 | Permission verification failed. A non-system application calls a system API. |
470|801 | Capability not supported. Failed to call ${geoLocationManager.enableLocationMock} due to limited device capabilities.          |
471|3301000 | The location service is unavailable.                                            |
472|3301100 | The location switch is off.|
473
474**示例**
475
476  ```ts
477  import { geoLocationManager } from '@kit.LocationKit';
478  try {
479      geoLocationManager.enableLocationMock();
480  } catch (err) {
481      console.error("errCode:" + err.code + ", message:"  + err.message);
482  }
483  ```
484
485
486## geoLocationManager.disableLocationMock
487
488disableLocationMock(): void
489
490去使能位置模拟功能。
491
492**系统能力**:SystemCapability.Location.Location.Core
493
494**系统API**:此接口为系统接口。
495
496**需要权限**: ohos.permission.MOCK_LOCATION
497
498**错误码**:
499
500以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
501
502| 错误码ID | 错误信息 |
503| -------- | ---------------------------------------- |
504|201 | Permission verification failed. The application does not have the permission required to call the API.                 |
505|202 | Permission verification failed. A non-system application calls a system API. |
506|801 | Capability not supported. Failed to call ${geoLocationManager.disableLocationMock} due to limited device capabilities.          |
507|3301000 | The location service is unavailable.                                            |
508|3301100 | The location switch is off.|
509
510**示例**
511
512  ```ts
513  import { geoLocationManager } from '@kit.LocationKit';
514  try {
515      geoLocationManager.disableLocationMock();
516  } catch (err) {
517      console.error("errCode:" + err.code + ", message:"  + err.message);
518  }
519  ```
520
521
522## geoLocationManager.setMockedLocations
523
524setMockedLocations(config: LocationMockConfig): void
525
526设置模拟的位置信息,后面会以该接口中携带的时间间隔上报模拟位置。
527
528该接口需要在调用[geoLocationManager.enableLocationMock](#geolocationmanagerenablelocationmock)之后才能调用。
529
530**系统能力**:SystemCapability.Location.Location.Core
531
532**系统API**:此接口为系统接口。
533
534**需要权限**: ohos.permission.MOCK_LOCATION
535
536**参数**:
537
538  | 参数名 | 类型 | 必填 | 说明 |
539  | -------- | -------- | -------- | -------- |
540  | config |  [LocationMockConfig](#locationmockconfig) | 是 | 指示位置模拟的配置参数,包含模拟位置上报的时间间隔和模拟位置数组。 |
541
542**错误码**:
543
544以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
545
546| 错误码ID | 错误信息 |
547| -------- | ---------------------------------------- |
548|201 | Permission verification failed. The application does not have the permission required to call the API.                 |
549|202 | Permission verification failed. A non-system application calls a system API. |
550|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.                 |
551|801 | Capability not supported. Failed to call ${geoLocationManager.setMockedLocations} due to limited device capabilities.          |
552|3301000 | The location service is unavailable.                                            |
553|3301100 | The location switch is off.|
554
555**示例**
556
557  ```ts
558  import { geoLocationManager } from '@kit.LocationKit';
559  let locations:Array<geoLocationManager.Location> = [
560      {"latitude": 30.12, "longitude": 120.11, "altitude": 123, "accuracy": 1, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 1000000000, "additionSize": 0, "isFromMock": true},
561      {"latitude": 31.13, "longitude": 121.11, "altitude": 123, "accuracy": 2, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 2000000000, "additionSize": 0, "isFromMock": true},
562      {"latitude": 32.14, "longitude": 122.11, "altitude": 123, "accuracy": 3, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 3000000000, "additionSize": 0, "isFromMock": true},
563      {"latitude": 33.15, "longitude": 123.11, "altitude": 123, "accuracy": 4, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 4000000000, "additionSize": 0, "isFromMock": true},
564      {"latitude": 34.16, "longitude": 124.11, "altitude": 123, "accuracy": 5, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 5000000000, "additionSize": 0, "isFromMock": true}
565  ];
566  let config:geoLocationManager.LocationMockConfig = {"timeInterval": 5, "locations": locations};
567  try {
568      geoLocationManager.enableLocationMock();
569      geoLocationManager.setMockedLocations(config);
570  } catch (err) {
571      console.error("errCode:" + err.code + ", message:"  + err.message);
572  }
573  ```
574
575
576## geoLocationManager.enableReverseGeocodingMock
577
578enableReverseGeocodingMock(): void
579
580使能逆地理编码模拟功能。
581
582**系统能力**:SystemCapability.Location.Location.Core
583
584**系统API**:此接口为系统接口。
585
586**需要权限**: ohos.permission.MOCK_LOCATION
587
588**错误码**:
589
590以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
591
592| 错误码ID | 错误信息 |
593| -------- | ---------------------------------------- |
594|201 | Permission verification failed. The application does not have the permission required to call the API.                 |
595|202 | Permission verification failed. A non-system application calls a system API. |
596|801 | Capability not supported. Failed to call ${geoLocationManager.enableReverseGeocodingMock} due to limited device capabilities.          |
597|3301000 | The location service is unavailable.                                            |
598
599**示例**
600
601  ```ts
602  import { geoLocationManager } from '@kit.LocationKit';
603  try {
604      geoLocationManager.enableReverseGeocodingMock();
605  } catch (err) {
606      console.error("errCode:" + err.code + ", message:"  + err.message);
607  }
608  ```
609
610
611## geoLocationManager.disableReverseGeocodingMock
612
613disableReverseGeocodingMock(): void
614
615去使能逆地理编码模拟功能。
616
617**系统能力**:SystemCapability.Location.Location.Core
618
619**系统API**:此接口为系统接口。
620
621**需要权限**: ohos.permission.MOCK_LOCATION
622
623**错误码**:
624
625以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
626
627| 错误码ID | 错误信息 |
628| -------- | ---------------------------------------- |
629|201 | Permission verification failed. The application does not have the permission required to call the API.                 |
630|202 | Permission verification failed. A non-system application calls a system API. |
631|801 | Capability not supported. Failed to call ${geoLocationManager.disableReverseGeocodingMock} due to limited device capabilities.          |
632|3301000 | The location service is unavailable.                                            |
633
634**示例**
635
636  ```ts
637  import { geoLocationManager } from '@kit.LocationKit';
638  try {
639      geoLocationManager.disableReverseGeocodingMock();
640  } catch (err) {
641      console.error("errCode:" + err.code + ", message:"  + err.message);
642  }
643  ```
644
645
646## geoLocationManager.setReverseGeocodingMockInfo
647
648setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;): void
649
650设置逆地理编码模拟功能的配置信息,包含了位置和地名的对应关系,后续进行逆地理编码查询时如果位置信息位于配置信息中,就返回对应的地名。
651
652该接口需要在调用[geoLocationManager.enableReverseGeocodingMock](#geolocationmanagerenablereversegeocodingmock)之后才能调用。
653
654**系统能力**:SystemCapability.Location.Location.Core
655
656**系统API**:此接口为系统接口。
657
658**需要权限**: ohos.permission.MOCK_LOCATION
659
660**参数**:
661
662  | 参数名 | 类型 | 必填 | 说明 |
663  | -------- | -------- | -------- | -------- |
664  | mockInfos | Array&lt;[ReverseGeocodingMockInfo](#reversegeocodingmockinfo)&gt; | 是 | 指示逆地理编码模拟功能的配置参数数组。逆地理编码模拟功能的配置参数包含了一个位置和一个地名。 |
665
666**错误码**:
667
668以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
669
670| 错误码ID | 错误信息 |
671| -------- | ---------------------------------------- |
672|201 | Permission verification failed. The application does not have the permission required to call the API.                 |
673|202 | Permission verification failed. A non-system application calls a system API. |
674|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.                 |
675|801 | Capability not supported. Failed to call ${geoLocationManager.setReverseGeocodingMockInfo} due to limited device capabilities.          |
676|3301000 | The location service is unavailable.                                            |
677
678**示例**
679
680  ```ts
681  import { geoLocationManager } from '@kit.LocationKit';
682  let mockInfos:Array<geoLocationManager.ReverseGeocodingMockInfo> = [
683      {"location": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "isFromMock": true}},
684      {"location": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "isFromMock": true}},
685      {"location": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "isFromMock": true}},
686      {"location": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "isFromMock": true}},
687      {"location": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "isFromMock": true}},
688  ];
689  try {
690      geoLocationManager.enableReverseGeocodingMock();
691      geoLocationManager.setReverseGeocodingMockInfo(mockInfos);
692  } catch (err) {
693      console.error("errCode:" + err.code + ", message:"  + err.message);
694  }
695  ```
696
697
698## geoLocationManager.isLocationPrivacyConfirmed
699
700isLocationPrivacyConfirmed(type: LocationPrivacyType): boolean
701
702查询用户是否同意定位服务隐私申明,是否同意启用定位服务。只有系统应用才能调用。
703
704**系统API**:此接口为系统接口。
705
706**系统能力**:SystemCapability.Location.Location.Core
707
708**参数**:
709
710  | 参数名 | 类型 | 必填 | 说明 |
711  | -------- | -------- | -------- | -------- |
712  | type |  [LocationPrivacyType](#locationprivacytype)| 是 | 指定隐私申明场景,例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 |
713
714**返回值**:
715
716  | 类型 | 说明 |
717  | -------- | -------- |
718  | boolean | true:用户同意定位服务隐私申明。<br/>false:用户不同意定位服务隐私申明。 |
719
720**错误码**:
721
722以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
723
724| 错误码ID | 错误信息 |
725| -------- | ---------------------------------------- |
726|202 | Permission verification failed. A non-system application calls a system API. |
727|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.                 |
728|801 | Capability not supported. Failed to call ${geoLocationManager.isLocationPrivacyConfirmed} due to limited device capabilities.          |
729|3301000 | The location service is unavailable.                                            |
730
731**示例**
732
733  ```ts
734  import { geoLocationManager } from '@kit.LocationKit';
735  try {
736      let isConfirmed = geoLocationManager.isLocationPrivacyConfirmed(1);
737  } catch (err) {
738      console.error("errCode:" + err.code + ", message:"  + err.message);
739  }
740  ```
741
742
743## geoLocationManager.setLocationPrivacyConfirmStatus
744
745setLocationPrivacyConfirmStatus(type: LocationPrivacyType, isConfirmed: boolean): void
746
747设置用户勾选定位服务隐私申明的状态,记录用户是否同意启用定位服务。只有系统应用才能调用。
748
749**系统API**:此接口为系统接口。
750
751**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGS
752
753**系统能力**:SystemCapability.Location.Location.Core
754
755**参数**:
756
757  | 参数名 | 类型 | 必填 | 说明 |
758  | -------- | -------- | -------- | -------- |
759  | type | [LocationPrivacyType](#locationprivacytype) | 是 | 指定隐私申明场景,例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 |
760  | isConfirmed | boolean | 是 | true:用户同意定位服务隐私申明。<br/>false:用户不同意定位服务隐私申明。 |
761
762**错误码**:
763
764以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
765
766| 错误码ID | 错误信息 |
767| -------- | ---------------------------------------- |
768|201 | Permission verification failed. The application does not have the permission required to call the API.                 |
769|202 | Permission verification failed. A non-system application calls a system API. |
770|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.                 |
771|801 | Capability not supported. Failed to call ${geoLocationManager.setLocationPrivacyConfirmStatus} due to limited device capabilities.          |
772|3301000 | The location service is unavailable.                                            |
773
774**示例**
775
776  ```ts
777  import { geoLocationManager } from '@kit.LocationKit';
778  try {
779      geoLocationManager.setLocationPrivacyConfirmStatus(1, true);
780  } catch (err) {
781      console.error("errCode:" + err.code + ", message:"  + err.message);
782  }
783  ```
784
785
786## geoLocationManager.getLocatingRequiredData<sup>10+</sup>
787
788getLocatingRequiredData(config: LocatingRequiredDataConfig): Promise&lt;Array&lt;LocatingRequiredData&gt;&gt;
789
790单次获取定位业务所需数据,包含WiFi蓝牙扫描信息,使用Promise方式异步返回结果。
791
792**需要权限**:ohos.permission.LOCATIONohos.permission.APPROXIMATELY_LOCATION
793
794**系统能力**:SystemCapability.Location.Location.Core
795
796**系统API**:此接口为系统接口。
797
798**参数**:
799
800  | 参数名 | 类型 | 必填 | 说明 |
801  | -------- | -------- | -------- | -------- |
802  | config | [LocatingRequiredDataConfig](#locatingrequireddataconfig10) | 是 | 表示获取定位所需数据时的配置参数。 |
803
804**返回值**:
805
806  | 类型 | 说明 |
807  | -------- | -------- |
808  | Promise&lt;Array&lt;[LocatingRequiredData](#locatingrequireddata10)&gt;&gt; | 以Promise形式返回定位业务所需数据,包含WiFi蓝牙扫描信息。 |
809
810**错误码**:
811
812以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
813
814| 错误码ID | 错误信息 |
815| -------- | ---------------------------------------- |
816|201 | Permission verification failed. The application does not have the permission required to call the API.                 |
817|202 | Permission verification failed. A non-system application calls a system API. |
818|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.                 |
819|801 | Capability not supported. Failed to call ${geoLocationManager.getLocatingRequiredData} due to limited device capabilities.          |
820|3301800  | Failed to start WiFi or Bluetooth scanning.                    |
821
822**示例**
823
824  ```ts
825  import { geoLocationManager } from '@kit.LocationKit';
826  import { BusinessError } from '@kit.BasicServicesKit';
827  let config:geoLocationManager.LocatingRequiredDataConfig = {'type': 1, 'needStartScan': true, 'scanInterval': 10000};
828  try {
829      geoLocationManager.getLocatingRequiredData(config).then((result) => {
830          console.info('getLocatingRequiredData return: ' + JSON.stringify(result));
831      })
832      .catch((error:BusinessError) => {
833          console.error('promise, getLocatingRequiredData: error=' + JSON.stringify(error));
834      });
835  } catch (err) {
836      console.error("errCode:" + err.code + ", message:"  + err.message);
837  }
838  ```
839
840
841## geoLocationManager.on('locationIconStatusChange')<sup>12+</sup>
842
843on(type: 'locationIconStatusChange', callback: Callback&lt;LocationIconStatus&gt;): void
844
845订阅定位图标状态变化。使用callback异步回调。
846
847**系统能力**:SystemCapability.Location.Location.Core
848
849**系统API**:此接口为系统接口。
850
851**参数**:
852
853  | 参数名 | 类型 | 必填 | 说明 |
854  | -------- | -------- | -------- | -------- |
855  | type | string | 是 | 设置事件类型。type为“locationIconStatusChange”,表示订阅定位图标状态变化。 |
856  | callback | Callback&lt;[LocationIconStatus](#locationiconstatus12)&gt; | 是 | 回调函数,返回定位图标状态。 |
857
858**错误码**:
859
860以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
861
862| 错误码ID | 错误信息 |
863| -------- | ---------------------------------------- |
864|202 | Permission verification failed. A non-system application calls a system API. |
865|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.                 |
866|801 | Capability not supported. Failed to call ${geoLocationManager.on('locationIconStatusChange')} due to limited device capabilities.          |
867|3301000 | The location service is unavailable.                        |
868
869**示例**
870
871  ```ts
872  import { geoLocationManager } from '@kit.LocationKit';
873  let callback = (code: geoLocationManager.LocationIconStatus):void => {
874      console.info('LocationIconStatus: ' + JSON.stringify(code));
875  }
876  try {
877      geoLocationManager.on('locationIconStatusChange', callback);
878  } catch (err) {
879      console.error("errCode:" + err.code + ", message:"  + err.message);
880  }
881  ```
882
883
884## geoLocationManager.off('locationIconStatusChange')<sup>12+</sup>
885
886off(type: 'locationIconStatusChange', callback?: Callback&lt;LocationIconStatus&gt;): void
887
888取消订阅定位图标状态的变化。
889
890**系统能力**:SystemCapability.Location.Location.Core
891
892**系统API**:此接口为系统接口。
893
894**参数**:
895
896  | 参数名 | 类型 | 必填 | 说明 |
897  | -------- | -------- | -------- | -------- |
898  | type | string | 是 | 设置事件类型。type为“locationIconStatusChange”,表示取消订阅定位图标状态变化。 |
899  | callback | Callback&lt;[LocationIconStatus](#locationiconstatus12)&gt;  | 否 | 需要取消订阅的回调函数。该回调函数需要与on接口传入的回调函数保持一致。若无此参数,则取消当前类型的所有订阅。 |
900
901**错误码**:
902
903错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
904
905| 错误码ID | 错误信息 |
906| -------- | ---------------------------------------- |
907|202 | Permission verification failed. A non-system application calls a system API. |
908|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.                 |
909|801 | Capability not supported. Failed to call ${geoLocationManager.off('locationIconStatusChange')} due to limited device capabilities.          |
910|3301000 | The location service is unavailable.        |
911
912**示例**
913
914  ```ts
915  import { geoLocationManager } from '@kit.LocationKit';
916  let callback = (code: geoLocationManager.LocationIconStatus):void => {
917      console.info('LocationIconStatus: ' + JSON.stringify(code));
918  }
919  try {
920      geoLocationManager.on('locationIconStatusChange', callback);
921	  geoLocationManager.off('locationIconStatusChange', callback);
922  } catch (err) {
923      console.error("errCode:" + err.code + ", message:"  + err.message);
924  }
925  ```
926
927
928## geoLocationManager.getLocationIconStatus<sup>12+</sup>
929
930getLocationIconStatus(): LocationIconStatus
931
932获取当前的定位图标状态。
933
934**系统能力**:SystemCapability.Location.Location.Core
935
936**系统API**:此接口为系统接口。
937
938**返回值**:
939
940  | 类型 | 说明 |
941  | -------- | -------- |
942  | [LocationIconStatus](#locationiconstatus12) | 返回定位图标状态。 |
943
944**错误码**:
945
946以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
947
948| 错误码ID | 错误信息 |
949| -------- | ---------------------------------------- |
950|202 | Permission verification failed. A non-system application calls a system API. |
951|801 | Capability not supported. Failed to call ${geoLocationManager.getLocationIconStatus} due to limited device capabilities.          |
952|3301000  | The location service is unavailable.                  |
953
954**示例**
955
956  ```ts
957  import { geoLocationManager } from '@kit.LocationKit';
958  try {
959      let iconStatus = geoLocationManager.getLocationIconStatus();
960  } catch (err) {
961      console.error("errCode:" + err.code + ", message:"  + err.message);
962  }
963  ```
964
965
966## geoLocationManager.enableLocationByUserId<sup>18+</sup>
967
968enableLocationByUserId(userId: number): Promise&lt;void&gt;
969
970打开指定系统账号的定位开关,使用Promise异步回调。
971
972**系统API**:此接口为系统接口。
973
974**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGSohos.permission.CONTROL_LOCATION_SWITCH
975
976**系统能力**:SystemCapability.Location.Location.Core
977
978**参数**:
979
980  | 参数名 | 类型 | 必填 | 说明 |
981  | -------- | -------- | -------- | -------- |
982  | userId | number | 是 | 系统账号ID,获取系统账号ID可参考[查询所有已创建的系统账号](../../basic-services/account/manage-os-account.md#查询所有已创建的系统账号)|
983
984**返回值**:
985
986  | 类型 | 说明 |
987  | -------- | -------- |
988  | Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象 |
989
990**错误码**:
991
992以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
993
994| 错误码ID | 错误信息 |
995| -------- | ---------------------------------------- |
996|201 | Permission verification failed. The application does not have the permission required to call the API.                 |
997|202 | Permission verification failed. A non-system application calls a system API. |
998|801 | Capability not supported. Failed to call ${geoLocationManager.enableLocationByUserId} due to limited device capabilities.          |
999|3301000 | The location service is unavailable.                                            |
1000
1001**示例**
1002
1003  ```ts
1004  import { geoLocationManager } from '@kit.LocationKit';
1005  import { BusinessError } from '@kit.BasicServicesKit';
1006  try {
1007      // 打开指定系统账号的位置开关,如:处于ID为101的账号下,可以打开ID为100的账号的位置开关
1008      let userId:number = 100;
1009      geoLocationManager.enableLocationByUserId(userId).then(() => {
1010          console.info('promise, enableLocationByUserId succeed');
1011      })
1012      .catch((error:BusinessError) => {
1013          console.error('promise, enableLocationByUserId: error=' + JSON.stringify(error));
1014      });
1015  } catch (err) {
1016      console.error("errCode:" + err.code + ", message:"  + err.message);
1017  }
1018  ```
1019
1020
1021## geoLocationManager.disableLocationByUserId<sup>18+</sup>
1022
1023disableLocationByUserId(userId: number): void
1024
1025关闭指定系统账号的定位开关。
1026
1027**系统API**:此接口为系统接口。
1028
1029**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGSohos.permission.CONTROL_LOCATION_SWITCH
1030
1031**系统能力**:SystemCapability.Location.Location.Core
1032
1033**参数**:
1034
1035  | 参数名 | 类型 | 必填 | 说明 |
1036  | -------- | -------- | -------- | -------- |
1037  | userId | number | 是 | 系统账号ID,获取系统账号ID可参考[查询所有已创建的系统账号](../../basic-services/account/manage-os-account.md#查询所有已创建的系统账号)|
1038
1039**错误码**:
1040
1041以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
1042
1043| 错误码ID | 错误信息 |
1044| -------- | ---------------------------------------- |
1045|201 | Permission verification failed. The application does not have the permission required to call the API.                 |
1046|202 | Permission verification failed. A non-system application calls a system API. |
1047|801 | Capability not supported. Failed to call ${geoLocationManager.disableLocationByUserId} due to limited device capabilities.          |
1048|3301000 | The location service is unavailable.                                            |
1049
1050**示例**
1051
1052  ```ts
1053  import { geoLocationManager } from '@kit.LocationKit';
1054  try {
1055      // 关闭指定系统账号的位置开关,如:处于ID为101的账号下,可以关闭ID为100的账号的位置开关
1056      let userId:number = 100;
1057      geoLocationManager.disableLocationByUserId(userId);
1058  } catch (err) {
1059      console.error("errCode:" + err.code + ", message:"  + err.message);
1060  }
1061  ```
1062
1063
1064## geoLocationManager.isLocationEnabledByUserId<sup>18+</sup>
1065
1066isLocationEnabledByUserId(userId: number): boolean
1067
1068判断指定系统账号的位置开关是否开启。
1069
1070**系统API**:此接口为系统接口。
1071
1072**系统能力**:SystemCapability.Location.Location.Core
1073
1074**参数**:
1075
1076  | 参数名 | 类型 | 必填 | 说明 |
1077  | -------- | -------- | -------- | -------- |
1078  | userId | number | 是 | 系统账号ID,获取系统账号ID可参考 [查询所有已创建的系统账号](../../basic-services/account/manage-os-account.md#查询所有已创建的系统账号)|
1079
1080**返回值**:
1081
1082  | 类型 | 说明 |
1083  | -------- | -------- |
1084  | boolean | true:位置信息开关已开启。<br/>false:位置信息开关已关闭。 |
1085
1086**错误码**:
1087
1088以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
1089
1090| 错误码ID | 错误信息 |
1091| -------- | ---------------------------------------- |
1092|202 | Permission verification failed. A non-system application calls a system API. |
1093|801 | Capability not supported. Failed to call ${geoLocationManager.isLocationEnabledByUserId} due to limited device capabilities.          |
1094|3301000 | The location service is unavailable. |
1095
1096**示例**
1097
1098  ```ts
1099  import { geoLocationManager } from '@kit.LocationKit';
1100  try {
1101      // 查询指定系统账号的位置开关状态,如:处于ID为101的账号下,可以查询ID为100的账号的位置开关状态
1102      let userId:number = 100;
1103      let locationEnabled = geoLocationManager.isLocationEnabledByUserId(userId);
1104  } catch (err) {
1105      console.error("errCode:" + err.code + ", message:"  + err.message);
1106  }
1107  ```
1108
1109
1110## geoLocationManager.setLocationSwitchIgnored<sup>18+</sup>
1111
1112setLocationSwitchIgnored(isIgnored: boolean): void
1113
1114设置应用获取位置信息是否受位置开关控制。
1115
1116设置为true后,允许应用在位置开关关闭的场景获取到位置信息,有效时间为从调用接口成功开始的两分钟。
1117
1118**系统API**:此接口为系统接口。
1119
1120**需要权限**:ohos.permission.LOCATION_SWITCH_IGNORED
1121
1122**系统能力**:SystemCapability.Location.Location.Core
1123
1124**参数**:
1125
1126  | 参数名 | 类型 | 必填 | 说明 |
1127  | -------- | -------- | -------- | -------- |
1128  | isIgnored | boolean | 是 | true:需要在位置开关关闭的场景下获取位置信息。有效时间为从调用接口成功开始的两分钟。<br/>false:不需要在位置开关关闭的场景下获取位置信息。|
1129
1130**错误码**:
1131
1132以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
1133
1134| 错误码ID | 错误信息 |
1135| -------- | ---------------------------------------- |
1136|201 | Permission verification failed. The application does not have the permission required to call the API.                 |
1137|202 | Permission verification failed. A non-system application calls a system API. |
1138|801 | Capability not supported. Failed to call ${geoLocationManager.setLocationSwitchIgnored} due to limited device capabilities.          |
1139|3301000 | The location service is unavailable.                                            |
1140
1141**示例**
1142
1143  ```ts
1144  import { geoLocationManager } from '@kit.LocationKit';
1145  try {
1146      let isIgnored:boolean = true;
1147      geoLocationManager.setLocationSwitchIgnored(isIgnored);
1148  } catch (err) {
1149      console.error("errCode:" + err.code + ", message:"  + err.message);
1150  }
1151  ```