Android APIs
public class

CaptivePortal

extends Object
implements Parcelable
java.lang.Object
   ↳ android.net.CaptivePortal

Class Overview

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

[Expand]
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's marshalled 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.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Fields

public static final Creator<CaptivePortal> CREATOR

Added in API level 23

Public Methods

public int describeContents ()

Added in API level 23

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

Returns
  • a bitmask indicating the set of special object types marshalled by the Parcelable.

public void ignoreNetwork ()

Added in API level 23

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.

public void reportCaptivePortalDismissed ()

Added in API level 23

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.

public void writeToParcel (Parcel out, int flags)

Added in API level 23

Flatten this object in to a Parcel.

Parameters
out The Parcel in which the object should be written.
flags Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.