Added in API level 26

HomeSp

---

Kotlin |Java

class HomeSp : Parcelable

kotlin.Any
↳	android.net.wifi.hotspot2.pps.HomeSp

Class representing HomeSP subtree 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
HomeSp() Constructor for creating HomeSp with default values.
HomeSp(source: HomeSp!) Copy constructor.

Public methods
Int	describeContents()
Boolean	equals(other: Any?)
String!	getFqdn() Get the FQDN (Fully Qualified Domain Name) associated with this home service provider.
String!	getFriendlyName() Get the friendly name associated with this home service provider.
LongArray?	getMatchAllOis() Get the list of HomeOIs such that all OIs in the list must match an OI in the Roaming Consortium advertised by a hotspot operator.
LongArray?	getMatchAnyOis() Get a list of HomeOIs such that any OI in the list matches an OI in the Roaming Consortium advertised by a hotspot operator.
MutableCollection<String!>	getOtherHomePartnersList() Get the list of FQDN (Fully Qualified Domain Name) of other Home partner providers set in the profile.
LongArray!	getRoamingConsortiumOis() Get the Organization Identifiers (OIs) identifying a roaming consortium of which this provider is a member.
Int	hashCode()
Unit	setFqdn(fqdn: String!) Set the FQDN (Fully Qualified Domain Name) associated with this home service provider.
Unit	setFriendlyName(friendlyName: String!) Set the friendly name associated with this home service provider.
Unit	setMatchAllOis(matchAllOis: LongArray?) Set a list of HomeOIs such that all OIs in the list must match an OI in the Roaming Consortium advertised by a hotspot operator.
Unit	setMatchAnyOis(matchAnyOis: LongArray?) Set a list of HomeOIs such that any OI in the list matches an OI in the Roaming Consortium advertised by a hotspot operator.
Unit	setOtherHomePartnersList(otherHomePartners: MutableCollection<String!>) Set the list of FQDN (Fully Qualified Domain Name) of other Home partner providers.
Unit	setRoamingConsortiumOis(roamingConsortiumOis: LongArray!) Set the Organization Identifiers (OIs) identifying a roaming consortium of which this provider is a member.
String	toString()
Unit	writeToParcel(dest: Parcel, flags: Int)

Properties
static Parcelable.Creator<HomeSp!>	CREATOR

Public constructors

HomeSp

Added in API level 26

HomeSp()

Constructor for creating HomeSp with default values.

HomeSp

Added in API level 26

HomeSp(source: HomeSp!)

Copy constructor.

Parameters
source	HomeSp!: 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.

getFqdn

Added in API level 26

fun getFqdn(): String!

Get the FQDN (Fully Qualified Domain Name) associated with this home service provider.

Return
String!	the FQDN associated with this home service provider

getFriendlyName

Added in API level 26

fun getFriendlyName(): String!

Get the friendly name associated with this home service provider.

Return
String!	the friendly name associated with this home service provider

getMatchAllOis

Added in API level 31

fun getMatchAllOis(): LongArray?

Get the list of HomeOIs such that all OIs in the list must match an OI in the Roaming Consortium advertised by a hotspot operator.

Return
LongArray?	An array of longs containing the HomeOIs This value may be null.

getMatchAnyOis

Added in API level 31

fun getMatchAnyOis(): LongArray?

Get a list of HomeOIs such that any OI in the list matches an OI in the Roaming Consortium advertised by a hotspot operator.

Return
LongArray?	An array of longs containing the HomeOIs This value may be null.

getOtherHomePartnersList

Added in API level 31

fun getOtherHomePartnersList(): MutableCollection<String!>

Get the list of FQDN (Fully Qualified Domain Name) of other Home partner providers set in the profile.

Return
MutableCollection<String!>	Collection of Strings containing the FQDNs of other Home partner providers set in the profile This value cannot be null.

getRoamingConsortiumOis

Added in API level 26

fun getRoamingConsortiumOis(): LongArray!

Get the Organization Identifiers (OIs) identifying a roaming consortium of which this provider is a member.

Return
LongArray!	array of roaming consortium OIs

hashCode

Added in API level 26

fun hashCode(): Int

Return
Int	a hash code value for this object.

setFqdn

Added in API level 26

fun setFqdn(fqdn: String!): Unit

Set the FQDN (Fully Qualified Domain Name) associated with this home service provider.

Parameters
fqdn	String!: The FQDN to set to

setFriendlyName

Added in API level 26

fun setFriendlyName(friendlyName: String!): Unit

Set the friendly name associated with this home service provider.

Parameters
friendlyName	String!: The friendly name to set to

setMatchAllOis

Added in API level 31

fun setMatchAllOis(matchAllOis: LongArray?): Unit

Set a list of HomeOIs such that all OIs in the list must match an OI in the Roaming Consortium advertised by a hotspot operator. The list set by this API will have precedence over setMatchAnyOis(long[]), meaning the list set in setMatchAnyOis(long[]) will only be used for matching if the list set by this API is null or empty.

Parameters
matchAllOis	LongArray?: An array of longs containing the HomeOIs This value may be null.

setMatchAnyOis

Added in API level 31

fun setMatchAnyOis(matchAnyOis: LongArray?): Unit

Set a list of HomeOIs such that any OI in the list matches an OI in the Roaming Consortium advertised by a hotspot operator. The list set by setMatchAllOis(long[]) will have precedence over this API, meaning this list will only be used for matching if the list set by setMatchAllOis(long[]) is null or empty.

Parameters
matchAnyOis	LongArray?: An array of longs containing the HomeOIs This value may be null.

setOtherHomePartnersList

Added in API level 31

fun setOtherHomePartnersList(otherHomePartners: MutableCollection<String!>): Unit

Set the list of FQDN (Fully Qualified Domain Name) of other Home partner providers.

Parameters
otherHomePartners	MutableCollection<String!>: Collection of Strings containing the FQDNs of other Home partner providers This value cannot be null.

setRoamingConsortiumOis

Added in API level 26

fun setRoamingConsortiumOis(roamingConsortiumOis: LongArray!): Unit

Set the Organization Identifiers (OIs) identifying a roaming consortium of which this provider is a member.

Parameters
roamingConsortiumOis	LongArray!: Array of roaming consortium OIs

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<HomeSp!>