Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clarify JavaDoc for SoftAP APIs

Browse Source 
Add more documentation to WifiManager's
EXTRA_WIFI_AP_INTERFACE_NAME, EXTRA_WIFI_AP_MODE,
and startSoftAp().

Bug: 143138160
Test: compiles
Change-Id: I15a22ca8d0718e02e606ba6e19d20b1727aa93d2
Merged-In: I15a22ca8d0718e02e606ba6e19d20b1727aa93d2
This commit is contained in:
David Su
2019-10-22 13:50:05 -07:00
parent 562f07e9ed
commit 1cef853e2d
1 changed files with 14 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
wifi/java/android/net/wifi/WifiManager.java
View File

@@ -533,7 +533,9 @@ public class WifiManager {
@SystemApi
public static final String EXTRA_PREVIOUS_WIFI_AP_STATE = "previous_wifi_state";
/**
* The interface used for the softap.
* The lookup key for a String extra that stores the interface name used for the Soft AP.
* This extra is included in the broadcast {@link #WIFI_AP_STATE_CHANGED_ACTION}.
* Retrieve its value with {@link android.content.Intent#getStringExtra(String)}.
*
* @hide
*/
@@ -541,9 +543,10 @@ public class WifiManager {
public static final String EXTRA_WIFI_AP_INTERFACE_NAME =
"android.net.wifi.extra.WIFI_AP_INTERFACE_NAME";
/**
* The intended ip mode for this softap.
* @see #IFACE_IP_MODE_TETHERED
* @see #IFACE_IP_MODE_LOCAL_ONLY
* The lookup key for an int extra that stores the intended IP mode for this Soft AP.
* One of {@link #IFACE_IP_MODE_TETHERED} or {@link #IFACE_IP_MODE_LOCAL_ONLY}.
* This extra is included in the broadcast {@link #WIFI_AP_STATE_CHANGED_ACTION}.
* Retrieve its value with {@link android.content.Intent#getIntExtra(String, int)}.
*
* @hide
*/
@@ -2578,12 +2581,13 @@ public class WifiManager {
}
/**
* Start SoftAp mode with the specified configuration.
* Note that starting in access point mode disables station
* mode operation
* @param wifiConfig SSID, security and channel details as
* part of WifiConfiguration
* @return {@code true} if the operation succeeds, {@code false} otherwise
* Start Soft AP (hotspot) mode with the specified configuration.
* Note that starting Soft AP mode may disable station mode operation if the device does not
* support concurrency.
* @param wifiConfig SSID, security and channel details as part of WifiConfiguration, or null to
* use the persisted Soft AP configuration that was previously set using
* {@link #setWifiApConfiguration(WifiConfiguration)}.
* @return {@code true} if the operation succeeded, {@code false} otherwise
*
* @hide
*/