Added in API level 23

CaptivePortal

---

Kotlin |Java

open class CaptivePortal : Parcelable

kotlin.Any
↳	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

From class Parcelable Int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. Int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
open Int	describeContents()
open Unit	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.
open Unit	reportCaptivePortalDismissed() Indicate to the system that the captive portal has been dismissed.
open Unit	writeToParcel(out: Parcel, flags: Int)

Properties
static Parcelable.Creator<CaptivePortal!>	CREATOR

Public methods

describeContents

Added in API level 23

open fun describeContents(): Int

Return
Int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

ignoreNetwork

Added in API level 23

open fun ignoreNetwork(): Unit

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

open fun reportCaptivePortalDismissed(): Unit

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

open fun writeToParcel(
    out: Parcel, 
    flags: Int
): Unit

Parameters
dest	The Parcel in which the object should be written. This value cannot be null.
flags	Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 23

static val CREATOR: Parcelable.Creator<CaptivePortal!>