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

wifi: Revise java doc to add more explanation

Browse Source 
1. restoreSoftApBackupData - document return value
and behavior if input is invalid
2. onCapabilityChanged - document behavior on register

Bug: 149871866
Test: make docs frameworks/base/wifi/
Change-Id: I02085e614a35b0bf07dbc47cffe7255555a0deb8
This commit is contained in:
lesl
2020-02-20 19:32:17 +08:00
parent e7701cd8e7
commit dba305d37d
1 changed files with 14 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -3763,11 +3763,19 @@ public class WifiManager {
}
/**
* Registers a callback for Soft AP. See {@link SoftApCallback}. Caller will receive the current
* soft AP state and number of connected devices immediately after a successful call to this API
* via callback. Note that receiving an immediate WIFI_AP_STATE_FAILED value for soft AP state
* indicates that the latest attempt to start soft AP has failed. Caller can unregister a
* previously registered callback using {@link #unregisterSoftApCallback}
* Registers a callback for Soft AP. See {@link SoftApCallback}. Caller will receive the
* following callbacks on registration:
* <ul>
* <li> {@link SoftApCallback#onStateChanged(int, int)}</li>
* <li> {@link SoftApCallback#onConnectedClientsChanged(List<WifiClient>)}</li>
* <li> {@link SoftApCallback#onInfoChanged(SoftApInfo)}</li>
* <li> {@link SoftApCallback#onCapabilityChanged(SoftApCapability)}</li>
* </ul>
* These will be dispatched on registration to provide the caller with the current state
* (and are not an indication of any current change). Note that receiving an immediate
* WIFI_AP_STATE_FAILED value for soft AP state indicates that the latest attempt to start
* soft AP has failed. Caller can unregister a previously registered callback using
* {@link #unregisterSoftApCallback}
* <p>
* Applications should have the
* {@link android.Manifest.permission#NETWORK_SETTINGS NETWORK_SETTINGS} permission. Callers
@@ -5069,7 +5077,7 @@ public class WifiManager {
}
/**
* Returns soft ap config from the backed up data.
* Returns soft ap config from the backed up data or null if data is invalid.
* @param data byte stream in the same format produced by {@link #retrieveSoftApBackupData()}
*
* @hide