@ohos.enterprise.locationManager (Location Management) (System API)

The locationManager module provides location service management capabilities for devices, including setting and obtaining the location service policy.

NOTE

• The initial APIs of this module are supported since API version 11. Newly added APIs will be marked with a superscript to indicate their earliest API version.

• The APIs of this module can be used only in the stage model.

• The APIs provided by this module can be called only by a device administrator application that is enabled.

• The APIs provided by this module are system APIs.

Modules to Import

import locationManager from '@ohos.enterprise.locationManager';

locationManager.setLocationPolicy

setLocationPolicy(admin: Want, policy: LocationPolicy): void

Sets the location service policy. This API returns the result synchronously. If the operation fails, an exception will be thrown.

Required permissions: ohos.permission.ENTERPRISE_MANAGE_LOCATION

System capability: SystemCapability.Customization.EnterpriseDeviceManager

Parameters

Error codes

For details about the error codes, see Enterprise Device Management Error Codes.

Example

import Want from '@ohos.app.ability.Want';
import locationManager from '@ohos.enterprise.locationManager';

let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};

try {
    locationManager.setLocationPolicy(wantTemp, locationManager.LocationPolicy.DISALLOW_LOCATION_SERVICE);
    console.info(`Succeeded in setting location patch tag.`);
} catch(err) {
    console.error(`Failed to get location patch tag. Code: ${err.code}, message: ${err.message}`);
}

locationManager.getLocationPolicy

getLocationPolicy(admin: Want): LocationPolicy

Obtains the location service policy. This API returns the result synchronously. If the operation is successful, the location service policy is returned. If the operation fails, an exception will be thrown.

Required permissions: ohos.permission.ENTERPRISE_MANAGE_LOCATION

System capability: SystemCapability.Customization.EnterpriseDeviceManager

Parameters

Return value

Error codes

For details about the error codes, see Enterprise Device Management Error Codes.

Example

import Want from '@ohos.app.ability.Want';
import locationManager from '@ohos.enterprise.locationManager';
let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};

try {
    let result: locationManager.LocationPolicy = locationManager.getLocationPolicy(wantTemp);
    console.info(`Succeeded in getting location policy. policy: ${result}`);
} catch(err) {
    console.error(`Failed to get device encryption status. Code: ${err.code}, message: ${err.message}`);
}

LocationPolicy

Enumerates the location service policies.

System capability: SystemCapability.Customization.EnterpriseDeviceManager

Model restriction: This API can be used only in the stage model.