From 18017cb6d1fe8e85ab6690c242619aaa3f4f78e6 Mon Sep 17 00:00:00 2001 From: Remi NGUYEN VAN Date: Tue, 12 Mar 2019 09:21:55 +0900 Subject: [PATCH] Add documentation for CaptivePortal APP_RETURN_* This fixes API review requests. Test: atest FrameworksNetTests NetworkStackTests Bug: 126883311 Change-Id: I0632a98675e65c5e722e81a2c1e0cf1403b54395 --- core/java/android/net/CaptivePortal.java | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/core/java/android/net/CaptivePortal.java b/core/java/android/net/CaptivePortal.java index 3ab35e1eeb..ba7323ddbd 100644 --- a/core/java/android/net/CaptivePortal.java +++ b/core/java/android/net/CaptivePortal.java @@ -29,15 +29,33 @@ import android.os.RemoteException; * {@code ACTION_CAPTIVE_PORTAL_SIGN_IN} activity. */ public class CaptivePortal implements Parcelable { - /** @hide */ + /** + * Response code from the captive portal application, indicating that the portal was dismissed + * and the network should be re-validated. + * @see ICaptivePortal#appResponse(int) + * @see android.net.INetworkMonitor#notifyCaptivePortalAppFinished(int) + * @hide + */ @SystemApi @TestApi public static final int APP_RETURN_DISMISSED = 0; - /** @hide */ + /** + * Response code from the captive portal application, indicating that the user did not login and + * does not want to use the captive portal network. + * @see ICaptivePortal#appResponse(int) + * @see android.net.INetworkMonitor#notifyCaptivePortalAppFinished(int) + * @hide + */ @SystemApi @TestApi public static final int APP_RETURN_UNWANTED = 1; - /** @hide */ + /** + * Response code from the captive portal application, indicating that the user does not wish to + * login but wants to use the captive portal network as-is. + * @see ICaptivePortal#appResponse(int) + * @see android.net.INetworkMonitor#notifyCaptivePortalAppFinished(int) + * @hide + */ @SystemApi @TestApi public static final int APP_RETURN_WANTED_AS_IS = 2;