CaptivePortal

public class CaptivePortal
extends Object implements Parcelable

java.lang.Object
   ↳ android.net.CaptivePortal


A class allowing apps handling the ConnectivityManager.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 ConnectivityManager.EXTRA_CAPTIVE_PORTAL with the ACTION_CAPTIVE_PORTAL_SIGN_IN activity.

Summary

Inherited constants

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

Fields

CREATOR

added in API level 23
public static final Creator<CaptivePortal> CREATOR

Public methods

describeContents

added in API level 23
public 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
public 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
public 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
public 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.PARCELABLE_WRITE_RETURN_VALUE.