@ohos.configPolicy (Configuration Policy) (System API)

The configPolicy module provides APIs for obtaining the custom configuration directory and file path based on the predefined custom configuration level.

NOTE

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

• The APIs provided by this module are system APIs.

Modules to Import

import configPolicy from '@ohos.configPolicy';

getOneCfgFile

getOneCfgFile(relPath: string, callback: AsyncCallback<string>)

Obtains the path of the configuration file with the highest priority based on the specified file name. This API uses an asynchronous callback to return the result. For example, if there are two config.xml files (in ascending order of priority): /system/etc/config.xml and /sys_pod/etc/config.xml, then /sys_pod/etc/config.xml is returned.

System capability: SystemCapability.Customization.ConfigPolicy

Parameters

Example

import { BusinessError } from '@ohos.base';

try {
  let relpath: string = 'etc/config.xml';
  configPolicy.getOneCfgFile(relpath, (error: BusinessError, value: string) => {
    if (error == null) {
      console.log('value is ' + value);
    } else {
      console.log('error occurs ' + error);
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.log('error:' + code + ',' + message);
}

getOneCfgFile

getOneCfgFile(relPath: string): Promise<string>

Obtains the path of the configuration file with the highest priority based on the specified file name. This API uses a promise to return the result.

System capability: SystemCapability.Customization.ConfigPolicy

Parameters

Return value

Example

import { BusinessError } from '@ohos.base';

try {
  let relpath: string = 'etc/config.xml';
  configPolicy.getOneCfgFile(relpath).then((value: string) => {
    console.log('value is ' + value);
  }).catch((error: BusinessError) => {
    console.log('getOneCfgFile promise ' + error);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.log('error:' + code + ',' + message);
}

getCfgFiles

getCfgFiles(relPath: string, callback: AsyncCallback<Array<string>>)

Obtains a list of configuration files with the specified name, sorted in ascending order of priority. This API uses an asynchronous callback to return the result. For example, if there are two config.xml files (in ascending order of priority): /system/etc/config.xml and /sys_pod/etc/config.xml, then /system/etc/config.xml, /sys_pod/etc/config.xml is returned.

System capability: SystemCapability.Customization.ConfigPolicy

Parameters

Example

import { BusinessError } from '@ohos.base';

try {
  configPolicy.getCfgFiles('etc/config.xml', (error: BusinessError, value: Array<string>) => {
    if (error == null) {
      console.log('value is ' + value);
    } else {
      console.log('error occurs ' + error);
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.log('error:' + code + ',' + message);
}

getCfgFiles

getCfgFiles(relPath: string): Promise<Array<string>>

Obtains a list of configuration files with the specified name, sorted in ascending order of priority. This API uses a promise to return the result.

System capability: SystemCapability.Customization.ConfigPolicy

Parameters

Return value

Example

import { BusinessError } from '@ohos.base';

try {
  let relpath: string = 'etc/config.xml';
  configPolicy.getCfgFiles(relpath).then((value: Array<string>) => {
    console.log('value is ' + value);
  }).catch((error: BusinessError) => {
    console.log('getCfgFiles promise ' + error);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.log('error:' + code + ',' + message);
}

getCfgDirList

getCfgDirList(callback: AsyncCallback<Array<string>>)

Obtains the list of configuration level directories. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Customization.ConfigPolicy

Parameters

Example

import { BusinessError } from '@ohos.base';

try {
  configPolicy.getCfgDirList((error: BusinessError, value: Array<string>) => {
    if (error == null) {
      console.log('value is ' + value);
    } else {
      console.log('error occurs ' + error);
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.log('error:' + code + ',' + message);
}

getCfgDirList

getCfgDirList(): Promise<Array<string>>

Obtains the list of configuration level directories. This API uses a promise to return the result.

System capability: SystemCapability.Customization.ConfigPolicy

Return value

Example

import { BusinessError } from '@ohos.base';

try {
  configPolicy.getCfgDirList().then((value: Array<string>) => {
    console.log('value is ' + value);
  }).catch((error: BusinessError) => {
    console.log('getCfgDirList promise ' + error);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.log('error:' + code + ',' + message);
}

getOneCfgFile¹¹⁺

getOneCfgFile(relPath: string, followMode: FollowXMode, callback: AsyncCallback<string>)

Obtains the path of the configuration file with the highest priority based on the specified file name and follow mode. This API uses an asynchronous callback to return the result. For example, there are three config.xml files (in ascending order of priority): /system/etc/config.xml, /sys_pod/etc/config.xml, and /sys_pod/etc/carrier/46060/etc/config.xml. If the opkey of the default card is 46060 and the follow mode is SIM_DEFAULT, then /sys_pod/etc/carrier/46060/etc/config.xml is returned.

System capability: SystemCapability.Customization.ConfigPolicy

Parameters

Example

import { BusinessError } from '@ohos.base';

try {
  let relpath: string = 'etc/config.xml';
  configPolicy.getOneCfgFile(relpath, configPolicy.FollowXMode.SIM_DEFAULT,
    (error: BusinessError, value: string) => {
    if (error == null) {
      console.log('value is ' + value);
    } else {
      console.log('error occurs ' + error);
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.log('error:' + code + ',' + message);
}

getOneCfgFile¹¹⁺

getOneCfgFile(relPath: string, followMode: FollowXMode, extra: string, callback: AsyncCallback<string>)

Obtains the path of the configuration file with the highest priority based on the specified file name and custom follow rule. This API uses an asynchronous callback to return the result. For example, there are three config.xml files (in ascending order of priority): /system/etc/config.xml, /sys_pod/etc/config.xml, and /sys_pod/etc/carrier/46060/etc/config.xml. If the opkey of card 1 is 46060, the follow mode is USER_DEFINED, and the custom follow rule is etc/carrier/${telephony.sim.opkey0}, then /sys_pod/etc/carrier/46060/etc/config.xml is returned.

System capability: SystemCapability.Customization.ConfigPolicy

Parameters

Example

import { BusinessError } from '@ohos.base';

try {
  let relpath: string = 'etc/config.xml';
  let extra: string = 'etc/carrier/${telephony.sim.opkey0}';
  configPolicy.getOneCfgFile(relpath, configPolicy.FollowXMode.USER_DEFINED, extra,
    (error: BusinessError, value: string) => {
    if (error == null) {
      console.log('value is ' + value);
    } else {
      console.log('error occurs ' + error);
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.log('error:' + code + ',' + message);
}

getOneCfgFile¹¹⁺

getOneCfgFile(relPath: string, followMode: FollowXMode, extra?: string): Promise<string>

Obtains the path of the configuration file with the highest priority based on the specified file name and follow mode. This API uses a promise to return the result.

System capability: SystemCapability.Customization.ConfigPolicy

Parameters

Return value

Example

import { BusinessError } from '@ohos.base';

try {
  let relpath: string = 'etc/config.xml';
  let extra: string = 'etc/carrier/${telephony.sim.opkey0}';
  configPolicy.getOneCfgFile(relpath, configPolicy.FollowXMode.SIM_DEFAULT, extra).then((value: string) => {
    console.log('value is ' + value);
  }).catch((error: BusinessError) => {
    console.log('getOneCfgFile promise ' + error);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.log('error:' + code + ',' + message);
}

getOneCfgFileSync¹¹⁺

getOneCfgFileSync(relPath: string, followMode?: FollowXMode, extra?: string): string

Obtains the path of the configuration file with the highest priority based on the specified file name and follow mode. This API returns the result synchronously.

System capability: SystemCapability.Customization.ConfigPolicy

Parameters

Return value

Example

import { BusinessError } from '@ohos.base';

try {
  let relpath: string = 'etc/config.xml';
  let extra: string = 'etc/carrier/${telephony.sim.opkey0}';
  let result: string = configPolicy.getOneCfgFileSync(relpath, configPolicy.FollowXMode.USER_DEFINED, extra);
  console.log('result is ' + result);
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.log('error:' + code + ',' + message);
}

getCfgFiles¹¹⁺

getCfgFiles(relPath: string, followMode: FollowXMode, callback: AsyncCallback<Array<string>>)

Obtains a list of configuration files based on the specified file name and follow mode, sorted in ascending order of priority. This API uses an asynchronous callback to return the result. For example, there are three config.xml files (in ascending order of priority): /system/etc/config.xml, /sys_pod/etc/config.xml, and /sys_pod/etc/carrier/46060/etc/config.xml. If the opkey of the default card is 46060, and the follow mode is SIM_DEFAULT, then /system/etc/config.xml, /sys_pod/etc/config.xml, /sys_pod/etc/carrier/46060/etc/config.xml is returned.

System capability: SystemCapability.Customization.ConfigPolicy

Parameters

Example

import { BusinessError } from '@ohos.base';

try {
  let relpath: string = 'etc/config.xml';
  configPolicy.getCfgFiles(relpath, configPolicy.FollowXMode.SIM_DEFAULT,
    (error: BusinessError, value: Array<string>) => {
    if (error == null) {
      console.log('value is ' + value);
    } else {
      console.log('error occurs ' + error);
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.log('error:' + code + ',' + message);
}

getCfgFiles¹¹⁺

getCfgFiles(relPath: string, followMode: FollowXMode, extra: string, callback: AsyncCallback<Array<string>>)

Obtains a list of configuration files based on the specified file name and custom follow rule, sorted in ascending order of priority. This API uses an asynchronous callback to return the result. For example, there are three config.xml files (in ascending order of priority): /system/etc/config.xml, /sys_pod/etc/config.xml, and /sys_pod/etc/carrier/46060/etc/config.xml. The opkey of card 1 is 46060, the follow mode is USER_DEFINED, and the custom follow rule is etc/carrier/${telephony.sim.opkey0}, then /system/etc/config.xml, /sys_pod/etc/config.xml, /sys_pod/etc/carrier/46060/etc/config.xml is returned.

System capability: SystemCapability.Customization.ConfigPolicy

Parameters

Example

import { BusinessError } from '@ohos.base';

try {
  let relpath: string = 'etc/config.xml';
  let extra: string = 'etc/carrier/${telephony.sim.opkey0}';
  configPolicy.getCfgFiles(relpath, configPolicy.FollowXMode.SIM_DEFAULT, extra,
    (error: BusinessError, value: Array<string>) => {
    if (error == null) {
      console.log('value is ' + value);
    } else {
      console.log('error occurs ' + error);
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.log('error:' + code + ',' + message);
}

getCfgFiles¹¹⁺

getCfgFiles(relPath: string, followMode: FollowXMode, extra?: string): Promise<Array<string>>

Obtains a list of configuration files based on the specified file name and follow mode, sorted in ascending order of priority. This API uses a promise to return the result.

System capability: SystemCapability.Customization.ConfigPolicy

Parameters

Return value

Example

import { BusinessError } from '@ohos.base';

try {
  let relpath: string = 'etc/config.xml';
  let extra: string = 'etc/carrier/${telephony.sim.opkey0}';
  configPolicy.getCfgFiles(relpath, configPolicy.FollowXMode.SIM_DEFAULT, extra).then((value: Array<string>) => {
    console.log('value is ' + value);
  }).catch((error: BusinessError) => {
    console.log('getCfgFiles promise ' + error);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.log('error:' + code + ',' + message);
}

getCfgFilesSync¹¹⁺

getCfgFilesSync(relPath: string, followMode?: FollowXMode, extra?: string): Array<string>

Obtains a list of configuration files based on the specified file name and follow mode, sorted in ascending order of priority. This API returns the result synchronously.

System capability: SystemCapability.Customization.ConfigPolicy

Parameters

Return value

Example

import { BusinessError } from '@ohos.base';

try {
  let relpath: string = 'etc/config.xml';
  let extra: string = 'etc/carrier/${telephony.sim.opkey0}';
  let result: Array<string> = configPolicy.getCfgFilesSync(relpath, configPolicy.FollowXMode.USER_DEFINED, extra);
  console.log('result is ' + result);
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.log('error:' + code + ',' + message);
}

getCfgDirListSync¹¹⁺

getCfgDirListSync(): Array<string>

Obtains the list of configuration level directories. This API returns the result synchronously.

System capability: SystemCapability.Customization.ConfigPolicy

Return value

Example

import { BusinessError } from '@ohos.base';

try {
  let result: Array<string> = configPolicy.getCfgDirListSync();
  console.log('result is ' + result);
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.log('error:' + code + ',' + message);
}

FollowXMode¹¹⁺

System capability: SystemCapability.Customization.ConfigPolicy