# Print output for @column tags ?>
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)
.
Nested classes | |
---|---|
class |
WifiNetworkSuggestion.Builder
Builder used to create |
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)
Equals for network suggestions. |
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 |
int
|
getPriority()
|
String
|
getSsid()
Return the SSID of the network, or null if this is a Passpoint network. |
int
|
hashCode()
Returns a hash code value for the object. |
boolean
|
isAppInteractionRequired()
|
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 | |
---|---|
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 |
public boolean equals (Object obj)
Equals for network suggestions.
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. |
public WifiEnterpriseConfig getEnterpriseConfig ()
Get the WifiEnterpriseConfig, or null if unset.
Returns | |
---|---|
WifiEnterpriseConfig |
public PasspointConfiguration getPasspointConfig ()
Get the PasspointConfiguration
associated with this Suggestion, or null if this
Suggestion is not for a Passpoint network.
Returns | |
---|---|
PasspointConfiguration |
public int getPriority ()
Returns | |
---|---|
int |
Value is 0 or greater |
public String getSsid ()
Return the SSID of the network, or null if this is a Passpoint network.
Returns | |
---|---|
String |
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:
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.
equals(Object)
method, then calling the hashCode
method on each of
the two objects must produce the same integer result.
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. |
public boolean isAppInteractionRequired ()
Returns | |
---|---|
boolean |
public boolean isCredentialSharedWithUser ()
Returns | |
---|---|
boolean |
public boolean isEnhancedOpen ()
Returns | |
---|---|
boolean |
public boolean isHiddenSsid ()
Returns | |
---|---|
boolean |
public boolean isInitialAutojoinEnabled ()
Returns | |
---|---|
boolean |
public boolean isMetered ()
Returns | |
---|---|
boolean |
public boolean isUntrusted ()
Returns | |
---|---|
boolean |
public boolean isUserInteractionRequired ()
Returns | |
---|---|
boolean |
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. |
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 |