js-apis-system-parameter.md 4.9 KB
Newer Older
Z
zengyawen 已提交
1
# 系统属性
Z
zengyawen 已提交
2

Z
zengyawen 已提交
3
## 导入模块
Z
zengyawen 已提交
4 5 6 7 8

```
import parameter from '@ohos.systemParameter'
```

Z
zengyawen 已提交
9 10

## 权限列表
Z
zengyawen 已提交
11 12 13 14




Z
zengyawen 已提交
15 16 17
## parameter.getSync

getSync(key: string, def?: string)
Z
zengyawen 已提交
18 19 20 21 22

获取系统属性Key对应的值。

**参数:**

Z
zengyawen 已提交
23 24 25 26
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 待查询的系统属性Key。 |
| def | string | 否 | 默认值。 |
Z
zengyawen 已提交
27 28 29

**返回值:**

Z
zengyawen 已提交
30 31 32
| 类型 | 说明 |
| -------- | -------- |
| string | 系统属性值,若key不存在,返回默认值。若未指定默认值,返回空字符串。 |
Z
zengyawen 已提交
33 34 35 36 37 38 39 40 41 42 43 44 45

**示例:**

```
try {
    var info = parameter.getSync("test.parameter.key");
    console.log(JSON.stringify(info));
}catch(e){
    console.log("getSync unexpected error: " + e);
}
```


Z
zengyawen 已提交
46 47 48
## parameter.get

get(key: string, callback: AsyncCallback<string>)
Z
zengyawen 已提交
49 50 51 52 53

获取系统属性Key对应的值。

**参数:**

Z
zengyawen 已提交
54 55 56 57
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 待查询的系统属性Key。 |
| callback | AsyncCallback<string> | 是 | 回调函数。 |
Z
zengyawen 已提交
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74

**示例:**

```
try {
    parameter.get("test.parameter.key", 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);
}
```


Z
zengyawen 已提交
75 76 77
## parameter.get

get(key: string, def: string, callback: AsyncCallback<string>)
Z
zengyawen 已提交
78 79 80 81 82

获取系统属性Key对应的值。

**参数:**

Z
zengyawen 已提交
83 84 85 86 87
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 待查询的系统属性Key。 |
| def | string | 是 | 默认值。 |
| callback | AsyncCallback<string> | 是 | 回调函数。 |
Z
zengyawen 已提交
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105

**示例:**

```
try {
    parameter.get("test.parameter.key", "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)
}
```


Z
zengyawen 已提交
106 107 108
## parameter.get

get(key: string, def?: string)
Z
zengyawen 已提交
109 110 111 112 113

获取系统属性Key对应的值。

**参数:**

Z
zengyawen 已提交
114 115 116 117
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 待查询的系统属性Key。 |
| def | string | 否 | 默认值。 |
Z
zengyawen 已提交
118 119 120

**返回值:**

Z
zengyawen 已提交
121 122 123
| 类型 | 说明 |
| -------- | -------- |
| Promise<string> | Promise示例,用于异步获取结果。 |
Z
zengyawen 已提交
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140

**示例:**

```
try {
    var p = parameter.get("test.parameter.key");
    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);
}
```


Z
zengyawen 已提交
141 142 143
## parameter.setSync

setSync(key: string, value: string)
Z
zengyawen 已提交
144 145 146 147 148

设置系统属性Key对应的值。

**参数:**

Z
zengyawen 已提交
149 150 151 152
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 待设置的系统属性Key。 |
| value | string | 是 | 待设置的系统属性值。 |
Z
zengyawen 已提交
153 154 155 156 157 158 159 160 161 162 163 164

**示例:**

```
try {
    parameter.setSync("test.parameter.key", "default");
}catch(e){
    console.log("set unexpected error: " + e);
}
```


Z
zengyawen 已提交
165 166 167
## parameter.set(key: string, value: string, callback: AsyncCallback<void>)

set(key: string, value: string, callback: AsyncCallback<void>)
Z
zengyawen 已提交
168 169 170 171 172

设置系统属性Key对应的值。

**参数:**

Z
zengyawen 已提交
173 174 175 176 177
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 待查询的系统属性Key。 |
| def | string | 是 | 默认值。 |
| callback | AsyncCallback<void> | 是 | 回调函数。 |
Z
zengyawen 已提交
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194

**示例:**

```
try {
    parameter.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);
}
```


Z
zengyawen 已提交
195 196 197
## parameter.set(key: string, def?: string)

set(key: string, def?: string)
Z
zengyawen 已提交
198 199 200 201 202

设置系统属性Key对应的值。

**参数:**

Z
zengyawen 已提交
203 204 205 206
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 待查询的系统属性Key。 |
| def | string | 否 | 默认值。 |
Z
zengyawen 已提交
207 208 209

**返回值:**

Z
zengyawen 已提交
210 211 212
| 类型 | 说明 |
| -------- | -------- |
| Promise<string> | Promise示例,用于异步获取结果。 |
Z
zengyawen 已提交
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227

**示例:**

```
try {
    var p = para.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);
}
```