Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit bf3953a6 authored by lucaslin's avatar lucaslin Committed by Lucas Lin
Browse files

Modify javadoc for some extra values of VpnManager event 

The underlying network, NetworkCapabilities and LinkProperties
are not necessary to send to VPN app since the purpose of
CATEGORY_EVENT_DEACTIVATED_BY_USER and
CATEGORY_EVENT_ALWAYS_ON_STATE_CHANGED are to notify VPN
app that VPN is deactivated by the user or VPN always-on
status is changed.

Bug: 191413541
Test: Javadoc only changes.
Change-Id: I7fd4b6dad1a4363336f03c217e635fc45bcd0ab6
(cherry picked from commit 4b6b7987)
Merged-In: I7fd4b6dad1a4363336f03c217e635fc45bcd0ab6
parent 0eb8f090

core/java/android/net/VpnManager.java

+18 −3
Original line number Diff line number Diff line
@@ -187,14 +187,24 @@ public class VpnManager { 
    /**

     * The network that was underlying the VPN when the event occurred, as a {@link Network}.

     *

     * This extra will be null if there was no underlying network at the time of the event.

     * <p>This extra will be null if there was no underlying network at the time of the event, or

     *    the underlying network has no bearing on the event, as in the case of:

     * <ul>

     *   <li>CATEGORY_EVENT_DEACTIVATED_BY_USER

     *   <li>CATEGORY_EVENT_ALWAYS_ON_STATE_CHANGED

     * </ul>

     */

    public static final String EXTRA_UNDERLYING_NETWORK = "android.net.extra.UNDERLYING_NETWORK";



    /**

     * The {@link NetworkCapabilities} of the underlying network when the event occurred.

     *

     * This extra will be null if there was no underlying network at the time of the event.

     * <p>This extra will be null if there was no underlying network at the time of the event, or

     *    the underlying network has no bearing on the event, as in the case of:

     * <ul>

     *   <li>CATEGORY_EVENT_DEACTIVATED_BY_USER

     *   <li>CATEGORY_EVENT_ALWAYS_ON_STATE_CHANGED

     * </ul>

     */

    public static final String EXTRA_UNDERLYING_NETWORK_CAPABILITIES =

            "android.net.extra.UNDERLYING_NETWORK_CAPABILITIES";
@@ -202,7 +212,12 @@ public class VpnManager { 
    /**

     * The {@link LinkProperties} of the underlying network when the event occurred.

     *

     * This extra will be null if there was no underlying network at the time of the event.

     * <p>This extra will be null if there was no underlying network at the time of the event, or

     *    the underlying network has no bearing on the event, as in the case of:

     * <ul>

     *   <li>CATEGORY_EVENT_DEACTIVATED_BY_USER

     *   <li>CATEGORY_EVENT_ALWAYS_ON_STATE_CHANGED

     * </ul>

     */

    public static final String EXTRA_UNDERLYING_LINK_PROPERTIES =

            "android.net.extra.UNDERLYING_LINK_PROPERTIES";