Most visited

Recently visited

Results for

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

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.

Inherited constants

From interface android.os.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(Parcel, int)`: 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)`".

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 `PasspointConfiguration` associated with this Suggestion, or null if this Suggestion is not for a Passpoint network.
`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

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

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)

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.

getBssid

public MacAddress getBssid ()

Get the BSSID, or null if unset.

Returns
`MacAddress`

See also:

WifiNetworkSuggestion.Builder.setBssid(MacAddress)

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:

WifiNetworkSuggestion.Builder.setPriority(int)

getSsid

public String getSsid ()

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

Returns
`String`

See also:

WifiNetworkSuggestion.Builder.setSsid(String)

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:

WifiNetworkSuggestion.Builder.setIsAppInteractionRequired(boolean)

isCredentialSharedWithUser

public boolean isCredentialSharedWithUser ()

Returns
`boolean`

See also:

WifiNetworkSuggestion.Builder.setCredentialSharedWithUser(boolean)

isEnhancedOpen

public boolean isEnhancedOpen ()

Returns
`boolean`

See also:

WifiNetworkSuggestion.Builder.setIsEnhancedOpen(boolean)

isHiddenSsid

public boolean isHiddenSsid ()

Returns
`boolean`

See also:

WifiNetworkSuggestion.Builder.setIsHiddenSsid(boolean)

isInitialAutojoinEnabled

public boolean isInitialAutojoinEnabled ()

Returns
`boolean`

See also:

WifiNetworkSuggestion.Builder.setIsInitialAutojoinEnabled(boolean)

isMetered

public boolean isMetered ()

Returns
`boolean`

See also:

WifiNetworkSuggestion.Builder.setIsMetered(boolean)

isUntrusted

public boolean isUntrusted ()

Returns
`boolean`

See also:

WifiNetworkSuggestion.Builder.setUntrusted(boolean)

isUserInteractionRequired

public boolean isUserInteractionRequired ()

Returns
`boolean`

See also:

WifiNetworkSuggestion.Builder.setIsUserInteractionRequired(boolean)

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

Interfaces

Classes

Enums

Most visited

Recently visited

Results for

WifiNetworkSuggestion

Summary

Nested classes

Inherited constants

Fields

Public methods

Inherited methods

Fields

CREATOR

Public methods

describeContents

equals

getBssid

getEnterpriseConfig

getPassphrase

getPasspointConfig

getPriority

getSsid

hashCode

isAppInteractionRequired

isCredentialSharedWithUser

isEnhancedOpen

isHiddenSsid

isInitialAutojoinEnabled

isMetered

isUntrusted

isUserInteractionRequired

toString

writeToParcel