@ohos.net.policy (Network Policy Management)

The policy module provides APIs for managing network policies, through which you can control and manage the data volume used.

NOTE

The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import policy from '@ohos.net.policy'

policy.setBackgroundPolicy

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

Sets a background network policy. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Error codes

Example

policy.setBackgroundPolicy(Boolean(Number.parseInt(this.isBoolean))), (error, data) => {
  this.callBack(error, data);
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
}
)
;

policy.setBackgroundPolicy

setBackgroundPolicy(isAllowed: boolean): Promise<void>

Sets a background network policy. This API uses a promise to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Error codes

Return value

Example

policy.setBackgroundPolicy(Boolean(Number.parseInt(this.isBoolean))).then(function (error, data) {
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
})

policy.isBackgroundAllowed

isBackgroundAllowed(callback: AsyncCallback<boolean>): void

Obtains the background network policy. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Error codes

Example

policy.isBackgroundAllowed((error, data) => {
  this.callBack(error, data);
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
});

policy.isBackgroundAllowed

isBackgroundAllowed(): Promise<boolean>;

Obtains the background network policy. This API uses a promise to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Return value

Error codes

Example

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>): void

Sets an application-specific network policy. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Error codes

Example

let param = {
  uid: Number.parseInt(this.firstParam), policy: Number.parseInt(this.currentNetUidPolicy)
}
policy.setPolicyByUid(Number.parseInt(this.firstParam), Number.parseInt(this.currentNetUidPolicy), (error, data) => {
  this.callBack(error, data);
});

policy.setPolicyByUid

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

Sets an application-specific network policy. This API uses a promise to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Return value

Error codes

Example

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, data) {
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
})

policy.getPolicyByUid

getPolicyByUid(uid: number, callback: AsyncCallback<NetUidPolicy>): void

Obtains an application-specific network policy by uid. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Error codes

Example

policy.getPolicyByUid(Number.parseInt(this.firstParam), (error, data) => {
  this.callBack(error, data);
});

policy.getPolicyByUid

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

Obtains an application-specific network policy by uid. This API uses a promise to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Return value

Error codes

Example

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<Array<number>>): void

Obtains the UID array of applications configured with a certain application-specific network policy. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Error codes

Example

policy.getUidsByPolicy(Number.parseInt(this.currentNetUidPolicy), (error, data) => {
  this.callBack(error, data);
});

policy.getUidsByPolicy

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

Obtains the UID array of applications configured with a certain application-specific network policy. This API uses a promise to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Return value

Error codes

Example

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<Array<NetQuotaPolicy>>): void

Obtains the network quota policies. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Error codes

Example

policy.getNetQuotaPolicies((error, data) => {
  this.callBack(error, data);
});

policy.getNetQuotaPolicies

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

Obtains the network quota policies. This API uses a promise to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Return value

Error codes

Example

policy.getNetQuotaPolicies().then(function (error, data) {
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
})

policy.setNetQuotaPolicies

setNetQuotaPolicies(quotaPolicies: Array<NetQuotaPolicy>, callback: AsyncCallback<void>): void

Sets an array of network quota policies. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Error codes

Example

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, data) => {
  this.callBack(error, data);
});

policy.setNetQuotaPolicies

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

Sets an array of network quota policies. This API uses a promise to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Error codes

Return value

Example

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, data) {
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
})

policy.restoreAllPolicies

restoreAllPolicies(iccid: string, callback: AsyncCallback<void>): void

Restores all the policies (cellular network, background network, firewall, and application-specific network policies) for the given SIM card. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Error codes

Example

this.firstParam = iccid;
policy.restoreAllPolicies(this.firstParam, (error, data) => {
  this.callBack(error, data);
});

policy.restoreAllPolicies

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

Restores all the policies (cellular network, background network, firewall, and application-specific network policies) for the given SIM card. This API uses a promise to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Return value

Error codes

Example

this.firstParam = iccid;
policy.restoreAllPolicies(this.firstParam).then(function (error, data) {
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
})

policy.isUidNetAllowed

isUidNetAllowed(uid: number, isMetered: boolean, callback: AsyncCallback<boolean>): void

Checks whether an application is allowed to access metered networks. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Error codes

Example

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<boolean>;

Checks whether an application is allowed to access metered networks. This API uses a promise to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Return value

Error codes

Example

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<boolean>): void

Checks whether an application is allowed to access the given network. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Error codes

Example

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<boolean>;

Checks whether an application is allowed to access the given network. This API uses a promise to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Return value

Error codes

Example

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>): void

Sets whether to add an application to the device idle allowlist. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Error codes

Example

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, data) => {
  this.callBack(error, data);
});

policy.setDeviceIdleAllowList

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

Sets whether to add an application to the device idle allowlist. This API uses a promise to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Return value

Error codes

Example

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, data) {
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
})

policy.getDeviceIdleAllowList

getDeviceIdleAllowList(callback: AsyncCallback<Array<number>>): void

Obtains the UID array of applications that are on the device idle allowlist. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Error codes

Example

policy.getDeviceIdleAllowList((error, data) => {
  this.callBack(error, data);
});

