SoftApConfiguration
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 | |
|---|---|
|
Builds a |
|
| Constants | |
|---|---|
| static Int |
2GHz band. |
| static Int |
5GHz band. |
| static Int |
60GHz band. |
| static Int |
6GHz band. |
| static Int |
THe definition of security type OPEN. |
| static Int |
The definition of security type WPA2-PSK. |
| static Int |
The definition of security type WPA3-OWE. |
| static Int |
The definition of security type WPA3-OWE Transition. |
| static Int |
The definition of security type WPA3-SAE. |
| static Int |
The definition of security type WPA3-SAE Transition mode. |
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| Boolean |
Indicates whether some other object is "equal to" this one. |
| MacAddress? |
getBssid()Returns MAC address set to be BSSID for the AP. |
| SparseIntArray |
Returns SparseIntArray (key: |
| String? |
Returns String set to be passphrase for current AP. |
| Int |
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? |
Return WifiSsid set to be the SSID for the AP. |
| Int |
hashCode()Returns a hash code value for the object. |
| Boolean |
Returns Boolean set to be indicate hidden (true: doesn't broadcast its SSID) or not (false: broadcasts its SSID) for the AP. |
| String |
toString()Returns a string representation of the object. |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<SoftApConfiguration!> | |
Constants
SECURITY_TYPE_OPEN
static val SECURITY_TYPE_OPEN: Int
THe definition of security type OPEN.
Value: 0SECURITY_TYPE_WPA2_PSK
static val SECURITY_TYPE_WPA2_PSK: Int
The definition of security type WPA2-PSK.
Value: 1SECURITY_TYPE_WPA3_OWE
static val SECURITY_TYPE_WPA3_OWE: Int
The definition of security type WPA3-OWE.
Value: 5SECURITY_TYPE_WPA3_OWE_TRANSITION
static val SECURITY_TYPE_WPA3_OWE_TRANSITION: Int
The definition of security type WPA3-OWE Transition.
Value: 4SECURITY_TYPE_WPA3_SAE
static val SECURITY_TYPE_WPA3_SAE: Int
The definition of security type WPA3-SAE.
Value: 3SECURITY_TYPE_WPA3_SAE_TRANSITION
static val SECURITY_TYPE_WPA3_SAE_TRANSITION: Int
The definition of security type WPA3-SAE Transition mode.
Value: 2Public methods
describeContents
fun describeContents(): Int
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.
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
equals
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
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. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getBssid
fun getBssid(): MacAddress?
Returns MAC address set to be BSSID for the AP.
| Return | |
|---|---|
MacAddress? |
This value may be null. |
getChannels
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
fun getPassphrase(): String?
Returns String set to be passphrase for current AP.
| Return | |
|---|---|
String? |
This value may be null. |
getSecurityType
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 one of the following: |
getSsid
fungetSsid(): 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
fun getWifiSsid(): WifiSsid?
Return WifiSsid set to be the SSID for the AP.
| Return | |
|---|---|
WifiSsid? |
This value may be null. |
hashCode
fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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
equalsmethod, then calling thehashCodemethod 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
equalsmethod, then calling thehashCodemethod 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.
| Return | |
|---|---|
Int |
a hash code value for this object. |
isHiddenSsid
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
fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
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 the following:
|