Added in API level 34

WifiAvailableChannel

---

Kotlin |Java

class WifiAvailableChannel : Parcelable

kotlin.Any
↳	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
static Int	OP_MODE_SAP Wifi SoftAp (Mobile Hotspot) operational mode.
static Int	OP_MODE_STA Wifi Infrastructure client (STA) operational mode.
static Int	OP_MODE_TDLS Wifi Tunneled Direct Link Setup (TDLS) operational mode.
static Int	OP_MODE_WIFI_AWARE Wifi Aware (NAN) operational mode.
static Int	OP_MODE_WIFI_DIRECT_CLI Wifi Direct client (CLI) operational mode.
static Int	OP_MODE_WIFI_DIRECT_GO Wifi Direct Group Owner (GO) operational mode.

Inherited constants

From class 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: 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)". Some implementations may want to release resources at this point.

Public constructors
WifiAvailableChannel(freq: Int, opModes: Int)

Public methods
Int	describeContents()
Boolean	equals(other: Any?) 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()
String	toString()
Unit	writeToParcel(dest: Parcel, flags: Int) Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<WifiAvailableChannel!>	CREATOR

Constants

OP_MODE_SAP

Added in API level 34

static val OP_MODE_SAP: Int

Wifi SoftAp (Mobile Hotspot) operational mode.

Value: 2

OP_MODE_STA

Added in API level 34

static val OP_MODE_STA: Int

Wifi Infrastructure client (STA) operational mode.

Value: 1

OP_MODE_TDLS

Added in API level 34

static val OP_MODE_TDLS: Int

Wifi Tunneled Direct Link Setup (TDLS) operational mode.

Value: 32

OP_MODE_WIFI_AWARE

Added in API level 34

static val OP_MODE_WIFI_AWARE: Int

Wifi Aware (NAN) operational mode.

Value: 16

OP_MODE_WIFI_DIRECT_CLI

Added in API level 34

static val OP_MODE_WIFI_DIRECT_CLI: Int

Wifi Direct client (CLI) operational mode.

Value: 4

OP_MODE_WIFI_DIRECT_GO

Added in API level 34

static val OP_MODE_WIFI_DIRECT_GO: Int

Wifi Direct Group Owner (GO) operational mode.

Value: 8

Public constructors

WifiAvailableChannel

Added in API level 34

WifiAvailableChannel(
    freq: Int, 
    opModes: Int)

Parameters
opModes	Int: Value is either 0 or a combination of android.net.wifi.WifiAvailableChannel#OP_MODE_STA, android.net.wifi.WifiAvailableChannel#OP_MODE_SAP, android.net.wifi.WifiAvailableChannel#OP_MODE_WIFI_DIRECT_CLI, android.net.wifi.WifiAvailableChannel#OP_MODE_WIFI_DIRECT_GO, android.net.wifi.WifiAvailableChannel#OP_MODE_WIFI_AWARE, and android.net.wifi.WifiAvailableChannel#OP_MODE_TDLS

Public methods

describeContents

Added in API level 34

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 34

fun equals(other: Any?): Boolean

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	the reference object with which to compare.
o	This value may be null.

Return
Boolean	true if this object is the same as the obj argument; false otherwise.

getChannelWidth

Added in API level Baklava

fun getChannelWidth(): Int

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

Return

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 android.net.wifi.ScanResult#CHANNEL_WIDTH_20MHZ, android.net.wifi.ScanResult#CHANNEL_WIDTH_40MHZ, android.net.wifi.ScanResult#CHANNEL_WIDTH_80MHZ, android.net.wifi.ScanResult#CHANNEL_WIDTH_160MHZ, android.net.wifi.ScanResult#CHANNEL_WIDTH_80MHZ_PLUS_MHZ, or android.net.wifi.ScanResult#CHANNEL_WIDTH_320MHZ

getFrequencyMhz

Added in API level 34

fun getFrequencyMhz(): Int

Get the channel frequency in MHz.

getOperationalModes

Added in API level 34

fun getOperationalModes(): Int

Get the operational modes allowed on a channel.

Return
Int	Value is either 0 or a combination of android.net.wifi.WifiAvailableChannel#OP_MODE_STA, android.net.wifi.WifiAvailableChannel#OP_MODE_SAP, android.net.wifi.WifiAvailableChannel#OP_MODE_WIFI_DIRECT_CLI, android.net.wifi.WifiAvailableChannel#OP_MODE_WIFI_DIRECT_GO, android.net.wifi.WifiAvailableChannel#OP_MODE_WIFI_AWARE, and android.net.wifi.WifiAvailableChannel#OP_MODE_TDLS

hashCode

Added in API level 34

fun hashCode(): Int

Return
Int	a hash code value for this object.

toString

Added in API level 34

fun toString(): String

Return
String	a string representation of the object.

writeToParcel

Added in API level 34

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

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_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 34

static val CREATOR: Parcelable.Creator<WifiAvailableChannel!>