@ohos.app.ability.VpnExtensionAbility (Enhanced VPN Management)

This module provides lifecycle callbacks for third-party VPNs, including VPN creation and destruction.

NOTE

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

The APIs of this module can be used only in the stage model.

Modules to Import

import { VpnExtensionAbility } from '@kit.NetworkKit';

Attributes

System capability: SystemCapability.Ability.AbilityRuntime.Core.

Name	Type	Readable	Writable	Description
context	VpnExtensionContext	Yes	No	Context of the VpnExtension. This context is inherited from ExtensionContext.

VpnExtensionAbility.onCreate

onCreate(want: Want): void

Called when the third-party VPN is initialized upon startup.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Name	Type	Mandatory	Description
want	Want	Yes	Want information.

Example

import { VpnExtensionAbility } from '@kit.NetworkKit';
import { Want } from '@kit.AbilityKit';

class MyVpnExtAbility extends VpnExtensionAbility {
  onCreate(want: Want) {
     console.log('MyVpnExtAbility onCreate');
  }
}

VpnExtensionAbility.onDestroy

onDestroy(): void

Called when the third-party VPN is destroyed to clear resources.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Example

import { VpnExtensionAbility } from '@kit.NetworkKit';

class MyVpnExtAbility extends VpnExtensionAbility {
  onDestroy() {
     console.log('MyVpnExtAbility onDestroy');
  }
}