summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author Rubin Xu <rubinxu@google.com> 2018-03-02 10:41:02 +0000
committer Rubin Xu <rubinxu@google.com> 2018-03-06 15:34:42 +0000
commitdf2ec09a9ca74556ab8140a1cc5450b755f21dd4 (patch)
tree5f4bae713eee00daba1b32b7c7c6e4164a1c6a0b
parent9bbd9661c05cbf0895e9468519ebf8effa655617 (diff)
Update javadoc for WifiConfiguration.setHttpProxy
Clarify that this method is only available to device owner and profile owner. Change-Id: I2f77a16442a0403cc7895bdc3b8375cb22cb68a9 Fixes: 70038439 Test: builds
-rw-r--r--wifi/java/android/net/wifi/WifiConfiguration.java12
1 files changed, 8 insertions, 4 deletions
diff --git a/wifi/java/android/net/wifi/WifiConfiguration.java b/wifi/java/android/net/wifi/WifiConfiguration.java
index ddcf327b9dd1..93fa5987aa9c 100644
--- a/wifi/java/android/net/wifi/WifiConfiguration.java
+++ b/wifi/java/android/net/wifi/WifiConfiguration.java
@@ -2076,11 +2076,15 @@ public class WifiConfiguration implements Parcelable {
}
/**
- * Set the {@link ProxyInfo} for this WifiConfiguration.
+ * Set the {@link ProxyInfo} for this WifiConfiguration. This method should only be used by a
+ * device owner or profile owner. When other apps attempt to save a {@link WifiConfiguration}
+ * with modified proxy settings, the methods {@link WifiManager#addNetwork} and
+ * {@link WifiManager#updateNetwork} fail and return {@code -1}.
+ *
* @param httpProxy {@link ProxyInfo} representing the httpProxy to be used by this
- * WifiConfiguration. Setting this {@code null} will explicitly set no proxy,
- * removing any proxy that was previously set.
- * @exception throw IllegalArgumentException for invalid httpProxy
+ * WifiConfiguration. Setting this to {@code null} will explicitly set no
+ * proxy, removing any proxy that was previously set.
+ * @exception IllegalArgumentException for invalid httpProxy
*/
public void setHttpProxy(ProxyInfo httpProxy) {
if (httpProxy == null) {