Added in API level 34

WifiAvailableChannel

Kotlin |Java

public final class WifiAvailableChannel
extends Object implements Parcelable

java.lang.Object
↳	android.net.wifi.WifiAvailableChannel

Contains information about a Wifi channel and bitmask of Wifi operational modes allowed on that channel. Use WifiManager.getAllowedChannels(int, int) to retrieve the list of channels filtered by regulatory constraints. Use WifiManager.getUsableChannels(int, int) to retrieve the list of channels filtered by regulatory and dynamic constraints like concurrency and interference due to other radios.

Summary

Constants
`int`	`OP_MODE_SAP` Wifi SoftAp (Mobile Hotspot) operational mode.
`int`	`OP_MODE_STA` Wifi Infrastructure client (STA) operational mode.
`int`	`OP_MODE_TDLS` Wifi Tunneled Direct Link Setup (TDLS) operational mode.
`int`	`OP_MODE_WIFI_AWARE` Wifi Aware (NAN) operational mode.
`int`	`OP_MODE_WIFI_DIRECT_CLI` Wifi Direct client (CLI) operational mode.
`int`	`OP_MODE_WIFI_DIRECT_GO` Wifi Direct Group Owner (GO) operational mode.

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<WifiAvailableChannel>`	`CREATOR`

Public constructors
`WifiAvailableChannel(int freq, int opModes)`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`boolean`	`equals(Object o)` Indicates whether some other object is "equal to" this one.
`int`	`getChannelWidth()` Get the channel bandwidth, which indicates the amount of frequency spectrum allocated for data transmission within a channel.
`int`	`getFrequencyMhz()` Get the channel frequency in MHz.
`int`	`getOperationalModes()` Get the operational modes allowed on a channel.
`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

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 timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

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.

Constants

OP_MODE_SAP

Added in API level 34

public static final int OP_MODE_SAP

Wifi SoftAp (Mobile Hotspot) operational mode.

Constant Value: 2 (0x00000002)

OP_MODE_STA

Added in API level 34

public static final int OP_MODE_STA

Wifi Infrastructure client (STA) operational mode.

Constant Value: 1 (0x00000001)

OP_MODE_TDLS

Added in API level 34

public static final int OP_MODE_TDLS

Wifi Tunneled Direct Link Setup (TDLS) operational mode.

Constant Value: 32 (0x00000020)

OP_MODE_WIFI_AWARE

Added in API level 34

public static final int OP_MODE_WIFI_AWARE

Wifi Aware (NAN) operational mode.

Constant Value: 16 (0x00000010)

OP_MODE_WIFI_DIRECT_CLI

Added in API level 34

public static final int OP_MODE_WIFI_DIRECT_CLI

Wifi Direct client (CLI) operational mode.

Constant Value: 4 (0x00000004)

OP_MODE_WIFI_DIRECT_GO

Added in API level 34

public static final int OP_MODE_WIFI_DIRECT_GO

Wifi Direct Group Owner (GO) operational mode.

Constant Value: 8 (0x00000008)

Fields

CREATOR

Added in API level 34

public static final Creator<WifiAvailableChannel> CREATOR

Public constructors

WifiAvailableChannel

Added in API level 34

public WifiAvailableChannel (int freq, 
                int opModes)

Parameters
`freq`	`int`
`opModes`	`int`: Value is either `0` or a combination of `OP_MODE_STA`, `OP_MODE_SAP`, `OP_MODE_WIFI_DIRECT_CLI`, `OP_MODE_WIFI_DIRECT_GO`, `OP_MODE_WIFI_AWARE`, and `OP_MODE_TDLS`

Public methods

describeContents

Added in API level 34

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 34

public boolean equals (Object o)

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
`o`	`Object`: This value may be `null`.

Returns
`boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getChannelWidth

Added in Android Baklava

public int getChannelWidth ()

Get the channel bandwidth, which indicates the amount of frequency spectrum allocated for data transmission within a channel.

Returns

Returns
`int`	the bandwidth representation of the Wi-Fi channel from `ScanResult.CHANNEL_WIDTH_20MHZ`, `ScanResult.CHANNEL_WIDTH_40MHZ`, `ScanResult.CHANNEL_WIDTH_80MHZ`, `ScanResult.CHANNEL_WIDTH_160MHZ`, `ScanResult.CHANNEL_WIDTH_80MHZ_PLUS_MHZ` or `ScanResult.CHANNEL_WIDTH_320MHZ`. Value is `ScanResult.CHANNEL_WIDTH_20MHZ`, `ScanResult.CHANNEL_WIDTH_40MHZ`, `ScanResult.CHANNEL_WIDTH_80MHZ`, `ScanResult.CHANNEL_WIDTH_160MHZ`, `ScanResult.CHANNEL_WIDTH_80MHZ_PLUS_MHZ`, or `ScanResult.CHANNEL_WIDTH_320MHZ`

int

the bandwidth representation of the Wi-Fi channel from ScanResult.CHANNEL_WIDTH_20MHZ, ScanResult.CHANNEL_WIDTH_40MHZ, ScanResult.CHANNEL_WIDTH_80MHZ, ScanResult.CHANNEL_WIDTH_160MHZ, ScanResult.CHANNEL_WIDTH_80MHZ_PLUS_MHZ or ScanResult.CHANNEL_WIDTH_320MHZ. Value is ScanResult.CHANNEL_WIDTH_20MHZ, ScanResult.CHANNEL_WIDTH_40MHZ, ScanResult.CHANNEL_WIDTH_80MHZ, ScanResult.CHANNEL_WIDTH_160MHZ, ScanResult.CHANNEL_WIDTH_80MHZ_PLUS_MHZ, or ScanResult.CHANNEL_WIDTH_320MHZ

getFrequencyMhz

Added in API level 34

public int getFrequencyMhz ()

Get the channel frequency in MHz.

Returns
`int`

getOperationalModes

Added in API level 34

public int getOperationalModes ()

Get the operational modes allowed on a channel.

Returns
`int`	Value is either `0` or a combination of `OP_MODE_STA`, `OP_MODE_SAP`, `OP_MODE_WIFI_DIRECT_CLI`, `OP_MODE_WIFI_DIRECT_GO`, `OP_MODE_WIFI_AWARE`, and `OP_MODE_TDLS`

hashCode

Added in API level 34

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 34

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

writeToParcel

Added in API level 34

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`dest`	`Parcel`: 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