Added in API level 29

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 WifiNetworkSuggestion objects.

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

Boolean
equals(other: Any?)

MacAddress?

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

Int

Int

String?

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

Int

Boolean

Boolean

Boolean

Boolean

Boolean

Boolean

Boolean

Boolean

Return if a suggestion is for a restricted network

Boolean

Boolean

String

Unit
writeToParcel(dest: Parcel, flags: Int)

Properties
static Parcelable.Creator<WifiNetworkSuggestion!>

Constants

RANDOMIZATION_NON_PERSISTENT

Added in API level 31
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: 1

RANDOMIZATION_PERSISTENT

Added in API level 31
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: 0

Public methods

describeContents

Added in API level 29
fun describeContents(): Int
Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 29
fun equals(other: Any?): Boolean
Parameters
obj the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getBssid

Added in API level 30
fun getBssid(): MacAddress?

Get the BSSID, or null if unset.

getMacRandomizationSetting

Added in API level 33
fun getMacRandomizationSetting(): Int

Get the MAC randomization method.

Return
Int one of RANDOMIZATION_* values Value is android.net.wifi.WifiNetworkSuggestion#RANDOMIZATION_PERSISTENT, or android.net.wifi.WifiNetworkSuggestion#RANDOMIZATION_NON_PERSISTENT

getPasspointConfig

Added in API level 30
fun getPasspointConfig(): PasspointConfiguration?

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

getPriority

Added in API level 30
fun getPriority(): Int
Return
Int Value is 0 or greater

getPriorityGroup

Added in API level 31
fun getPriorityGroup(): Int
Return
Int Value is 0 or greater

getSsid

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

Added in API level 33
fun getSubscriptionGroup(): ParcelUuid?

Get the subscription Group UUID of the suggestion

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

getSubscriptionId

Added in API level 31
fun getSubscriptionId(): Int

getWifiSsid

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

Added in API level 29
fun hashCode(): Int
Return
Int a hash code value for this object.

isAppInteractionRequired

Added in API level 30
fun isAppInteractionRequired(): Boolean

isCarrierMerged

Added in API level 31
fun isCarrierMerged(): Boolean

isCredentialSharedWithUser

Added in API level 30
fun isCredentialSharedWithUser(): Boolean

isInitialAutojoinEnabled

Added in API level 30
fun isInitialAutojoinEnabled(): Boolean

isRestricted

Added in API level 33
fun isRestricted(): Boolean

Return if a suggestion is for a restricted network

Return
Boolean true if the suggestion is restricted, false otherwise

isUserInteractionRequired

Added in API level 30
fun isUserInteractionRequired(): Boolean

toString

Added in API level 29
fun toString(): String
Return
String a string representation of the object.

writeToParcel

Added in API level 29
fun writeToParcel(
    dest: Parcel,
    flags: Int
): Unit
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 android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 29
static val CREATOR: Parcelable.Creator<WifiNetworkSuggestion!>