WifiNetworkSuggestion

public final class WifiNetworkSuggestion
extends Object implements Parcelable

java.lang.Object
   ↳ 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

class WifiNetworkSuggestion.Builder

Builder used to create WifiNetworkSuggestion objects. 

Constants

int RANDOMIZATION_NON_PERSISTENT

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.

int RANDOMIZATION_PERSISTENT

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

Fields

public static final Creator<WifiNetworkSuggestion> CREATOR

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object obj)

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

MacAddress getBssid()

Get the BSSID, or null if unset.

WifiEnterpriseConfig getEnterpriseConfig()

Get the WifiEnterpriseConfig, or null if unset.

int getMacRandomizationSetting()

Get the MAC randomization method.

String getPassphrase()

Get the passphrase, or null if unset.

PasspointConfiguration getPasspointConfig()

Get the PasspointConfiguration associated with this Suggestion, or null if this Suggestion is not for a Passpoint network.

int getPriority()
int getPriorityGroup()
String getSsid()

Return the unicode SSID of the network, or null if this is a Passpoint network or the SSID is non-unicode.

ParcelUuid getSubscriptionGroup()

Get the subscription Group UUID of the suggestion

int getSubscriptionId()
WifiSsid getWifiSsid()

Return the WifiSsid of the network, or null if this is a Passpoint network.

int hashCode()

Returns a hash code value for the object.

boolean isAppInteractionRequired()
boolean isCarrierMerged()
boolean isCredentialSharedWithUser()
boolean isEnhancedOpen()
boolean isHiddenSsid()
boolean isInitialAutojoinEnabled()
boolean isMetered()
boolean isRestricted()

Return if a suggestion is for a restricted network

boolean isUntrusted()
boolean isUserInteractionRequired()
String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

RANDOMIZATION_NON_PERSISTENT

Added in API level 31
public static final int RANDOMIZATION_NON_PERSISTENT

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.

Constant Value: 1 (0x00000001)

RANDOMIZATION_PERSISTENT

Added in API level 31
public static final int RANDOMIZATION_PERSISTENT

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.

Constant Value: 0 (0x00000000)

Fields

CREATOR

Added in API level 29
public static final Creator<WifiNetworkSuggestion> CREATOR

Public methods

describeContents

Added in API level 29
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 29
public boolean equals (Object obj)

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
obj Object: the reference object with which to compare.

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

getBssid

Added in API level 30
public MacAddress getBssid ()

Get the BSSID, or null if unset.

Returns
MacAddress

getMacRandomizationSetting

Added in API level 33
public int getMacRandomizationSetting ()

Get the MAC randomization method.

Returns
int one of RANDOMIZATION_* values Value is RANDOMIZATION_PERSISTENT, or RANDOMIZATION_NON_PERSISTENT

getPasspointConfig

Added in API level 30
public PasspointConfiguration getPasspointConfig ()

Get the PasspointConfiguration associated with this Suggestion, or null if this Suggestion is not for a Passpoint network.

Returns
PasspointConfiguration

getPriority

Added in API level 30
public int getPriority ()

Returns
int Value is 0 or greater

getPriorityGroup

Added in API level 31
public int getPriorityGroup ()

Returns
int Value is 0 or greater

getSsid

Added in API level 30
public String getSsid ()

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.

Returns
String

getSubscriptionGroup

Added in API level 33
public ParcelUuid getSubscriptionGroup ()

Get the subscription Group UUID of the suggestion

Returns
ParcelUuid Uuid represent a Subscription Group This value may be null.

getSubscriptionId

Added in API level 31
public int getSubscriptionId ()

Returns
int

getWifiSsid

Added in API level 33
public WifiSsid getWifiSsid ()

Return the WifiSsid of the network, or null if this is a Passpoint network.

Returns
WifiSsid An object representing the SSID the network. null for passpoint network.

hashCode

Added in API level 29
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.

isAppInteractionRequired

Added in API level 30
public boolean isAppInteractionRequired ()

Returns
boolean

isCarrierMerged

Added in API level 31
public boolean isCarrierMerged ()

Returns
boolean

isCredentialSharedWithUser

Added in API level 30
public boolean isCredentialSharedWithUser ()

Returns
boolean

isEnhancedOpen

Added in API level 30
public boolean isEnhancedOpen ()

Returns
boolean

isHiddenSsid

Added in API level 30
public boolean isHiddenSsid ()

Returns
boolean

isInitialAutojoinEnabled

Added in API level 30
public boolean isInitialAutojoinEnabled ()

Returns
boolean

isMetered

Added in API level 30
public boolean isMetered ()

Returns
boolean

isRestricted

Added in API level 33
public boolean isRestricted ()

Return if a suggestion is for a restricted network

Returns
boolean true if the suggestion is restricted, false otherwise

isUntrusted

Added in API level 30
public boolean isUntrusted ()

Returns
boolean

isUserInteractionRequired

Added in API level 30
public boolean isUserInteractionRequired ()

Returns
boolean

toString

Added in API level 29
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in API level 29
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