# @ohos.net.policy (网络策略管理)(系统接口)
网络策略管理通过对用户使用数据流量进行控制管理,采用防火墙技术实现网络策略的管理。
> **说明:**
>
> 本模块首批接口从 API version 10 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块为系统接口。
## 导入模块
```ts
import { policy } from '@kit.NetworkKit';
```
## policy.setBackgroundAllowed10+
setBackgroundAllowed(isAllowed: boolean, callback: AsyncCallback\): void
设置是否允许后台应用访问网络,使用 callback 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | -------------------- | ---- | ------------------------------------------------------------ |
| isAllowed | boolean | 是 | 是否允许应用后台使用数据 |
| callback | AsyncCallback\ | 是 | 回调函数,成功时,err 为 undefined,失败返回错误码错误信息。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
policy.setBackgroundAllowed(true, (error: BusinessError) => {
console.log(JSON.stringify(error));
});
```
## policy.setBackgroundAllowed10+
setBackgroundAllowed(isAllowed: boolean): Promise\
设置是否允许后台应用访问网络,使用 Promise 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------- | ---- | ------------------------ |
| isAllowed | boolean | 是 | 是否允许应用后台使用数据 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**返回值:**
| 类型 | 说明 |
| -------------- | ----------------------------------------------------------------- |
| Promise\ | 以 Promise 形式返回设定结果,成功返回空,失败返回错误码错误信息。 |
**示例:**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
policy.setBackgroundAllowed(true).then(() => {
console.log("setBackgroundAllowed success");
}).catch((error: BusinessError) => {
console.log(JSON.stringify(error));
});
```
## policy.isBackgroundAllowed10+
isBackgroundAllowed(callback: AsyncCallback\): void
获取当前应用是否允许后台访问网络,使用 callback 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ---------------------------------------------------------------- |
| callback | AsyncCallback\ | 是 | 回调函数,返回 true 代表后台策略为允许。失败返回错误码错误信息。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
policy.isBackgroundAllowed((error: BusinessError, data: boolean) => {
console.log(JSON.stringify(error));
console.log(JSON.stringify(data));
});
```
## policy.isBackgroundAllowed10+
isBackgroundAllowed(): Promise\;
获取当前应用是否允许后台访问网络,使用 Promise 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**返回值:**
| 类型 | 说明 |
| ----------------- | ------------------------------------------------------------------------------------ |
| Promise\ | 以 Promise 形式返回设定结果。 返回 true 代表后台策略为允许。失败返回错误码错误信息。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
policy
.isBackgroundAllowed()
.then((data: boolean) => {
console.log(JSON.stringify(data));
})
.catch((error: BusinessError) => {
console.log(JSON.stringify(error));
});
```
## policy.setPolicyByUid10+
setPolicyByUid(uid: number, policy: NetUidPolicy, callback: AsyncCallback\): void
设置对应 uid 应用是否能够访问计量网络的策略,使用 callback 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ---------------------------------------------- |
| uid | number | 是 | app 唯一标识符 |
| policy | [NetUidPolicy](#netuidpolicy10) | 是 | 应用对应的策略 |
| callback | AsyncCallback\ | 是 | 回调函数,成功返回空,失败返回错误码错误信息。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
policy.setPolicyByUid(11111, policy.NetUidPolicy.NET_POLICY_NONE, (error: BusinessError) => {
console.log(JSON.stringify(error));
});
```
## policy.setPolicyByUid10+
setPolicyByUid(uid: number, policy: NetUidPolicy): Promise\;
设置对应 uid 应用是否能够访问计量网络的策略,使用 Promise 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------------------- | ---- | -------------- |
| uid | number | 是 | app 唯一标识符 |
| policy | [NetUidPolicy](#netuidpolicy10) | 是 | 应用对应的策略 |
**返回值:**
| 类型 | 说明 |
| -------------- | ----------------------------------------------------------------- |
| Promise\ | 以 Promise 形式返回设定结果。成功返回空,失败返回错误码错误信息。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
policy
.setPolicyByUid(11111, policy.NetUidPolicy.NET_POLICY_NONE)
.then(() => {
console.log('setPolicyByUid success');
})
.catch((error: BusinessError) => {
console.log(JSON.stringify(error));
});
```
## policy.getPolicyByUid10+
getPolicyByUid(uid: number, callback: AsyncCallback\): void
通过应用 uid 获取对应访问网络策略,使用 callback 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------- | ---- | -------------------------------------------------------- |
| uid | number | 是 | app 唯一标识符 |
| callback | AsyncCallback\<[NetUidPolicy](#netuidpolicy10)> | 是 | 回调函数,成功返回获取策略结果,失败返回错误码错误信息。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
policy.getPolicyByUid(11111, (error: BusinessError, data: policy.NetUidPolicy) => {
console.log(JSON.stringify(error));
console.log(JSON.stringify(data));
});
```
## policy.getPolicyByUid10+
getPolicyByUid(uid: number): Promise\;
通过应用 uid 获取对应访问网络策略,使用 Promise 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------- |
| uid | number | 是 | app 唯一标识符 |
**返回值:**
| 类型 | 说明 |
| ----------------------------------------- | --------------------------------------------------------- |
| Promise\<[NetUidPolicy](#netuidpolicy10)> | 以 Promise 形式返回获取策略结果。失败返回错误码错误信息。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
policy
.getPolicyByUid(11111)
.then((data: policy.NetUidPolicy) => {
console.log(JSON.stringify(data));
})
.catch((error: BusinessError) => {
console.log(JSON.stringify(error));
});
```
## policy.getUidsByPolicy10+
getUidsByPolicy(policy: NetUidPolicy, callback: AsyncCallback\>): void
通过策略获取跟策略匹配的所有 uid,使用 callback 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ----------------------------------------------------------- |
| policy | [NetUidPolicy](#netuidpolicy10) | 是 | 应用对应的计量网络下的策略 |
| callback | AsyncCallback\> | 是 | 回调函数,成功返回应用的 uid 数组,失败返回错误码错误信息。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
policy.getUidsByPolicy(11111, (error: BusinessError, data: number[]) => {
console.log(JSON.stringify(error));
console.log(JSON.stringify(data));
});
```
## policy.getUidsByPolicy10+
getUidsByPolicy(policy: NetUidPolicy): Promise\>;
通过策略获取跟策略匹配的所有 uid,使用 Promise 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------------------- | ---- | -------------------------- |
| policy | [NetUidPolicy](#netuidpolicy10) | 是 | app 对应的计量网络下的策略 |
**返回值:**
| 类型 | 说明 |
| ------------------------ | ------------------------------------------------------------ |
| Promise\> | 以 Promise 形式返回应用的 uid 数组,失败返回错误码错误信息。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
policy
.getUidsByPolicy(11111)
.then((data: object) => {
console.log(JSON.stringify(data));
})
.catch((error: BusinessError) => {
console.log(JSON.stringify(error));
});
```
## policy.getNetQuotaPolicies10+
getNetQuotaPolicies(callback: AsyncCallback\>): void
获取计量网络策略,使用 callback 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------------- | ---- | ------------------------ |
| callback | AsyncCallback\> | 是 | 回调函数,返回获取结果。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
policy.getNetQuotaPolicies((error: BusinessError, data: policy.NetQuotaPolicy[]) => {
console.log(JSON.stringify(error));
console.log(JSON.stringify(data));
});
```
## policy.getNetQuotaPolicies10+
getNetQuotaPolicies(): Promise\>;
获取计量网络策略,使用 Promise 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**返回值:**
| 类型 | 说明 |
| ----------------------------------------------------- | ----------------------------- |
| Promise\> | 以 Promise 形式返回设定结果。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
policy
.getNetQuotaPolicies()
.then((data: policy.NetQuotaPolicy[]) => {
console.log(JSON.stringify(data));
})
.catch((error: BusinessError) => {
console.log(JSON.stringify(error));
});
```
## policy.setNetQuotaPolicies10+
setNetQuotaPolicies(quotaPolicies: Array\, callback: AsyncCallback\): void
设置计量网络策略,使用 callback 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------------- | ------------------------------------------- | ---- | ---------------------------------------------- |
| quotaPolicies | Array\<[NetQuotaPolicy](#netquotapolicy10)> | 是 | 计量网络策略 |
| callback | AsyncCallback\ | 是 | 回调函数,成功返回空,失败返回错误码错误信息。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';
let netQuotaPolicyList: Array = [];
let netquotapolicy: policy.NetQuotaPolicy = {
networkMatchRule: {
netType: connection.NetBearType.BEARER_CELLULAR,
identity: '',
simId: '1'
},
quotaPolicy: {
periodDuration: 'M1',
warningBytes: 40000,
limitBytes: 50000,
metered: true,
limitAction: policy.LimitAction.LIMIT_ACTION_NONE
}
}
netQuotaPolicyList.push(netquotapolicy);
policy.setNetQuotaPolicies(netQuotaPolicyList, (error: BusinessError) => {
console.log(JSON.stringify(error));
});
```
## policy.setNetQuotaPolicies10+
setNetQuotaPolicies(quotaPolicies: Array\): Promise\;
设置计量网络策略,使用 Promise 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------------- | ------------------------------------------- | ---- | ------------ |
| quotaPolicies | Array\<[NetQuotaPolicy](#netquotapolicy10)> | 是 | 计量网络策略 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**返回值:**
| 类型 | 说明 |
| -------------- | ----------------------------------------------------------------- |
| Promise\ | 以 Promise 形式返回设定结果。成功返回空,失败返回错误码错误信息。 |
**示例:**
```ts
import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';
let netQuotaPolicyList: Array = [];
let netquotapolicy: policy.NetQuotaPolicy = {
networkMatchRule: {
netType: connection.NetBearType.BEARER_CELLULAR,
identity: '',
simId: '1'
},
quotaPolicy: {
periodDuration: 'M1',
warningBytes: 40000,
limitBytes: 50000,
metered: true,
limitAction: policy.LimitAction.LIMIT_ACTION_NONE
}
}
netQuotaPolicyList.push(netquotapolicy);
policy
.setNetQuotaPolicies(netQuotaPolicyList)
.then(() => {
console.log('setNetQuotaPolicies success');
})
.catch((error: BusinessError) => {
console.log(JSON.stringify(error));
});
```
## policy.isUidNetAllowed10+
isUidNetAllowed(uid: number, isMetered: boolean, callback: AsyncCallback\): void
判断对应 uid 能否访问计量或非计量网络,使用 callback 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ----------------------- | ---- | --------------------------------------------------------- |
| uid | number | 是 | app 唯一标识符 |
| isMetered | boolean | 是 | 是否为计量网络 |
| callback | AsyncCallback\ | 是 | 回调函数,返回 true 表示这个 uid 可以访问对应的计量网络。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
policy.isUidNetAllowed(11111, true, (error: BusinessError, data: boolean) => {
console.log(JSON.stringify(error));
console.log(JSON.stringify(data));
});
```
## policy.isUidNetAllowed10+
isUidNetAllowed(uid: number, isMetered: boolean): Promise\;
判断对应 uid 能否访问计量或非计量网络,使用 Promise 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------- | ---- | -------------- |
| uid | number | 是 | app 唯一标识符 |
| isMetered | boolean | 是 | 是否为计量网络 |
**返回值:**
| 类型 | 说明 |
| ----------------- | ----------------------------- |
| Promise\ | 以 Promise 形式返回设定结果。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
policy
.isUidNetAllowed(11111, true)
.then((data: boolean) => {
console.log(JSON.stringify(data));
})
.catch((error: BusinessError) => {
console.log(JSON.stringify(error));
});
```
## policy.isUidNetAllowed10+
isUidNetAllowed(uid: number, iface: string, callback: AsyncCallback\): void
获取对应 uid 能否访问指定的 iface 的网络,使用 callback 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ------------------------------------------------------------ |
| uid | number | 是 | app 唯一标识符 |
| iface | string | 是 | 网络对应的名称 |
| callback | AsyncCallback\ | 是 | 回调函数,返回 true 表示这个 uid 可以访问对应 iface 的网络。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
policy.isUidNetAllowed(11111, 'wlan0', (error: BusinessError, data: boolean) => {
console.log(JSON.stringify(error));
console.log(JSON.stringify(data));
});
```
## policy.isUidNetAllowed10+
isUidNetAllowed(uid: number, iface: string): Promise\;
获取对应 uid 能否访问指定的 iface 的网络,使用 Promise 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------- |
| uid | number | 是 | app 唯一标识符 |
| iface | string | 是 | 网络对应的名称 |
**返回值:**
| 类型 | 说明 |
| ----------------- | ------------------------------------------------------- |
| Promise\ | 以 Promise 形式返回当前 uid 能否访问对应 iface 的网络。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
policy
.isUidNetAllowed(11111, 'wlan0')
.then((data: boolean) => {
console.log(JSON.stringify(data));
})
.catch((error: BusinessError) => {
console.log(JSON.stringify(error));
});
```
## policy.setDeviceIdleTrustlist10+
setDeviceIdleTrustlist(uids: Array\, isAllowed: boolean, callback: AsyncCallback\): void
设置多个 uid 是否在休眠防火墙的白名单,使用 callback 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------------ | ---- | ---------------------------------------------- |
| uids | Array\ | 是 | app 唯一标识符 |
| isAllowed | boolean | 是 | 是否加入白名单 |
| callback | callback: AsyncCallback\ | 是 | 回调函数,成功返回空,失败返回错误码错误信息。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
policy.setDeviceIdleTrustlist([11111, 22222], true, (error: BusinessError) => {
console.log(JSON.stringify(error));
});
```
## policy.setDeviceIdleTrustlist10+
setDeviceIdleTrustlist(uids: Array\, isAllowed: boolean): Promise\;
设置多个 uid 是否在休眠防火墙的白名单,使用 Promise 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | -------------- | ---- | -------------- |
| uids | Array\ | 是 | app 唯一标识符 |
| isAllowed | boolean | 是 | 是否加入白名单 |
**返回值:**
| 类型 | 说明 |
| -------------- | ----------------------------------------------------------------- |
| Promise\ | 以 Promise 形式返回设定结果。成功返回空,失败返回错误码错误信息。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
policy
.setDeviceIdleTrustlist([11111, 22222], true)
.then(() => {
console.log('setDeviceIdleTrustlist success');
})
.catch((error: BusinessError) => {
console.log(JSON.stringify(error));
});
```
## policy.getDeviceIdleTrustlist10+
getDeviceIdleTrustlist(callback: AsyncCallback\>): void
获取休眠模式白名单所包含的 uid,使用 callback 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------ | ---- | ------------------------ |
| callback | AsyncCallback\> | 是 | 回调函数,返回获取结果。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
policy.getDeviceIdleTrustlist((error: BusinessError, data: number[]) => {
console.log(JSON.stringify(error));
console.log(JSON.stringify(data));
});
```
## policy.getDeviceIdleTrustlist10+
getDeviceIdleTrustlist(): Promise\>;
获取休眠模式白名单所包含的 uid,使用 Promise 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**返回值:**
| 类型 | 说明 |
| ------------------------ | ----------------------------- |
| Promise\> | 以 Promise 形式返回设定结果。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
policy
.getDeviceIdleTrustlist()
.then((data: number[]) => {
console.log(JSON.stringify(data));
})
.catch((error: BusinessError) => {
console.log(JSON.stringify(error));
});
```
## policy.getBackgroundPolicyByUid10+
getBackgroundPolicyByUid(uid: number, callback: AsyncCallback\): void
获取指定 uid 是否能访问后台网络,使用 callback 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------- | ---- | ------------------------ |
| uid | number | 是 | app 唯一标识符 |
| callback | AsyncCallback\<[NetBackgroundPolicy](#netbackgroundpolicy10)> | 是 | 回调函数,返回获取结果。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
policy.getBackgroundPolicyByUid(11111, (error: BusinessError, data: policy.NetBackgroundPolicy) => {
console.log(JSON.stringify(error));
console.log(JSON.stringify(data));
});
```
## policy.getBackgroundPolicyByUid10+
getBackgroundPolicyByUid(uid: number): Promise\;
获取指定 uid 能否访问后台网络,使用 Promise 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------- |
| uid | number | 是 | app 唯一标识符 |
**返回值:**
| 类型 | 说明 |
| ------------------------------------------------------- | ----------------------------- |
| Promise\<[NetBackgroundPolicy](#netbackgroundpolicy10)> | 以 Promise 形式返回设定结果。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
policy
.getBackgroundPolicyByUid(11111)
.then((data: policy.NetBackgroundPolicy) => {
console.log(JSON.stringify(data));
})
.catch((error: BusinessError) => {
console.log(JSON.stringify(error));
});
```
## policy.resetPolicies10+
resetPolicies(simId: string, callback: AsyncCallback\): void
重置对应 sim 卡 id 的蜂窝网络、后台网络策略、防火墙策略、应用对应的策略,使用 callback 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------------------------- |
| simId | string | 是 | SIM 卡 ID |
| callback | AsyncCallback\ | 是 | 回调函数,成功返回空,失败返回错误码错误信息。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
policy.resetPolicies('1', (error: BusinessError) => {
console.log(JSON.stringify(error));
});
```
## policy.resetPolicies10+
resetPolicies(simId: string): Promise\;
重置对应 sim 卡 id 的蜂窝网络、后台网络策略、防火墙策略、应用对应的策略,使用 Promise 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | --------- |
| simId | string | 是 | SIM 卡 ID |
**返回值:**
| 类型 | 说明 |
| -------------- | ----------------------------------------------------------------- |
| Promise\ | 以 Promise 形式返回设定结果。成功返回空,失败返回错误码错误信息。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
policy
.resetPolicies('1')
.then(() => {
console.log('resetPolicies success');
})
.catch((error: BusinessError) => {
console.log(JSON.stringify(error));
});
```
## policy.updateRemindPolicy10+
updateRemindPolicy(netType: NetBearType, simId: string, remindType: RemindType, callback: AsyncCallback\): void
更新提醒策略,使用 callback 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ---------------------------------------------------- | ---- | ---------------------------------------------- |
| netType | [NetBearType](js-apis-net-connection.md#netbeartype) | 是 | 网络类型 |
| simId | string | 是 | SIM 卡 ID |
| remindType | [RemindType](#remindtype10) | 是 | 提醒类型 |
| callback | AsyncCallback\ | 是 | 回调函数,成功返回空,失败返回错误码错误信息。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';
policy.updateRemindPolicy(
connection.NetBearType.BEARER_CELLULAR,
'1',
policy.RemindType.REMIND_TYPE_WARNING,
(error: BusinessError) => {
console.log(JSON.stringify(error));
}
);
```
## policy.updateRemindPolicy10+
updateRemindPolicy(netType: NetBearType, simId: string, remindType: RemindType): Promise\;
更新提醒策略,使用 Promise 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ---------------------------------------------------- | ---- | --------- |
| netType | [NetBearType](js-apis-net-connection.md#netbeartype) | 是 | 网络类型 |
| simId | string | 是 | SIM 卡 ID |
| remindType | [RemindType](#remindtype10) | 是 | 提醒类型 |
**返回值:**
| 类型 | 说明 |
| -------------- | ----------------------------------------------------------------- |
| Promise\ | 以 Promise 形式返回设定结果。成功返回空,失败返回错误码错误信息。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';
policy
.updateRemindPolicy(
connection.NetBearType.BEARER_CELLULAR,
'1',
policy.RemindType.REMIND_TYPE_WARNING
)
.then(() => {
console.log('updateRemindPolicy success');
})
.catch((error: BusinessError) => {
console.log(JSON.stringify(error));
});
```
## policy.setPowerSaveTrustlist10+
setPowerSaveTrustlist(uids: Array\, isAllowed: boolean, callback: AsyncCallback\): void
设置指定 uid 应用是否在省电防火墙的白名单,使用 callback 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------------ | ---- | ---------------------------------------------- |
| uids | Array\ | 是 | app 唯一标识符 |
| isAllowed | boolean | 是 | 是否加入白名单 |
| callback | callback: AsyncCallback\ | 是 | 回调函数,成功返回空,失败返回错误码错误信息。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
policy.setPowerSaveTrustlist([11111, 22222], true, (error: BusinessError) => {
console.log(JSON.stringify(error));
});
```
## policy.setPowerSaveTrustlist10+
setPowerSaveTrustlist(uids: Array\, isAllowed: boolean): Promise\;
设置指定 uid 应用是否在省电防火墙的白名单,使用 Promise 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | -------------- | ---- | -------------- |
| uids | Array\ | 是 | app 唯一标识符 |
| isAllowed | boolean | 是 | 是否加入白名单 |
**返回值:**
| 类型 | 说明 |
| -------------- | ----------------------------------------------------------------- |
| Promise\ | 以 Promise 形式返回设定结果。成功返回空,失败返回错误码错误信息。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
policy
.setPowerSaveTrustlist([11111, 22222], true)
.then(() => {
console.log('setPowerSaveTrustlist success');
})
.catch((error: BusinessError) => {
console.log(JSON.stringify(error));
});
```
## policy.getPowerSaveTrustlist10+
getPowerSaveTrustlist(callback: AsyncCallback\>): void
获取省电模式白名单所包含的 uid 数组,使用 callback 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------ | ---- | ------------------------ |
| callback | AsyncCallback\> | 是 | 回调函数,返回获取结果。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
policy.getPowerSaveTrustlist((error: BusinessError, data: number[]) => {
console.log(JSON.stringify(error));
console.log(JSON.stringify(data));
});
```
## policy.getPowerSaveTrustlist10+
getPowerSaveTrustlist(): Promise\>;
获取休眠模式白名单所包含的 uid 数组,使用 Promise 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**返回值:**
| 类型 | 说明 |
| ------------------------ | ----------------------------- |
| Promise\> | 以 Promise 形式返回设定结果。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
policy
.getPowerSaveTrustlist()
.then((data: number[]) => {
console.log(JSON.stringify(data));
})
.catch((error: BusinessError) => {
console.log(JSON.stringify(error));
});
```
## policy.setNetworkAccessPolicy12+
setNetworkAccessPolicy(uid: number, policy: NetworkAccessPolicy, isReconfirmed?: boolean): Promise
设置指定 uid 应用能否能访问网络的策略,使用 Promise 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------------- | ---------------------------------------------- | ---- | ---------------------------------------------------------------------------- |
| uid | number | 是 | app 唯一标识符 |
| policy | [NetworkAccessPolicy](#networkaccesspolicy12) | 是 | 网络策略 |
| isReconfirmed | boolean | 否 | 默认false;false 表示需要重确认,应用访问网络会弹框; true 表示不需要重确认,无弹框 |
**返回值:**
| 类型 | 说明 |
| -------------- | ------------------------------------------------------------ |
| Promise\ | 以 Promise 形式返回设定结果。成功返回空,失败返回错误码错误信息。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
let accessPolicy: policy.NetworkAccessPolicy = {
allowWiFi: false,
allowCellular: true,
}
policy
.setNetworkAccessPolicy(11111, accessPolicy)
.then(() => {
console.log('setNetworkAccessPolicy success');
})
.catch((error: BusinessError) => {
console.error(JSON.stringify(error));
});
```
## policy.getNetworkAccessPolicy12+
getNetworkAccessPolicy(uid: number): Promise
获取指定 uid 能否访问网络策略,使用 Promise 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------- |
| uid | number | 是 | app 唯一标识符 |
**返回值:**
| 类型 | 说明 |
| ------------------------------------------------------- | ----------------------------- |
| Promise\<[NetworkAccessPolicy](#networkaccesspolicy12)> | 以 Promise 形式返回设定结果。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
policy
.getNetworkAccessPolicy(11111)
.then((data: policy.NetworkAccessPolicy) => {
console.log(JSON.stringify(data));
})
.catch((error: BusinessError) => {
console.error(JSON.stringify(error));
});
```
## policy.getNetworkAccessPolicy12+
getNetworkAccessPolicy(): Promise
获取当前用户下所有应用 app 能否访问网络策略信息,使用 Promise 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**返回值:**
| 类型 | 说明 |
| ------------------------------------------------------------- | --------------------------- |
| Promise\<[UidNetworkAccessPolicy](#uidnetworkaccesspolicy12)> | 以 Promise 形式返回设定结果。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
policy
.getNetworkAccessPolicy()
.then((data: policy.UidNetworkAccessPolicy) => {
let keyMap: Map = new Map(Object.entries(data));
let uid:number = 0;
let allowWiFi: string = "";
let allowCellular: string = "";
keyMap.forEach((value:object, key:string) => {
let valueMap: Map = new Map(Object.entries(value));
uid = Number.parseInt(key);
valueMap.forEach((value:string, key:string)=>{
if (key == "allowWiFi") {
allowWiFi = value;
}
if (key == "allowCellular") {
allowCellular = value;
}
})
})
console.log(JSON.stringify(data));
})
.catch((error: BusinessError) => {
console.error(JSON.stringify(error));
});
```
## policy.on
网络策略的句柄。
### on('netUidPolicyChange')10+
on(type: "netUidPolicyChange", callback: Callback\): void
注册 policy 发生改变时的回调,使用 callback 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------------- | ---- | -------------------------------------- |
| type | string | 是 | policy 发生改变的类型 |
| callback | Callback\<[NetUidPolicyInfo](#netuidpolicyinfo11)> | 是 | 回调函数。注册 policy 发生改变时调用。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { policy } from '@kit.NetworkKit';
interface Data {
uid: number,
policy: policy.NetUidPolicy
}
try {
policy.on('netUidPolicyChange', (data: Data) => {
console.log('on netUidPolicyChange data: ' + JSON.stringify(data));
});
} catch(err) {
console.error('on netUidPolicyChange error: ' + JSON.stringify(err));
}
```
### off('netUidPolicyChange')10+
off(type: "netUidPolicyChange", callback?: Callback\): void
注销 policy 发生改变时的回调,使用 callback 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------------- | ---- | -------------------------------------- |
| type | string | 是 | policy 发生改变的类型 |
| callback | Callback\<[NetUidPolicyInfo](#netuidpolicyinfo11)> | 否 | 回调函数。注销 policy 发生改变时调用。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { policy } from '@kit.NetworkKit';
interface Data {
uid: number,
policy: policy.NetUidPolicy
}
try {
policy.on('netUidPolicyChange', (data: Data) => {
console.log('on netUidPolicyChange data: ' + JSON.stringify(data));
});
} catch(err) {
console.error('on netUidPolicyChange error: ' + JSON.stringify(err));
}
try {
policy.off('netUidPolicyChange', (data: Data) => {
console.log('off netUidPolicyChange data: ' + JSON.stringify(data));
});
} catch(err) {
console.error('off netUidPolicyChange error: ' + JSON.stringify(err));
}
```
### on('netUidRuleChange')10+
on(type: "netUidRuleChange", callback: Callback\): void
注册 rule 发生改变时的回调,使用 callback 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------- | ---- | -------------------------------------- |
| type | string | 是 | rule 发生改变的类型 |
| callback | Callback\<[NetUidRuleInfo](#netuidruleinfo11)> | 是 | 回调函数。注册 rule 发生改变时的调用。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { policy } from '@kit.NetworkKit';
interface Data {
uid: number,
rule: policy.NetUidRule
}
try {
policy.on('netUidRuleChange', (data: Data) => {
console.log('on netUidRuleChange data: ' + JSON.stringify(data));
});
} catch(err) {
console.error('on netUidRuleChange error: ' + JSON.stringify(err));
}
```
### off('netUidRuleChange')10+
off(type: "netUidRuleChange", callback?: Callback\): void
注销 rule 发生改变时的回调,使用 callback 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------- | ---- | -------------------------------------- |
| type | string | 是 | rule 发生改变的类型 |
| callback | Callback\<[NetUidRuleInfo](#netuidruleinfo11)> | 否 | 回调函数。注销 rule 发生改变时的调用。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { policy } from '@kit.NetworkKit';
interface Data {
uid: number,
rule: policy.NetUidRule
}
try {
policy.on('netUidRuleChange', (data: Data) => {
console.log('on netUidRuleChange data: ' + JSON.stringify(data));
});
} catch(err) {
console.error('on netUidRuleChange error: ' + JSON.stringify(err));
}
try {
policy.off('netUidRuleChange', (data: Data) => {
console.log('off netUidRuleChange data: ' + JSON.stringify(data));
});
} catch(err) {
console.error('off netUidRuleChange error: ' + JSON.stringify(err));
}
```
### on('netMeteredIfacesChange')10+
on(type: "netMeteredIfacesChange", callback: Callback\>): void
注册计量 iface 发生改变时的回调,使用 callback 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ----------------------------------------- |
| type | string | 是 | 计量 iface 发生改变的类型 |
| callback | Callback\> | 是 | 回调函数。注册计量 iface 发生改变时调用。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { policy } from '@kit.NetworkKit';
try {
policy.on('netMeteredIfacesChange', (data: string[]) => {
console.log('on netMeteredIfacesChange data: ' + JSON.stringify(data));
});
} catch(err) {
console.error('on netMeteredIfacesChange error: ' + JSON.stringify(err));
}
```
### off('netMeteredIfacesChange')10+
off(type: "netMeteredIfacesChange", callback?: Callback\>): void
注销计量 iface 发生改变时的回调,使用 callback 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ----------------------------------------- |
| type | string | 是 | 计量 iface 发生改变的类型 |
| callback | Callback\> | 否 | 回调函数。注册计量 iface 发生改变时调用。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { policy } from '@kit.NetworkKit';
try {
policy.on('netMeteredIfacesChange', (data: string[]) => {
console.log('on netMeteredIfacesChange data: ' + JSON.stringify(data));
});
} catch(err) {
console.error('on netMeteredIfacesChange error: ' + JSON.stringify(err));
}
try {
policy.off('netMeteredIfacesChange', (data: string[]) => {
console.log('off netMeteredIfacesChange data: ' + JSON.stringify(data));
});
} catch(err) {
console.error('off netMeteredIfacesChange error: ' + JSON.stringify(err));
}
```
### on('netQuotaPolicyChange')10+
on(type: "netQuotaPolicyChange", callback: Callback\>): void
注册计量网络策略发生改变时的回调,使用 callback 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------ | ---- | ------------------------------------------ |
| type | string | 是 | 计量网络策略发生改变的类型 |
| callback | Callback\> | 是 | 回调函数。注册计量网络策略发生改变时调用。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { policy } from '@kit.NetworkKit';
interface Data {
uid: number,
policy: policy.NetUidPolicy
}
try {
policy.on('netQuotaPolicyChange', (data: policy.NetQuotaPolicy[]) => {
console.log('on netQuotaPolicyChange data: ' + JSON.stringify(data));
});
} catch(err) {
console.error('on netQuotaPolicyChange error: ' + JSON.stringify(err));
}
```
### off('netQuotaPolicyChange')10+
off(type: "netQuotaPolicyChange", callback?: Callback\>): void
注销计量网络策略发生改变时的回调,使用 callback 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------ | ---- | ------------------------------------------ |
| type | string | 是 | 计量网络策略发生改变的类型 |
| callback | Callback\> | 否 | 回调函数。注册计量网络策略发生改变时调用。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { policy } from '@kit.NetworkKit';
try {
policy.on('netQuotaPolicyChange', (data: Array) => {
console.log('on netQuotaPolicyChange data: ' + JSON.stringify(data));
});
} catch(err) {
console.error('on netQuotaPolicyChange error: ' + JSON.stringify(err));
}
try {
policy.off('netQuotaPolicyChange', (data: Array) => {
console.log('off netQuotaPolicyChange data: ' + JSON.stringify(data));
});
} catch(err) {
console.error('off netQuotaPolicyChange error: ' + JSON.stringify(err));
}
```
### on('netBackgroundPolicyChange')10+
on(type: "netBackgroundPolicyChange", callback: Callback\): void
注册后台网络策略发生改变时的回调,使用 callback 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------ | ---- | ------------------------------------------ |
| type | string | 是 | 后台网络策略发生改变的类型 |
| callback | Callback\ | 是 | 回调函数。注册后台网络策略发生改变时调用。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { policy } from '@kit.NetworkKit';
try {
policy.on('netBackgroundPolicyChange', (data: boolean) => {
console.log('on netBackgroundPolicyChange data: ' + JSON.stringify(data));
});
} catch(err) {
console.error('on netBackgroundPolicyChange error: ' + JSON.stringify(err));
}
```
### off('netBackgroundPolicyChange')10+
off(type: "netBackgroundPolicyChange", callback?: Callback\): void
注销后台网络策略发生改变时的回调,使用 callback 方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.MANAGE_NET_STRATEGY
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------ | ---- | ------------------------------------------ |
| type | string | 是 | 后台网络策略发生改变的类型 |
| callback | Callback\ | 否 | 回调函数。注册后台网络策略发生改变时调用。 |
**错误码:**
| 错误码 ID | 错误信息 |
| --------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 2100001 | Invalid parameter value. |
| 2100002 | Failed to connect to the service. |
| 2100003 | System internal error. |
**示例:**
```ts
import { policy } from '@kit.NetworkKit';
try {
policy.on('netBackgroundPolicyChange', (data: boolean) => {
console.log('on netBackgroundPolicyChange data: ' + JSON.stringify(data));
});
} catch(err) {
console.error('on netBackgroundPolicyChange error: ' + JSON.stringify(err));
}
try {
policy.off('netBackgroundPolicyChange', (data: boolean) => {
console.log('off netBackgroundPolicyChange data: ' + JSON.stringify(data));
});
} catch(err) {
console.error('off netBackgroundPolicyChange error: ' + JSON.stringify(err));
}
```
## NetBackgroundPolicy10+
后台网络策略。
**系统接口**:此接口为系统接口。
**系统能力**:SystemCapability.Communication.NetManager.Core
| 名称 | 值 | 说明 |
| ------------------------------- | --- | ------------------------------------------ |
| NET_BACKGROUND_POLICY_NONE | 0 | 默认值。 |
| NET_BACKGROUND_POLICY_ENABLE | 1 | 应用在后台可以使用计量网路。 |
| NET_BACKGROUND_POLICY_DISABLE | 2 | 应用在后台不可以使用计量网路。 |
| NET_BACKGROUND_POLICY_TRUSTLIST | 3 | 只有应用指定的列表在后台可以使用计量网络。 |
## NetQuotaPolicy10+
计量网络策略。
**系统接口**:此接口为系统接口。
**系统能力**:SystemCapability.Communication.NetManager.Core
| 名称 | 类型 | 必填 | 说明 |
| ---------------- | --------------------------------------- | ---- | -------------------------------- |
| networkMatchRule | [NetworkMatchRule](#networkmatchrule10) | 是 | 网络标识,用来确定设置哪一个网络 |
| quotaPolicy | [QuotaPolicy](#quotapolicy10) | 是 | 具体的计量网络策略 |
## NetworkMatchRule10+
网络标识,用来确定设置哪一个网络
**系统接口**:此接口为系统接口。
**系统能力**:SystemCapability.Communication.NetManager.Core
| 名称 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------------------- | ---- | ---------------------------------------------------------------------------- |
| netType | [NetBearType](js-apis-net-connection.md#netbeartype) | 是 | 网络类型。 |
| simId | string | 是 | 计量蜂窝网络的 SIM 卡的标识值。以太网,wifi 网络不会用到 |
| identity | string | 是 | 计量蜂窝网络中配合 simId 联合使用。以太网,wifi 网络单独使用。用于标记类型。 |
## QuotaPolicy10+
计量网络策略
**系统接口**:此接口为系统接口。
**系统能力**:SystemCapability.Communication.NetManager.Core
| 名称 | 类型 | 必填 | 说明 |
| ----------------- |-------------------------------| ---- |-----------------------------------------------------|
| periodDuration | string | 是 | 流量限制计量周期。D1,M1,Y1 分别代表 1 天,1 个月,1 年内流量限制,超出时间则不受限制。 |
| warningBytes | number | 是 | 发出警告的流量阈值。 |
| limitBytes | number | 是 | 流量设置的配额。 |
| metered | boolean | 是 | 是否为计量网络。 |
| limitAction | [LimitAction](#limitaction10) | 是 | 到达流量限制后的动作。 |
| lastWarningRemind | number | 否 | 最新一次发出警告的时间。默认值:-1 |
| lastLimitRemind | number | 否 | 最新一次配额耗尽的时间。默认值:-1 |
## LimitAction10+
限制动作。
**系统接口**:此接口为系统接口。
**系统能力**:SystemCapability.Communication.NetManager.Core
| 名称 | 值 | 说明 |
| ---------------------------- | --- | ---------------------------------- |
| LIMIT_ACTION_NONE | -1 | 默认值。 |
| LIMIT_ACTION_ACCESS_DISABLED | 0 | 当配额策略达到限制时,访问被禁用。 |
| LIMIT_ACTION_ALERT_ONLY | 1 | 当配额策略达到限制时,将警告用户。 |
## NetUidRule10+
计量网络规则。
**系统接口**:此接口为系统接口。
**系统能力**:SystemCapability.Communication.NetManager.Core
| 名称 | 值 | 说明 |
| --------------------------------- | ------ | -------------------- |
| NET_RULE_NONE | 0 | 默认规则 |
| NET_RULE_ALLOW_METERED_FOREGROUND | 1 << 0 | 允许前台访问计量网络 |
| NET_RULE_ALLOW_METERED | 1 << 1 | 允许访问计量网络 |
| NET_RULE_REJECT_METERED | 1 << 2 | 拒绝访问计量网络 |
| NET_RULE_ALLOW_ALL | 1 << 5 | 允许访问所有网络 |
| NET_RULE_REJECT_ALL | 1 << 6 | 拒绝访问所有网络 |
## NetUidRuleInfo11+
生成网络唯一标识
**系统接口**:此接口为系统接口。
**系统能力**:SystemCapability.Communication.NetManager.Core
| 名称 | 类型 | 必填 | 说明 |
| ----------------- | ----------------------------- | ---- | ----------------------------------------- |
| uid | number | 是 | 流量警告的阈值,默认:DATA_USAGE_UNKNOWN。 |
| rule | [NetUidRule](#netuidrule10) | 是 | 规定一个UID访问计量网络还是非计量网络。 |
## NetUidPolicyInfo11+
注册网络UID策略变化的回调函数
**系统接口**:此接口为系统接口。
**系统能力**:SystemCapability.Communication.NetManager.Core
| 名称 | 类型 | 必填 | 说明 |
| ----------------- | ------------------------------- | ---- | -------------------------------------- |
| uid | number | 是 | 流量警告的阈值,默认:DATA_USAGE_UNKNOWN |
| policy | [NetUidPolicy](#netuidpolicy10) | 是 | UID指定了在后台模式下网络访问的策略。 |
## RemindType10+
提醒类型。
**系统接口**:此接口为系统接口。
**系统能力**:SystemCapability.Communication.NetManager.Core
| 名称 | 值 | 说明 |
| ------------------- | --- | -------- |
| REMIND_TYPE_WARNING | 1 | 警告提醒 |
| REMIND_TYPE_LIMIT | 2 | 限制提醒 |
## NetUidPolicy10+
应用对应的网络策略。
**系统接口**:此接口为系统接口。
**系统能力**:SystemCapability.Communication.NetManager.Core
| 名称 | 值 | 说明 |
| ------------------------------------ | ------ | -------------------------- |
| NET_POLICY_NONE | 0 | 默认网络策略 |
| NET_POLICY_ALLOW_METERED_BACKGROUND | 1 << 0 | 允许应用在后台访问计量网络 |
| NET_POLICY_REJECT_METERED_BACKGROUND | 1 << 1 | 拒绝应用在后台访问计量网络 |
## NetworkAccessPolicy12+
应用对应的连接网络的策略。
**系统接口**:此接口为系统接口。
**系统能力**:SystemCapability.Communication.NetManager.Core
| 名称 | 类型 | 必填 | 说明 |
| ----------------- | --------- | ---- | ----------------------------- |
| allowWiFi | boolean | 是 | 能否允许访问wifi网络 |
| allowCellular | boolean | 是 | 能否允许访问蜂窝网络 |
## UidNetworkAccessPolicy12+
应用标识以及对应应用连接网络的策略。
**系统接口**:此接口为系统接口。
**系统能力**:SystemCapability.Communication.NetManager.Core
| 名称 | 类型 | 必填 | 说明 |
| --------- | ----------------------------------------------------------- | ---- | ------------------- |
| undefined | [uid: string]: [NetworkAccessPolicy](#networkaccesspolicy12) | 否 | 数据类型为键值对 |