PasspointConfiguration
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 | |
|---|---|
| Public constructors | |
|---|---|
|
Constructor for creating PasspointConfiguration with default values. |
|
PasspointConfiguration(source: PasspointConfiguration!)Copy constructor. |
|
| Public methods | |
|---|---|
| Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| Boolean |
Indicates whether some other object is "equal to" this one. |
| Credential! |
Get the credential information. |
| String? |
Get the decorated identity prefix. |
| HomeSp! |
Get the Home SP (Service Provider) information. |
| Long |
Utility method to get the time this subscription will expire. |
| String |
Get a unique identifier for a PasspointConfiguration object. |
| Int |
hashCode()Returns a hash code value for the object. |
| Boolean |
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 |
Set the Home SP (Service Provider) information. |
| Unit |
setSubscriptionExpirationTimeInMillis(subscriptionExpirationTimeInMillis: Long)Utility method to set the time this subscription will expire. |
| String |
toString()Returns a string representation of the object. |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<PasspointConfiguration!> | |
Public constructors
PasspointConfiguration
PasspointConfiguration()
Constructor for creating PasspointConfiguration with default values.
PasspointConfiguration
PasspointConfiguration(source: PasspointConfiguration!)
Copy constructor.
| Parameters | |
|---|---|
source |
PasspointConfiguration!: The source to copy from |
Public methods
describeContents
fun describeContents(): Int
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.
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
equals
fun equals(other: Any?): Boolean
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
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 | |
|---|---|
obj |
the reference object with which to compare. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getCredential
fun getCredential(): Credential!
Get the credential information.
| Return | |
|---|---|
Credential! |
credential information |
getDecoratedIdentityPrefix
fun getDecoratedIdentityPrefix(): String?
Get the decorated identity prefix.
| Return | |
|---|---|
String? |
The decorated identity prefix. This value may be null. |
getHomeSp
fun getHomeSp(): HomeSp!
Get the Home SP (Service Provider) information.
| Return | |
|---|---|
HomeSp! |
Home SP information |
getSubscriptionExpirationTimeMillis
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
fun getUniqueId(): String
Get a unique identifier for a PasspointConfiguration object. The identifier depends on the subscription ID, the configuration that identify the service provider under the HomeSp subtree, and 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
fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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
equalsmethod, then calling thehashCodemethod 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
equalsmethod, then calling thehashCodemethod 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.
| Return | |
|---|---|
Int |
a hash code value for this object. |
isOsuProvisioned
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
fun setCredential(credential: Credential!): Unit
Set the credential information.
| Parameters | |
|---|---|
credential |
Credential!: The credential information to set to |
setDecoratedIdentityPrefix
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: 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
fun setHomeSp(homeSp: HomeSp!): Unit
Set the Home SP (Service Provider) information.
| Parameters | |
|---|---|
homeSp |
HomeSp!: The Home SP information to set to |
setSubscriptionExpirationTimeInMillis
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
fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
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_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following:
|