# Print output for @column tags ?> WifiNetworkSuggestion - Android SDK | Android Developers
Developer Console

Most visited

Recently visited

Results for

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.

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 SSID of the network, or null if this is a Passpoint network.

int getSubscriptionId()
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 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

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

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

public static final Creator<WifiNetworkSuggestion> CREATOR

Public methods

describeContents

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

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.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

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

public MacAddress getBssid ()

Get the BSSID, or null if unset.

Returns
MacAddress

See also:

getEnterpriseConfig

public WifiEnterpriseConfig getEnterpriseConfig ()

Get the WifiEnterpriseConfig, or null if unset.

Returns
WifiEnterpriseConfig

See also:

getPassphrase

public String getPassphrase ()

Get the passphrase, or null if unset.

Returns
String

See also:

getPasspointConfig

public PasspointConfiguration getPasspointConfig ()

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

Returns
PasspointConfiguration

getPriority

public int getPriority ()

Returns
int Value is 0 or greater

See also:

getPriorityGroup

public int getPriorityGroup ()

Returns
int Value is 0 or greater

See also:

getSsid

public String getSsid ()

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

Returns
String

See also:

getSubscriptionId

public int getSubscriptionId ()

Returns
int

See also:

hashCode

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

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Returns
int a hash code value for this object.

isAppInteractionRequired

public boolean isAppInteractionRequired ()

Returns
boolean

See also:

isCarrierMerged

public boolean isCarrierMerged ()

Returns
boolean

See also:

isCredentialSharedWithUser

public boolean isCredentialSharedWithUser ()

Returns
boolean

See also:

isEnhancedOpen

public boolean isEnhancedOpen ()

Returns
boolean

See also:

isHiddenSsid

public boolean isHiddenSsid ()

Returns
boolean

See also:

isInitialAutojoinEnabled

public boolean isInitialAutojoinEnabled ()

Returns
boolean

See also:

isMetered

public boolean isMetered ()

Returns
boolean

See also:

isUntrusted

public boolean isUntrusted ()

Returns
boolean

See also:

isUserInteractionRequired

public boolean isUserInteractionRequired ()

Returns
boolean

See also:

toString

public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of: 

 getClass().getName() + '@' + Integer.toHexString(hashCode())

Returns
String a string representation of the object.

writeToParcel

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.
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
Get news & tips
Blog Support

Except as noted, this content is licensed under Apache 2.0. For details and restrictions, see the Content License.

Android 7.0 r1 —

About Android Auto TV Wear Legal