js-apis-net-policy.md 54.3 KB
Newer Older
Z
zhanghaifeng 已提交
1
# @ohos.net.policy (网络策略管理)
Z
zhanghaifeng 已提交
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45

网络策略管理通过对用户使用数据流量进行控制管理,采用防火墙技术实现网络策略的管理。

> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

## 导入模块

```js
import policy from '@ohos.net.policy'
```

## policy.setBackgroundPolicy

setBackgroundPolicy(isAllowed: boolean, callback: AsyncCallback\<void>): void

设置后台网络策略,使用callback方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                                    | 必填 | 说明       |
| -------- | --------------------------------------- | ---- | ---------- |
| isAllowed | boolean | 是   | 是否允许应用后台使用数据 |
| callback | AsyncCallback\<void> | 是   | 回调函数,成功返回设置后台网络策略的结果,失败返回错误码错误信息。 |

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 401     | Parameter error.                             |
| 2100001 | Invalid parameter value.                |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js
policy.setBackgroundPolicy(Boolean(Number.parseInt(this.isBoolean))), (error, data) => {
Y
Yangys 已提交
46 47 48 49 50 51
  this.callBack(error, data);
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
}
)
;
Z
zhanghaifeng 已提交
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
```

## policy.setBackgroundPolicy

setBackgroundPolicy(isAllowed: boolean): Promise\<void>

设置后台网络策略,使用Promise方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                                    | 必填 | 说明       |
| -------- | --------------------------------------- | ---- | ---------- |
| isAllowed | boolean | 是   | 是否允许应用后台使用数据 |

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 401     | Parameter error.                             |
| 2100001 | Invalid parameter value.                |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**返回值:**

| 类型                              | 说明                                  |
| --------------------------------- | ------------------------------------- |
| Promise\<void> | 以Promise形式返回设定结果,失败返回错误码错误信息。 |

**示例:**

```js
Y
Yangys 已提交
89 90 91
policy.setBackgroundPolicy(Boolean(Number.parseInt(this.isBoolean))).then(function (error, data) {
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
Z
zhanghaifeng 已提交
92 93 94 95 96
})
```

## policy.isBackgroundAllowed

Z
zhanghaifeng 已提交
97
isBackgroundAllowed(callback: AsyncCallback\<boolean>): void
Z
zhanghaifeng 已提交
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122

获取后台网络策略,使用callback方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                                    | 必填 | 说明       |
| -------- | --------------------------------------- | ---- | ---------- |
| callback | AsyncCallback\<boolean> | 是   | 回调函数,返回true代表后台策略为允许。失败返回错误码错误信息。 |

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js
policy.isBackgroundAllowed((error, data) => {
Y
Yangys 已提交
123 124 125
  this.callBack(error, data);
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
Z
zhanghaifeng 已提交
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
});
```

## policy.isBackgroundAllowed

isBackgroundAllowed(): Promise\<boolean>;

获取后台网络策略,使用Promise方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**返回值:**

| 类型                              | 说明                                  |
| --------------------------------- | ------------------------------------- |
Z
zhanghaifeng 已提交
143
| Promise\<boolean> | 以Promise形式返回设定结果。 返回true代表后台策略为允许。失败返回错误码错误信息。|
Z
zhanghaifeng 已提交
144 145 146 147 148 149 150 151 152 153 154 155

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js
Y
Yangys 已提交
156 157 158
policy.isBackgroundAllowed().then(function (error, data) {
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
Z
zhanghaifeng 已提交
159 160 161 162 163 164
})

```

## policy.setPolicyByUid

Z
zhanghaifeng 已提交
165
setPolicyByUid(uid: number, policy: NetUidPolicy, callback: AsyncCallback\<void>): void
Z
zhanghaifeng 已提交
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194

设置对应uid应用的访问计量网络的策略,使用callback方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                                    | 必填 | 说明       |
| -------- | --------------------------------------- | ---- | ---------- |
| uid | number | 是   | 应用的唯一标识符 |
| policy | [NetUidPolicy](#netuidpolicy) | 是 | 应用对应的策略 |
| callback | AsyncCallback\<void> | 是   | 回调函数,成功返回设定结果。失败返回错误码错误信息。 |

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 401     | Parameter error.                             |
| 2100001 | Invalid parameter value.                |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js
let param = {
Y
Yangys 已提交
195
  uid: Number.parseInt(this.firstParam), policy: Number.parseInt(this.currentNetUidPolicy)
Z
zhanghaifeng 已提交
196 197
}
policy.setPolicyByUid(Number.parseInt(this.firstParam), Number.parseInt(this.currentNetUidPolicy), (error, data) => {
Y
Yangys 已提交
198
  this.callBack(error, data);
Z
zhanghaifeng 已提交
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
});
```

## policy.setPolicyByUid

setPolicyByUid(uid: number, policy: NetUidPolicy): Promise\<void>;

