Added in API level 30

SoftApConfiguration

---

Kotlin |Java

class SoftApConfiguration : Parcelable

kotlin.Any
↳	android.net.wifi.SoftApConfiguration

Configuration for a soft access point (a.k.a. Soft AP, SAP, Hotspot).

This is input for the framework provided by a client app, i.e. it exposes knobs to instruct the framework how it should configure a hotspot.

System apps can use this to configure a tethered hotspot or local-only hotspot.

Instances of this class are immutable.

Summary

Nested classes
	Builder Builds a SoftApConfiguration, which allows an app to configure various aspects of a Soft AP.

Constants
static Int	BAND_2GHZ 2GHz band.
static Int	BAND_5GHZ 5GHz band.
static Int	BAND_60GHZ 60GHz band.
static Int	BAND_6GHZ 6GHz band.
static Int	SECURITY_TYPE_OPEN THe definition of security type OPEN.
static Int	SECURITY_TYPE_WPA2_PSK The definition of security type WPA2-PSK.
static Int	SECURITY_TYPE_WPA3_OWE The definition of security type WPA3-OWE.
static Int	SECURITY_TYPE_WPA3_OWE_TRANSITION The definition of security type WPA3-OWE Transition.
static Int	SECURITY_TYPE_WPA3_SAE The definition of security type WPA3-SAE.
static Int	SECURITY_TYPE_WPA3_SAE_TRANSITION The definition of security type WPA3-SAE Transition 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 methods
Int	describeContents()
Boolean	equals(other: Any?)
MacAddress?	getBssid() Returns MAC address set to be BSSID for the AP.
SparseIntArray	getChannels() Returns SparseIntArray (key: BandType , value: channel) that consists of the configured bands and channels for the AP(s).
String?	getPassphrase() Returns String set to be passphrase for current AP.
Int	getSecurityType() Get security type params which depends on which security passphrase to set.
String?	getSsid() Return the UTF-8 String set to be the SSID for the AP.
WifiSsid?	getWifiSsid() Return WifiSsid set to be the SSID for the AP.
Int	hashCode()
Boolean	isHiddenSsid() Returns Boolean set to be indicate hidden (true: doesn't broadcast its SSID) or not (false: broadcasts its SSID) for the AP.
String	toString()
Unit	writeToParcel(dest: Parcel, flags: Int) Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<SoftApConfiguration!>	CREATOR

Constants

BAND_2GHZ

Added in API level 36

static val BAND_2GHZ: Int

2GHz band.

Value: 1

BAND_5GHZ

Added in API level 36

static val BAND_5GHZ: Int

5GHz band.

Value: 2

BAND_60GHZ

Added in API level 36

static val BAND_60GHZ: Int

60GHz band.

Value: 8

BAND_6GHZ

Added in API level 36

static val BAND_6GHZ: Int

6GHz band.

Value: 4

SECURITY_TYPE_OPEN

Added in API level 30

static val SECURITY_TYPE_OPEN: Int

THe definition of security type OPEN.

Value: 0

SECURITY_TYPE_WPA2_PSK

Added in API level 30

static val SECURITY_TYPE_WPA2_PSK: Int

The definition of security type WPA2-PSK.

Value: 1

SECURITY_TYPE_WPA3_OWE

Added in API level 33

static val SECURITY_TYPE_WPA3_OWE: Int

The definition of security type WPA3-OWE.

Value: 5

SECURITY_TYPE_WPA3_OWE_TRANSITION

Added in API level 33

static val SECURITY_TYPE_WPA3_OWE_TRANSITION: Int

The definition of security type WPA3-OWE Transition.

Value: 4

SECURITY_TYPE_WPA3_SAE

Added in API level 30

static val SECURITY_TYPE_WPA3_SAE: Int

The definition of security type WPA3-SAE.

Value: 3

SECURITY_TYPE_WPA3_SAE_TRANSITION

Added in API level 30

static val SECURITY_TYPE_WPA3_SAE_TRANSITION: Int

The definition of security type WPA3-SAE Transition mode.

Value: 2

Public methods

describeContents

Added in API level 30

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 30

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?

Returns MAC address set to be BSSID for the AP.

Return
MacAddress?	This value may be null.

getChannels

Added in API level 36

fun getChannels(): SparseIntArray

Returns SparseIntArray (key: BandType , value: channel) that consists of the configured bands and channels for the AP(s). The returned channel value is Wi-Fi channel numbering. Reference the Wi-Fi channel numbering and the channelization in IEEE 802.11-2016 specifications, section 17.3.8.4.2, 17.3.8.4.3 and Table 15-6. Note: return array may only include one channel when current setting is single AP mode. See also Builder.setChannels(SparseIntArray).

Return
SparseIntArray	This value cannot be null.

getPassphrase

Added in API level 30

fun getPassphrase(): String?

Returns String set to be passphrase for current AP.

Return
String?	This value may be null.

getSecurityType

Added in API level 30

fun getSecurityType(): Int

Get security type params which depends on which security passphrase to set.

Return

Int

One of: SECURITY_TYPE_OPEN, SECURITY_TYPE_WPA2_PSK, SECURITY_TYPE_WPA3_SAE_TRANSITION, SECURITY_TYPE_WPA3_SAE, SECURITY_TYPE_WPA3_OWE_TRANSITION, SECURITY_TYPE_WPA3_OWE Value is android.net.wifi.SoftApConfiguration#SECURITY_TYPE_OPEN, android.net.wifi.SoftApConfiguration#SECURITY_TYPE_WPA2_PSK, android.net.wifi.SoftApConfiguration#SECURITY_TYPE_WPA3_SAE_TRANSITION, android.net.wifi.SoftApConfiguration#SECURITY_TYPE_WPA3_SAE, android.net.wifi.SoftApConfiguration#SECURITY_TYPE_WPA3_OWE_TRANSITION, or android.net.wifi.SoftApConfiguration#SECURITY_TYPE_WPA3_OWE

getSsid

Added in API level 30
Deprecated in API level 33

fun getSsid(): String?

Deprecated: Use getWifiSsid() instead.

Return the UTF-8 String set to be the SSID for the AP. If the SSID cannot be decoded as UTF-8, then this will return WifiManager.UNKNOWN_SSID.

Return
String?	This value may be null.

getWifiSsid

Added in API level 33

fun getWifiSsid(): WifiSsid?

Return WifiSsid set to be the SSID for the AP.

Return
WifiSsid?	This value may be null.

hashCode

Added in API level 30

fun hashCode(): Int

Return
Int	a hash code value for this object.

isHiddenSsid

Added in API level 30

fun isHiddenSsid(): Boolean

Returns Boolean set to be indicate hidden (true: doesn't broadcast its SSID) or not (false: broadcasts its SSID) for the AP.

toString

Added in API level 30

fun toString(): String

Return
String	a string representation of the object.

writeToParcel

Added in API level 30

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 30

static val CREATOR: Parcelable.Creator<SoftApConfiguration!>