SoftApConfiguration
public
final
class
SoftApConfiguration
extends Object
implements
Parcelable
java.lang.Object | |
↳ | 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 | |
---|---|
class |
SoftApConfiguration.Builder
Builds a |
Constants | |
---|---|
int |
BAND_2GHZ
2GHz band. |
int |
BAND_5GHZ
5GHz band. |
int |
BAND_60GHZ
60GHz band. |
int |
BAND_6GHZ
6GHz band. |
int |
SECURITY_TYPE_OPEN
THe definition of security type OPEN. |
int |
SECURITY_TYPE_WPA2_PSK
The definition of security type WPA2-PSK. |
int |
SECURITY_TYPE_WPA3_OWE
The definition of security type WPA3-OWE. |
int |
SECURITY_TYPE_WPA3_OWE_TRANSITION
The definition of security type WPA3-OWE Transition. |
int |
SECURITY_TYPE_WPA3_SAE
The definition of security type WPA3-SAE. |
int |
SECURITY_TYPE_WPA3_SAE_TRANSITION
The definition of security type WPA3-SAE Transition mode. |
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<SoftApConfiguration> |
CREATOR
|
Public methods | |
---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
boolean
|
equals(Object otherObj)
Indicates whether some other object is "equal to" this one. |
MacAddress
|
getBssid()
Returns MAC address set to be BSSID for the AP. |
SparseIntArray
|
getChannels()
Returns SparseIntArray (key: |
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()
This method was deprecated
in API level 33.
Use |
WifiSsid
|
getWifiSsid()
Return WifiSsid set to be the SSID for the AP. |
int
|
hashCode()
Returns a hash code value for the object. |
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()
Returns a string representation of the object. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
Constants
BAND_2GHZ
public static final int BAND_2GHZ
2GHz band.
Constant Value: 1 (0x00000001)
BAND_5GHZ
public static final int BAND_5GHZ
5GHz band.
Constant Value: 2 (0x00000002)
BAND_60GHZ
public static final int BAND_60GHZ
60GHz band.
Constant Value: 8 (0x00000008)
BAND_6GHZ
public static final int BAND_6GHZ
6GHz band.
Constant Value: 4 (0x00000004)
SECURITY_TYPE_OPEN
public static final int SECURITY_TYPE_OPEN
THe definition of security type OPEN.
Constant Value: 0 (0x00000000)
SECURITY_TYPE_WPA2_PSK
public static final int SECURITY_TYPE_WPA2_PSK
The definition of security type WPA2-PSK.
Constant Value: 1 (0x00000001)
SECURITY_TYPE_WPA3_OWE
public static final int SECURITY_TYPE_WPA3_OWE
The definition of security type WPA3-OWE.
Constant Value: 5 (0x00000005)
SECURITY_TYPE_WPA3_OWE_TRANSITION
public static final int SECURITY_TYPE_WPA3_OWE_TRANSITION
The definition of security type WPA3-OWE Transition.
Constant Value: 4 (0x00000004)
SECURITY_TYPE_WPA3_SAE
public static final int SECURITY_TYPE_WPA3_SAE
The definition of security type WPA3-SAE.
Constant Value: 3 (0x00000003)
SECURITY_TYPE_WPA3_SAE_TRANSITION
public static final int SECURITY_TYPE_WPA3_SAE_TRANSITION
The definition of security type WPA3-SAE Transition mode.
Constant Value: 2 (0x00000002)
Fields
Public methods
describeContents
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
public boolean equals (Object otherObj)
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
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons 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 | |
---|---|
otherObj |
Object : the reference object with which to compare. |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
getBssid
public MacAddress getBssid ()
Returns MAC address set to be BSSID for the AP.
Returns | |
---|---|
MacAddress |
This value may be null . |
getChannels
public SparseIntArray getChannels ()
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)
.
Returns | |
---|---|
SparseIntArray |
This value cannot be null . |
getPassphrase
public String getPassphrase ()
Returns String set to be passphrase for current AP.
Returns | |
---|---|
String |
This value may be null . |
getSecurityType
public int getSecurityType ()
Get security type params which depends on which security passphrase to set.
getSsid
public String getSsid ()
This method was deprecated
in API level 33.
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
.
Returns | |
---|---|
String |
This value may be null . |
getWifiSsid
public WifiSsid getWifiSsid ()
Return WifiSsid set to be the SSID for the AP.
Returns | |
---|---|
WifiSsid |
This value may be null . |
hashCode
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 inequals
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 thehashCode
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 thehashCode
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. |
isHiddenSsid
public boolean isHiddenSsid ()
Returns Boolean set to be indicate hidden (true: doesn't broadcast its SSID) or not (false: broadcasts its SSID) for the AP.
Returns | |
---|---|
boolean |
toString
public String toString ()
Returns a string representation of the object.
Returns | |
---|---|
String |
a string representation of the object. |
writeToParcel
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 |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-01-23 UTC.