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

Commit 28a3e859 authored by Benjamin Miller's avatar Benjamin Miller
Browse files

Docs: VPNs under Android O should promote to the foreground 

Add note for VPN developers that VPN apps started in the background must transition to the foreground in Android O to avoid the system stopping them.

Staged at: go/dac-stage/reference/android/net/VpnService.html

Test: make ds-docs
Bug: 38023983
Change-Id: I33c7ca1717c332ffab495eb51c4c6b9c5c304cef
parent f75d22dc

core/java/android/net/VpnService.java

+8 −1
Original line number Diff line number Diff line
@@ -99,7 +99,7 @@ import java.util.List; 
 *       shut down the tunnel gracefully.</li>

 * </ol>

 *

 * <p>Services extended this class need to be declared with appropriate

 * <p>Services extending this class need to be declared with an appropriate

 * permission and intent filter. Their access must be secured by

 * {@link android.Manifest.permission#BIND_VPN_SERVICE} permission, and

 * their intent filter must match {@link #SERVICE_INTERFACE} action. Here
@@ -112,6 +112,13 @@ import java.util.List; 
 *     &lt;/intent-filter&gt;

 * &lt;/service&gt;</pre>

 *

 * <p> The Android system starts a VPN in the background by calling

 * {@link android.content.Context#startService startService()}. In Android 8.0

 * (API level 26) and higher, the system places VPN apps on the temporary

 * whitelist for a short period so the app can start in the background. The VPN

 * app must promote itself to the foreground after it's launched or the system

 * will shut down the app.

 *

 * @see Builder

 */

public class VpnService extends Service {