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

Merge "wifi: document UnsupportedOperationException for Passpoint related APIs" into oc-dev

Browse Source
This commit is contained in:
TreeHugger Robot
2017-03-29 19:34:05 +00:00
committed by Android (Google) Code Review
parent 10180bb47b 1fe2a8cfa6
commit ef4b501c6d
1 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -858,6 +858,10 @@ public class WifiManager {
/** /**
* Returns a WifiConfiguration matching this ScanResult * Returns a WifiConfiguration matching this ScanResult
*
* An {@link UnsupportedOperationException} will be thrown if Passpoint is not enabled
* on the device.
*
* @param scanResult scanResult that represents the BSSID * @param scanResult scanResult that represents the BSSID
* @return {@link WifiConfiguration} that matches this BSSID or null * @return {@link WifiConfiguration} that matches this BSSID or null
* @hide * @hide
@@ -944,6 +948,8 @@ public class WifiManager {
* FQDN, the new configuration will replace the existing configuration. * FQDN, the new configuration will replace the existing configuration.
* *
* An {@link IllegalArgumentException} will be thrown on failure. * An {@link IllegalArgumentException} will be thrown on failure.
* An {@link UnsupportedOperationException} will be thrown if Passpoint is not enabled
* on the device.
* *
* @param config The Passpoint configuration to be added * @param config The Passpoint configuration to be added
*/ */
@@ -961,6 +967,8 @@ public class WifiManager {
* Remove the Passpoint configuration identified by its FQDN (Fully Qualified Domain Name). * Remove the Passpoint configuration identified by its FQDN (Fully Qualified Domain Name).
* *
* An {@link IllegalArgumentException} will be thrown on failure. * An {@link IllegalArgumentException} will be thrown on failure.
* An {@link UnsupportedOperationException} will be thrown if Passpoint is not enabled
* on the device.
* *
* @param fqdn The FQDN of the Passpoint configuration to be removed * @param fqdn The FQDN of the Passpoint configuration to be removed
*/ */
@@ -979,6 +987,9 @@ public class WifiManager {
* *
* An empty list will be returned when no configurations are installed. * An empty list will be returned when no configurations are installed.
* *
* An {@link UnsupportedOperationException} will be thrown if Passpoint is not enabled
* on the device.
*
* @return A list of {@link PasspointConfiguration} * @return A list of {@link PasspointConfiguration}
*/ */
public List<PasspointConfiguration> getPasspointConfigurations() { public List<PasspointConfiguration> getPasspointConfigurations() {
@@ -995,6 +1006,9 @@ public class WifiManager {
* {@link #EXTRA_ICON} will indicate the result of the request. * {@link #EXTRA_ICON} will indicate the result of the request.
* A missing intent extra {@link #EXTRA_ICON} will indicate a failure. * A missing intent extra {@link #EXTRA_ICON} will indicate a failure.
* *
* An {@link UnsupportedOperationException} will be thrown if Passpoint is not enabled
* on the device.
*
* @param bssid The BSSID of the AP * @param bssid The BSSID of the AP
* @param fileName Name of the icon file (remote file) to query from the AP * @param fileName Name of the icon file (remote file) to query from the AP
*/ */