Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
3f7a075b
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
未验证
提交
3f7a075b
编写于
3月 14, 2022
作者:
O
openharmony_ci
提交者:
Gitee
3月 14, 2022
浏览文件
操作
浏览文件
下载
差异文件
!2013 config_policy增加api说明
Merge pull request !2013 from huangke11/master
上级
12bdcf19
62ecd2c2
变更
2
显示空白变更内容
内联
并排
Showing
2 changed file
with
173 addition
and
1 deletion
+173
-1
zh-cn/application-dev/reference/apis/Readme-CN.md
zh-cn/application-dev/reference/apis/Readme-CN.md
+2
-1
zh-cn/application-dev/reference/apis/js-apis-config-policy.md
...n/application-dev/reference/apis/js-apis-config-policy.md
+171
-0
未找到文件。
zh-cn/application-dev/reference/apis/Readme-CN.md
浏览文件 @
3f7a075b
...
@@ -114,4 +114,5 @@
...
@@ -114,4 +114,5 @@
-
[
非线性容器TreeSet
](
js-apis-treeset.md
)
-
[
非线性容器TreeSet
](
js-apis-treeset.md
)
-
[
非线性容器LightWeightMap
](
js-apis-lightweightmap.md
)
-
[
非线性容器LightWeightMap
](
js-apis-lightweightmap.md
)
-
[
非线性容器LightWeightSet
](
js-apis-lightweightset.md
)
-
[
非线性容器LightWeightSet
](
js-apis-lightweightset.md
)
-
定制管理
-
[
配置策略
](
js-apis-config-policy.md
)
zh-cn/application-dev/reference/apis/js-apis-config-policy.md
0 → 100644
浏览文件 @
3f7a075b
# 配置策略
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> - 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> - 本模块接口均为系统接口,三方应用不支持调用。
配置策略提供按预先定义的定制配置层级获取对应定制配置目录和文件路径的能力。
## 导入模块
```
import configPolicy from '@ohos.configPolicy';
```
## getOneCfgFile
getOneCfgFile(relPath: string, callback: AsyncCallback
<
string
>
): void
使用callback形式返回指定文件名的最高优先级配置文件路径。
例如,config.xml在设备中存在以下路径(优先级从低到高):/system/etc/config.xml、/sys-pod/etc/config.xml,最终返回/sys-pod/etc/config.xml。
**系统能力**
:SystemCapability.Customization.ConfigPolicy
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| relPath | string | 是 | 配置文件名 |
| callback | AsyncCallback
<
string
>
| 是 | 异步回调,用于返回最高优先级配置文件的路径 |
**示例:**
```
configPolicy.getOneCfgFile('config.xml', (error, value) => {
if (error == undefined) {
console.log(value);
} else {
console.log(error);
}
});
```
## getOneCfgFile
getOneCfgFile(relPath: string): Promise
<
string
>
使用Promise形式返回指定文件名的最高优先级配置文件路径。
**系统能力**
:SystemCapability.Customization.ConfigPolicy
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| relPath | string | 是 | 配置文件名 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
string
>
| 最高优先级配置文件的路径 |
**示例:**
```
configPolicy.getOneCfgFile('config.xml').then(value => {
console.log(value);
}).catch(error => {
console.log("getOneCfgFile promise " + error);
});
```
## getCfgFiles
getCfgFiles(relPath: string, callback: AsyncCallback
<
Array
<
string
>>
): void
按优先级从低到高,使用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
<
string
>>
| 是 | 异步回调,用于返回文件列表 |
**示例:**
```
configPolicy.getCfgFiles('config.xml', (error, value) => {
if (error == undefined) {
console.log(value);
} else {
console.log(error);
}
});
```
## getCfgFiles
getCfgFiles(relPath: string): Promise
<
Array
<
string
>>
按优先级从低到高,使用Promise形式返回指定文件名所有的文件列表。
**系统能力**
:SystemCapability.Customization.ConfigPolicy
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| relPath | string | 是 | 配置文件名 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
Array
<
string
>>
| 文件列表 |
**示例:**
```
configPolicy.getCfgFiles('config.xml').then(value => {
console.log(value);
}).catch(error => {
console.log("getCfgFiles promise " + error);
});
```
## getCfgDirList
getCfgDirList(callback: AsyncCallback
<
Array
<
string
>>
): void
使用callback形式返回配置层级目录列表。
**系统能力**
:SystemCapability.Customization.ConfigPolicy
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
Array
<
string
>>
| 是 | 异步回调,用于返回配置层级目录列表 |
**示例:**
```
configPolicy.getCfgDirList((error, value) => {
if (error == undefined) {
console.log(value);
} else {
console.log(error);
}
});
```
## getCfgDirList
getCfgDirList(): Promise
<
Array
<
string
>>
使用Promise形式返回配置层级目录列表。
**系统能力**
:SystemCapability.Customization.ConfigPolicy
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
Array
<
string
>>
| 配置层级目录列表 |
**示例:**
```
configPolicy.getCfgDirList().then(value => {
console.log(value);
}).catch(error => {
console.log("getCfgDirList promise " + error);
});
```
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录