Skip to content

Most visited

Recently visited

navigation

CaptivePortal

public class CaptivePortal
extends Object implements Parcelable

java.lang.Object
   ↳ android.net.CaptivePortal


A class allowing apps handling the ACTION_CAPTIVE_PORTAL_SIGN_IN activity to indicate to the system different outcomes of captive portal sign in. This class is passed as an extra named EXTRA_CAPTIVE_PORTAL with the ACTION_CAPTIVE_PORTAL_SIGN_IN activity.

Summary

Inherited constants

From interface android.os.Parcelable

Fields

public static final Creator<CaptivePortal> CREATOR

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

void ignoreNetwork()

Indicate to the system that the user does not want to pursue signing in to the captive portal and the system should continue to prefer other networks without captive portals for use as the default active data network.

void reportCaptivePortalDismissed()

Indicate to the system that the captive portal has been dismissed.

void writeToParcel(Parcel out, int flags)

Flatten this object in to a Parcel.

Inherited methods

From class java.lang.Object
From interface android.os.Parcelable

Fields

CREATOR

Added in API level 23
Creator<CaptivePortal> CREATOR

Public methods

describeContents

Added in API level 23
int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

ignoreNetwork

Added in API level 23
void ignoreNetwork ()

Indicate to the system that the user does not want to pursue signing in to the captive portal and the system should continue to prefer other networks without captive portals for use as the default active data network. The system will not retest the network for a captive portal so as to avoid disturbing the user with further sign in to network notifications.

reportCaptivePortalDismissed

Added in API level 23
void reportCaptivePortalDismissed ()

Indicate to the system that the captive portal has been dismissed. In response the framework will re-evaluate the network's connectivity and might take further action thereafter.

writeToParcel

Added in API level 23
void writeToParcel (Parcel out, 
                int flags)

Flatten this object in to a Parcel.

Parameters
out Parcel: The Parcel in which the object should be written.
flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.