From 4c9f382313ca054d33578b619a9ce0941e44e56c Mon Sep 17 00:00:00 2001 From: xujie Date: Thu, 18 May 2023 19:24:37 +0800 Subject: [PATCH] =?UTF-8?q?=E5=88=A0=E9=99=A4policy=E7=9B=B8=E5=85=B3?= =?UTF-8?q?=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: xujie --- .../reference/apis/Readme-CN.md | 1 - .../reference/apis/js-apis-net-policy.md | 1555 ----------------- .../reference/errorcodes/Readme-CN.md | 1 - .../errorcodes/errorcode-net-policy.md | 63 - 4 files changed, 1620 deletions(-) delete mode 100644 zh-cn/application-dev/reference/apis/js-apis-net-policy.md delete mode 100644 zh-cn/application-dev/reference/errorcodes/errorcode-net-policy.md diff --git a/zh-cn/application-dev/reference/apis/Readme-CN.md b/zh-cn/application-dev/reference/apis/Readme-CN.md index e503185274..a0b352c493 100755 --- a/zh-cn/application-dev/reference/apis/Readme-CN.md +++ b/zh-cn/application-dev/reference/apis/Readme-CN.md @@ -265,7 +265,6 @@ - [@ohos.net.connection (网络连接管理)](js-apis-net-connection.md) - [@ohos.net.ethernet (以太网连接管理)](js-apis-net-ethernet.md) - [@ohos.net.http (数据请求)](js-apis-http.md) - - [@ohos.net.policy (网络策略管理)](js-apis-net-policy.md) - [@ohos.net.sharing (网络共享管理)](js-apis-net-sharing.md) - [@ohos.net.socket (Socket连接)](js-apis-socket.md) - [@ohos.net.webSocket (WebSocket连接)](js-apis-webSocket.md) diff --git a/zh-cn/application-dev/reference/apis/js-apis-net-policy.md b/zh-cn/application-dev/reference/apis/js-apis-net-policy.md deleted file mode 100644 index 7f2f0faad4..0000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-net-policy.md +++ /dev/null @@ -1,1555 +0,0 @@ -# @ohos.net.policy (网络策略管理) - -网络策略管理通过对用户使用数据流量进行控制管理，采用防火墙技术实现网络策略的管理。 - -> **说明：** -> -> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - -## 导入模块 - -```js -import policy from '@ohos.net.policy' -``` - -## policy.setBackgroundAllowed - -setBackgroundAllowed(isAllowed: boolean, callback: AsyncCallback\): void - -设置后台网络策略，使用callback方式作为异步方法。 - -**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL - -**系统能力**：SystemCapability.Communication.NetManager.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------- | ---- | ---------- | -| isAllowed | boolean | 是 | 是否允许应用后台使用数据 | -| callback | AsyncCallback\ | 是 | 回调函数，成功返回设置后台网络策略的结果，失败返回错误码错误信息。 | - -**错误码：** - -| 错误码ID | 错误信息 | -| ------- | -------------------------------------------- | -| 201 | Permission denied. | -| 401 | Parameter error. | -| 2100001 | Invalid parameter value. | -| 2100002 | Operation failed. Cannot connect to service.| -| 2100003 | System internal error. | - -**示例：** - -```js -policy.setBackgroundAllowed(Boolean(Number.parseInt(this.isBoolean)), (error) => { - console.log(JSON.stringify(error)) -}) -; -``` - -## policy.setBackgroundAllowed - -setBackgroundAllowed(isAllowed: boolean): Promise\ - -设置后台网络策略，使用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\ | 以Promise形式返回设定结果，失败返回错误码错误信息。 | - -**示例：** - -```js -policy.setBackgroundAllowed(Boolean(Number.parseInt(this.isBoolean))).then(function (error) { - console.log(JSON.stringify(error)) -}) -``` - -## policy.isBackgroundAllowed - -isBackgroundAllowed(callback: AsyncCallback\): void - -获取后台网络策略，使用callback方式作为异步方法。 - -**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL - -**系统能力**：SystemCapability.Communication.NetManager.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------- | ---- | ---------- | -| callback | AsyncCallback\ | 是 | 回调函数，返回true代表后台策略为允许。失败返回错误码错误信息。 | - -**错误码：** - -| 错误码ID | 错误信息 | -| ------- | -------------------------------------------- | -| 201 | Permission denied. | -| 2100002 | Operation failed. Cannot connect to service.| -| 2100003 | System internal error. | - -**示例：** - -```js -policy.isBackgroundAllowed((error, data) => { - this.callBack(error, data); - console.log(JSON.stringify(error)) - console.log(JSON.stringify(data)) -}); -``` - -## policy.isBackgroundAllowed - -isBackgroundAllowed(): Promise\; - -获取后台网络策略，使用Promise方式作为异步方法。 - -**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL - -**系统能力**：SystemCapability.Communication.NetManager.Core - -**返回值：** - -| 类型 | 说明 | -| --------------------------------- | ------------------------------------- | -| Promise\ | 以Promise形式返回设定结果。 返回true代表后台策略为允许。失败返回错误码错误信息。| - -**错误码：** - -| 错误码ID | 错误信息 | -| ------- | -------------------------------------------- | -| 201 | Permission denied. | -| 2100002 | Operation failed. Cannot connect to service.| -| 2100003 | System internal error. | - -**示例：** - -```js -policy.isBackgroundAllowed().then(function (error, data) { - console.log(JSON.stringify(error)) - console.log(JSON.stringify(data)) -}) -``` - -## policy.setPolicyByUid - -setPolicyByUid(uid: number, policy: NetUidPolicy, callback: AsyncCallback\): void - -设置对应uid应用的访问计量网络的策略，使用callback方式作为异步方法。 - -**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL - -**系统能力**：SystemCapability.Communication.NetManager.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------- | ---- | ---------- | -| uid | number | 是 | 应用的唯一标识符 | -| policy | [NetUidPolicy](#netuidpolicy) | 是 | 应用对应的策略 | -| callback | AsyncCallback\ | 是 | 回调函数，成功返回设定结果。失败返回错误码错误信息。 | - -**错误码：** - -| 错误码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 = { - uid: Number.parseInt(this.firstParam), policy: Number.parseInt(this.currentNetUidPolicy) -} -policy.setPolicyByUid(Number.parseInt(this.firstParam), Number.parseInt(this.currentNetUidPolicy), (error) => { - this.callBack(error); -}); -``` - -## policy.setPolicyByUid - -setPolicyByUid(uid: number, policy: NetUidPolicy): Promise\; - -设置对应uid应用的访问计量网络的策略，使用Promise方式作为异步方法。 - -**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL - -**系统能力**：SystemCapability.Communication.NetManager.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------- | ---- | ---------- | -| uid | number | 是 | 应用的唯一标识符 | -| policy | [NetUidPolicy](#netuidpolicy) | 是 | 应用对应的策略 | - -**返回值：** - -| 类型 | 说明 | -| --------------------------------- | ------------------------------------- | -| Promise\ | 以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 = { - uid: Number.parseInt(this.firstParam), policy: Number.parseInt(this.currentNetUidPolicy) -} -policy.setPolicyByUid(Number.parseInt(this.firstParam), Number.parseInt(this.currentNetUidPolicy)).then(function (error) { - console.log(JSON.stringify(error)) -}) -``` - -## policy.getPolicyByUid - -getPolicyByUid(uid: number, callback: AsyncCallback\): void - -通过应用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) => { - this.callBack(error, data); -}); -``` - -## policy.getPolicyByUid - -getPolicyByUid(uid: number): Promise\; - -通过应用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 -policy.getPolicyByUid(Number.parseInt(this.firstParam)).then(function (error, data) { - console.log(JSON.stringify(error)) - console.log(JSON.stringify(data)) -}) -``` - -## policy.getUidsByPolicy - -getUidsByPolicy(policy: NetUidPolicy, callback: AsyncCallback\>): void - -通过策略获取设置这一策略的应用uid数组，使用callback方式作为异步方法。 - -**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL - -**系统能力**：SystemCapability.Communication.NetManager.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------- | ---- | ---------- | -| policy | [NetUidPolicy](#netuidpolicy) | 是 | 应用对应的计量网络下的策略 | -| callback | AsyncCallback\> | 是 | 回调函数，成功返回应用的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) => { - this.callBack(error, data); -}); -``` - -## policy.getUidsByPolicy - -function getUidsByPolicy(policy: NetUidPolicy): Promise\>; - -通过策略获取设置这一策略的应用uid数组，使用Promise方式作为异步方法。 - -**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL - -**系统能力**：SystemCapability.Communication.NetManager.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------- | ---- | ---------- | -| policy | [NetUidPolicy](#netuidpolicy) | 是 | app对应的计量网络下的策略 | - -**返回值：** - -| 类型 | 说明 | -| --------------------------------- | ------------------------------------- | -| Promise\> | 以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 -policy.getUidsByPolicy(Number.parseInt(this.firstParam)).then(function (error, data) { - console.log(JSON.stringify(error)) - console.log(JSON.stringify(data)) -}) -``` - -## policy.getNetQuotaPolicies - -getNetQuotaPolicies(callback: AsyncCallback\>): void - -获取计量网络策略，使用callback方式作为异步方法。 - -**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL - -**系统能力**：SystemCapability.Communication.NetManager.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------- | ---- | ---------- | -| callback | AsyncCallback\> | 是 | 回调函数，返回获取结果。 | - -**错误码：** - -| 错误码ID | 错误信息 | -| ------- | -------------------------------------------- | -| 201 | Permission denied. | -| 2100002 | Operation failed. Cannot connect to service.| -| 2100003 | System internal error. | - -**示例：** - -```js -policy.getNetQuotaPolicies((error, data) => { - this.callBack(error, data); -}); -``` - -## policy.getNetQuotaPolicies - -getNetQuotaPolicies(): Promise\>; - -获取计量网络策略，使用Promise方式作为异步方法。 - -**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL - -**系统能力**：SystemCapability.Communication.NetManager.Core - -**返回值：** - -| 类型 | 说明 | -| --------------------------------- | ------------------------------------- | -| Promise\> | 以Promise形式返回设定结果。 | - -**错误码：** - -| 错误码ID | 错误信息 | -| ------- | -------------------------------------------- | -| 201 | Permission denied. | -| 2100002 | Operation failed. Cannot connect to service.| -| 2100003 | System internal error. | - -**示例：** - -```js -policy.getNetQuotaPolicies().then(function (error, data) { - console.log(JSON.stringify(error)) - console.log(JSON.stringify(data)) -}) - -``` - -## policy.setNetQuotaPolicies - -setNetQuotaPolicies(quotaPolicies: Array\, callback: AsyncCallback\): void - -设置计量网络策略，使用callback方式作为异步方法。 - -**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL - -**系统能力**：SystemCapability.Communication.NetManager.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------- | ---- | ---------- | -| quotaPolicies | Array\<[NetQuotaPolicy](#netquotapolicy)> | 是 | 计量网络策略 | -| callback | AsyncCallback\ | 是 | 回调函数，返回设定结果。 | - -**错误码：** - -| 错误码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 = { - 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 -}; -this.netQuotaPolicyList.push(param); - -policy.setNetQuotaPolicies(this.netQuotaPolicyList, (error) => { - console.log(JSON.stringify(error)) -}); -``` - -## policy.setNetQuotaPolicies - -setNetQuotaPolicies(quotaPolicies: Array\): Promise\; - -设置计量网络策略，使用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\ | 以Promise形式返回设定结果。 | - -**示例：** - -```js -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 -}; -this.netQuotaPolicyList.push(param); - -policy.setNetQuotaPolicies(this.netQuotaPolicyList).then(function (error) { - console.log(JSON.stringify(error)) -}) -``` - -## policy.restoreAllPolicies - -restoreAllPolicies(iccid: string, callback: AsyncCallback\): void - -重置对应sim卡id的蜂窝网络、后台网络策略、防火墙策略、应用对应的策略，使用callback方式作为异步方法。 - -**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL - -**系统能力**：SystemCapability.Communication.NetManager.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------- | ---- | ---------- | -| iccid | string | 是 | SIM卡ID| -| callback | AsyncCallback\ | 是 | 回调函数，返回重置结果。 | - -**错误码：** - -| 错误码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) => { - console.log(JSON.stringify(error)) -}); -``` - -## policy.restoreAllPolicies - -restoreAllPolicies(iccid: string): Promise\; - -重置对应sim卡id的蜂窝网络、后台网络策略、防火墙策略、应用对应的策略，使用Promise方式作为异步方法。 - -**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL - -**系统能力**：SystemCapability.Communication.NetManager.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------- | ---- | ---------- | -| iccid | string | 是 | SIM卡ID| - -**返回值：** - -| 类型 | 说明 | -| --------------------------------- | ------------------------------------- | -| Promise\ | 以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; -policy.restoreAllPolicies(this.firstParam).then(function (error) { - console.log(JSON.stringify(error)) -}) -``` - -## policy.isUidNetAllowed - -isUidNetAllowed(uid: number, isMetered: boolean, callback: AsyncCallback\): void - -获取对应uid能否访问计量或非计量网络，使用callback方式作为异步方法。 - -**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL - -**系统能力**：SystemCapability.Communication.NetManager.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------- | ---- | ---------- | -| uid | number | 是 | app唯一标识符 | -| isMetered | boolean | 是 | 是否为计量网络 | -| callback | AsyncCallback\ | 是 | 回调函数，返回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 = { - uid: Number.parseInt(this.firstParam), isMetered: Boolean(Number.parseInt(this.isBoolean)) -} -policy.isUidNetAllowed(Number.parseInt(this.firstParam), Boolean(Number.parseInt(this.isBoolean)), (error, data) => { - this.callBack(error, data); -}); -``` - -## policy.isUidNetAllowed - -isUidNetAllowed(uid: number, isMetered: boolean): Promise\; - -获取对应uid能否访问计量或非计量网络，使用Promise方式作为异步方法。 - -**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL - -**系统能力**：SystemCapability.Communication.NetManager.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------- | ---- | ---------- | -| uid | number | 是 | app唯一标识符 | -| isMetered | boolean | 是 | 是否为计量网络 | - -**返回值：** - -| 类型 | 说明 | -| --------------------------------- | ------------------------------------- | -| Promise\ | 以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 = { - uid: Number.parseInt(this.firstParam), isMetered: Boolean(Number.parseInt(this.isBoolean)) -} -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)) -}) -``` - -## policy.isUidNetAllowed - -isUidNetAllowed(uid: number, iface: string, callback: AsyncCallback\): void - -获取对应uid能否访问指定的iface的网络，使用callback方式作为异步方法。 - -**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL - -**系统能力**：SystemCapability.Communication.NetManager.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------- | ---- | ---------- | -| uid | number | 是 | app唯一标识符 | -| iface | string | 是 | 网络对应的名称 | -| callback | AsyncCallback\ | 是 | 回调函数，返回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 = { - uid: Number.parseInt(this.firstParam), iface: this.secondParam -} -policy.isUidNetAllowed(Number.parseInt(this.firstParam), this.secondParam, (error, data) => { - this.callBack(error, data); -}); -``` - -## policy.isUidNetAllowed - -isUidNetAllowed(uid: number, iface: string): Promise\; - -获取对应uid能否访问指定的iface的网络，使用Promise方式作为异步方法。 - -**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL - -**系统能力**：SystemCapability.Communication.NetManager.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------- | ---- | ---------- | -| uid | number | 是 | app唯一标识符 | -| iface | string | 是 | 网络对应的名称 | - -**返回值：** - -| 类型 | 说明 | -| --------------------------------- | ------------------------------------- | -| Promise\ | 以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 = { - uid: Number.parseInt(this.firstParam), iface: this.secondParam -} -policy.isUidNetAllowed(Number.parseInt(this.firstParam), this.secondParam).then(function (error, data) { - console.log(JSON.stringify(error)) - console.log(JSON.stringify(data)) -}) -``` - -## policy.setDeviceIdleAllowList - -setDeviceIdleAllowList(uid: number, isAllowed: boolean, callback: AsyncCallback\): void - -设置指定uid应用是否在休眠防火墙的白名单，使用callback方式作为异步方法。 - -**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL - -**系统能力**：SystemCapability.Communication.NetManager.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------- | ---- | ---------- | -| uid | number | 是 | app唯一标识符 | -| isAllowed | boolean | 是 | 是否加入白名单 | -| callback | callback: AsyncCallback\ | 是 | 回调函数，返回设定结果。 | - -**错误码：** - -| 错误码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 = { - uid: Number.parseInt(this.firstParam), isAllowed: Boolean(Number.parseInt(this.isBoolean)) -} -policy.setDeviceIdleAllowList(Number.parseInt(this.firstParam), Boolean(Number.parseInt(this.isBoolean)), (error) => { - console.log(JSON.stringify(error)) -}); -``` - -## policy.setDeviceIdleAllowList - -setDeviceIdleAllowList(uid: number, isAllowed: boolean): Promise\; - -设置指定uid应用是否在休眠防火墙的白名单，使用Promise方式作为异步方法。 - -**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL - -**系统能力**：SystemCapability.Communication.NetManager.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------- | ---- | ---------- | -| uid | number | 是 | app唯一标识符 | -| isAllowed | boolean | 是 | 是否加入白名单 | - -**返回值：** - -| 类型 | 说明 | -| --------------------------------- | ------------------------------------- | -| Promise\ | 以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 = { - uid: Number.parseInt(this.firstParam), isAllowed: Boolean(Number.parseInt(this.isBoolean)) -} -policy.setDeviceIdleAllowList(Number.parseInt(this.firstParam), Boolean(Number.parseInt(this.isBoolean))).then(function (error) { - console.log(JSON.stringify(error)) -}) -``` - -## policy.getDeviceIdleAllowList - -getDeviceIdleAllowList(callback: AsyncCallback\>): void - -获取休眠模式白名单所包含的uid数组，使用callback方式作为异步方法。 - -**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL - -**系统能力**：SystemCapability.Communication.NetManager.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------- | ---- | ---------- | -| callback | AsyncCallback\> | 是 | 回调函数，返回获取结果。 | - -**错误码：** - -| 错误码ID | 错误信息 | -| ------- | -------------------------------------------- | -| 201 | Permission denied. | -| 2100002 | Operation failed. Cannot connect to service.| -| 2100003 | System internal error. | - -**示例：** - -```js -policy.getDeviceIdleAllowList((error, data) => { - this.callBack(error, data); -}); -``` - -## policy.getDeviceIdleAllowList - -getDeviceIdleAllowList(): Promise\>; - -获取休眠模式白名单所包含的uid数组，使用Promise方式作为异步方法。 - -**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL - -**系统能力**：SystemCapability.Communication.NetManager.Core - -**返回值：** - -| 类型 | 说明 | -| --------------------------------- | ------------------------------------- | -| Promise\> | 以Promise形式返回设定结果。 | - -**错误码：** - -| 错误码ID | 错误信息 | -| ------- | -------------------------------------------- | -| 201 | Permission denied. | -| 2100002 | Operation failed. Cannot connect to service.| -| 2100003 | System internal error. | - -**示例：** - -```js -policy.getDeviceIdleAllowList().then(function (error, data) { - console.log(JSON.stringify(error)) - console.log(JSON.stringify(data)) -}) -``` - -## policy.getBackgroundPolicyByUid - -getBackgroundPolicyByUid(uid: number, callback: AsyncCallback\): void - -获取指定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) => { - this.callBack(error, data); -}); -``` - -## policy.getBackgroundPolicyByUid - -getBackgroundPolicyByUid(uid: number): Promise\; - -获取指定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 -policy.getBackgroundPolicyByUid(Number.parseInt(this.firstParam)).then(function (error, data) { - console.log(JSON.stringify(error)) - console.log(JSON.stringify(data)) -}) -``` - -## policy.resetPolicies - -resetPolicies(iccid: string, callback: AsyncCallback\): void - -重置对应sim卡id的蜂窝网络、后台网络策略、防火墙策略、应用对应的策略，使用callback方式作为异步方法。 - -**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL - -**系统能力**：SystemCapability.Communication.NetManager.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------- | ---- | ---------- | -| iccid | string | 是 | SIM卡ID| -| callback | AsyncCallback\ | 是 | 回调函数，返回重置结果。 | - -**错误码：** - -| 错误码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) => { - console.log(JSON.stringify(error)) -}); -``` - -## policy.resetPolicies - -resetPolicies(iccid: string): Promise\; - -重置对应sim卡id的蜂窝网络、后台网络策略、防火墙策略、应用对应的策略，使用Promise方式作为异步方法。 - -**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL - -**系统能力**：SystemCapability.Communication.NetManager.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------- | ---- | ---------- | -| iccid | string | 是 | SIM卡ID| - -**返回值：** - -| 类型 | 说明 | -| --------------------------------- | ------------------------------------- | -| Promise\ | 以Promise形式返回设定结果。 | - -**错误码：** - -| 错误码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.firstParam)).then(function (error, data) { - -}) -this.firstParam = iccid -policy.resetPolicies(this.firstParam).then(function (error) { - console.log(JSON.stringify(error)) -}) -``` - -## policy.updateRemindPolicy - -updateRemindPolicy(netType: NetBearType, iccid: string, remindType: RemindType, callback: AsyncCallback\): void - -更新提醒策略，使用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\ | 是 | 回调函数，返回更新结果。 | - -**错误码：** - -| 错误码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 = { - netType: Number.parseInt(this.netType), iccid: this.firstParam, remindType: this.currentRemindType -} -policy.updateRemindPolicy(Number.parseInt(this.netType), this.firstParam, Number.parseInt(this.currentRemindType), (error) => { - console.log(JSON.stringify(error)) -}); -``` - -## policy.updateRemindPolicy - -updateRemindPolicy(netType: NetBearType, iccid: string, remindType: RemindType): Promise\; - -更新提醒策略，使用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\ | 以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 = { - netType: Number.parseInt(this.netType), iccid: this.firstParam, remindType: this.currentRemindType -} -policy.updateRemindPolicy(Number.parseInt(this.netType), this.firstParam, Number.parseInt(this.currentRemindType)).then(function (error) { - console.log(JSON.stringify(error)) -}) -``` - -## policy.setPowerSaveAllowList - -setPowerSaveAllowList(uid: number, isAllowed: boolean, callback: AsyncCallback\): void - -设置指定uid应用是否在省电防火墙的白名单，使用callback方式作为异步方法。 - -**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL - -**系统能力**：SystemCapability.Communication.NetManager.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------- | ---- | ---------- | -| uid | number | 是 | app唯一标识符 | -| isAllowed | boolean | 是 | 是否加入白名单 | -| callback | callback: AsyncCallback\ | 是 | 回调函数，返回设定结果。 | - -**错误码：** - -| 错误码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 = { - uid: Number.parseInt(this.firstParam), isAllowed: Boolean(Number.parseInt(this.isBoolean)) -} -policy.setPowerSaveAllowList(Number.parseInt(this.firstParam), Boolean(Number.parseInt(this.isBoolean)), (error) => { - console.log(JSON.stringify(error)) -}); -``` - -## policy.setPowerSaveAllowList - -setPowerSaveAllowList(uid: number, isAllowed: boolean): Promise\; - -设置指定uid应用是否在省电防火墙的白名单，使用Promise方式作为异步方法。 - -**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL - -**系统能力**：SystemCapability.Communication.NetManager.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------- | ---- | ---------- | -| uid | number | 是 | app唯一标识符 | -| isAllowed | boolean | 是 | 是否加入白名单 | - -**返回值：** - -| 类型 | 说明 | -| --------------------------------- | ------------------------------------- | -| Promise\ | 以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 = { - uid: Number.parseInt(this.firstParam), isAllowed: Boolean(Number.parseInt(this.isBoolean)) -} -policy.setPowerSaveAllowList(Number.parseInt(this.firstParam), Boolean(Number.parseInt(this.isBoolean))).then(function (error) { - console.log(JSON.stringify(error)) -}) -``` - -## policy.getPowerSaveAllowList - -getPowerSaveAllowList(callback: AsyncCallback\>): void - -获取省电模式白名单所包含的uid数组，使用callback方式作为异步方法。 - -**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL - -**系统能力**：SystemCapability.Communication.NetManager.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------- | ---- | ---------- | -| callback | AsyncCallback\> | 是 | 回调函数，返回获取结果。 | - -**错误码：** - -| 错误码ID | 错误信息 | -| ------- | -------------------------------------------- | -| 201 | Permission denied. | -| 2100002 | Operation failed. Cannot connect to service.| -| 2100003 | System internal error. | - -**示例：** - -```js -policy.getPowerSaveAllowList((error, data) => { - this.callBack(error, data); -}); -``` - -## policy.getPowerSaveAllowList - -getPowerSaveAllowList(): Promise\>; - -获取休眠模式白名单所包含的uid数组，使用Promise方式作为异步方法。 - -**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL - -**系统能力**：SystemCapability.Communication.NetManager.Core - -**返回值：** - -| 类型 | 说明 | -| --------------------------------- | ------------------------------------- | -| Promise\> | 以Promise形式返回设定结果。 | - -**错误码：** - -| 错误码ID | 错误信息 | -| ------- | -------------------------------------------- | -| 201 | Permission denied. | -| 2100002 | Operation failed. Cannot connect to service.| -| 2100003 | System internal error. | - -**示例：** - -```js -policy.getPowerSaveAllowList().then(function (error, data) { - console.log(JSON.stringify(error)) - console.log(JSON.stringify(data)) -}) -``` - -## policy.on - -网络策略的句柄。 - -### on('netUidPolicyChange') - -on(type: "netUidPolicyChange", callback: Callback\<{ uid: number, policy: NetUidPolicy }>): void - -注册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) => { - this.log('on netUidPolicyChange: ' + JSON.stringify(data)); -}) -``` - -### on('netUidRuleChange') - -on(type: "netUidRuleChange", callback: Callback\<{ uid: number, rule: NetUidRule }>): void - -注册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) => { - this.log('on netUidRuleChange: ' + JSON.stringify(data)); -}) -``` - -### on('netMeteredIfacesChange') - -on(type: "netMeteredIfacesChange", callback: Callback\>): void - -注册计量iface发生改变时的回调，使用callback方式作为异步方法。 - -**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL - -**系统能力**：SystemCapability.Communication.NetManager.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------- | ---- | ------------------------------------------------------------ | -| type | netMeteredIfacesChange | 是 | 计量iface发生改变的类型 | -| callback | Callback\> | 是 | 回调函数。注册计量iface发生改变时调用。 | - -**示例：** - -```js -policy.on('netMeteredIfacesChange', (data) => { - this.log('on netMeteredIfacesChange: ' + JSON.stringify(data)); -}) -``` - -### on('netQuotaPolicyChange') - -on(type: "netQuotaPolicyChange", callback: Callback\>): void - -注册计量网络策略发生改变时的回调，使用callback方式作为异步方法。 - -**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL - -**系统能力**：SystemCapability.Communication.NetManager.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------- | ---- | ------------------------------------------------------------ | -| type | netQuotaPolicyChange | 是 | 计量网络策略发生改变的类型 | -| callback | Callback\> | 是 | 回调函数。注册计量网络策略发生改变时调用。 | - -**示例：** - -```js -policy.on('netQuotaPolicyChange', (data) => { - this.log('on netQuotaPolicyChange: ' + JSON.stringify(data)); -}) -``` - -### on('netBackgroundPolicyChange') - -on(type: "netBackgroundPolicyChange", callback: Callback\): void - -注册后台网络策略发生改变时的回调，使用callback方式作为异步方法。 - -**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL - -**系统能力**：SystemCapability.Communication.NetManager.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------- | ---- | ------------------------------------------------------------ | -| type | netBackgroundPolicyChange | 是 | 后台网络策略发生改变的类型 | -| callback | Callback\ | 是 | 回调函数。注册后台网络策略发生改变时调用。 | - -**示例：** - -```js -policy.on('netBackgroundPolicyChange', (data) => { - this.log('on netBackgroundPolicyChange: ' + JSON.stringify(data)); -}) -``` - -## NetBackgroundPolicy - -后台网络策略。 - -**系统能力**：SystemCapability.Communication.NetManager.Core - -| 参数名 | 值 | 说明 | -| ------------------------ | ---- | ---------------------- | -| NET_BACKGROUND_POLICY_NONE | 0 | 默认值。 | -| NET_BACKGROUND_POLICY_ENABLE | 1 | 应用在后台可以使用计量网路。 | -| NET_BACKGROUND_POLICY_DISABLE | 2 | 应用在后台不可以使用计量网路。 | -| NET_BACKGROUND_POLICY_ALLOW_LIST | 3 | 只有应用指定的列表在后台可以使用计量网络。 | - -## NetQuotaPolicy - -计量网络策略。 - -**系统能力**：SystemCapability.Communication.NetManager.Core - -| 参数名 | 类型 | 说明 | -| ----------------------- | ----------------------------------- | ------------------------------------------------------------ | -| 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 - -限制动作。 - -**系统能力**：SystemCapability.Communication.NetManager.Core - -| 参数名 | 值 | 说明 | -| ---------------------- | ----- | ------------ | -| LIMIT_ACTION_NONE | -1 | 默认值。 | -| LIMIT_ACTION_DISABLE | 0 | 当配额策略达到限制时，访问被禁用。 | -| LIMIT_ACTION_AUTO_BILL| 1 | 当配额策略达到限制时，用户将自动计费。 | - -## NetUidRule - -计量网络规则。 - -**系统能力**：SystemCapability.Communication.NetManager.Core - -| 参数名 | 值 | 说明 | -| ---------------------- | ----- | ------------ | -| 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 - -提醒类型。 - -**系统能力**：SystemCapability.Communication.NetManager.Core - -| 参数名 | 值 | 说明 | -| ---------------------- | - | ------- | -| REMIND_TYPE_WARNING | 1 | 警告提醒 | -| REMIND_TYPE_LIMIT | 2 | 限制提醒 | - -## NetUidPolicy - -应用对应的网络策略。 - -**系统能力**：SystemCapability.Communication.NetManager.Core - -| 参数名 | 值 | 说明 | -| ---------------------- | ----- | ------------ | -| NET_POLICY_NONE | 0 | 默认网络策略 | -| NET_POLICY_ALLOW_METERED_BACKGROUND | 1 | 允许应用在后台访问计量网络 | -| NET_POLICY_REJECT_METERED_BACKGROUND | 2 | 拒绝应用在后台访问计量网络 | diff --git a/zh-cn/application-dev/reference/errorcodes/Readme-CN.md b/zh-cn/application-dev/reference/errorcodes/Readme-CN.md index 6d2b475900..97e1500abe 100644 --- a/zh-cn/application-dev/reference/errorcodes/Readme-CN.md +++ b/zh-cn/application-dev/reference/errorcodes/Readme-CN.md @@ -55,7 +55,6 @@ - [网络连接管理错误码](errorcode-net-connection.md) - [以太网连接错误码](errorcode-net-ethernet.md) - [网络共享错误码](errorcode-net-sharing.md) - - [策略管理错误码](errorcode-net-policy.md) - 通信与连接 - [Bluetooth错误码](errorcode-bluetoothManager.md) - [WIFI错误码](errorcode-wifi.md) diff --git a/zh-cn/application-dev/reference/errorcodes/errorcode-net-policy.md b/zh-cn/application-dev/reference/errorcodes/errorcode-net-policy.md deleted file mode 100644 index f296f790ca..0000000000 --- a/zh-cn/application-dev/reference/errorcodes/errorcode-net-policy.md +++ /dev/null @@ -1,63 +0,0 @@ -# 策略管理错误码 - -> **说明：** -> -> 以下仅介绍本模块特有错误码，通用错误码请参考[通用错误码说明文档](errorcode-universal.md)。 - -## 2100001 非法参数值 - -**错误信息** - -Invalid parameter value. - -**错误描述** - -非法参数值 - -**可能原因** - -输入参数取值范围错误。 - -**处理步骤** - -检查输入参数的取值范围是否正确。 - -## 2100002 连接服务失败 - -**错误信息** - -Operation failed. Cannot connect to service. - -**错误描述** - -操作失败，连接系统服务发生异常。 - -**可能原因** - -服务发生异常。 - -**处理步骤** - -检查系统服务运行状态是否正常。 - -## 2100003 系统内部错误 - -**错误信息** - -System internal error. - -**错误描述** - -系统内部错误。 - -**可能原因** - -1.内存异常。 - -2.空指针。 - -**处理步骤** - -1.检查内存空间是否充足，清理内存后重试。 - -2.系统异常，请稍后重试或重启设备。 -- GitLab