Added in API level 26

Summary: Inherited Constants | Fields | Ctors | Methods | Inherited Methods

PasspointConfiguration

Kotlin |Java

public final class PasspointConfiguration
extends Object implements Parcelable

java.lang.Object
↳	android.net.wifi.hotspot2.PasspointConfiguration

Class representing Passpoint configuration. This contains configurations specified in PerProviderSubscription (PPS) Management Object (MO) tree. For more info, refer to Hotspot 2.0 PPS MO defined in section 9.1 of the Hotspot 2.0 Release 2 Technical Specification.

Summary

Inherited constants

From interface android.os.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(Parcel, int)`: 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)`".

Fields
`public static final Creator<PasspointConfiguration>`	`CREATOR`

Public constructors
`PasspointConfiguration()` Constructor for creating PasspointConfiguration with default values.
`PasspointConfiguration(PasspointConfiguration source)` Copy constructor.

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`boolean`	`equals(Object thatObject)` Indicates whether some other object is "equal to" this one.
`Credential`	`getCredential()` Get the credential information.
`String`	`getDecoratedIdentityPrefix()` Get the decorated identity prefix.
`HomeSp`	`getHomeSp()` Get the Home SP (Service Provider) information.
`long`	`getSubscriptionExpirationTimeMillis()` Utility method to get the time this subscription will expire.
`String`	`getUniqueId()` Get a unique identifier for a PasspointConfiguration object.
`int`	`hashCode()` Returns a hash code value for the object.
`boolean`	`isOsuProvisioned()` Indicates if the Passpoint Configuration was provisioned by a subscription (OSU) server, which means that it's an R2 (or R3) profile.
`void`	`setCredential(Credential credential)` Set the credential information.
`void`	`setDecoratedIdentityPrefix(String decoratedIdentityPrefix)` Set a prefix for a decorated identity as per RFC 7542.
`void`	`setHomeSp(HomeSp homeSp)` Set the Home SP (Service Provider) information.
`void`	`setSubscriptionExpirationTimeInMillis(long subscriptionExpirationTimeInMillis)` Utility method to set the time this subscription will expire.
`String`	`toString()` Returns a string representation of the object.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 26

public static final Creator<PasspointConfiguration> CREATOR

Public constructors

PasspointConfiguration

Added in API level 26

public PasspointConfiguration ()

Constructor for creating PasspointConfiguration with default values.

PasspointConfiguration

Added in API level 26

public PasspointConfiguration (PasspointConfiguration source)

Copy constructor.

Parameters
`source`	`PasspointConfiguration`: The source to copy from

Public methods

describeContents

Added in API level 26

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(android.os.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. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

equals

Added in API level 26

public boolean equals (Object thatObject)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
`thatObject`	`Object`: the reference object with which to compare.

Returns
`boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getCredential

Added in API level 26

public Credential getCredential ()

Get the credential information.

Returns
`Credential`	credential information

getDecoratedIdentityPrefix

Added in API level 31

public String getDecoratedIdentityPrefix ()

Get the decorated identity prefix.

Returns
`String`	The decorated identity prefix This value may be `null`.

getHomeSp

Added in API level 26

public HomeSp getHomeSp ()

Get the Home SP (Service Provider) information.

Returns
`HomeSp`	Home SP information

getSubscriptionExpirationTimeMillis

Added in API level 30

public long getSubscriptionExpirationTimeMillis ()

Utility method to get the time this subscription will expire. It is in the format of number of milliseconds since January 1, 1970, 00:00:00 GMT.
Value is a non-negative timestamp measured as the number of milliseconds since 1970-01-01T00:00:00Z.

Returns
`long`	The time this subscription will expire, or Long.MIN_VALUE to indicate unset value Value is a non-negative timestamp measured as the number of milliseconds since 1970-01-01T00:00:00Z.

getUniqueId

Added in API level 30

public String getUniqueId ()

Get a unique identifier for a PasspointConfiguration object. The identifier depends on the configuration that identify the service provider under the HomeSp subtree, and on the credential configuration under the Credential subtree. The method throws an IllegalStateException if the configuration under HomeSp subtree or the configuration under Credential subtree are not initialized.

Returns
`String`	A unique identifier This value cannot be `null`.

hashCode

Added in API level 26

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
`int`	a hash code value for this object.

isOsuProvisioned

Added in API level 30

public boolean isOsuProvisioned ()

Indicates if the Passpoint Configuration was provisioned by a subscription (OSU) server, which means that it's an R2 (or R3) profile.

Returns
`boolean`	true if the Passpoint Configuration was provisioned by a subscription server.

setCredential

Added in API level 26

public void setCredential (Credential credential)

Set the credential information.

Parameters
`credential`	`Credential`: The credential information to set to

setDecoratedIdentityPrefix

Added in API level 31

public void setDecoratedIdentityPrefix (String decoratedIdentityPrefix)

Set a prefix for a decorated identity as per RFC 7542. This prefix must contain a list of realms (could be a list of 1) delimited by a '!' character. e.g. homerealm.example.org! or proxyrealm.example.net!homerealm.example.org! A prefix of "homerealm.example.org!" will generate a decorated identity that looks like: homerealm.example.org!user@otherrealm.example.net Calling with a null parameter will clear the decorated prefix. Note: Caller must verify that the device supports this feature by calling WifiManager#isDecoratedIdentitySupported()

Parameters
`decoratedIdentityPrefix`	`String`: The prefix to add to the outer/anonymous identity This value may be `null`.

setHomeSp

Added in API level 26

public void setHomeSp (HomeSp homeSp)

Set the Home SP (Service Provider) information.

Parameters
`homeSp`	`HomeSp`: The Home SP information to set to

setSubscriptionExpirationTimeInMillis

Added in API level 33

public void setSubscriptionExpirationTimeInMillis (long subscriptionExpirationTimeInMillis)

Utility method to set the time this subscription will expire. The framework will not attempt to auto-connect to networks using expired subscriptions.

Parameters
`subscriptionExpirationTimeInMillis`	`long`: The expiration time in the format of number of milliseconds since January 1, 1970, 00:00:00 GMT, or `Long#MIN_VALUE` to unset. Value is a non-negative timestamp measured as the number of milliseconds since 1970-01-01T00:00:00Z.

toString

Added in API level 26

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

writeToParcel

Added in API level 26

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`dest`	`Parcel`: 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.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES