未验证 提交 a2bd7686 编写于 作者: O openharmony_ci 提交者: Gitee

!5794 config_policy接口资料优化

Merge pull request !5794 from huangke11/master
# 配置策略 # 配置策略
配置策略提供按预先定义的定制配置层级获取对应定制配置目录和文件路径的能力。
> **说明:** > **说明:**
> >
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> >
> 本模块接口均为系统接口,三方应用不支持调用。 > 本模块接口均为系统接口,三方应用不支持调用。
配置策略提供按预先定义的定制配置层级获取对应定制配置目录和文件路径的能力。
## 导入模块 ## 导入模块
```js ```js
...@@ -16,10 +16,10 @@ import configPolicy from '@ohos.configPolicy'; ...@@ -16,10 +16,10 @@ import configPolicy from '@ohos.configPolicy';
## getOneCfgFile ## getOneCfgFile
getOneCfgFile(relPath: string, callback: AsyncCallback<string>): void getOneCfgFile(relPath: string, callback: AsyncCallback<string>)
使用callback形式返回指定文件名的最高优先级配置文件路径。 使用callback形式返回指定文件名的最高优先级配置文件路径。
例如,config.xml在设备中存在以下路径(优先级从低到高):/system/etc/config.xml、/sys-pod/etc/config.xml,最终返回/sys-pod/etc/config.xml。 例如,config.xml在设备中存在以下路径(优先级从低到高):/system/etc/config.xml、/sys_pod/etc/config.xml,最终返回/sys_pod/etc/config.xml。
**系统能力**:SystemCapability.Customization.ConfigPolicy **系统能力**:SystemCapability.Customization.ConfigPolicy
...@@ -31,7 +31,7 @@ getOneCfgFile(relPath: string, callback: AsyncCallback<string>): void ...@@ -31,7 +31,7 @@ getOneCfgFile(relPath: string, callback: AsyncCallback<string>): void
**示例:** **示例:**
```js ```js
configPolicy.getOneCfgFile('config.xml', (error, value) => { configPolicy.getOneCfgFile('etc/config.xml', (error, value) => {
if (error == undefined) { if (error == undefined) {
console.log("value is " + value); console.log("value is " + value);
} else { } else {
...@@ -61,7 +61,7 @@ getOneCfgFile(relPath: string): Promise<string> ...@@ -61,7 +61,7 @@ getOneCfgFile(relPath: string): Promise<string>
**示例:** **示例:**
```js ```js
configPolicy.getOneCfgFile('config.xml').then(value => { configPolicy.getOneCfgFile('etc/config.xml').then(value => {
console.log("value is " + value); console.log("value is " + value);
}).catch(error => { }).catch(error => {
console.log("getOneCfgFile promise " + error); console.log("getOneCfgFile promise " + error);
...@@ -71,10 +71,10 @@ getOneCfgFile(relPath: string): Promise<string> ...@@ -71,10 +71,10 @@ getOneCfgFile(relPath: string): Promise<string>
## getCfgFiles ## getCfgFiles
getCfgFiles(relPath: string, callback: AsyncCallback<Array<string>>): void getCfgFiles(relPath: string, callback: AsyncCallback<Array<string>>)
按优先级从低到高,使用callback形式返回指定文件名所有的文件列表。例如,config.xml在设备中存在以下路径(优先级从低到高):/system/etc/config.xml、 按优先级从低到高,使用callback形式返回指定文件名所有的文件列表。例如,config.xml在设备中存在以下路径(优先级从低到高):/system/etc/config.xml、
/sys-pod/etc/config.xml,最终返回/system/etc/config.xml, /sys-pod/etc/config.xml。 /sys_pod/etc/config.xml,最终返回/system/etc/config.xml, /sys_pod/etc/config.xml。
**系统能力**:SystemCapability.Customization.ConfigPolicy **系统能力**:SystemCapability.Customization.ConfigPolicy
...@@ -86,7 +86,7 @@ getCfgFiles(relPath: string, callback: AsyncCallback<Array<string>>) ...@@ -86,7 +86,7 @@ getCfgFiles(relPath: string, callback: AsyncCallback<Array<string>>)
**示例:** **示例:**
```js ```js
configPolicy.getCfgFiles('config.xml', (error, value) => { configPolicy.getCfgFiles('etc/config.xml', (error, value) => {
if (error == undefined) { if (error == undefined) {
console.log("value is " + value); console.log("value is " + value);
} else { } else {
...@@ -116,7 +116,7 @@ getCfgFiles(relPath: string): Promise<Array<string>> ...@@ -116,7 +116,7 @@ getCfgFiles(relPath: string): Promise<Array<string>>
**示例:** **示例:**
```js ```js
configPolicy.getCfgFiles('config.xml').then(value => { configPolicy.getCfgFiles('etc/config.xml').then(value => {
console.log("value is " + value); console.log("value is " + value);
}).catch(error => { }).catch(error => {
console.log("getCfgFiles promise " + error); console.log("getCfgFiles promise " + error);
...@@ -126,7 +126,7 @@ getCfgFiles(relPath: string): Promise<Array<string>> ...@@ -126,7 +126,7 @@ getCfgFiles(relPath: string): Promise<Array<string>>
## getCfgDirList ## getCfgDirList
getCfgDirList(callback: AsyncCallback<Array<string>>): void getCfgDirList(callback: AsyncCallback<Array<string>>)
使用callback形式返回配置层级目录列表。 使用callback形式返回配置层级目录列表。
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册