1# @ohos.configPolicy (配置策略) 2 3配置策略提供按预先定义的定制配置层级获取对应定制配置目录和文件路径的能力。 4 5> **说明：** 6> 7> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 8> 9> 本模块接口均为系统接口。 10 11## 导入模块 12 13```js 14import configPolicy from '@ohos.configPolicy'; 15``` 16 17## getOneCfgFile 18 19getOneCfgFile(relPath: string, callback: AsyncCallback<string>) 20 21使用callback形式返回指定文件名的最高优先级配置文件路径。 22例如，config.xml在设备中存在以下路径（优先级从低到高）：/system/etc/config.xml、/sys_pod/etc/config.xml，最终返回/sys_pod/etc/config.xml。 23 24**系统能力**：SystemCapability.Customization.ConfigPolicy 25 26**参数：** 27 28| 参数名 | 类型 | 必填 | 说明 | 29| -------- | --------------------------- | ---- | --------------------- | 30| relPath | string | 是 | 配置文件名 | 31| callback | AsyncCallback<string> | 是 | 异步回调，用于返回最高优先级配置文件的路径 | 32 33**示例：** 34 ```js 35 configPolicy.getOneCfgFile('etc/config.xml', (error, value) => { 36 if (error == null) { 37 console.log("value is " + value); 38 } else { 39 console.log("error occurs "+ error); 40 } 41 }); 42 ``` 43 44 45## getOneCfgFile 46 47getOneCfgFile(relPath: string): Promise<string> 48 49使用Promise形式返回指定文件名的最高优先级配置文件路径。 50 51**系统能力**：SystemCapability.Customization.ConfigPolicy 52 53**参数：** 54 55| 参数名 | 类型 | 必填 | 说明 | 56| ------- | ------ | ---- | ----- | 57| relPath | string | 是 | 配置文件名 | 58 59**返回值：** 60 61| 类型 | 说明 | 62| --------------------- | ------------ | 63| Promise<string> | 最高优先级配置文件的路径 | 64 65**示例：** 66 ```js 67 configPolicy.getOneCfgFile('etc/config.xml').then(value => { 68 console.log("value is " + value); 69 }).catch(error => { 70 console.log("getOneCfgFile promise " + error); 71 }); 72 ``` 73 74 75## getCfgFiles 76 77getCfgFiles(relPath: string, callback: AsyncCallback<Array<string>>) 78 79按优先级从低到高，使用callback形式返回指定文件名所有的文件列表。 80例如，config.xml在设备中存在以下路径（优先级从低到高）：/system/etc/config.xml、/sys_pod/etc/config.xml，最终返回/system/etc/config.xml, /sys_pod/etc/config.xml。 81 82**系统能力**：SystemCapability.Customization.ConfigPolicy 83 84**参数：** 85 86| 参数名 | 类型 | 必填 | 说明 | 87| -------- | ---------------------------------------- | ---- | ------------- | 88| relPath | string | 是 | 配置文件名 | 89| callback | AsyncCallback<Array<string>> | 是 | 异步回调，用于返回文件列表 | 90 91**示例：** 92 ```js 93 configPolicy.getCfgFiles('etc/config.xml', (error, value) => { 94 if (error == null) { 95 console.log("value is " + value); 96 } else { 97 console.log("error occurs "+ error); 98 } 99 }); 100 ``` 101 102 103## getCfgFiles 104 105getCfgFiles(relPath: string): Promise<Array<string>> 106 107按优先级从低到高，使用Promise形式返回指定文件名所有的文件列表。 108 109**系统能力**：SystemCapability.Customization.ConfigPolicy 110 111**参数：** 112 113| 参数名 | 类型 | 必填 | 说明 | 114| ------- | ------ | ---- | ----- | 115| relPath | string | 是 | 配置文件名 | 116 117**返回值：** 118 119| 类型 | 说明 | 120| ---------------------------------- | ---- | 121| Promise<Array<string>> | 文件列表 | 122 123**示例：** 124 ```js 125 configPolicy.getCfgFiles('etc/config.xml').then(value => { 126 console.log("value is " + value); 127 }).catch(error => { 128 console.log("getCfgFiles promise " + error); 129 }); 130 ``` 131 132 133## getCfgDirList 134 135getCfgDirList(callback: AsyncCallback<Array<string>>) 136 137使用callback形式返回配置层级目录列表。 138 139**系统能力**：SystemCapability.Customization.ConfigPolicy 140 141**参数：** 142 143| 参数名 | 类型 | 必填 | 说明 | 144| -------- | ---------------------------------------- | ---- | ----------------- | 145| callback | AsyncCallback<Array<string>> | 是 | 异步回调，用于返回配置层级目录列表 | 146 147**示例：** 148 ```js 149 configPolicy.getCfgDirList((error, value) => { 150 if (error == null) { 151 console.log("value is " + value); 152 } else { 153 console.log("error occurs "+ error); 154 } 155 }); 156 ``` 157 158 159## getCfgDirList 160 161getCfgDirList(): Promise<Array<string>> 162 163使用Promise形式返回配置层级目录列表。 164 165**系统能力**：SystemCapability.Customization.ConfigPolicy 166 167**返回值：** 168 169| 类型 | 说明 | 170| ---------------------------------- | -------- | 171| Promise<Array<string>> | 配置层级目录列表 | 172 173**示例：** 174 ```js 175 configPolicy.getCfgDirList().then(value => { 176 console.log("value is " + value); 177 }).catch(error => { 178 console.log("getCfgDirList promise " + error); 179 }); 180 ``` 181 182