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

update the document of API - WifiManager#getMatchingScanResults

Browse Source 
Bug: 150205351
Test: build
Change-Id: I21ab33a0ed25f2f1f9ab078fbb7cce38b5015c6b
This commit is contained in:
Steven Liu
2020-03-04 13:52:40 -08:00
parent ba592a2da0
commit 24f78d3fc3
1 changed files with 13 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -2735,27 +2735,30 @@ public class WifiManager {
}
/**
* Return the filtered ScanResults which may be authenticated by the suggested network
* configurations.
* @param networkSuggestions The list of {@link WifiNetworkSuggestion}
* @param scanResults The scan results to be filtered, this is optional, if it is null or
* empty, wifi system would use the recent scan results in the system.
* @return The map of {@link WifiNetworkSuggestion} and the list of {@link ScanResult} which
* may be authenticated by the corresponding network configuration.
* Get the filtered ScanResults which match the network configurations specified by the
* {@code networkSuggestionsToMatch}. Suggestions which use {@link WifiConfiguration} use
* SSID and the security type to match. Suggestions which use {@link PasspointConfigration}
* use the matching rules of Hotspot 2.0.
* @param networkSuggestionsToMatch The list of {@link WifiNetworkSuggestion} to match against.
* These may or may not be suggestions which are installed on the device.
* @param scanResults The scan results to be filtered. Optional - if not provided(empty list),
* the Wi-Fi service will use the most recent scan results which the system has.
* @return The map of {@link WifiNetworkSuggestion} to the list of {@link ScanResult}
* corresponding to networks which match them.
* @hide
*/
@SystemApi
@RequiresPermission(allOf = {ACCESS_FINE_LOCATION, ACCESS_WIFI_STATE})
@NonNull
public Map<WifiNetworkSuggestion, List<ScanResult>> getMatchingScanResults(
@NonNull List<WifiNetworkSuggestion> networkSuggestions,
@NonNull List<WifiNetworkSuggestion> networkSuggestionsToMatch,
@Nullable List<ScanResult> scanResults) {
if (networkSuggestions == null) {
if (networkSuggestionsToMatch == null) {
throw new IllegalArgumentException("networkSuggestions must not be null.");
}
try {
return mService.getMatchingScanResults(
networkSuggestions, scanResults,
networkSuggestionsToMatch, scanResults,
mContext.getOpPackageName(), mContext.getFeatureId());
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();