配置策略

配置策略提供按預先定義的定制配置層級獲取對應定制配置目錄和文件路徑的能力。

說明：

本模塊首批接口從API version 8開始支持。后續版本的新增接口，采用上角標單獨標記接口的起始版本。

本模塊接口均為系統接口，三方應用不支持調用。

導入模塊

import configPolicy from '@ohos.configPolicy';

getOneCfgFile

getOneCfgFile(relPath: string, callback: AsyncCallback)

使用callback形式返回指定文件名的最高優先級配置文件路徑。 例如，config.xml在設備中存在以下路徑（優先級從低到高）：/system/etc/config.xml、/sys_pod/etc/config.xml，最終返回/sys_pod/etc/config.xml。

系統能力：SystemCapability.Customization.ConfigPolicy

參數：

參數名	類型	必填	說明
relPath	string	是	配置文件名
callback	AsyncCallback	是	異步回調，用于返回最高優先級配置文件的路徑

示例：

configPolicy.getOneCfgFile('etc/config.xml', (error, value) => {if (error == undefined) {console.log("value is " + value);} else {console.log("error occurs "+ error);}
});

getOneCfgFile

getOneCfgFile(relPath: string): Promise

使用Promise形式返回指定文件名的最高優先級配置文件路徑。

系統能力：SystemCapability.Customization.ConfigPolicy

參數：

參數名	類型	必填	說明
relPath	string	是	配置文件名

返回值：

類型	說明
Promise	最高優先級配置文件的路徑

示例：

configPolicy.getOneCfgFile('etc/config.xml').then(value => {console.log("value is " + value);
}).catch(error => {console.log("getOneCfgFile promise " + error);
});

getCfgFiles

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

按優先級從低到高，使用callback形式返回指定文件名所有的文件列表。例如，config.xml在設備中存在以下路徑（優先級從低到高）：/system/etc/config.xml、 /sys_pod/etc/config.xml，最終返回/system/etc/config.xml, /sys_pod/etc/config.xml。

系統能力：SystemCapability.Customization.ConfigPolicy

參數：

參數名	類型	必填	說明
relPath	string	是	配置文件名
callback	AsyncCallback<Array>	是	異步回調，用于返回文件列表

示例：

configPolicy.getCfgFiles('etc/config.xml', (error, value) => {if (error == undefined) {console.log("value is " + value);} else {console.log("error occurs "+ error);}
});

getCfgFiles

getCfgFiles(relPath: string): Promise<Array>

按優先級從低到高，使用Promise形式返回指定文件名所有的文件列表。

系統能力：SystemCapability.Customization.ConfigPolicy

參數：

參數名	類型	必填	說明
relPath	string	是	配置文件名

返回值：

類型	說明
Promise<Array>	文件列表

示例：

configPolicy.getCfgFiles('etc/config.xml').then(value => {console.log("value is " + value);
}).catch(error => {console.log("getCfgFiles promise " + error);
});

getCfgDirList

getCfgDirList(callback: AsyncCallback<Array>)

使用callback形式返回配置層級目錄列表。

系統能力：SystemCapability.Customization.ConfigPolicy

參數：

參數名	類型	必填	說明
callback	AsyncCallback<Array>	是	異步回調，用于返回配置層級目錄列表

示例：

configPolicy.getCfgDirList((error, value) => {if (error == undefined) {console.log("value is " + value);} else {console.log("error occurs "+ error);}
});

getCfgDirList

getCfgDirList(): Promise<Array>

使用Promise形式返回配置層級目錄列表。

系統能力：SystemCapability.Customization.ConfigPolicy

返回值：

類型	說明
Promise<Array>	配置層級目錄列表

示例：

configPolicy.getCfgDirList().then(value => {console.log("value is " + value);
}).catch(error => {console.log("getCfgDirList promise " + error);
});