WifiNetworkSpecifier


public final class WifiNetworkSpecifier
extends NetworkSpecifier implements Parcelable

java.lang.Object
   ↳ android.net.NetworkSpecifier
     ↳ android.net.wifi.WifiNetworkSpecifier


Network specifier object used to request a Wi-Fi network. Apps should use the WifiNetworkSpecifier.Builder class to create an instance.

This specifier can be used to request a local-only connection on devices that support concurrent connections (indicated via WifiManager#isStaConcurrencyForLocalOnlyConnectionsSupported() and if the initiating app targets SDK ≥ Build.VERSION_CODES.S or is a system app. These local-only connections may be brought up as a secondary concurrent connection (primary connection will be used for networks with internet connectivity available to the user and all apps).

This specifier can also be used to listen for connected Wi-Fi networks on a particular band. Additionally, some devices may support requesting a connection to a particular band. If the device does not support such a request, it will send NetworkCallback#onUnavailable() upon request to the callback passed to ConnectivityManager#requestNetwork(NetworkRequest, NetworkCallback) or equivalent. See Builder#build() for details.

Summary

Nested classes

class WifiNetworkSpecifier.Builder

Builder used to create WifiNetworkSpecifier objects. 

Inherited constants

Fields

public static final Creator<WifiNetworkSpecifier> 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.

int getBand()

The band for this Wi-Fi network specifier.

int[] getPreferredChannelFrequenciesMhz()

The preferred channels fot this network specifier.

int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

Added in API level 29
public static final Creator<WifiNetworkSpecifier> 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.

getBand

Added in API level 31
public int getBand ()

The band for this Wi-Fi network specifier.

Returns
int Value is ScanResult.UNSPECIFIED, ScanResult.WIFI_BAND_24_GHZ, ScanResult.WIFI_BAND_5_GHZ, ScanResult.WIFI_BAND_6_GHZ, or ScanResult.WIFI_BAND_60_GHZ

getPreferredChannelFrequenciesMhz

Added in API level 34
public int[] getPreferredChannelFrequenciesMhz ()

The preferred channels fot this network specifier.

Returns
int[] This value cannot be null.

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.

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