设置对应uid应用的访问计量网络的策略,使用Promise方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                                    | 必填 | 说明       |
| -------- | --------------------------------------- | ---- | ---------- |
| uid | number | 是   | 应用的唯一标识符 |
| policy | [NetUidPolicy](#netuidpolicy) | 是 | 应用对应的策略 |

**返回值:**

| 类型                              | 说明                                  |
| --------------------------------- | ------------------------------------- |
| Promise\<void> | 以Promise形式返回设定结果。失败返回错误码错误信息。 |

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 401     | Parameter error.                             |
| 2100001 | Invalid parameter value.                |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js
let param = {
Y
Yangys 已提交
239
  uid: Number.parseInt(this.firstParam), policy: Number.parseInt(this.currentNetUidPolicy)
Z
zhanghaifeng 已提交
240
}
Y
Yangys 已提交
241 242 243
policy.setPolicyByUid(Number.parseInt(this.firstParam), Number.parseInt(this.currentNetUidPolicy)).then(function (error, data) {
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
Z
zhanghaifeng 已提交
244 245 246 247 248 249
})

```

## policy.getPolicyByUid

Z
zhanghaifeng 已提交
250
getPolicyByUid(uid: number, callback: AsyncCallback\<NetUidPolicy>): void
Z
zhanghaifeng 已提交
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278

通过应用uid获取策略,使用callback方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                                    | 必填 | 说明       |
| -------- | --------------------------------------- | ---- | ---------- |
| uid | number | 是 | app唯一标识符 |
| callback | AsyncCallback\<[NetUidPolicy](#netuidpolicy)> | 是   | 回调函数,成功返回获取策略结果,失败返回错误码错误信息。 |

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 401     | Parameter error.                             |
| 2100001 | Invalid parameter value.                |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js
policy.getPolicyByUid(Number.parseInt(this.firstParam), (error, data) => {
Y
Yangys 已提交
279
  this.callBack(error, data);
Z
zhanghaifeng 已提交
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
});
```

## policy.getPolicyByUid

getPolicyByUid(uid: number): Promise\<NetUidPolicy>;

通过应用uid获取策略,使用Promise方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                                    | 必填 | 说明       |
| -------- | --------------------------------------- | ---- | ---------- |
| uid | number | 是 | app唯一标识符 |

**返回值:**

| 类型                              | 说明                                  |
| --------------------------------- | ------------------------------------- |
| Promise\<[NetUidPolicy](#netuidpolicy)> | 以Promise形式返回获取策略结果。失败返回错误码错误信息。|

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 401     | Parameter error.                             |
| 2100001 | Invalid parameter value.                |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js
Y
Yangys 已提交
318 319 320
policy.getPolicyByUid(Number.parseInt(this.firstParam)).then(function (error, data) {
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
Z
zhanghaifeng 已提交
321 322 323 324 325 326
})

```

## policy.getUidsByPolicy

Z
zhanghaifeng 已提交
327
getUidsByPolicy(policy: NetUidPolicy, callback: AsyncCallback\<Array\<number>>): void
Z
zhanghaifeng 已提交
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355

通过策略获取设置这一策略的应用uid数组,使用callback方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                                    | 必填 | 说明       |
| -------- | --------------------------------------- | ---- | ---------- |
| policy | [NetUidPolicy](#netuidpolicy) | 是 | 应用对应的计量网络下的策略 |
| callback | AsyncCallback\<Array\<number>> | 是   | 回调函数,成功返回应用的uid数组,失败返回错误码错误信息。|

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 401     | Parameter error.                             |
| 2100001 | Invalid parameter value.                |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js
policy.getUidsByPolicy(Number.parseInt(this.currentNetUidPolicy), (error, data) => {
Y
Yangys 已提交
356
  this.callBack(error, data);
Z
zhanghaifeng 已提交
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
});
```

## policy.getUidsByPolicy

function getUidsByPolicy(policy: NetUidPolicy): Promise\<Array\<number>>;

通过策略获取设置这一策略的应用uid数组,使用Promise方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                                    | 必填 | 说明       |
| -------- | --------------------------------------- | ---- | ---------- |
| policy | [NetUidPolicy](#netuidpolicy) | 是 | app对应的计量网络下的策略 |

**返回值:**

| 类型                              | 说明                                  |
| --------------------------------- | ------------------------------------- |
| Promise\<Array\<number>> | 以Promise形式返回应用的uid数组,失败返回错误码错误信息。|

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 401     | Parameter error.                             |
| 2100001 | Invalid parameter value.                |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js
Y
Yangys 已提交
395 396 397
policy.getUidsByPolicy(Number.parseInt(this.firstParam)).then(function (error, data) {
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
Z
zhanghaifeng 已提交
398 399 400 401 402 403
})

```

## policy.getNetQuotaPolicies

Z
zhanghaifeng 已提交
404
getNetQuotaPolicies(callback: AsyncCallback\<Array\<NetQuotaPolicy>>): void
Z
zhanghaifeng 已提交
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429

获取计量网络策略,使用callback方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                                    | 必填 | 说明       |
| -------- | --------------------------------------- | ---- | ---------- |
| callback | AsyncCallback\<Array\<[NetQuotaPolicy](#netquotapolicy)>> | 是   | 回调函数,返回获取结果。 |

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js
policy.getNetQuotaPolicies((error, data) => {
Y
Yangys 已提交
430
  this.callBack(error, data);
Z
zhanghaifeng 已提交
431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
});
```

## policy.getNetQuotaPolicies

getNetQuotaPolicies(): Promise\<Array\<NetQuotaPolicy>>;

获取计量网络策略,使用Promise方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**返回值:**

| 类型                              | 说明                                  |
| --------------------------------- | ------------------------------------- |
| Promise\<Array\<[NetQuotaPolicy](#netquotapolicy)>> | 以Promise形式返回设定结果。 |

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js
Y
Yangys 已提交
461 462 463
policy.getNetQuotaPolicies().then(function (error, data) {
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
Z
zhanghaifeng 已提交
464 465 466 467 468 469
})

```

## policy.setNetQuotaPolicies

Z
zhanghaifeng 已提交
470
setNetQuotaPolicies(quotaPolicies: Array\<NetQuotaPolicy>, callback: AsyncCallback\<void>): void
Z
zhanghaifeng 已提交
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497

设置计量网络策略,使用callback方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                                    | 必填 | 说明       |
| -------- | --------------------------------------- | ---- | ---------- |
| quotaPolicies | Array\<[NetQuotaPolicy](#netquotapolicy)> | 是 | 计量网络策略 |
| callback | AsyncCallback\<void> | 是   | 回调函数,返回设定结果。 |

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 401     | Parameter error.                             |
| 2100001 | Invalid parameter value.                |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js
Y
Yangys 已提交
498 499 500 501 502 503 504 505 506 507 508 509
let param = {
  netType: Number.parseInt(this.netType),
  iccid: this.iccid,
  ident: this.ident,
  periodDuration: this.periodDuration,
  warningBytes: Number.parseInt(this.warningBytes),
  limitBytes: Number.parseInt(this.limitBytes),
  lastWarningRemind: this.lastWarningRemind,
  lastLimitRemind: this.lastLimitRemind,
  metered: Boolean(Number.parseInt(this.metered)),
  limitAction: this.limitAction
};
Z
zhanghaifeng 已提交
510 511 512
this.netQuotaPolicyList.push(param);

policy.setNetQuotaPolicies(this.netQuotaPolicyList, (error, data) => {
Y
Yangys 已提交
513
  this.callBack(error, data);
Z
zhanghaifeng 已提交
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551
});
```

## policy.setNetQuotaPolicies

setNetQuotaPolicies(quotaPolicies: Array\<NetQuotaPolicy>): Promise\<void>;

设置计量网络策略,使用Promise方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                                    | 必填 | 说明       |
| -------- | --------------------------------------- | ---- | ---------- |
| quotaPolicies | Array\<[NetQuotaPolicy](#netquotapolicy)> | 是 | 计量网络策略 |

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 401     | Parameter error.                             |
| 2100001 | Invalid parameter value.                |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**返回值:**

| 类型                              | 说明                                  |
| --------------------------------- | ------------------------------------- |
| Promise\<void> | 以Promise形式返回设定结果。 |

**示例:**

```js
Y
Yangys 已提交
552 553 554 555 556 557 558 559 560 561 562 563
let param = {
  netType: Number.parseInt(this.netType),
  iccid: this.iccid,
  ident: this.ident,
  periodDuration: this.periodDuration,
  warningBytes: Number.parseInt(this.warningBytes),
  limitBytes: Number.parseInt(this.limitBytes),
  lastWarningRemind: this.lastWarningRemind,
  lastLimitRemind: this.lastLimitRemind,
  metered: Boolean(Number.parseInt(this.metered)),
  limitAction: this.limitAction
};
Z
zhanghaifeng 已提交
564 565
this.netQuotaPolicyList.push(param);

Y
Yangys 已提交
566 567 568
policy.setNetQuotaPolicies(this.netQuotaPolicyList).then(function (error, data) {
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
Z
zhanghaifeng 已提交
569 570 571 572 573
})
```

## policy.restoreAllPolicies

Z
zhanghaifeng 已提交
574
restoreAllPolicies(iccid: string, callback: AsyncCallback\<void>): void
Z
zhanghaifeng 已提交
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603

重置对应sim卡id的蜂窝网络、后台网络策略、防火墙策略、应用对应的策略,使用callback方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                                    | 必填 | 说明       |
| -------- | --------------------------------------- | ---- | ---------- |
| iccid | string | 是 | SIM卡ID|
| callback | AsyncCallback\<void> | 是   | 回调函数,返回重置结果。 |

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 401     | Parameter error.                             |
| 2100001 | Invalid parameter value.                |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js
this.firstParam = iccid;
policy.restoreAllPolicies(this.firstParam, (error, data) => {
Y
Yangys 已提交
604
  this.callBack(error, data);
Z
zhanghaifeng 已提交
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
});
```

## policy.restoreAllPolicies

restoreAllPolicies(iccid: string): Promise\<void>;

重置对应sim卡id的蜂窝网络、后台网络策略、防火墙策略、应用对应的策略,使用Promise方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                                    | 必填 | 说明       |
| -------- | --------------------------------------- | ---- | ---------- |
| iccid | string | 是 | SIM卡ID|

**返回值:**

| 类型                              | 说明                                  |
| --------------------------------- | ------------------------------------- |
| Promise\<void> | 以Promise形式返回设定结果。 |

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 401     | Parameter error.                             |
| 2100001 | Invalid parameter value.                |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js
this.firstParam = iccid;
Y
Yangys 已提交
644 645 646
policy.restoreAllPolicies(this.firstParam).then(function (error, data) {
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
Z
zhanghaifeng 已提交
647 648 649 650 651 652
})

```

## policy.isUidNetAllowed

Z
zhanghaifeng 已提交
653
isUidNetAllowed(uid: number, isMetered: boolean, callback: AsyncCallback\<boolean>): void
Z
zhanghaifeng 已提交
654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683

获取对应uid能否访问计量或非计量网络,使用callback方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                                    | 必填 | 说明       |
| -------- | --------------------------------------- | ---- | ---------- |
| uid | number | 是 | app唯一标识符 |
| isMetered | boolean | 是 | 是否为计量网络 |
| callback | AsyncCallback\<boolean> | 是   | 回调函数,返回true表示这个uid可以访问对应的计量网络。 |

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 401     | Parameter error.                             |
| 2100001 | Invalid parameter value.                |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js

let param = {
Y
Yangys 已提交
684
  uid: Number.parseInt(this.firstParam), isMetered: Boolean(Number.parseInt(this.isBoolean))
Z
zhanghaifeng 已提交
685 686
}
policy.isUidNetAllowed(Number.parseInt(this.firstParam), Boolean(Number.parseInt(this.isBoolean)), (error, data) => {
Y
Yangys 已提交
687
  this.callBack(error, data);
Z
zhanghaifeng 已提交
688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728
});
```

## policy.isUidNetAllowed

isUidNetAllowed(uid: number, isMetered: boolean): Promise\<boolean>;

获取对应uid能否访问计量或非计量网络,使用Promise方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                                    | 必填 | 说明       |
| -------- | --------------------------------------- | ---- | ---------- |
| uid | number | 是 | app唯一标识符 |
| isMetered | boolean | 是 | 是否为计量网络 |

**返回值:**

| 类型                              | 说明                                  |
| --------------------------------- | ------------------------------------- |
| Promise\<boolean> | 以Promise形式返回设定结果。 |

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 401     | Parameter error.                             |
| 2100001 | Invalid parameter value.                |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js

let param = {
Y
Yangys 已提交
729
  uid: Number.parseInt(this.firstParam), isMetered: Boolean(Number.parseInt(this.isBoolean))
Z
zhanghaifeng 已提交
730
}
Y
Yangys 已提交
731 732 733
policy.isUidNetAllowed(Number.parseInt(this.firstParam), Boolean(Number.parseInt(this.isBoolean))).then(function (error, data) {
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
Z
zhanghaifeng 已提交
734 735 736 737 738 739
})

```

## policy.isUidNetAllowed

Z
zhanghaifeng 已提交
740
isUidNetAllowed(uid: number, iface: string, callback: AsyncCallback\<boolean>): void
Z
zhanghaifeng 已提交
741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770

获取对应uid能否访问指定的iface的网络,使用callback方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                                    | 必填 | 说明       |
| -------- | --------------------------------------- | ---- | ---------- |
| uid | number | 是 | app唯一标识符 |
| iface | string | 是 | 网络对应的名称 |
| callback | AsyncCallback\<boolean> | 是   | 回调函数,返回true表示这个uid可以访问对应iface的网络。 |

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 401     | Parameter error.                             |
| 2100001 | Invalid parameter value.                |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js

let param = {
Y
Yangys 已提交
771
  uid: Number.parseInt(this.firstParam), iface: this.secondParam
Z
zhanghaifeng 已提交
772 773
}
policy.isUidNetAllowed(Number.parseInt(this.firstParam), this.secondParam, (error, data) => {
Y
Yangys 已提交
774
  this.callBack(error, data);
Z
zhanghaifeng 已提交
775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814
});
```

## policy.isUidNetAllowed

isUidNetAllowed(uid: number, iface: string): Promise\<boolean>;

获取对应uid能否访问指定的iface的网络,使用Promise方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                                    | 必填 | 说明       |
| -------- | --------------------------------------- | ---- | ---------- |
| uid | number | 是 | app唯一标识符 |
| iface | string | 是 | 网络对应的名称 |

**返回值:**

| 类型                              | 说明                                  |
| --------------------------------- | ------------------------------------- |
| Promise\<boolean> | 以Promise形式返回设定结果。 |

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 401     | Parameter error.                             |
| 2100001 | Invalid parameter value.                |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js
let param = {
Y
Yangys 已提交
815
  uid: Number.parseInt(this.firstParam), iface: this.secondParam
Z
zhanghaifeng 已提交
816
}
Y
Yangys 已提交
817 818 819
policy.isUidNetAllowed(Number.parseInt(this.firstParam), this.secondParam).then(function (error, data) {
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
Z
zhanghaifeng 已提交
820 821 822 823 824 825
})

```

## policy.setDeviceIdleAllowList

Z
zhanghaifeng 已提交
826
setDeviceIdleAllowList(uid: number, isAllowed: boolean, callback: AsyncCallback\<void>): void
Z
zhanghaifeng 已提交
827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855

设置指定uid应用是否在休眠防火墙的白名单,使用callback方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                                    | 必填 | 说明       |
| -------- | --------------------------------------- | ---- | ---------- |
| uid | number | 是 | app唯一标识符 |
| isAllowed | boolean | 是 | 是否加入白名单 |
| callback | callback: AsyncCallback\<void> | 是   | 回调函数,返回设定结果。 |

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 401     | Parameter error.                             |
| 2100001 | Invalid parameter value.                |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js
let param = {
Y
Yangys 已提交
856
  uid: Number.parseInt(this.firstParam), isAllowed: Boolean(Number.parseInt(this.isBoolean))
Z
zhanghaifeng 已提交
857 858
}
policy.setDeviceIdleAllowList(Number.parseInt(this.firstParam), Boolean(Number.parseInt(this.isBoolean)), (error, data) => {
Y
Yangys 已提交
859
  this.callBack(error, data);
Z
zhanghaifeng 已提交
860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899
});
```

## policy.setDeviceIdleAllowList

setDeviceIdleAllowList(uid: number, isAllowed: boolean): Promise\<void>;

设置指定uid应用是否在休眠防火墙的白名单,使用Promise方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                                    | 必填 | 说明       |
| -------- | --------------------------------------- | ---- | ---------- |
| uid | number | 是 | app唯一标识符 |
| isAllowed | boolean | 是 | 是否加入白名单 |

**返回值:**

| 类型                              | 说明                                  |
| --------------------------------- | ------------------------------------- |
| Promise\<void> | 以Promise形式返回设定结果。 |

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 401     | Parameter error.                             |
| 2100001 | Invalid parameter value.                |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js
let param = {
Y
Yangys 已提交
900
  uid: Number.parseInt(this.firstParam), isAllowed: Boolean(Number.parseInt(this.isBoolean))
Z
zhanghaifeng 已提交
901
}
Y
Yangys 已提交
902 903 904
policy.setDeviceIdleAllowList(Number.parseInt(this.firstParam), Boolean(Number.parseInt(this.isBoolean))).then(function (error, data) {
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
Z
zhanghaifeng 已提交
905 906 907 908 909 910
})

```

## policy.getDeviceIdleAllowList

Z
zhanghaifeng 已提交
911
getDeviceIdleAllowList(callback: AsyncCallback\<Array\<number>>): void
Z
zhanghaifeng 已提交
912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936

获取休眠模式白名单所包含的uid数组,使用callback方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                                    | 必填 | 说明       |
| -------- | --------------------------------------- | ---- | ---------- |
| callback | AsyncCallback\<Array\<number>> | 是   | 回调函数,返回获取结果。 |

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js
policy.getDeviceIdleAllowList((error, data) => {
Y
Yangys 已提交
937
  this.callBack(error, data);
Z
zhanghaifeng 已提交
938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967
});
```

## policy.getDeviceIdleAllowList

getDeviceIdleAllowList(): Promise\<Array\<number>>;

获取休眠模式白名单所包含的uid数组,使用Promise方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**返回值:**

| 类型                              | 说明                                  |
| --------------------------------- | ------------------------------------- |
| Promise\<Array\<number>> | 以Promise形式返回设定结果。 |

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js
Y
Yangys 已提交
968 969 970
policy.getDeviceIdleAllowList().then(function (error, data) {
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
Z
zhanghaifeng 已提交
971 972 973 974 975
})
```

## policy.getBackgroundPolicyByUid

Z
zhanghaifeng 已提交
976
getBackgroundPolicyByUid(uid: number, callback: AsyncCallback\<NetBackgroundPolicy>): void
Z
zhanghaifeng 已提交
977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005

获取指定uid能否访问后台网络,使用callback方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                                    | 必填 | 说明       |
| -------- | --------------------------------------- | ---- | ---------- |
| uid | number | 是 | app唯一标识符 |
| callback | AsyncCallback\<[NetBackgroundPolicy](#netbackgroundpolicy)> | 是   | 回调函数,返回获取结果。 |

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 401     | Parameter error.                             |
| 2100001 | Invalid parameter value.                |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js
this.firstParam = uid
policy.getBackgroundPolicyByUid(Number.parseInt(this.firstParam), (error, data) => {
Y
Yangys 已提交
1006
  this.callBack(error, data);
Z
zhanghaifeng 已提交
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
});
```

## policy.getBackgroundPolicyByUid

getBackgroundPolicyByUid(uid: number): Promise\<NetBackgroundPolicy>;

获取指定uid能否访问后台网络,使用Promise方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                                    | 必填 | 说明       |
| -------- | --------------------------------------- | ---- | ---------- |
| uid | number | 是 | app唯一标识符 |

**返回值:**

| 类型                              | 说明                                  |
| --------------------------------- | ------------------------------------- |
| Promise\<[NetBackgroundPolicy](#netbackgroundpolicy)> | 以Promise形式返回设定结果。 |

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 401     | Parameter error.                             |
| 2100001 | Invalid parameter value.                |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js
this.firstParam = uid
Y
Yangys 已提交
1046 1047 1048
policy.getBackgroundPolicyByUid(Number.parseInt(this.firstParam)).then(function (error, data) {
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
Z
zhanghaifeng 已提交
1049 1050 1051 1052 1053
})
```

## policy.resetPolicies

Z
zhanghaifeng 已提交
1054
resetPolicies(iccid: string, callback: AsyncCallback\<void>): void
Z
zhanghaifeng 已提交
1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083

重置对应sim卡id的蜂窝网络、后台网络策略、防火墙策略、应用对应的策略,使用callback方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                                    | 必填 | 说明       |
| -------- | --------------------------------------- | ---- | ---------- |
| iccid | string | 是 | SIM卡ID|
| callback | AsyncCallback\<void> | 是   | 回调函数,返回重置结果。 |

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 401     | Parameter error.                             |
| 2100001 | Invalid parameter value.                |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js
this.firstParam = iccid
policy.resetPolicies(this.firstParam, (error, data) => {
Y
Yangys 已提交
1084
  this.callBack(error, data);
Z
zhanghaifeng 已提交
1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122
});
```

## policy.resetPolicies

resetPolicies(iccid: string): Promise\<void>;

重置对应sim卡id的蜂窝网络、后台网络策略、防火墙策略、应用对应的策略,使用Promise方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                                    | 必填 | 说明       |
| -------- | --------------------------------------- | ---- | ---------- |
| iccid | string | 是 | SIM卡ID|

**返回值:**

| 类型                              | 说明                                  |
| --------------------------------- | ------------------------------------- |
| Promise\<void> | 以Promise形式返回设定结果。 |

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 401     | Parameter error.                             |
| 2100001 | Invalid parameter value.                |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js
Y
Yangys 已提交
1123
policy.getUidsByPolicy(Number.parseInt(this.firstParam)).then(function (error, data) {
Z
zhanghaifeng 已提交
1124 1125 1126

})
this.firstParam = iccid
Y
Yangys 已提交
1127 1128 1129
policy.resetPolicies(this.firstParam).then(function (error, data) {
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
Z
zhanghaifeng 已提交
1130 1131 1132 1133 1134 1135
})

```

## policy.updateRemindPolicy

Z
zhanghaifeng 已提交
1136
updateRemindPolicy(netType: NetBearType, iccid: string, remindType: RemindType, callback: AsyncCallback\<void>): void
Z
zhanghaifeng 已提交
1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166

更新提醒策略,使用callback方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                                    | 必填 | 说明       |
| -------- | --------------------------------------- | ---- | ---------- |
| netType | [NetBearType](js-apis-net-connection.md#netbeartype) | 是 | 网络类型 |
| iccid | string | 是 | SIM卡ID|
| remindType | [RemindType](#remindtype) | 是 | 提醒类型 |
| callback | AsyncCallback\<void> | 是   | 回调函数,返回更新结果。 |

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 401     | Parameter error.                             |
| 2100001 | Invalid parameter value.                |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js
let param = {
Y
Yangys 已提交
1167
  netType: Number.parseInt(this.netType), iccid: this.firstParam, remindType: this.currentRemindType
Z
zhanghaifeng 已提交
1168 1169
}
policy.updateRemindPolicy(Number.parseInt(this.netType), this.firstParam, Number.parseInt(this.currentRemindType), (error, data) => {
Y
Yangys 已提交
1170
  this.callBack(error, data);
Z
zhanghaifeng 已提交
1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211
});
```

## policy.updateRemindPolicy

updateRemindPolicy(netType: NetBearType, iccid: string, remindType: RemindType): Promise\<void>;

更新提醒策略,使用Promise方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                                    | 必填 | 说明       |
| -------- | --------------------------------------- | ---- | ---------- |
| netType | [NetBearType](js-apis-net-connection.md#netbeartype) | 是 | 网络类型 |
| iccid | string | 是 | SIM卡ID|
| remindType | [RemindType](#remindtype) | 是 | 提醒类型 |

**返回值:**

| 类型                              | 说明                                  |
| --------------------------------- | ------------------------------------- |
| Promise\<void> | 以Promise形式返回设定结果。 |

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 401     | Parameter error.                             |
| 2100001 | Invalid parameter value.                |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js
let param = {
Y
Yangys 已提交
1212
  netType: Number.parseInt(this.netType), iccid: this.firstParam, remindType: this.currentRemindType
Z
zhanghaifeng 已提交
1213
}
Y
Yangys 已提交
1214 1215 1216
policy.updateRemindPolicy(Number.parseInt(this.netType), this.firstParam, Number.parseInt(this.currentRemindType)).then(function (error, data) {
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
Z
zhanghaifeng 已提交
1217 1218 1219 1220 1221 1222
})

```

## policy.setPowerSaveAllowList

Z
zhanghaifeng 已提交
1223
setPowerSaveAllowList(uid: number, isAllowed: boolean, callback: AsyncCallback\<void>): void
Z
zhanghaifeng 已提交
1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252

设置指定uid应用是否在省电防火墙的白名单,使用callback方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                                    | 必填 | 说明       |
| -------- | --------------------------------------- | ---- | ---------- |
| uid | number | 是 | app唯一标识符 |
| isAllowed | boolean | 是 | 是否加入白名单 |
| callback | callback: AsyncCallback\<void> | 是   | 回调函数,返回设定结果。 |

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 401     | Parameter error.                             |
| 2100001 | Invalid parameter value.                |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js
let param = {
Y
Yangys 已提交
1253
  uid: Number.parseInt(this.firstParam), isAllowed: Boolean(Number.parseInt(this.isBoolean))
Z
zhanghaifeng 已提交
1254 1255
}
policy.setPowerSaveAllowList(Number.parseInt(this.firstParam), Boolean(Number.parseInt(this.isBoolean)), (error, data) => {
Y
Yangys 已提交
1256
  this.callBack(error, data);
Z
zhanghaifeng 已提交
1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296
});
```

## policy.setPowerSaveAllowList

setPowerSaveAllowList(uid: number, isAllowed: boolean): Promise\<void>;

设置指定uid应用是否在省电防火墙的白名单,使用Promise方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                                    | 必填 | 说明       |
| -------- | --------------------------------------- | ---- | ---------- |
| uid | number | 是 | app唯一标识符 |
| isAllowed | boolean | 是 | 是否加入白名单 |

**返回值:**

| 类型                              | 说明                                  |
| --------------------------------- | ------------------------------------- |
| Promise\<void> | 以Promise形式返回设定结果。 |

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 401     | Parameter error.                             |
| 2100001 | Invalid parameter value.                |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js
let param = {
Y
Yangys 已提交
1297
  uid: Number.parseInt(this.firstParam), isAllowed: Boolean(Number.parseInt(this.isBoolean))
Z
zhanghaifeng 已提交
1298
}
Y
Yangys 已提交
1299 1300 1301
policy.setPowerSaveAllowList(Number.parseInt(this.firstParam), Boolean(Number.parseInt(this.isBoolean))).then(function (error, data) {
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
Z
zhanghaifeng 已提交
1302 1303 1304 1305 1306 1307
})

```

## policy.getPowerSaveAllowList

Z
zhanghaifeng 已提交
1308
getPowerSaveAllowList(callback: AsyncCallback\<Array\<number>>): void
Z
zhanghaifeng 已提交
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333

获取省电模式白名单所包含的uid数组,使用callback方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                                    | 必填 | 说明       |
| -------- | --------------------------------------- | ---- | ---------- |
| callback | AsyncCallback\<Array\<number>> | 是   | 回调函数,返回获取结果。 |

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js
policy.getPowerSaveAllowList((error, data) => {
Y
Yangys 已提交
1334
  this.callBack(error, data);
Z
zhanghaifeng 已提交
1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364
});
```

## policy.getPowerSaveAllowList

getPowerSaveAllowList(): Promise\<Array\<number>>;

获取休眠模式白名单所包含的uid数组,使用Promise方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**返回值:**

| 类型                              | 说明                                  |
| --------------------------------- | ------------------------------------- |
| Promise\<Array\<number>> | 以Promise形式返回设定结果。 |

**错误码:**

| 错误码ID | 错误信息                                      |
| ------- | -------------------------------------------- |
| 201     | Permission denied.                           |
| 2100002 | Operation failed. Cannot connect to service.|
| 2100003 | System internal error.                  |

**示例:**

```js
Y
Yangys 已提交
1365 1366 1367
policy.getPowerSaveAllowList().then(function (error, data) {
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
Z
zhanghaifeng 已提交
1368 1369 1370 1371 1372 1373 1374 1375 1376
})
```

## policy.on

网络策略的句柄。

### on('netUidPolicyChange')

Z
zhanghaifeng 已提交
1377
on(type: "netUidPolicyChange", callback: Callback\<{ uid: number, policy: NetUidPolicy }>): void
Z
zhanghaifeng 已提交
1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395

注册policy发生改变时的回调,使用callback方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                               | 必填 | 说明                                                         |
| -------- | ---------------------------------- | ---- | ------------------------------------------------------------ |
| type | netUidPolicyChange | 是 | policy发生改变的类型 |
| callback | Callback\<{ uid: number, policy: [NetUidPolicy](#netuidpolicy) }> | 是   | 回调函数。注册policy发生改变时调用。 |

**示例:**

```js
policy.on('netUidPolicyChange', (data) => {
Y
Yangys 已提交
1396
  this.log('on netUidPolicyChange:' + JSON.stringify(data));
Z
zhanghaifeng 已提交
1397 1398 1399 1400 1401
})
```

### on('netUidRuleChange')

Z
zhanghaifeng 已提交
1402
on(type: "netUidRuleChange", callback: Callback\<{ uid: number, rule: NetUidRule }>): void
Z
zhanghaifeng 已提交
1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420

注册rule发生改变时的回调,使用callback方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                               | 必填 | 说明                                                         |
| -------- | ---------------------------------- | ---- | ------------------------------------------------------------ |
| type | netUidRuleChange | 是 | rule发生改变的类型 |
| callback | Callback\<{ uid: number, rule: [NetUidRule](#netuidrule) }> | 是   | 回调函数。注册rule发生改变时的调用。 |

**示例:**

```js
policy.on('netUidRuleChange', (data) => {
Y
Yangys 已提交
1421
  this.log('on netUidRuleChange:' + JSON.stringify(data));
Z
zhanghaifeng 已提交
1422 1423 1424 1425 1426
})
```

### on('netMeteredIfacesChange')

Z
zhanghaifeng 已提交
1427
on(type: "netMeteredIfacesChange", callback: Callback\<Array\<string>>): void
Z
zhanghaifeng 已提交
1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445

注册计量iface发生改变时的回调,使用callback方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                               | 必填 | 说明                                                         |
| -------- | ---------------------------------- | ---- | ------------------------------------------------------------ |
| type | netMeteredIfacesChange | 是 | 计量iface发生改变的类型 |
| callback | Callback\<Array\<string>> | 是   | 回调函数。注册计量iface发生改变时调用。 |

**示例:**

```js
policy.on('netMeteredIfacesChange', (data) => {
Y
Yangys 已提交
1446
  this.log('on netMeteredIfacesChange:' + JSON.stringify(data));
Z
zhanghaifeng 已提交
1447 1448 1449 1450 1451
})
```

### on('netQuotaPolicyChange')

Z
zhanghaifeng 已提交
1452
on(type: "netQuotaPolicyChange", callback: Callback\<Array\<NetQuotaPolicy>>): void
Z
zhanghaifeng 已提交
1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470

注册计量网络策略发生改变时的回调,使用callback方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                               | 必填 | 说明                                                         |
| -------- | ---------------------------------- | ---- | ------------------------------------------------------------ |
| type | netQuotaPolicyChange | 是 | 计量网络策略发生改变的类型 |
| callback | Callback\<Array\<[NetQuotaPolicy](#netquotapolicy)>> | 是   | 回调函数。注册计量网络策略发生改变时调用。 |

**示例:**

```js
policy.on('netQuotaPolicyChange', (data) => {
Y
Yangys 已提交
1471
  this.log('on netQuotaPolicyChange:' + JSON.stringify(data));
Z
zhanghaifeng 已提交
1472 1473 1474 1475 1476
})
```

### on('netBackgroundPolicyChange')

Z
zhanghaifeng 已提交
1477
on(type: "netBackgroundPolicyChange", callback: Callback\<boolean>): void
Z
zhanghaifeng 已提交
1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495

注册后台网络策略发生改变时的回调,使用callback方式作为异步方法。

**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL

**系统能力**:SystemCapability.Communication.NetManager.Core

**参数:**

| 参数名   | 类型                               | 必填 | 说明                                                         |
| -------- | ---------------------------------- | ---- | ------------------------------------------------------------ |
| type | netBackgroundPolicyChange | 是 | 后台网络策略发生改变的类型 |
| callback | Callback\<boolean> | 是   | 回调函数。注册后台网络策略发生改变时调用。 |

**示例:**

```js
policy.on('netBackgroundPolicyChange', (data) => {
Y
Yangys 已提交
1496
  this.log('on netBackgroundPolicyChange:' + JSON.stringify(data));
Z
zhanghaifeng 已提交
1497 1498 1499 1500 1501 1502 1503
})
```

## NetBackgroundPolicy

后台网络策略。

Z
zengyawen 已提交
1504
**系统能力**:SystemCapability.Communication.NetManager.Core
Z
zhanghaifeng 已提交
1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516

| 参数名                  | 值   | 说明                   |
| ------------------------ | ---- | ---------------------- |
| NET_BACKGROUND_POLICY_NONE       | 0 | 默认值。 |
| NET_BACKGROUND_POLICY_ENABLE     | 1 | 应用在后台可以使用计量网路。 |
| NET_BACKGROUND_POLICY_DISABLE    | 2 | 应用在后台不可以使用计量网路。 |
| NET_BACKGROUND_POLICY_ALLOW_LIST | 3 | 只有应用指定的列表在后台可以使用计量网络。 |

## NetQuotaPolicy

计量网络策略。

Z
zengyawen 已提交
1517
**系统能力**:SystemCapability.Communication.NetManager.Core
Z
zhanghaifeng 已提交
1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535

| 参数名                  | 类型                                | 说明                                                         |
| ----------------------- | ----------------------------------- | ------------------------------------------------------------ |
| netType           | [NetBearType](js-apis-net-connection.md#netbeartype) | 网络类型。 |
| iccid             | string                      | 计量蜂窝网络的SIM卡的标识值。以太网,wifi网络不会用到 |
| ident             | string                      | 计量蜂窝网络中配合iccid联合使用。以太网,wifi网络单独使用。用于标记类型。 |
| periodDuration    | string                      | 计量开始时间。 |
| warningBytes      | number                      | 发出警告的流量阈值。 |
| limitBytes        | number                      | 流量设置的配额。 |
| lastWarningRemind | string                      | 最新一次发出警告的时间。 |
| lastLimitRemind   | string                      | 最新一次配额耗尽的时间。 |
| metered           | string                      | 是否为计量网络。 |
| limitAction       | [LimitAction](#limitaction) | 到达流量限制后的动作。 |

## LimitAction

限制动作。

Z
zengyawen 已提交
1536
**系统能力**:SystemCapability.Communication.NetManager.Core
Z
zhanghaifeng 已提交
1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547

| 参数名                  | 值 | 说明   |
| ---------------------- | ----- | ------------ |
| LIMIT_ACTION_NONE     | -1 | 默认值。 |
| LIMIT_ACTION_DISABLE  | 0  | 当配额策略达到限制时,访问被禁用。 |
| LIMIT_ACTION_AUTO_BILL| 1  | 当配额策略达到限制时,用户将自动计费。 |

## NetUidRule

计量网络规则。

Z
zengyawen 已提交
1548
**系统能力**:SystemCapability.Communication.NetManager.Core
Z
zhanghaifeng 已提交
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562

| 参数名                  | 值 | 说明   |
| ---------------------- | ----- | ------------ |
| NET_RULE_NONE                     | 0 | 默认规则 |
| NET_RULE_ALLOW_METERED_FOREGROUND | 1 | 允许前台访问计量网络 |
| NET_RULE_ALLOW_METERED            | 2 | 允许访问计量网络 |
| NET_RULE_REJECT_METERED           | 4 | 拒绝访问计量网络 |
| NET_RULE_ALLOW_ALL                | 32 | 允许访问所有网络 |
| NET_RULE_REJECT_ALL               | 64 | 拒绝访问所有网络 |

## RemindType

提醒类型。

Z
zengyawen 已提交
1563
**系统能力**:SystemCapability.Communication.NetManager.Core
Z
zhanghaifeng 已提交
1564

1565 1566 1567 1568
| 参数名 | 值 | 说明 |
| ---------------------- | - | ------- |
| REMIND_TYPE_WARNING | 1 | 警告提醒 |
| REMIND_TYPE_LIMIT   | 2 | 限制提醒 |
Z
zhanghaifeng 已提交
1569 1570 1571 1572 1573

## NetUidPolicy

应用对应的网络策略。

Z
zengyawen 已提交
1574
**系统能力**:SystemCapability.Communication.NetManager.Core
Z
zhanghaifeng 已提交
1575 1576 1577 1578 1579 1580

| 参数名                  | 值 | 说明   |
| ---------------------- | ----- | ------------ |
| NET_POLICY_NONE                       | 0 | 默认网络策略 |
| NET_POLICY_ALLOW_METERED_BACKGROUND   | 1 | 允许应用在后台访问计量网络 |
| NET_POLICY_REJECT_METERED_BACKGROUND  | 2 | 拒绝应用在后台访问计量网络 |