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

Merge "Change doc for suggestion API" into rvc-dev

Browse Source
This commit is contained in:
TreeHugger Robot
2020-04-10 03:19:43 +00:00
committed by Android (Google) Code Review
parent cb437ade00 69e1136884
commit e6897b1950
1 changed files with 15 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -179,6 +179,8 @@ public class WifiManager {
/** /**
* Reason code if one or more of the network suggestions added already exists in platform's * Reason code if one or more of the network suggestions added already exists in platform's
* database. * database.
* Note: this code will not be returned with Android 11 as in-place modification is allowed,
* please check {@link #addNetworkSuggestions(List)}.
* @see WifiNetworkSuggestion#equals(Object) * @see WifiNetworkSuggestion#equals(Object)
*/ */
public static final int STATUS_NETWORK_SUGGESTIONS_ERROR_ADD_DUPLICATE = 3; public static final int STATUS_NETWORK_SUGGESTIONS_ERROR_ADD_DUPLICATE = 3;
@@ -186,6 +188,8 @@ public class WifiManager {
/** /**
* Reason code if the number of network suggestions provided by the app crosses the max * Reason code if the number of network suggestions provided by the app crosses the max
* threshold set per app. * threshold set per app.
* The framework will reject all suggestions provided by {@link #addNetworkSuggestions(List)} if
* the total size exceeds the limit.
* @see #getMaxNumberOfNetworkSuggestionsPerApp() * @see #getMaxNumberOfNetworkSuggestionsPerApp()
*/ */
public static final int STATUS_NETWORK_SUGGESTIONS_ERROR_ADD_EXCEEDS_MAX_PER_APP = 4; public static final int STATUS_NETWORK_SUGGESTIONS_ERROR_ADD_EXCEEDS_MAX_PER_APP = 4;
@@ -193,21 +197,27 @@ public class WifiManager {
/** /**
* Reason code if one or more of the network suggestions removed does not exist in platform's * Reason code if one or more of the network suggestions removed does not exist in platform's
* database. * database.
* The framework won't remove any suggestions if one or more of suggestions provided
* by {@link #removeNetworkSuggestions(List)} does not exist in database.
* @see WifiNetworkSuggestion#equals(Object)
*/ */
public static final int STATUS_NETWORK_SUGGESTIONS_ERROR_REMOVE_INVALID = 5; public static final int STATUS_NETWORK_SUGGESTIONS_ERROR_REMOVE_INVALID = 5;
/** /**
* Reason code if one or more of the network suggestions added is not allowed. * Reason code if one or more of the network suggestions added is not allowed.
* * The framework will reject all suggestions provided by {@link #addNetworkSuggestions(List)}
* if one or more of them is not allowed.
* This error may be caused by suggestion is using SIM-based encryption method, but calling app * This error may be caused by suggestion is using SIM-based encryption method, but calling app
* is not carrier privileged. * is not carrier privileged.
*/ */
public static final int STATUS_NETWORK_SUGGESTIONS_ERROR_ADD_NOT_ALLOWED = 6; public static final int STATUS_NETWORK_SUGGESTIONS_ERROR_ADD_NOT_ALLOWED = 6;
/** /**
* Reason code if one or more of the network suggestions added is invalid. * Reason code if one or more of the network suggestions added is invalid. Framework will reject
* * all the suggestions in the list.
* Please user {@link WifiNetworkSuggestion.Builder} to create network suggestions. * The framework will reject all suggestions provided by {@link #addNetworkSuggestions(List)}
* if one or more of them is invalid.
* Please use {@link WifiNetworkSuggestion.Builder} to create network suggestions.
*/ */
public static final int STATUS_NETWORK_SUGGESTIONS_ERROR_ADD_INVALID = 7; public static final int STATUS_NETWORK_SUGGESTIONS_ERROR_ADD_INVALID = 7;
@@ -1887,7 +1897,7 @@ public class WifiManager {
* <li> If user reset network settings, all added suggestions will be discarded. Apps can use * <li> If user reset network settings, all added suggestions will be discarded. Apps can use
* {@link #getNetworkSuggestions()} to check if their suggestions are in the device.</li> * {@link #getNetworkSuggestions()} to check if their suggestions are in the device.</li>
* <li> In-place modification of existing suggestions are allowed. * <li> In-place modification of existing suggestions are allowed.
* <li>If the provided suggestions includes any previously provided suggestions by the app, * <li> If the provided suggestions include any previously provided suggestions by the app,
* previous suggestions will be updated.</li> * previous suggestions will be updated.</li>
* <li>If one of the provided suggestions marks a previously unmetered suggestion as metered and * <li>If one of the provided suggestions marks a previously unmetered suggestion as metered and
* the device is currently connected to that suggested network, then the device will disconnect * the device is currently connected to that suggested network, then the device will disconnect