WifiNetworkSuggestion
class WifiNetworkSuggestion : Parcelable
| kotlin.Any | |
| ↳ | android.net.wifi.WifiNetworkSuggestion |
The Network Suggestion object is used to provide a Wi-Fi network for consideration when auto-connecting to networks. Apps cannot directly create this object, they must use WifiNetworkSuggestion.Builder.build() to obtain an instance of this object.
Apps can provide a list of such networks to the platform using WifiManager.addNetworkSuggestions(List).
Summary
| Nested classes | |
|---|---|
|
Builder used to create |
|
| Constants | |
|---|---|
| static Int |
With this option, the randomized MAC address will periodically get re-randomized, and the randomized MAC address will change if the suggestion is removed and then added back. |
| static Int |
Generate a randomized MAC from a secret seed and information from the Wi-Fi configuration (SSID or Passpoint profile) and reuse it for all connections to this network. |
| Inherited constants | |
|---|---|
| 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. |
| MacAddress? |
getBssid()Get the BSSID, or null if unset. |
| WifiEnterpriseConfig? |
Get the WifiEnterpriseConfig, or null if unset. |
| Int |
Get the MAC randomization method. |
| String? |
Get the passphrase, or null if unset. |
| PasspointConfiguration? |
Get the |
| Int | |
| Int | |
| String? |
getSsid()Return the unicode SSID of the network, or null if this is a Passpoint network or the SSID is non-unicode. |
| ParcelUuid? |
Get the subscription Group UUID of the suggestion |
| Int | |
| WifiSsid? |
Return the |
| Int |
hashCode()Returns a hash code value for the object. |
| Boolean | |
| Boolean | |
| Boolean | |
| Boolean | |
| Boolean | |
| Boolean | |
| Boolean | |
| Boolean |
Return if a suggestion is for a restricted network |
| Boolean | |
| Boolean | |
| Boolean | |
| 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<WifiNetworkSuggestion!> | |
Constants
RANDOMIZATION_NON_PERSISTENT
static val RANDOMIZATION_NON_PERSISTENT: Int
With this option, the randomized MAC address will periodically get re-randomized, and the randomized MAC address will change if the suggestion is removed and then added back.
Value: 1RANDOMIZATION_PERSISTENT
static val RANDOMIZATION_PERSISTENT: Int
Generate a randomized MAC from a secret seed and information from the Wi-Fi configuration (SSID or Passpoint profile) and reuse it for all connections to this network. The randomized MAC address for this network will stay the same for each subsequent association until the device undergoes factory reset.
Value: 0Public 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. |
getEnterpriseConfig
fun getEnterpriseConfig(): WifiEnterpriseConfig?
Get the WifiEnterpriseConfig, or null if unset.
getMacRandomizationSetting
fun getMacRandomizationSetting(): Int
Get the MAC randomization method.
| Return | |
|---|---|
Int |
one of RANDOMIZATION_* values. Value is one of the following: |
getPassphrase
fun getPassphrase(): String?
Get the passphrase, or null if unset.
getPasspointConfig
fun getPasspointConfig(): PasspointConfiguration?
Get the PasspointConfiguration associated with this Suggestion, or null if this Suggestion is not for a Passpoint network.
getSsid
fun getSsid(): String?
Return the unicode SSID of the network, or null if this is a Passpoint network or the SSID is non-unicode.
Note: use getWifiSsid() which supports both unicode and non-unicode SSID.
getSubscriptionGroup
fun getSubscriptionGroup(): ParcelUuid?
Get the subscription Group UUID of the suggestion
| Return | |
|---|---|
ParcelUuid? |
Uuid represent a Subscription Group. This value may be null. |
getWifiSsid
fun getWifiSsid(): WifiSsid?
Return the WifiSsid of the network, or null if this is a Passpoint network.
| Return | |
|---|---|
WifiSsid? |
An object representing the SSID the network. null for passpoint network. |
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. |
isRestricted
fun isRestricted(): Boolean
Return if a suggestion is for a restricted network
| Return | |
|---|---|
Boolean |
true if the suggestion is restricted, false otherwise |
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:
|