PasspointConfiguration

Kotlin |Java

class PasspointConfiguration : Parcelable

kotlin.Any
↳	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 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 constructors
`PasspointConfiguration()` Constructor for creating PasspointConfiguration with default values.
`PasspointConfiguration(source: PasspointConfiguration!)` Copy constructor.

Public methods
Int	`describeContents()`
Boolean	`equals(other: Any?)`
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()`
Boolean	`isOsuProvisioned()` Indicates if the Passpoint Configuration was provisioned by a subscription (OSU) server, which means that it's an R2 (or R3) profile.
Unit	`setCredential(credential: Credential!)` Set the credential information.
Unit	`setDecoratedIdentityPrefix(decoratedIdentityPrefix: String?)` Set a prefix for a decorated identity as per RFC 7542.
Unit	`setHomeSp(homeSp: HomeSp!)` Set the Home SP (Service Provider) information.
Unit	`setSubscriptionExpirationTimeInMillis(subscriptionExpirationTimeInMillis: Long)` Utility method to set the time this subscription will expire.
String	`toString()`
Unit	`writeToParcel(dest: Parcel, flags: Int)`

Properties
static Parcelable.Creator<PasspointConfiguration!>	`CREATOR`

Public constructors

PasspointConfiguration

Added in API level 26

PasspointConfiguration()

Constructor for creating PasspointConfiguration with default values.

PasspointConfiguration

Added in API level 26

PasspointConfiguration(source: PasspointConfiguration!)

Copy constructor.

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

Public methods

describeContents

Added in API level 26

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`

equals

Added in API level 26

fun equals(other: Any?): Boolean

Parameters
`obj`	the reference object with which to compare.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getCredential

Added in API level 26

fun getCredential(): Credential!

Get the credential information.

Return
`Credential!`	credential information

getDecoratedIdentityPrefix

Added in API level 31

fun getDecoratedIdentityPrefix(): String?

Get the decorated identity prefix.

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

getHomeSp

Added in API level 26

fun getHomeSp(): HomeSp!

Get the Home SP (Service Provider) information.

Return
`HomeSp!`	Home SP information

getSubscriptionExpirationTimeMillis

Added in API level 30

fun getSubscriptionExpirationTimeMillis(): Long

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.

Return
`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

fun getUniqueId(): String

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.

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

hashCode

Added in API level 26

fun hashCode(): Int

Return
`Int`	a hash code value for this object.

isOsuProvisioned

Added in API level 30

fun isOsuProvisioned(): Boolean

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

Return
`Boolean`	true if the Passpoint Configuration was provisioned by a subscription server.

setCredential

Added in API level 26

fun setCredential(credential: Credential!): Unit

Set the credential information.

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

setDecoratedIdentityPrefix

Added in API level 31

fun setDecoratedIdentityPrefix(decoratedIdentityPrefix: String?): Unit

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: [email protected] 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

fun setHomeSp(homeSp: HomeSp!): Unit

Set the Home SP (Service Provider) information.

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

setSubscriptionExpirationTimeInMillis

Added in API level 33

fun setSubscriptionExpirationTimeInMillis(subscriptionExpirationTimeInMillis: Long): Unit

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

fun toString(): String

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 26

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

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_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 26

static val CREATOR: Parcelable.Creator<PasspointConfiguration!>