Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
74b3aeaa
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看板
未验证
提交
74b3aeaa
编写于
10月 19, 2022
作者:
O
openharmony_ci
提交者:
Gitee
10月 19, 2022
浏览文件
操作
浏览文件
下载
差异文件
!10574 FIX: parameter v9文档刷新
Merge pull request !10574 from cheng_jinsong/1013_v9
上级
f2fb3afa
baf97e39
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
238 addition
and
0 deletion
+238
-0
zh-cn/application-dev/reference/apis/js-apis-system-parameterV9.md
...lication-dev/reference/apis/js-apis-system-parameterV9.md
+238
-0
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-system-parameterV9.md
0 → 100755
浏览文件 @
74b3aeaa
# 系统参数
系统参数(SystemParameter)是为各系统服务提供的简单易用的键值对访问接口,各个系统服务可以定义系统参数来描述该服务的状态信息,或者通过系统参数来改变系统服务的行为。其基本操作原语为get和set,通过get可以查询系统参数的值,通过set可以修改系统参数的值。
详细的系统参数设计原理及定义可参考
[
系统参数
](
../../../device-dev/subsystems/subsys-boot-init-sysparam.md
)
。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> - 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> - 本模块接口为系统接口。
> - 由于系统参数都是各个系统服务的内部信息和控制参数,每个系统参数都有各自不同的DAC和MAC访问控制权限,三方应用不能使用此类接口。
## 导入模块
```
ts
import
systemparameter
from
'
@ohos.systemParameterV9
'
```
## systemparameter.getSync
getSync(key: string, def?: string): string
获取系统参数Key对应的值。
**系统能力:**
SystemCapability.Startup.SystemInfo
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 待查询的系统参数Key。 |
| def | string | 否 | 默认值。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| string | 系统参数值,若key不存在,返回默认值。若未指定默认值,返回空字符串。 |
**示例:**
```
ts
try
{
var
info
=
systemparameter
.
getSync
(
"
const.ohos.apiversion
"
);
console
.
log
(
JSON
.
stringify
(
info
));
}
catch
(
e
){
console
.
log
(
"
getSync unexpected error:
"
+
e
);
}
```
## systemparameter.get
get(key: string, callback: AsyncCallback
<
string
>
): void
获取系统参数Key对应的值。
**系统能力:**
SystemCapability.Startup.SystemInfo
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 待查询的系统参数Key。 |
| callback | AsyncCallback
<
string
>
| 是 | 回调函数。 |
**示例:**
```
ts
try
{
systemparameter
.
get
(
"
const.ohos.apiversion
"
,
function
(
err
,
data
)
{
if
(
err
==
undefined
)
{
console
.
log
(
"
get test.parameter.key value success:
"
+
data
)
}
else
{
console
.
log
(
"
get test.parameter.key value err:
"
+
err
.
code
)
}});
}
catch
(
e
){
console
.
log
(
"
get unexpected error:
"
+
e
);
}
```
## systemparameter.get
get(key: string, def: string, callback: AsyncCallback
<
string
>
): void
获取系统参数Key对应的值。
**系统能力:**
SystemCapability.Startup.SystemInfo
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 待查询的系统参数Key。 |
| def | string | 是 | 默认值。 |
| callback | AsyncCallback
<
string
>
| 是 | 回调函数。 |
**示例:**
```
ts
try
{
systemparameter
.
get
(
"
const.ohos.apiversion
"
,
"
default
"
,
function
(
err
,
data
)
{
if
(
err
==
undefined
)
{
console
.
log
(
"
get test.parameter.key value success:
"
+
data
)
}
else
{
console
.
log
(
"
get test.parameter.key value err:
"
+
err
.
code
)
}
});
}
catch
(
e
){
console
.
log
(
"
get unexpected error:
"
+
e
)
}
```
## systemparameter.get
get(key: string, def?: string): Promise
<
string
>
获取系统参数Key对应的值。
**系统能力:**
SystemCapability.Startup.SystemInfo
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 待查询的系统参数Key。 |
| def | string | 否 | 默认值。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
string
>
| Promise示例,用于异步获取结果。 |
**示例:**
```
ts
try
{
var
p
=
systemparameter
.
get
(
"
const.ohos.apiversion
"
);
p
.
then
(
function
(
value
)
{
console
.
log
(
"
get test.parameter.key success:
"
+
value
);
}).
catch
(
function
(
err
)
{
console
.
log
(
"
get test.parameter.key error:
"
+
err
.
code
);
});
}
catch
(
e
){
console
.
log
(
"
get unexpected error:
"
+
e
);
}
```
## systemparameter.setSync
setSync(key: string, value: string): void
设置系统参数Key对应的值。
**系统能力:**
SystemCapability.Startup.SystemInfo
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 待设置的系统参数Key。 |
| value | string | 是 | 待设置的系统参数值。 |
**示例:**
```
ts
try
{
systemparameter
.
setSync
(
"
test.parameter.key
"
,
"
default
"
);
}
catch
(
e
){
console
.
log
(
"
set unexpected error:
"
+
e
);
}
```
## systemparameter.set
set(key: string, value: string, callback: AsyncCallback
<
void
>
): void
设置系统参数Key对应的值。
**系统能力:**
SystemCapability.Startup.SystemInfo
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 待设置的系统参数Key。 |
| value | string | 是 | 待设置的系统参数值。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
**示例:**
```
ts
try
{
systemparameter
.
set
(
"
test.parameter.key
"
,
"
testValue
"
,
function
(
err
,
data
)
{
if
(
err
==
undefined
)
{
console
.
log
(
"
set test.parameter.key value success :
"
+
data
)
}
else
{
console
.
log
(
"
set test.parameter.key value err:
"
+
err
.
code
)
}});
}
catch
(
e
){
console
.
log
(
"
set unexpected error:
"
+
e
);
}
```
## systemparameter.set
set(key: string, value: string): Promise
<
void
>
设置系统参数Key对应的值。
**系统能力:**
SystemCapability.Startup.SystemInfo
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 待设置的系统参数Key。 |
| value| string | 是 | 待设置的系统参数值。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
void
>
| Promise示例,用于异步获取结果。 |
**示例:**
```
ts
try
{
var
p
=
systemparameter
.
set
(
"
test.parameter.key
"
,
"
testValue
"
);
p
.
then
(
function
(
value
)
{
console
.
log
(
"
set test.parameter.key success:
"
+
value
);
}).
catch
(
function
(
err
)
{
console
.
log
(
"
set test.parameter.key error:
"
+
err
.
code
);
});
}
catch
(
e
){
console
.
log
(
"
set unexpected error:
"
+
e
);
}
```
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录