Add documentation for CaptivePortal APP_RETURN_*

This fixes API review requests.

Test: atest FrameworksNetTests NetworkStackTests
Bug: 126883311
Change-Id: I0632a98675e65c5e722e81a2c1e0cf1403b54395
This commit is contained in:
Remi NGUYEN VAN
2019-03-12 09:21:55 +09:00
parent 44bd665c9e
commit cd13f8f3d5

View File

@@ -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;