policy.getDeviceIdleAllowList

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

Obtains the UID array of applications that are on the device idle allowlist. This API uses a promise to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Return value

Error codes

Example

policy.getDeviceIdleAllowList().then(function (error, data) {
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
})

policy.getBackgroundPolicyByUid

getBackgroundPolicyByUid(uid: number, callback: AsyncCallback<NetBackgroundPolicy>): void

Obtains the background network policies configured for the given application. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Error codes

Example

this.firstParam = uid
policy.getBackgroundPolicyByUid(Number.parseInt(this.firstParam), (error, data) => {
  this.callBack(error, data);
});

policy.getBackgroundPolicyByUid

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

Obtains the background network policies configured for the given application. This API uses a promise to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Return value

Error codes

Example

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>): void

Restores all the policies (cellular network, background network, firewall, and application-specific network policies) for the given SIM card. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Error codes

Example

this.firstParam = iccid
policy.resetPolicies(this.firstParam, (error, data) => {
  this.callBack(error, data);
});

policy.resetPolicies

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

Restores all the policies (cellular network, background network, firewall, and application-specific network policies) for the given SIM card. This API uses a promise to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Return value

Error codes

Example

policy.getUidsByPolicy(Number.parseInt(this.firstParam)).then(function (error, data) {

})
this.firstParam = iccid
policy.resetPolicies(this.firstParam).then(function (error, data) {
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
})

policy.updateRemindPolicy

updateRemindPolicy(netType: NetBearType, iccid: string, remindType: RemindType, callback: AsyncCallback<void>): void

Updates a reminder policy. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Error codes

Example

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, data) => {
  this.callBack(error, data);
});

policy.updateRemindPolicy

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

Updates a reminder policy. This API uses a promise to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Return value

Error codes

Example

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, data) {
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
})

policy.setPowerSaveAllowList

setPowerSaveAllowList(uid: number, isAllowed: boolean, callback: AsyncCallback<void>): void

Sets whether to add an application to the power-saving allowlist. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Error codes

Example

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, data) => {
  this.callBack(error, data);
});

policy.setPowerSaveAllowList

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

Sets whether to add an application to the power-saving allowlist. This API uses a promise to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Return value

Error codes

Example

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, data) {
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
})

policy.getPowerSaveAllowList

getPowerSaveAllowList(callback: AsyncCallback<Array<number>>): void

Obtains the UID array of applications that are on the power-saving allowlist. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Error codes

Example

policy.getPowerSaveAllowList((error, data) => {
  this.callBack(error, data);
});

policy.getPowerSaveAllowList

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

Obtains the UID array of applications that are on the device idle allowlist. This API uses a promise to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Return value

Error codes

Example

policy.getPowerSaveAllowList().then(function (error, data) {
  console.log(JSON.stringify(error))
  console.log(JSON.stringify(data))
})

policy.on

Functions as the handle to a network policy.

on('netUidPolicyChange')

on(type: "netUidPolicyChange", callback: Callback<{ uid: number, policy: NetUidPolicy }>): void

Subscribes to policy changes. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Example

policy.on('netUidPolicyChange', (data) => {
  this.log('on netUidPolicyChange: ' + JSON.stringify(data));
})

on('netUidRuleChange')

on(type: "netUidRuleChange", callback: Callback<{ uid: number, rule: NetUidRule }>): void

Subscribes to rule changes. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Example

policy.on('netUidRuleChange', (data) => {
  this.log('on netUidRuleChange: ' + JSON.stringify(data));
})

on('netMeteredIfacesChange')

on(type: "netMeteredIfacesChange", callback: Callback<Array<string>>): void

Subscribes to metered iface changes. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Example

policy.on('netMeteredIfacesChange', (data) => {
  this.log('on netMeteredIfacesChange: ' + JSON.stringify(data));
})

on('netQuotaPolicyChange')

on(type: "netQuotaPolicyChange", callback: Callback<Array<NetQuotaPolicy>>): void

Subscribes to network quota policy changes. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Example

policy.on('netQuotaPolicyChange', (data) => {
  this.log('on netQuotaPolicyChange: ' + JSON.stringify(data));
})

on('netBackgroundPolicyChange')

on(type: "netBackgroundPolicyChange", callback: Callback<boolean>): void

Subscribes to background network policy changes. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Example

policy.on('netBackgroundPolicyChange', (data) => {
  this.log('on netBackgroundPolicyChange: ' + JSON.stringify(data));
})

NetBackgroundPolicy

Enumerates the background network policies.

System capability: SystemCapability.Communication.NetManager.Core

NetQuotaPolicy

Defines a network quota policy.

System capability: SystemCapability.Communication.NetManager.Core

LimitAction

Enumerates the actions that can be taken when the data volume quota is reached.

System capability: SystemCapability.Communication.NetManager.Core

NetUidRule

Enumerates the metered network rules.

System capability: SystemCapability.Communication.NetManager.Core

RemindType

Enumerates the reminder types.

System capability: SystemCapability.Communication.NetManager.Core

NetUidPolicy

Enumerates the application-specific network policies.

System capability: SystemCapability.Communication.NetManager.Core