VpnProfileState

STATE_CONNECTED

static val STATE_CONNECTED: Int

The VPN was established successfully.

Value: 2

STATE_CONNECTING

static val STATE_CONNECTING: Int

The VPN is attempting to connect, potentially after a failure.

Value: 1

STATE_DISCONNECTED

static val STATE_DISCONNECTED: Int

The VPN has not been started, or some other VPN is active.

Value: 0

STATE_FAILED

static val STATE_FAILED: Int

A non-recoverable error has occurred, and will not be retried.

Value: 3

VpnProfileState

VpnProfileState(
    state: Int, 
    sessionKey: String?, 
    alwaysOn: Boolean, 
    lockdown: Boolean)

describeContents

fun describeContents(): Int

Implement the Parcelable interface

equals

fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

getSessionId

fun getSessionId(): String?

Retrieves the Session Key

The session key is an ephemeral key uniquely identifying the session for a Platform VPN. The lifetime of this key is tied to the lifetime of the VPN session. In other words, reprovisioning of the VPN profile, restarting of the device, or manually restarting the platform VPN session will result in a new VPN session, and a new key.

getState

fun getState(): Int

Returns the state of the Platform VPN

This state represents the internal connection state of the VPN. This state may diverge from the VPN Network's state during error and recovery handling.

hashCode

fun hashCode(): Int

isAlwaysOn

fun isAlwaysOn(): Boolean

Returns the always-on status of the PlatformVpnProfile.

If the PlatformVpnProfile is set to be running in always-on mode, the system will ensure that the profile is always started, and restarting it when necessary (e.g. after reboot).

Always-on can be set by an appropriately privileged user via the Settings VPN menus, or by the Device Policy Manager app programmatically. See DevicePolicyManager#setAlwaysOnVpnPackage(ComponentName, String, boolean, Set)

isLockdownEnabled

fun isLockdownEnabled(): Boolean

Returns the lockdown mode status of the PlatformVpnProfile.

In lockdown mode, the system will ensure that apps are not allowed to bypass the VPN, including during startup or failure of the VPN.

Lockdown mode can be set by an appropriately privileged user via the Settings VPN menus, or by the Device Policy Manager app programmatically. See DevicePolicyManager#setAlwaysOnVpnPackage(ComponentName, String, boolean, Set)

toString

fun toString(): String

writeToParcel

fun writeToParcel(
    out: Parcel, 
    flags: Int
): Unit

Implement the Parcelable interface

CREATOR

static val CREATOR: Parcelable.Creator<VpnProfileState!>