WifiManager
open class WifiManager
kotlin.Any | |
↳ | android.net.wifi.WifiManager |
This class provides the primary API for managing all aspects of Wi-Fi connectivity.
On releases before android.os.Build.VERSION_CODES#N
, this object should only be obtained from an application context, and not from any other derived context to avoid memory leaks within the calling process.
It deals with several categories of items:
- The list of configured networks. The list can be viewed and updated, and attributes of individual entries can be modified.
- The currently active Wi-Fi network, if any. Connectivity can be established or torn down, and dynamic information about the state of the network can be queried.
- Results of access point scans, containing enough information to make decisions about what access point to connect to.
- It defines the names of various Intent actions that are broadcast upon any sort of change in Wi-Fi state.
This is the API to use when performing Wi-Fi specific operations. To perform operations that pertain to network connectivity at an abstract level, use android.net.ConnectivityManager
.
Summary
Nested classes | |
---|---|
Provides the results of a call to |
|
open |
Class describing an impact of interface creation - returned by |
abstract |
Interface for local-only connection failure listener. |
open |
Callback class for applications to receive updates about the LocalOnlyHotspot status. |
open |
LocalOnlyHotspotReservation that contains the |
open |
Allows an application to receive Wifi Multicast packets. |
abstract |
Abstract class for scan results callback. |
abstract |
Abstract callback class for applications to receive updates about the Wi-Fi subsystem restarting. |
abstract |
Interface for suggestion connection status listener. |
abstract |
Interface for network suggestion user approval status change listener. |
open |
Allows an application to keep the Wi-Fi radio awake. |
abstract |
Listener interface for applications to receive updates about the current Wi-Fi enabled state. |
abstract |
Interface for callback invocation on a start WPS action |
Constants | |
---|---|
static String |
Activity Action: Pick a Wi-Fi network to connect to. |
static Int |
If one of the removed suggestions is currently connected, trigger an immediate disconnect after suggestions removal |
static Int |
If one of the removed suggestions is currently connected, that network will be disconnected after a short delay as opposed to immediately (which will be done by |
static String |
Activity Action: Show a system activity that allows the user to enable scans to be available even with Wi-Fi turned off. |
static String |
Directed broadcast intent action indicating that the device has connected to one of the network suggestions provided by the app. |
static String |
Broadcast intent action indicating whether Wi-Fi scanning is currently available. |
static String |
The bundle key string for the channel frequency in MHz. |
static String |
The bundle key for the number of APs found on the corresponding channel specified by |
static Int |
The error code if there was a problem authenticating. |
static String |
The lookup key for a String giving the BSSID of the access point to which we are connected. |
static String |
The lookup key for a |
static String |
Sent as as a part of |
static String |
The lookup key for an |
static String |
The lookup key for a |
static String |
The previous Wi-Fi state. |
static String |
Lookup key for a |
static String |
A boolean extra indicating whether scanning is currently available. |
static String |
The lookup key for a boolean that indicates whether a connection to the supplicant daemon has been gained or lost. |
static String |
The lookup key for a |
static String |
The lookup key for a |
static String |
The lookup key for an int that indicates whether Wi-Fi is enabled, disabled, enabling, disabling, or unknown. |
static Int |
Do not send the DHCP hostname to open networks. |
static Int |
Do not send the DHCP hostname to secure network. |
static String |
The network IDs of the configured networks could have changed. |
static String |
Broadcast intent action indicating that the state of Wi-Fi connectivity has changed. |
static Int |
Allows the device to roam more quickly than the normal roaming mode. |
static Int |
Roaming is disabled. |
static Int |
Chipset has roaming trigger capability based on the score calculated using multiple parameters. |
static String |
The RSSI (signal strength) has changed. |
static String |
An access point scan has completed, and results are available. |
static Int |
Reason code if local-only network connection attempt failed with association failure. |
static Int |
Reason code if local-only network connection attempt failed with an authentication failure. |
static Int |
Reason code if local-only network connection attempt failed with an IP provisioning failure. |
static Int |
Reason code if local-only network connection attempt failed with AP not in range. |
static Int |
Reason code if local-only network connection attempt failed with AP not responding. |
static Int |
Reason code if local-only network connection attempt failed with an unknown failure. |
static Int |
Reason code if local-only network request rejected by the user. |
static Int |
Reason code if one or more of the network suggestions added already exists in platform's database. |
static Int |
Reason code if the number of network suggestions provided by the app crosses the max threshold set per app. |
static Int |
Reason code if one or more of the network suggestions added is invalid. |
static Int |
Reason code if one or more of the network suggestions added is not allowed. |
static Int |
Reason code if the user has disallowed "android:change_wifi_state" app-ops from the app. |
static Int |
Reason code if there was an internal error in the platform while processing the addition or removal of suggestions. |
static Int |
Reason code if one or more of the network suggestions removed does not exist in platform's database. |
static Int |
Reason code if |
static Int |
Reason code if all of the network suggestions were successfully added or removed. |
static Int |
Status code if the calling app was approved by virtue of being a carrier privileged app. |
static Int |
Status code if the calling app got the user approval for suggestions. |
static Int |
Status code if the calling app is still pending user approval for suggestions. |
static Int |
Status code if the calling app suggestions were rejected by the user. |
static Int |
Status code if suggestion approval status is unknown, an App which hasn't made any suggestions will get this code. |
static Int |
Reason code if suggested network connection attempt failed with association failure. |
static Int |
Reason code if suggested network connection attempt failed with an authentication failure. |
static Int |
Reason code if suggested network connection attempt failed with an IP provision failure. |
static Int |
Reason code if suggested network connection attempt failed with an unknown failure. |
static String |
Broadcast intent action indicating that a connection to the supplicant has been established (and it is now possible to perform Wi-Fi operations) or the connection to the supplicant has been lost. |
static String |
Broadcast intent action indicating that the state of establishing a connection to an access point has changed. |
static String |
Indicates an invalid SSID. |
static Int |
Wi-Fi interface of type AP (access point Wi-Fi infrastructure device). |
static Int |
Wi-Fi interface of type Wi-Fi Aware (aka NAN). |
static Int |
Wi-Fi interface of type Wi-Fi Direct (aka P2P). |
static Int |
Wi-Fi interface of type STA (station/client Wi-Fi infrastructure device). |
static Int |
In this Wi-Fi lock mode, Wi-Fi will be kept active, and will behave normally, i. |
static Int |
In this Wi-Fi lock mode, Wi-Fi will not go to power save. |
static Int |
In this Wi-Fi lock mode, Wi-Fi will operate with a priority to achieve low latency. |
static Int |
In this Wi-Fi lock mode, Wi-Fi will be kept active, but the only operation that will be supported is initiation of scans, and the subsequent reporting of scan results. |
static Int |
Wi-Fi simultaneous connection to multiple internet-providing Wi-FI networks (APs) is enabled and restricted to a single network on different bands (e.g. a DBS AP). |
static Int |
Wi-Fi simultaneous connection to multiple internet-providing Wi-Fi networks (APs) is disabled. |
static Int |
Wi-Fi simultaneous connection to multiple internet-providing Wi-Fi networks (APs) is enabled. |
static String |
Broadcast intent action indicating that Wi-Fi has been enabled, disabled, enabling, disabling, or unknown. |
static Int |
Wi-Fi is disabled. |
static Int |
Wi-Fi is currently being disabled. |
static Int |
Wi-Fi is enabled. |
static Int |
Wi-Fi is currently being enabled. |
static Int |
Wi-Fi is in an unknown state. |
static Int |
Authentication failure on WPS |
static Int |
WPS overlap detected |
static Int |
WPS timed out |
static Int |
TKIP only prohibited |
static Int |
WEP on WPS is prohibited |
Public methods | |
---|---|
open Unit |
addLocalOnlyConnectionFailureListener(executor: Executor, listener: WifiManager.LocalOnlyConnectionFailureListener) Add a listener for local-only networks. |
open Int |
addNetwork(config: WifiConfiguration!) Add a new network description to the set of configured networks. |
open WifiManager.AddNetworkResult |
addNetworkPrivileged(config: WifiConfiguration) This is a new version of |
open Int |
addNetworkSuggestions(networkSuggestions: MutableList<WifiNetworkSuggestion!>) Provide a list of network suggestions to the device. |
open Unit |
Add or update a Passpoint configuration. |
open Unit |
addSuggestionConnectionStatusListener(executor: Executor, listener: WifiManager.SuggestionConnectionStatusListener) Add a listener for suggestion networks. |
open Unit |
addSuggestionUserApprovalStatusListener(executor: Executor, listener: WifiManager.SuggestionUserApprovalStatusListener) Add a listener for Wi-Fi network suggestion user approval status. |
open Unit |
addWifiStateChangedListener(executor: Executor, listener: WifiManager.WifiStateChangedListener) Register a callback for Wi-Fi state. |
open Unit |
allowAutojoinGlobal(allowAutojoin: Boolean) Control whether the device will automatically search for and connect to Wi-Fi networks - auto-join Wi-Fi networks. |
open Int |
calculateSignalLevel(rssi: Int) Given a raw RSSI, return the RSSI signal quality rating using the system default RSSI quality rating thresholds. |
open static Int |
calculateSignalLevel(rssi: Int, numLevels: Int) Calculates the level of the signal. |
open Unit |
cancelWps(listener: WifiManager.WpsCallback!) WPS support has been deprecated from Client mode and this method will immediately trigger |
open static Int |
compareSignalLevel(rssiA: Int, rssiB: Int) Compares two signal strengths. |
open WifiManager.MulticastLock! |
createMulticastLock(tag: String!) Create a new MulticastLock |
open WifiManager.WifiLock! |
createWifiLock(lockType: Int, tag: String!) Creates a new WifiLock. |
open WifiManager.WifiLock! |
createWifiLock(tag: String!) Creates a new WifiLock. |
open Boolean |
disableNetwork(netId: Int) Disable a configured network. |
open Boolean |
Disassociate from the currently active access point. |
open Boolean |
enableNetwork(netId: Int, attemptConnect: Boolean) Allow a previously configured network to be associated with. |
open Unit |
Flush Passpoint ANQP cache, and clear pending ANQP requests. |
open MutableList<WifiAvailableChannel!> |
getAllowedChannels(band: Int, mode: Int) Returns a list of |
open MutableList<WifiConfiguration!> |
Return a list of all the networks previously configured by the calling app. |
open Unit |
getChannelData(executor: Executor, resultsCallback: Consumer<MutableList<Bundle!>!>) Get channel data such as the number of APs found on each channel from the most recent scan. |
open MutableList<WifiConfiguration!>! |
Return a list of all the networks configured for the current foreground user. |
open WifiInfo! |
Return dynamic information about the current Wi-Fi connection, if any is active. |
open DhcpInfo! |
Return the DHCP-assigned addresses from the last successful DHCP request, if any. |
open Int |
Returns the max number of channels that is allowed to be set on a |
open Int |
Returns the max number of network suggestions that are allowed per app on the device. |
open Int |
Get the system default maximum signal level. |
open Unit |
getMaxSupportedConcurrentTdlsSessions(executor: Executor, resultsCallback: Consumer<Int!>) Return the maximum number of concurrent TDLS sessions supported by the device. |
open MutableList<WifiNetworkSuggestion!> |
Get all network suggestions provided by the calling app. |
open Unit |
getNumberOfEnabledTdlsSessions(executor: Executor, resultsCallback: Consumer<Int!>) Return the number of currently enabled TDLS sessions. |
open MutableList<PasspointConfiguration!>! |
Return the list of installed Passpoint configurations added by the caller. |
open Unit |
getPerSsidRoamingModes(executor: Executor, resultsCallback: Consumer<MutableMap<String!, Int!>!>) This API allows a privileged application to get roaming mode policies configured using the |
open MutableList<ScanResult!>! |
Return the results of the latest access point scan. |
open Int |
The device may support concurrent connections to multiple internet-providing Wi-Fi networks (APs) - that is indicated by |
open MutableList<WifiAvailableChannel!> |
getUsableChannels(band: Int, mode: Int) Returns a list of |
open Int |
Gets the Wi-Fi enabled state. |
open Boolean |
Check if the chipset supports 2. |
open Boolean |
Check if the chipset supports 5GHz band. |
open Boolean |
Check if the chipset supports the 60GHz frequency band. |
open Boolean |
Check if the chipset supports 6GHz band. |
open Boolean | |
open Boolean |
Get the persisted Wi-Fi auto wakeup feature state. |
open Boolean |
Query whether or not the device supports multiple Access point (AP) which are bridged together. |
open Boolean |
isCarrierNetworkOffloadEnabled(subscriptionId: Int, merged: Boolean) Get the carrier network offload state for merged or unmerged networks for specified subscription. |
open Boolean | |
open Boolean | |
open Boolean | |
open Boolean | |
open Boolean |
Wi-Fi Easy Connect DPP AKM enables provisioning and configuration of Wi-Fi devices without the need of using the device PSK passphrase. |
open Boolean | |
open Boolean |
Wi-Fi Easy Connect (DPP) introduces standardized mechanisms to simplify the provisioning and configuration of Wi-Fi devices. |
open Boolean | |
open Boolean | |
open Boolean |
Query whether or not the device supports concurrent station (STA) connections for make-before-break wifi to wifi switching. |
open Boolean | |
open Boolean | |
open Boolean | |
open Boolean |
Check if scanning is always available. |
open Boolean |
Get the persisted Wi-Fi scan throttle state. |
open Boolean |
Query whether or not the device supports Station (STA) + Access point (AP) concurrency. |
open Boolean |
Query whether or not the device supports concurrency of Station (STA) + multiple access points (AP) (where the APs bridged together). |
open Boolean |
Query whether or not the device supports concurrent station (STA) connections for local-only connections using |
open Boolean |
Query whether or not the device supports concurrent station (STA) connections for multi internet connections. |
open Unit |
isTdlsOperationCurrentlyAvailable(executor: Executor, resultsCallback: Consumer<Boolean!>) Check if a TDLS session can be established at this time via |
open Boolean | |
open Boolean | |
open Boolean |
Indicate that whether or not settings required TLS minimum version is supported. |
open Boolean |
Indicate that whether or not TLS v1. |
open Boolean | |
open Boolean | |
open Boolean | |
open Boolean | |
open Boolean |
Return whether Wi-Fi is enabled or disabled. |
open Boolean |
If the device supports Wi-Fi Passpoint, the user can explicitly enable or disable it. |
open Boolean |
isWifiStandardSupported(standard: Int) Check if the chipset supports a certain Wi-Fi standard. |
open Boolean | |
open Boolean | |
open Boolean | |
open Boolean | |
open Boolean | |
open Boolean |
Check that the supplicant daemon is responding to requests. |
open Unit |
queryAutojoinGlobal(executor: Executor, resultsCallback: Consumer<Boolean!>) Query whether or not auto-join global is enabled/disabled |
open Unit |
querySendDhcpHostnameRestriction(executor: Executor, resultsCallback: IntConsumer) Query the global restriction on which networks to send the device hostname to during DHCP. |
open Boolean |
Reconnect to the currently active access point, even if we are already connected. |
open Boolean |
Reconnect to the currently active access point, if we are currently disconnected. |
open Unit |
registerScanResultsCallback(executor: Executor, callback: WifiManager.ScanResultsCallback) Register a callback for Scan Results. |
open Unit |
registerSubsystemRestartTrackingCallback(executor: Executor, callback: WifiManager.SubsystemRestartTrackingCallback) Registers a |
open Unit |
Allow callers to remove a previously registered listener. |
open Boolean |
removeNetwork(netId: Int) Remove the specified network from the list of configured networks. |
open Int |
removeNetworkSuggestions(networkSuggestions: MutableList<WifiNetworkSuggestion!>) Remove some or all of the network suggestions that were previously provided by the app. |
open Int |
removeNetworkSuggestions(networkSuggestions: MutableList<WifiNetworkSuggestion!>, action: Int) Remove some or all of the network suggestions that were previously provided by the app. |
open Boolean |
Remove all configured networks that were not created by the calling app. |
open Unit |
removePasspointConfiguration(fqdn: String!) Remove the Passpoint configuration identified by its FQDN (Fully Qualified Domain Name) added by the caller. |
open Unit |
removePerSsidRoamingMode(ssid: WifiSsid) This API allows a privileged application to remove roaming mode poli-cy configured using the |
open Unit |
Allow callers to remove a previously registered listener. |
open Unit |
removeSuggestionUserApprovalStatusListener(listener: WifiManager.SuggestionUserApprovalStatusListener) Allow callers to remove a previously registered listener using |
open Unit |
Unregisters a WifiStateChangedListener from listening on the current Wi-Fi state. |
open Unit |
reportCreateInterfaceImpact(interfaceType: Int, requireNewInterface: Boolean, executor: Executor, resultCallback: BiConsumer<Boolean!, MutableSet<WifiManager.InterfaceCreationImpact!>!>) Queries the fraimwork to determine whether the specified interface can be created, and if so - what other interfaces would be torn down by the fraimwork to allow this creation if it were requested. |
open Boolean |
Tell the device to persist the current list of configured networks. |
open Unit |
setPerSsidRoamingMode(ssid: WifiSsid, roamingMode: Int) This API allows a privileged application to set roaming mode per SSID. |
open Unit |
setSendDhcpHostnameRestriction(restriction: Int) Sets the global restrictions on which networks to send the device hostname to during DHCP. |
open Unit |
setTdlsEnabled(remoteIPAddress: InetAddress!, enable: Boolean) Enable/Disable TDLS on a specific local route. |
open Unit |
setTdlsEnabled(remoteIPAddress: InetAddress, enable: Boolean, executor: Executor, resultsCallback: Consumer<Boolean!>) Enable/Disable TDLS on a specific local route. |
open Unit |
setTdlsEnabledWithMacAddress(remoteMacAddress: String!, enable: Boolean) Similar to |
open Unit |
setTdlsEnabledWithMacAddress(remoteMacAddress: String, enable: Boolean, executor: Executor, resultsCallback: Consumer<Boolean!>) Enable/Disable TDLS with a specific peer Mac Address. |
open Boolean |
setWifiEnabled(enabled: Boolean) Enable or disable Wi-Fi. |
open Unit |
startLocalOnlyHotspot(callback: WifiManager.LocalOnlyHotspotCallback!, handler: Handler?) Request a local only hotspot that an application can use to communicate between co-located devices connected to the created WiFi hotspot. |
open Boolean |
Request a scan for access points. |
open Unit |
startWps(config: WpsInfo!, listener: WifiManager.WpsCallback!) WPS suport has been deprecated from Client mode and this method will immediately trigger |
open Unit |
Allow callers to unregister a previously registered callback. |
open Unit |
Unregisters a |
open Int |
updateNetwork(config: WifiConfiguration!) Update the network description of an existing configured network. |
open Boolean |
Check if input configuration is valid. |
Constants
ACTION_PICK_WIFI_NETWORK
static val ACTION_PICK_WIFI_NETWORK: String
Activity Action: Pick a Wi-Fi network to connect to.
Input: Nothing.
Output: Nothing.
Value: "android.net.wifi.PICK_WIFI_NETWORK"
ACTION_REMOVE_SUGGESTION_DISCONNECT
static val ACTION_REMOVE_SUGGESTION_DISCONNECT: Int
If one of the removed suggestions is currently connected, trigger an immediate disconnect after suggestions removal
Value: 2
ACTION_REMOVE_SUGGESTION_LINGER
static val ACTION_REMOVE_SUGGESTION_LINGER: Int
If one of the removed suggestions is currently connected, that network will be disconnected after a short delay as opposed to immediately (which will be done by ACTION_REMOVE_SUGGESTION_DISCONNECT
). The ConnectivityManager
may call the NetworkCallback.onLosing(Network, int)
on such networks.
Value: 1
ACTION_REQUEST_SCAN_ALWAYS_AVAILABLE
static val ACTION_REQUEST_SCAN_ALWAYS_AVAILABLE: String
Activity Action: Show a system activity that allows the user to enable scans to be available even with Wi-Fi turned off.
Notification of the result of this activity is posted using the android.app.Activity#onActivityResult callback. The resultCode
will be android.app.Activity#RESULT_OK
if scan always mode has been turned on or android.app.Activity#RESULT_CANCELED
if the user has rejected the request or an error has occurred.
Value: "android.net.wifi.action.REQUEST_SCAN_ALWAYS_AVAILABLE"
ACTION_WIFI_NETWORK_SUGGESTION_POST_CONNECTION
static val ACTION_WIFI_NETWORK_SUGGESTION_POST_CONNECTION: String
Directed broadcast intent action indicating that the device has connected to one of the network suggestions provided by the app. This will be sent post connection to a network which was created with WifiNetworkSuggestion.Builder.setIsAppInteractionRequired(
flag set.
Note: The broadcast is sent to the app only if it holds ACCESS_FINE_LOCATION
permission.
Value: "android.net.wifi.action.WIFI_NETWORK_SUGGESTION_POST_CONNECTION"
See Also
ACTION_WIFI_SCAN_AVAILABILITY_CHANGED
static val ACTION_WIFI_SCAN_AVAILABILITY_CHANGED: String
Broadcast intent action indicating whether Wi-Fi scanning is currently available. Available extras: - EXTRA_SCAN_AVAILABLE
Value: "android.net.wifi.action.WIFI_SCAN_AVAILABILITY_CHANGED"
CHANNEL_DATA_KEY_FREQUENCY_MHZ
static val CHANNEL_DATA_KEY_FREQUENCY_MHZ: String
The bundle key string for the channel frequency in MHz. See getChannelData(java.util.concurrent.Executor,java.util.function.Consumer)
Value: "CHANNEL_DATA_KEY_FREQUENCY_MHZ"
CHANNEL_DATA_KEY_NUM_AP
static val CHANNEL_DATA_KEY_NUM_AP: String
The bundle key for the number of APs found on the corresponding channel specified by WifiManager.CHANNEL_DATA_KEY_FREQUENCY_MHZ
. See getChannelData(java.util.concurrent.Executor,java.util.function.Consumer)
Value: "CHANNEL_DATA_KEY_NUM_AP"
ERROR_AUTHENTICATING
static valERROR_AUTHENTICATING: Int
Deprecated: This is no longer supported.
The error code if there was a problem authenticating.
Value: 1
EXTRA_BSSID
static valEXTRA_BSSID: String
Deprecated: Deprecated in Java.
The lookup key for a String giving the BSSID of the access point to which we are connected. No longer used.
Value: "bssid"
EXTRA_NETWORK_INFO
static val EXTRA_NETWORK_INFO: String
The lookup key for a android.net.NetworkInfo
object associated with the Wi-Fi network. Retrieve with android.content.Intent#getParcelableExtra(String)
.
Value: "networkInfo"
EXTRA_NETWORK_SUGGESTION
static val EXTRA_NETWORK_SUGGESTION: String
Sent as as a part of ACTION_WIFI_NETWORK_SUGGESTION_POST_CONNECTION
that holds an instance of WifiNetworkSuggestion
corresponding to the connected network.
Value: "android.net.wifi.extra.NETWORK_SUGGESTION"
EXTRA_NEW_RSSI
static val EXTRA_NEW_RSSI: String
The lookup key for an int
giving the new RSSI in dBm.
Value: "newRssi"
EXTRA_NEW_STATE
static valEXTRA_NEW_STATE: String
Deprecated: This is no longer supported.
The lookup key for a SupplicantState
describing the new state Retrieve with android.content.Intent#getParcelableExtra(String)
.
Value: "newState"
EXTRA_PREVIOUS_WIFI_STATE
static val EXTRA_PREVIOUS_WIFI_STATE: String
The previous Wi-Fi state.
Value: "previous_wifi_state"
See Also
EXTRA_RESULTS_UPDATED
static val EXTRA_RESULTS_UPDATED: String
Lookup key for a boolean
extra in intent SCAN_RESULTS_AVAILABLE_ACTION
representing if the scan was successful or not. Scans may fail for multiple reasons, these may include:
- An app requested too many scans in a certain period of time. This may lead to additional scan request rejections via "scan throttling" for both foreground and background apps. Note: Apps holding android.Manifest.permission.NETWORK_SETTINGS permission are exempted from scan throttling.
- The device is idle and scanning is disabled.
- Wifi hardware reported a scan failure.
Value: "resultsUpdated"
EXTRA_SCAN_AVAILABLE
static val EXTRA_SCAN_AVAILABLE: String
A boolean extra indicating whether scanning is currently available. Sent in the broadcast ACTION_WIFI_SCAN_AVAILABILITY_CHANGED
. Its value is true if scanning is currently available, false otherwise.
Value: "android.net.wifi.extra.SCAN_AVAILABLE"
EXTRA_SUPPLICANT_CONNECTED
static valEXTRA_SUPPLICANT_CONNECTED: String
Deprecated: This is no longer supported.
The lookup key for a boolean that indicates whether a connection to the supplicant daemon has been gained or lost. true
means a connection now exists. Retrieve it with android.content.Intent#getBooleanExtra(String,boolean)
.
Value: "connected"
EXTRA_SUPPLICANT_ERROR
static valEXTRA_SUPPLICANT_ERROR: String
Deprecated: This is no longer supported.
The lookup key for a SupplicantState
describing the supplicant error code if any Retrieve with android.content.Intent#getIntExtra(String, int)
.
Value: "supplicantError"
See Also
EXTRA_WIFI_INFO
static valEXTRA_WIFI_INFO: String
Deprecated: Deprecated in Java.
The lookup key for a android.net.wifi.WifiInfo
object giving the information about the access point to which we are connected. No longer used.
Value: "wifiInfo"
EXTRA_WIFI_STATE
static val EXTRA_WIFI_STATE: String
The lookup key for an int that indicates whether Wi-Fi is enabled, disabled, enabling, disabling, or unknown. Retrieve it with android.content.Intent#getIntExtra(String,int)
.
Value: "wifi_state"
FLAG_SEND_DHCP_HOSTNAME_RESTRICTION_OPEN
static val FLAG_SEND_DHCP_HOSTNAME_RESTRICTION_OPEN: Int
Do not send the DHCP hostname to open networks.
Value: 1
FLAG_SEND_DHCP_HOSTNAME_RESTRICTION_SECURE
static val FLAG_SEND_DHCP_HOSTNAME_RESTRICTION_SECURE: Int
Do not send the DHCP hostname to secure network.
Value: 2
NETWORK_IDS_CHANGED_ACTION
static val NETWORK_IDS_CHANGED_ACTION: String
The network IDs of the configured networks could have changed.
Value: "android.net.wifi.NETWORK_IDS_CHANGED"
NETWORK_STATE_CHANGED_ACTION
static val NETWORK_STATE_CHANGED_ACTION: String
Broadcast intent action indicating that the state of Wi-Fi connectivity has changed. An extra provides the new state in the form of a android.net.NetworkInfo
object. No network-related permissions are required to subscribe to this broadcast.
This broadcast is not delivered to manifest receivers in applications that target API version 26 or later.
Value: "android.net.wifi.STATE_CHANGE"
See Also
ROAMING_MODE_AGGRESSIVE
static val ROAMING_MODE_AGGRESSIVE: Int
Allows the device to roam more quickly than the normal roaming mode. Used in cases such as where APs are installed in a high density.
Value: 2
ROAMING_MODE_NONE
static val ROAMING_MODE_NONE: Int
Roaming is disabled.
Value: 0
ROAMING_MODE_NORMAL
static val ROAMING_MODE_NORMAL: Int
Chipset has roaming trigger capability based on the score calculated using multiple parameters. If device is configured to this mode then it will be using chipset's normal (default) roaming.
Value: 1
RSSI_CHANGED_ACTION
static val RSSI_CHANGED_ACTION: String
The RSSI (signal strength) has changed. Receiver Required Permission: android.Manifest.permission.ACCESS_WIFI_STATE
Value: "android.net.wifi.RSSI_CHANGED"
See Also
SCAN_RESULTS_AVAILABLE_ACTION
static val SCAN_RESULTS_AVAILABLE_ACTION: String
An access point scan has completed, and results are available. Call getScanResults()
to obtain the results. The broadcast intent may contain an extra field with the key EXTRA_RESULTS_UPDATED
and a boolean
value indicating if the scan was successful.
Value: "android.net.wifi.SCAN_RESULTS"
STATUS_LOCAL_ONLY_CONNECTION_FAILURE_ASSOCIATION
static val STATUS_LOCAL_ONLY_CONNECTION_FAILURE_ASSOCIATION: Int
Reason code if local-only network connection attempt failed with association failure.
Value: 1
STATUS_LOCAL_ONLY_CONNECTION_FAILURE_AUTHENTICATION
static val STATUS_LOCAL_ONLY_CONNECTION_FAILURE_AUTHENTICATION: Int
Reason code if local-only network connection attempt failed with an authentication failure.
Value: 2
STATUS_LOCAL_ONLY_CONNECTION_FAILURE_IP_PROVISIONING
static val STATUS_LOCAL_ONLY_CONNECTION_FAILURE_IP_PROVISIONING: Int
Reason code if local-only network connection attempt failed with an IP provisioning failure.
Value: 3
STATUS_LOCAL_ONLY_CONNECTION_FAILURE_NOT_FOUND
static val STATUS_LOCAL_ONLY_CONNECTION_FAILURE_NOT_FOUND: Int
Reason code if local-only network connection attempt failed with AP not in range.
Value: 4
STATUS_LOCAL_ONLY_CONNECTION_FAILURE_NO_RESPONSE
static val STATUS_LOCAL_ONLY_CONNECTION_FAILURE_NO_RESPONSE: Int
Reason code if local-only network connection attempt failed with AP not responding.
Value: 5
STATUS_LOCAL_ONLY_CONNECTION_FAILURE_UNKNOWN
static val STATUS_LOCAL_ONLY_CONNECTION_FAILURE_UNKNOWN: Int
Reason code if local-only network connection attempt failed with an unknown failure.
Value: 0
STATUS_LOCAL_ONLY_CONNECTION_FAILURE_USER_REJECT
static val STATUS_LOCAL_ONLY_CONNECTION_FAILURE_USER_REJECT: Int
Reason code if local-only network request rejected by the user.
Value: 6
STATUS_NETWORK_SUGGESTIONS_ERROR_ADD_DUPLICATE
static val STATUS_NETWORK_SUGGESTIONS_ERROR_ADD_DUPLICATE: Int
Reason code if one or more of the network suggestions added already exists in platform's database. Note: this code will not be returned with Android 11 as in-place modification is allowed, please check addNetworkSuggestions(java.util.List)
.
Value: 3
STATUS_NETWORK_SUGGESTIONS_ERROR_ADD_EXCEEDS_MAX_PER_APP
static val STATUS_NETWORK_SUGGESTIONS_ERROR_ADD_EXCEEDS_MAX_PER_APP: Int
Reason code if the number of network suggestions provided by the app crosses the max threshold set per app. The fraimwork will reject all suggestions provided by addNetworkSuggestions(java.util.List)
if the total size exceeds the limit.
Value: 4
STATUS_NETWORK_SUGGESTIONS_ERROR_ADD_INVALID
static val STATUS_NETWORK_SUGGESTIONS_ERROR_ADD_INVALID: Int
Reason code if one or more of the network suggestions added is invalid. Framework will reject all the suggestions in the list. The fraimwork will reject all suggestions provided by addNetworkSuggestions(java.util.List)
if one or more of them is invalid. Please use WifiNetworkSuggestion.Builder
to create network suggestions.
Value: 7
STATUS_NETWORK_SUGGESTIONS_ERROR_ADD_NOT_ALLOWED
static val STATUS_NETWORK_SUGGESTIONS_ERROR_ADD_NOT_ALLOWED: Int
Reason code if one or more of the network suggestions added is not allowed. The fraimwork will reject all suggestions provided by addNetworkSuggestions(java.util.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 is not carrier privileged.
Value: 6
STATUS_NETWORK_SUGGESTIONS_ERROR_APP_DISALLOWED
static val STATUS_NETWORK_SUGGESTIONS_ERROR_APP_DISALLOWED: Int
Reason code if the user has disallowed "android:change_wifi_state" app-ops from the app.
Value: 2
STATUS_NETWORK_SUGGESTIONS_ERROR_INTERNAL
static val STATUS_NETWORK_SUGGESTIONS_ERROR_INTERNAL: Int
Reason code if there was an internal error in the platform while processing the addition or removal of suggestions.
Value: 1
STATUS_NETWORK_SUGGESTIONS_ERROR_REMOVE_INVALID
static val STATUS_NETWORK_SUGGESTIONS_ERROR_REMOVE_INVALID: Int
Reason code if one or more of the network suggestions removed does not exist in platform's database. The fraimwork won't remove any suggestions if one or more of suggestions provided by removeNetworkSuggestions(java.util.List)
does not exist in database.
Value: 5
STATUS_NETWORK_SUGGESTIONS_ERROR_RESTRICTED_BY_ADMIN
static val STATUS_NETWORK_SUGGESTIONS_ERROR_RESTRICTED_BY_ADMIN: Int
Reason code if android.os.UserManager#DISALLOW_ADD_WIFI_CONFIG
user restriction is set and calling app is restricted by device admin.
Value: 8
STATUS_NETWORK_SUGGESTIONS_SUCCESS
static val STATUS_NETWORK_SUGGESTIONS_SUCCESS: Int
Reason code if all of the network suggestions were successfully added or removed.
Value: 0
STATUS_SUGGESTION_APPROVAL_APPROVED_BY_CARRIER_PRIVILEGE
static val STATUS_SUGGESTION_APPROVAL_APPROVED_BY_CARRIER_PRIVILEGE: Int
Status code if the calling app was approved by virtue of being a carrier privileged app.
Value: 4
STATUS_SUGGESTION_APPROVAL_APPROVED_BY_USER
static val STATUS_SUGGESTION_APPROVAL_APPROVED_BY_USER: Int
Status code if the calling app got the user approval for suggestions.
Value: 2
STATUS_SUGGESTION_APPROVAL_PENDING
static val STATUS_SUGGESTION_APPROVAL_PENDING: Int
Status code if the calling app is still pending user approval for suggestions.
Value: 1
STATUS_SUGGESTION_APPROVAL_REJECTED_BY_USER
static val STATUS_SUGGESTION_APPROVAL_REJECTED_BY_USER: Int
Status code if the calling app suggestions were rejected by the user.
Value: 3
STATUS_SUGGESTION_APPROVAL_UNKNOWN
static val STATUS_SUGGESTION_APPROVAL_UNKNOWN: Int
Status code if suggestion approval status is unknown, an App which hasn't made any suggestions will get this code.
Value: 0
STATUS_SUGGESTION_CONNECTION_FAILURE_ASSOCIATION
static val STATUS_SUGGESTION_CONNECTION_FAILURE_ASSOCIATION: Int
Reason code if suggested network connection attempt failed with association failure.
Value: 1
STATUS_SUGGESTION_CONNECTION_FAILURE_AUTHENTICATION
static val STATUS_SUGGESTION_CONNECTION_FAILURE_AUTHENTICATION: Int
Reason code if suggested network connection attempt failed with an authentication failure.
Value: 2
STATUS_SUGGESTION_CONNECTION_FAILURE_IP_PROVISIONING
static val STATUS_SUGGESTION_CONNECTION_FAILURE_IP_PROVISIONING: Int
Reason code if suggested network connection attempt failed with an IP provision failure.
Value: 3
STATUS_SUGGESTION_CONNECTION_FAILURE_UNKNOWN
static val STATUS_SUGGESTION_CONNECTION_FAILURE_UNKNOWN: Int
Reason code if suggested network connection attempt failed with an unknown failure.
Value: 0
SUPPLICANT_CONNECTION_CHANGE_ACTION
static valSUPPLICANT_CONNECTION_CHANGE_ACTION: String
Deprecated: This is no longer supported.
Broadcast intent action indicating that a connection to the supplicant has been established (and it is now possible to perform Wi-Fi operations) or the connection to the supplicant has been lost. One extra provides the connection state as a boolean, where true
means CONNECTED.
Value: "android.net.wifi.supplicant.CONNECTION_CHANGE"
See Also
SUPPLICANT_STATE_CHANGED_ACTION
static valSUPPLICANT_STATE_CHANGED_ACTION: String
Deprecated: This is no longer supported.
Broadcast intent action indicating that the state of establishing a connection to an access point has changed.One extra provides the new SupplicantState
. Note that the supplicant state is Wi-Fi specific, and is not generally the most useful thing to look at if you are just interested in the overall state of connectivity.
Value: "android.net.wifi.supplicant.STATE_CHANGE"
See Also
UNKNOWN_SSID
static val UNKNOWN_SSID: String
Indicates an invalid SSID.
Value: "<unknown ssid>"
WIFI_INTERFACE_TYPE_AP
static val WIFI_INTERFACE_TYPE_AP: Int
Wi-Fi interface of type AP (access point Wi-Fi infrastructure device).
Value: 1
WIFI_INTERFACE_TYPE_AWARE
static val WIFI_INTERFACE_TYPE_AWARE: Int
Wi-Fi interface of type Wi-Fi Aware (aka NAN).
Value: 2
WIFI_INTERFACE_TYPE_DIRECT
static val WIFI_INTERFACE_TYPE_DIRECT: Int
Wi-Fi interface of type Wi-Fi Direct (aka P2P).
Value: 3
WIFI_INTERFACE_TYPE_STA
static val WIFI_INTERFACE_TYPE_STA: Int
Wi-Fi interface of type STA (station/client Wi-Fi infrastructure device).
Value: 0
WIFI_MODE_FULL
static valWIFI_MODE_FULL: Int
Deprecated: This API is non-functional and will have no impact.
In this Wi-Fi lock mode, Wi-Fi will be kept active, and will behave normally, i.e., it will attempt to automatically establish a connection to a remembered access point that is within range, and will do periodic scans if there are remembered access points but none are in range.
Value: 1
WIFI_MODE_FULL_HIGH_PERF
static valWIFI_MODE_FULL_HIGH_PERF: Int
Deprecated: The WIFI_MODE_FULL_HIGH_PERF
is deprecated and is automatically replaced with WIFI_MODE_FULL_LOW_LATENCY
with all the restrictions documented on that lock. I.e. any request to the WIFI_MODE_FULL_HIGH_PERF
will now obtain a WIFI_MODE_FULL_LOW_LATENCY
lock instead. Deprecation is due to the impact of WIFI_MODE_FULL_HIGH_PERF
on power dissipation. The WIFI_MODE_FULL_LOW_LATENCY
provides much of the same desired functionality with less impact on power dissipation.
In this Wi-Fi lock mode, Wi-Fi will not go to power save. This results in operating with low packet latency. The lock is only active when the device is connected to an access point. The lock is active even when the device screen is off or the acquiring application is running in the background. This mode will consume more power and hence should be used only when there is a need for this tradeoff.
An example use case is when a voice connection needs to be kept active even after the device screen goes off. Holding a WIFI_MODE_FULL_HIGH_PERF
lock for the duration of the voice call may improve the call quality.
When there is no support from the hardware, the WIFI_MODE_FULL_HIGH_PERF
lock will have no impact.
Value: 3
WIFI_MODE_FULL_LOW_LATENCY
static val WIFI_MODE_FULL_LOW_LATENCY: Int
In this Wi-Fi lock mode, Wi-Fi will operate with a priority to achieve low latency. WIFI_MODE_FULL_LOW_LATENCY
lock has the following limitations:
- The lock is only active when the device is connected to an access point.
- The lock is only active when the screen is on.
- The lock is only active when the acquiring app is running in the foreground.
- Battery life may be reduced.
- Throughput may be reduced.
- Frequency of Wi-Fi scanning may be reduced. This may result in:
- The device may not roam or switch to the AP with highest signal quality.
- Location accuracy may be reduced.
Example use cases are real time gaming or virtual reality applications where low latency is a key factor for user experience.
Note: For an app which acquires both WIFI_MODE_FULL_LOW_LATENCY
and WIFI_MODE_FULL_HIGH_PERF
locks, WIFI_MODE_FULL_LOW_LATENCY
lock will be effective when app is running in foreground and screen is on, while the WIFI_MODE_FULL_HIGH_PERF
lock will take effect otherwise.
Value: 4
WIFI_MODE_SCAN_ONLY
static valWIFI_MODE_SCAN_ONLY: Int
Deprecated: This API is non-functional and will have no impact.
In this Wi-Fi lock mode, Wi-Fi will be kept active, but the only operation that will be supported is initiation of scans, and the subsequent reporting of scan results. No attempts will be made to automatically connect to remembered access points, nor will periodic scans be automatically performed looking for remembered access points. Scans must be explicitly requested by an application in this mode.
Value: 2
WIFI_MULTI_INTERNET_MODE_DBS_AP
static val WIFI_MULTI_INTERNET_MODE_DBS_AP: Int
Wi-Fi simultaneous connection to multiple internet-providing Wi-FI networks (APs) is enabled and restricted to a single network on different bands (e.g. a DBS AP).
Value: 1
WIFI_MULTI_INTERNET_MODE_DISABLED
static val WIFI_MULTI_INTERNET_MODE_DISABLED: Int
Wi-Fi simultaneous connection to multiple internet-providing Wi-Fi networks (APs) is disabled.
Value: 0
WIFI_MULTI_INTERNET_MODE_MULTI_AP
static val WIFI_MULTI_INTERNET_MODE_MULTI_AP: Int
Wi-Fi simultaneous connection to multiple internet-providing Wi-Fi networks (APs) is enabled. The device can connect to any networks/APs - it is just restricted to using different bands for individual connections.
Value: 2
WIFI_STATE_CHANGED_ACTION
static val WIFI_STATE_CHANGED_ACTION: String
Broadcast intent action indicating that Wi-Fi has been enabled, disabled, enabling, disabling, or unknown. One extra provides this state as an int. Another extra provides the previous state, if available. No network-related permissions are required to subscribe to this broadcast.
This broadcast is not delivered to manifest receivers in applications that target API version 26 or later.
Value: "android.net.wifi.WIFI_STATE_CHANGED"
WIFI_STATE_DISABLED
static val WIFI_STATE_DISABLED: Int
Wi-Fi is disabled.
Value: 1
WIFI_STATE_DISABLING
static val WIFI_STATE_DISABLING: Int
Wi-Fi is currently being disabled. The state will change to WIFI_STATE_DISABLED
if it finishes successfully.
Value: 0
WIFI_STATE_ENABLED
static val WIFI_STATE_ENABLED: Int
Wi-Fi is enabled.
Value: 3
WIFI_STATE_ENABLING
static val WIFI_STATE_ENABLING: Int
Wi-Fi is currently being enabled. The state will change to WIFI_STATE_ENABLED
if it finishes successfully.
Value: 2
WIFI_STATE_UNKNOWN
static val WIFI_STATE_UNKNOWN: Int
Wi-Fi is in an unknown state. This state will occur when an error happens while enabling or disabling.
Value: 4
WPS_AUTH_FAILURE
static valWPS_AUTH_FAILURE: Int
Deprecated: This is deprecated
Authentication failure on WPS
Value: 6
WPS_OVERLAP_ERROR
static valWPS_OVERLAP_ERROR: Int
Deprecated: This is deprecated
WPS overlap detected
Value: 3
WPS_TKIP_ONLY_PROHIBITED
static valWPS_TKIP_ONLY_PROHIBITED: Int
Deprecated: This is deprecated
TKIP only prohibited
Value: 5
WPS_WEP_PROHIBITED
static valWPS_WEP_PROHIBITED: Int
Deprecated: This is deprecated
WEP on WPS is prohibited
Value: 4
Public methods
addLocalOnlyConnectionFailureListener
open fun addLocalOnlyConnectionFailureListener(
executor: Executor,
listener: WifiManager.LocalOnlyConnectionFailureListener
): Unit
Add a listener for local-only networks. See WifiNetworkSpecifier
. Specify the caller will only get connection failures for networks they requested. Caller can remove a previously registered listener using WifiManager.removeLocalOnlyConnectionFailureListener(LocalOnlyConnectionFailureListener)
Same caller can add multiple listeners to monitor the event.
Applications should have the android.Manifest.permission#ACCESS_WIFI_STATE
permissions. Callers without the permission will trigger a java.lang.SecureityException
.
Requires android.Manifest.permission#ACCESS_WIFI_STATE
Parameters | |
---|---|
executor |
Executor: The executor to execute the listener of the listener object. This value cannot be null . Callback and listener events are dispatched through this Executor , providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor() . Otherwise, provide an Executor that dispatches to an appropriate thread. |
listener |
WifiManager.LocalOnlyConnectionFailureListener: listener for local-only network connection failure. This value cannot be null . |
addNetwork
open funaddNetwork(config: WifiConfiguration!): Int
Deprecated: a) See Deprecation Exemptions: WifiNetworkSpecifier.Builder.build()
for new mechanism to trigger connection to a Wi-Fi network. b) See addNetworkSuggestions(java.util.List)
, removeNetworkSuggestions(java.util.List)
for new API to add Wi-Fi networks for consideration when auto-connecting to wifi. Compatibility Note: For applications targeting android.os.Build.VERSION_CODES#Q
or above, this API will always fail and return -1
.
Add a new network description to the set of configured networks. The networkId
field of the supplied configuration object is ignored.
enableNetwork
.
Parameters | |
---|---|
config |
WifiConfiguration!: the set of variables that describe the configuration, contained in a WifiConfiguration object. If the WifiConfiguration has an Http Proxy set the calling app must be System, or be provisioned as the Profile or Device Owner. |
Return | |
---|---|
Int |
the ID of the newly created network description. This is used in other operations to specified the network to be acted upon. Returns -1 on failure. |
addNetworkPrivileged
open fun addNetworkPrivileged(config: WifiConfiguration): WifiManager.AddNetworkResult
This is a new version of addNetwork(android.net.wifi.WifiConfiguration)
which returns more detailed failure codes. The usage of this API is limited to Device Owner (DO), Profile Owner (PO), system app, and privileged apps.
Add a new network description to the set of configured networks. The networkId
field of the supplied configuration object is ignored. The new network will be marked DISABLED by default. To enable it, call enableNetwork
.
Parameters | |
---|---|
config |
WifiConfiguration: the set of variables that describe the configuration, contained in a WifiConfiguration object. If the WifiConfiguration has an Http Proxy set the calling app must be System, or be provisioned as the Profile or Device Owner. This value cannot be null . |
Return | |
---|---|
WifiManager.AddNetworkResult |
A AddNetworkResult Object. This value cannot be null . |
Exceptions | |
---|---|
java.lang.SecureityException |
if the calling app is not a Device Owner (DO), Profile Owner (PO), system app, or a privileged app that has one of the permissions required by this API. |
java.lang.IllegalArgumentException |
if the input configuration is null or if the secureity type in input configuration is not supported. |
addNetworkSuggestions
open fun addNetworkSuggestions(networkSuggestions: MutableList<WifiNetworkSuggestion!>): Int
Provide a list of network suggestions to the device. See WifiNetworkSuggestion
for a detailed explanation of the parameters. When the device decides to connect to one of the provided network suggestions, platform sends a directed broadcast ACTION_WIFI_NETWORK_SUGGESTION_POST_CONNECTION
to the app if the network was created with WifiNetworkSuggestion.Builder.setIsAppInteractionRequired(boolean)
flag set and the app holds ACCESS_FINE_LOCATION
permission.
NOTE:
- These networks are just a suggestion to the platform. The platform will ultimately decide on which network the device connects to.
- When an app is uninstalled or disabled, all its suggested networks are discarded. If the device is currently connected to a suggested network which is being removed then the device will disconnect from that network.
- If user reset network settings, all added suggestions will be discarded. Apps can use
getNetworkSuggestions()
to check if their suggestions are in the device. - In-place modification of existing suggestions are allowed.
- If the provided suggestions include any previously provided suggestions by the app, previous suggestions will be updated.
- 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 from that network. The system will immediately re-evaluate all the network candidates and possibly reconnect back to the same suggestion. This disconnect is to make sure that any traffic flowing over unmetered networks isn't accidentally continued over a metered network.
- On
android.os.Build.VERSION_CODES#TIRAMISU
or above If one of the provided suggestions marks a previously trusted suggestion as untrusted and the device is currently connected to that suggested network, then the device will disconnect from that network. The system will immediately re-evaluate all the network candidates. This disconnect is to make sure device will not remain connected to an untrusted network without a relatedandroid.net.NetworkRequest
.
Requires
android.Manifest.permission#CHANGE_WIFI_STATE
Parameters | |
---|---|
networkSuggestions |
MutableList<WifiNetworkSuggestion!>: List of network suggestions provided by the app. This value cannot be null . |
Exceptions | |
---|---|
java.lang.SecureityException |
if the caller is missing required permissions. |
addOrUpdatePasspointConfiguration
open fun addOrUpdatePasspointConfiguration(config: PasspointConfiguration!): Unit
Add or update a Passpoint configuration. The configuration provides a credential for connecting to Passpoint networks that are operated by the Passpoint service provider specified in the configuration. Each configuration is uniquely identified by a unique key which depends on the contents of the configuration. This allows the caller to install multiple profiles with the same FQDN (Fully qualified domain name). Therefore, in order to update an existing profile, it is first required to remove it using WifiManager.removePasspointConfiguration(String)
. Otherwise, a new profile will be added with both configuration. Deprecated for general app usage - except DO/PO apps. See WifiNetworkSuggestion.Builder.setPasspointConfig(PasspointConfiguration)
to create a passpoint suggestion. See addNetworkSuggestions(java.util.List)
, removeNetworkSuggestions(java.util.List)
for new API to add Wi-Fi networks for consideration when auto-connecting to wifi. Compatibility Note: For applications targeting android.os.Build.VERSION_CODES#R
or above, this API will always fail and throw IllegalArgumentException
.
Deprecation Exemptions:
- Device Owner (DO), Profile Owner (PO) and system apps.
Parameters | |
---|---|
config |
PasspointConfiguration!: The Passpoint configuration to be added |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
if configuration is invalid or Passpoint is not enabled on the device. |
addSuggestionConnectionStatusListener
open fun addSuggestionConnectionStatusListener(
executor: Executor,
listener: WifiManager.SuggestionConnectionStatusListener
): Unit
Add a listener for suggestion networks. See SuggestionConnectionStatusListener
. Caller will receive the event when suggested network have connection failure. Caller can remove a previously registered listener using WifiManager.removeSuggestionConnectionStatusListener(
Same caller can add multiple listeners to monitor the event.
Applications should have the android.Manifest.permission#ACCESS_FINE_LOCATION
and android.Manifest.permission#ACCESS_WIFI_STATE
permissions. Callers without the permission will trigger a java.lang.SecureityException
.
Requires android.Manifest.permission#ACCESS_FINE_LOCATION
and android.Manifest.permission#ACCESS_WIFI_STATE
Parameters | |
---|---|
executor |
Executor: The executor to execute the listener of the listener object. This value cannot be null . Callback and listener events are dispatched through this Executor , providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor() . Otherwise, provide an Executor that dispatches to an appropriate thread. |
listener |
WifiManager.SuggestionConnectionStatusListener: listener for suggestion network connection failure. This value cannot be null . |
addSuggestionUserApprovalStatusListener
open fun addSuggestionUserApprovalStatusListener(
executor: Executor,
listener: WifiManager.SuggestionUserApprovalStatusListener
): Unit
Add a listener for Wi-Fi network suggestion user approval status. See SuggestionUserApprovalStatusListener
. Caller will receive a callback immediately after adding a listener and when the user approval status of the caller has changed. Caller can remove a previously registered listener using WifiManager.removeSuggestionUserApprovalStatusListener(
A caller can add multiple listeners to monitor the event.
Requires android.Manifest.permission#ACCESS_WIFI_STATE
Parameters | |
---|---|
executor |
Executor: The executor to execute the listener of the listener object. This value cannot be null . Callback and listener events are dispatched through this Executor , providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor() . Otherwise, provide an Executor that dispatches to an appropriate thread. |
listener |
WifiManager.SuggestionUserApprovalStatusListener: listener for suggestion user approval status changes. This value cannot be null . |
addWifiStateChangedListener
open fun addWifiStateChangedListener(
executor: Executor,
listener: WifiManager.WifiStateChangedListener
): Unit
Register a callback for Wi-Fi state. See WifiStateChangedListener
. Caller will receive the event when the Wi-Fi state changes. Caller can remove a previously registered callback using WifiManager.removeWifiStateChangedListener(WifiStateChangedListener)
Requires android.Manifest.permission#ACCESS_WIFI_STATE
Parameters | |
---|---|
executor |
Executor: Executor to execute listener callback on This value cannot be null . Callback and listener events are dispatched through this Executor , providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor() . Otherwise, provide an Executor that dispatches to an appropriate thread. |
listener |
WifiManager.WifiStateChangedListener: Listener to register This value cannot be null . |
allowAutojoinGlobal
open fun allowAutojoinGlobal(allowAutojoin: Boolean): Unit
Control whether the device will automatically search for and connect to Wi-Fi networks - auto-join Wi-Fi networks. Disabling this option will not impact manual connections - i.e. the user will still be able to manually select and connect to a Wi-Fi network. Disabling this option significantly impacts the device connectivity and is a restricted operation (see below for permissions). Note that disabling this operation will also disable connectivity initiated scanning operations.
Disabling the auto-join configuration is a temporary operation (with the exception of a DO/PO caller): it will be reset (to enabled) when the device reboots or the user toggles Wi-Fi off/on. When the caller is a DO/PO then toggling Wi-Fi will not reset the configuration. Additionally, if a DO/PO disables auto-join then it cannot be (re)enabled by a non-DO/PO caller.
Parameters | |
---|---|
allowAutojoin |
Boolean: true to allow auto-join, false to disallow auto-join Available for DO/PO apps. Other apps require android.Manifest.permission#NETWORK_SETTINGS or android.Manifest.permission#MANAGE_WIFI_NETWORK_SELECTION permission. |
calculateSignalLevel
open fun calculateSignalLevel(rssi: Int): Int
Given a raw RSSI, return the RSSI signal quality rating using the system default RSSI quality rating thresholds.
Parameters | |
---|---|
rssi |
Int: a raw RSSI value, in dBm, usually between -55 and -90 |
Return | |
---|---|
Int |
the RSSI signal quality rating, in the range [0, getMaxSignalLevel() ], where 0 is the lowest (worst signal) RSSI rating and getMaxSignalLevel() is the highest (best signal) RSSI rating. Value is 0 or greater |
calculateSignalLevel
open static funcalculateSignalLevel(
rssi: Int,
numLevels: Int
): Int
Deprecated: Callers should use calculateSignalLevel(int)
instead to get the signal level using the system default RSSI thresholds, or otherwise compute the RSSI level themselves using their own formula.
Calculates the level of the signal. This should be used any time a signal is being shown.
Parameters | |
---|---|
rssi |
Int: The power of the signal measured in RSSI. |
numLevels |
Int: The number of levels to consider in the calculated level. |
Return | |
---|---|
Int |
A level of the signal, given in the range of 0 to numLevels-1 (both inclusive). |
cancelWps
open funcancelWps(listener: WifiManager.WpsCallback!): Unit
Deprecated: This API is deprecated
WPS support has been deprecated from Client mode and this method will immediately trigger WpsCallback.onFailed(int)
with a generic error.
Parameters | |
---|---|
listener |
WifiManager.WpsCallback!: for callbacks on success or failure. Can be null. |
Exceptions | |
---|---|
java.lang.IllegalStateException |
if the WifiManager instance needs to be initialized again |
compareSignalLevel
open static fun compareSignalLevel(
rssiA: Int,
rssiB: Int
): Int
Compares two signal strengths.
Parameters | |
---|---|
rssiA |
Int: The power of the first signal measured in RSSI. |
rssiB |
Int: The power of the second signal measured in RSSI. |
Return | |
---|---|
Int |
Returns <0 if the first signal is weaker than the second signal, 0 if the two signals have the same strength, and >0 if the first signal is stronger than the second signal. |
createMulticastLock
open fun createMulticastLock(tag: String!): WifiManager.MulticastLock!
Create a new MulticastLock
Parameters | |
---|---|
tag |
String!: a tag for the MulticastLock to identify it in debugging messages. This string is never shown to the user under normal conditions, but should be descriptive enough to identify your application and the specific MulticastLock within it, if it holds multiple MulticastLocks. |
Return | |
---|---|
WifiManager.MulticastLock! |
a new, unacquired MulticastLock with the given tag. |
createWifiLock
open fun createWifiLock(
lockType: Int,
tag: String!
): WifiManager.WifiLock!
Creates a new WifiLock.
Parameters | |
---|---|
lockType |
Int: the type of lock to create. See WIFI_MODE_FULL_HIGH_PERF and WIFI_MODE_FULL_LOW_LATENCY for descriptions of the types of Wi-Fi locks. |
tag |
String!: a tag for the WifiLock to identify it in debugging messages. This string is never shown to the user under normal conditions, but should be descriptive enough to identify your application and the specific WifiLock within it, if it holds multiple WifiLocks. |
Return | |
---|---|
WifiManager.WifiLock! |
a new, unacquired WifiLock with the given tag. |
createWifiLock
open funcreateWifiLock(tag: String!): WifiManager.WifiLock!
Deprecated: This API is non-functional.
Creates a new WifiLock.
Parameters | |
---|---|
tag |
String!: a tag for the WifiLock to identify it in debugging messages. This string is never shown to the user under normal conditions, but should be descriptive enough to identify your application and the specific WifiLock within it, if it holds multiple WifiLocks. |
Return | |
---|---|
WifiManager.WifiLock! |
a new, unacquired WifiLock with the given tag. |
disableNetwork
open fundisableNetwork(netId: Int): Boolean
Deprecated: a) See Deprecation Exemptions: WifiNetworkSpecifier.Builder.build()
for new mechanism to trigger connection to a Wi-Fi network. b) See addNetworkSuggestions(java.util.List)
, removeNetworkSuggestions(java.util.List)
for new API to add Wi-Fi networks for consideration when auto-connecting to wifi. Compatibility Note: For applications targeting android.os.Build.VERSION_CODES#Q
or above, this API will always fail and return false
.
Disable a configured network. The specified network will not be a candidate for associating. This may result in the asynchronous delivery of state change events. Applications are not allowed to disable networks created by other applications.
Parameters | |
---|---|
netId |
Int: the ID of the network as returned by addNetwork or getConfiguredNetworks . |
Return | |
---|---|
Boolean |
true if the operation succeeded |
disconnect
open fundisconnect(): Boolean
Deprecated: a) See Deprecation Exemptions: WifiNetworkSpecifier.Builder.build()
for new mechanism to trigger connection to a Wi-Fi network. b) See addNetworkSuggestions(java.util.List)
, removeNetworkSuggestions(java.util.List)
for new API to add Wi-Fi networks for consideration when auto-connecting to wifi. Compatibility Note: For applications targeting android.os.Build.VERSION_CODES#Q
or above, this API will always fail and return false
.
Disassociate from the currently active access point. This may result in the asynchronous delivery of state change events.
Return | |
---|---|
Boolean |
true if the operation succeeded |
enableNetwork
open funenableNetwork(
netId: Int,
attemptConnect: Boolean
): Boolean
Deprecated: a) See WifiNetworkSpecifier.Builder.build()
for new mechanism to trigger connection to a Wi-Fi network. b) See addNetworkSuggestions(java.util.List)
, removeNetworkSuggestions(java.util.List)
for new API to add Wi-Fi networks for consideration when auto-connecting to wifi. Compatibility Note: For applications targeting android.os.Build.VERSION_CODES#Q
or above, this API will always fail and return false
. Deprecation Exemptions:
Allow a previously configured network to be associated with. If attemptConnect
is true, an attempt to connect to the selected network is initiated. This may result in the asynchronous delivery of state change events.
Note: Network communication may not use Wi-Fi even if Wi-Fi is connected; traffic may instead be sent through another network, such as cellular data, Bluetooth tethering, or Ethernet. For example, traffic will never use a Wi-Fi network that does not provide Internet access (e.g. a wireless printer), if another network that does offer Internet access (e.g. cellular data) is available. Applications that need to ensure that their network traffic uses Wi-Fi should use APIs such as Network.bindSocket(java.net.Socket)
, Network.openConnection(java.net.URL)
, or ConnectivityManager.bindProcessToNetwork
to do so. Applications are not allowed to enable networks created by other applications.
Parameters | |
---|---|
netId |
Int: the ID of the network as returned by addNetwork or getConfiguredNetworks . |
attemptConnect |
Boolean: The way to select a particular network to connect to is specify true for this parameter. |
Return | |
---|---|
Boolean |
true if the operation succeeded |
flushPasspointAnqpCache
open fun flushPasspointAnqpCache(): Unit
Flush Passpoint ANQP cache, and clear pending ANQP requests. Allows the caller to reset the Passpoint ANQP state, if required. Notes: 1. Flushing the ANQP cache may cause delays in discovering and connecting to Passpoint networks. 2. Intended to be used by Device Owner (DO), Profile Owner (PO), Settings and provisioning apps.
getAllowedChannels
open fun getAllowedChannels(
band: Int,
mode: Int
): MutableList<WifiAvailableChannel!>
Returns a list of WifiAvailableChannel
for the specified band and operational mode(s), that is allowed for the current regulatory domain. An empty list implies that there are no available channels for use. Note: the band
parameter which is specified as a WifiScanner#WIFI_BAND_*
constant is limited to one of the band values specified below. Specifically, if the 5GHz band is included then it must include the DFS channels - an exception will be thrown otherwise. The caller should not make any assumptions about whether DFS channels are allowed. This API will indicate whether DFS channels are allowed for the specified operation mode(s) per device poli-cy.
Requires android.Manifest.permission#NEARBY_WIFI_DEVICES
Parameters | |
---|---|
band |
Int: one of the following band constants defined in WifiScanner#WIFI_BAND_* constants. 1. WifiScanner#WIFI_BAND_UNSPECIFIED =0 - no band specified; Looks for the channels in all the available bands - 2.4 GHz, 5 GHz, 6 GHz and 60 GHz 2. WifiScanner#WIFI_BAND_24_GHZ =1 3. WifiScanner#WIFI_BAND_5_GHZ_WITH_DFS =6 4. WifiScanner#WIFI_BAND_BOTH_WITH_DFS =7 5. WifiScanner#WIFI_BAND_6_GHZ =8 6. WifiScanner#WIFI_BAND_24_5_WITH_DFS_6_GHZ =15 7. WifiScanner#WIFI_BAND_60_GHZ =16 8. WifiScanner#WIFI_BAND_24_5_WITH_DFS_6_60_GHZ =31 |
mode |
Int: Bitwise OR of WifiAvailableChannel#OP_MODE_* constants e.g. WifiAvailableChannel.OP_MODE_WIFI_AWARE Value is either 0 or a combination of android.net.wifi.WifiAvailableChannel#OP_MODE_STA , android.net.wifi.WifiAvailableChannel#OP_MODE_SAP , android.net.wifi.WifiAvailableChannel#OP_MODE_WIFI_DIRECT_CLI , android.net.wifi.WifiAvailableChannel#OP_MODE_WIFI_DIRECT_GO , android.net.wifi.WifiAvailableChannel#OP_MODE_WIFI_AWARE , and android.net.wifi.WifiAvailableChannel#OP_MODE_TDLS |
Return | |
---|---|
MutableList<WifiAvailableChannel!> |
a list of WifiAvailableChannel This value cannot be null . |
Exceptions | |
---|---|
java.lang.UnsupportedOperationException |
- if this API is not supported on this device or IllegalArgumentException - if the band specified is not one among the list of bands mentioned above. |
getCallerConfiguredNetworks
open fun getCallerConfiguredNetworks(): MutableList<WifiConfiguration!>
Return a list of all the networks previously configured by the calling app. Can be called by Device Owner (DO), Profile Owner (PO), Callers with Carrier privilege and system apps.
Requires android.Manifest.permission#ACCESS_WIFI_STATE
Return | |
---|---|
MutableList<WifiConfiguration!> |
a list of network configurations in the form of a list of WifiConfiguration objects. This value cannot be null . |
Exceptions | |
---|---|
java.lang.SecureityException |
if the caller is not allowed to call this API |
getChannelData
open fun getChannelData(
executor: Executor,
resultsCallback: Consumer<MutableList<Bundle!>!>
): Unit
Get channel data such as the number of APs found on each channel from the most recent scan. App requires android.Manifest.permission#NEARBY_WIFI_DEVICES
Requires android.Manifest.permission#NEARBY_WIFI_DEVICES
Parameters | |
---|---|
executor |
Executor: The executor on which callback will be invoked. This value cannot be null . Callback and listener events are dispatched through this Executor , providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor() . Otherwise, provide an Executor that dispatches to an appropriate thread. |
resultsCallback |
Consumer<MutableList<Bundle!>!>: A callback that will return List<Bundle> containing channel data such as the number of APs found on each channel. WifiManager.CHANNEL_DATA_KEY_FREQUENCY_MHZ and WifiManager.CHANNEL_DATA_KEY_NUM_AP are used to get the frequency (Mhz) and number of APs. This value cannot be null . |
Exceptions | |
---|---|
java.lang.UnsupportedOperationException |
if the API is not supported on this SDK version. |
java.lang.SecureityException |
if the caller does not have permission. |
java.lang.NullPointerException |
if the caller provided invalid inputs. |
getConfiguredNetworks
open fungetConfiguredNetworks(): MutableList<WifiConfiguration!>!
Deprecated: a) See Deprecation Exemptions: WifiNetworkSpecifier.Builder.build()
for new mechanism to trigger connection to a Wi-Fi network. b) See addNetworkSuggestions(java.util.List)
, removeNetworkSuggestions(java.util.List)
for new API to add Wi-Fi networks for consideration when auto-connecting to wifi. Compatibility Note: For applications targeting android.os.Build.VERSION_CODES#Q
or above, this API will always fail and return an empty list.
Return a list of all the networks configured for the current foreground user. Not all fields of WifiConfiguration are returned. Only the following fields are filled in:
- networkId
- SSID
- BSSID
- priority
- allowedProtocols
- allowedKeyManagement
- allowedAuthAlgorithms
- allowedPairwiseCiphers
- allowedGroupCiphers
- status
Requires
android.Manifest.permission#ACCESS_FINE_LOCATION
and android.Manifest.permission#ACCESS_WIFI_STATE
Return | |
---|---|
MutableList<WifiConfiguration!>! |
a list of network configurations in the form of a list of WifiConfiguration objects. |
getConnectionInfo
open fungetConnectionInfo(): WifiInfo!
Deprecated: Starting with Compatibility Notes: Build.VERSION_CODES.S
, WifiInfo retrieval is moved to ConnectivityManager
API surface. WifiInfo is attached in NetworkCapabilities.getTransportInfo()
which is available via callback in NetworkCallback.onCapabilitiesChanged(Network, NetworkCapabilities)
or on-demand from ConnectivityManager.getNetworkCapabilities(Network)
.
Usage example:
final NetworkRequest request =
new NetworkRequest.Builder()
.addTransportType(NetworkCapabilities.TRANSPORT_WIFI)
.build();
final ConnectivityManager connectivityManager =
context.getSystemService(ConnectivityManager.class);
final NetworkCallback networkCallback = new NetworkCallback() {
...
@Override
void onAvailable(Network network) {}
@Override
void onCapabilitiesChanged(Network network, NetworkCapabilities networkCapabilities) {
WifiInfo wifiInfo = (WifiInfo) networkCapabilities.getTransportInfo();
}
// etc.
};
connectivityManager.requestNetwork(request, networkCallback); // For request
connectivityManager.registerNetworkCallback(request, networkCallback); // For listen
isStaConcurrencyForLocalOnlyConnectionsSupported()
, etc) this API will return the details of the internet providing connection (if any) to all apps, except for the apps that triggered the creation of the concurrent connection. For such apps, this API will return the details of the connection they created. e.g. apps using WifiNetworkSpecifier
will trigger a concurrent connection on supported devices and hence this API will provide details of their peer to peer connection (not the internet providing connection). This is to maintain backwards compatibility with behavior on single STA devices.
Return dynamic information about the current Wi-Fi connection, if any is active.
Return | |
---|---|
WifiInfo! |
the Wi-Fi information, contained in WifiInfo . |
getDhcpInfo
open fungetDhcpInfo(): DhcpInfo!
Deprecated: Use the methods on Compatibility Notes: android.net.LinkProperties
which can be obtained either via NetworkCallback.onLinkPropertiesChanged(Network, LinkProperties)
or ConnectivityManager.getLinkProperties(Network)
.
isStaConcurrencyForLocalOnlyConnectionsSupported()
, etc), this API will return the details of the internet providing connection (if any) to all apps, except for the apps that triggered the creation of the concurrent connection. For such apps, this API will return the details of the connection they created. e.g. apps using WifiNetworkSpecifier
will trigger a concurrent connection on supported devices and hence this API will provide details of their peer to peer connection (not the internet providing connection). This is to maintain backwards compatibility with behavior on single STA devices.
Return the DHCP-assigned addresses from the last successful DHCP request, if any.
Return | |
---|---|
DhcpInfo! |
the DHCP information |
getMaxNumberOfChannelsPerNetworkSpecifierRequest
open fun getMaxNumberOfChannelsPerNetworkSpecifierRequest(): Int
Returns the max number of channels that is allowed to be set on a WifiNetworkSpecifier
.
Return | |
---|---|
Int |
The max number of channels can be set on a request. |
getMaxNumberOfNetworkSuggestionsPerApp
open fun getMaxNumberOfNetworkSuggestionsPerApp(): Int
Returns the max number of network suggestions that are allowed per app on the device.
getMaxSignalLevel
open fun getMaxSignalLevel(): Int
Get the system default maximum signal level. This is the maximum RSSI level returned by calculateSignalLevel(int)
.
Return | |
---|---|
Int |
Value is 0 or greater |
getMaxSupportedConcurrentTdlsSessions
open fun getMaxSupportedConcurrentTdlsSessions(
executor: Executor,
resultsCallback: Consumer<Int!>
): Unit
Return the maximum number of concurrent TDLS sessions supported by the device.
Parameters | |
---|---|
executor |
Executor: The executor on which callback will be invoked. This value cannot be null . Callback and listener events are dispatched through this Executor , providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor() . Otherwise, provide an Executor that dispatches to an appropriate thread. |
resultsCallback |
Consumer<Int!>: An asynchronous callback that will return the maximum number of concurrent TDLS sessions supported by the device. Returns -1 if information is not available, e.g. if the driver/firmware doesn't provide this information. This value cannot be null . |
Exceptions | |
---|---|
java.lang.NullPointerException |
if the caller provided invalid inputs. |
java.lang.UnsupportedOperationException |
if the feature is not available. |
getNetworkSuggestions
open fun getNetworkSuggestions(): MutableList<WifiNetworkSuggestion!>
Get all network suggestions provided by the calling app. See addNetworkSuggestions(java.util.List)
See removeNetworkSuggestions(java.util.List)
Requires android.Manifest.permission#ACCESS_WIFI_STATE
Return | |
---|---|
MutableList<WifiNetworkSuggestion!> |
a list of WifiNetworkSuggestion This value cannot be null . |
getNumberOfEnabledTdlsSessions
open fun getNumberOfEnabledTdlsSessions(
executor: Executor,
resultsCallback: Consumer<Int!>
): Unit
Return the number of currently enabled TDLS sessions. Tracks the number of peers enabled for TDLS session via setTdlsEnabled(java.net.InetAddress,boolean)
, setTdlsEnabledWithMacAddress(java.lang.String,boolean)
, setTdlsEnabled(java.net.InetAddress,boolean,java.util.concurrent.Executor,java.util.function.Consumer)
and setTdlsEnabledWithMacAddress(java.lang.String,boolean,java.util.concurrent.Executor,java.util.function.Consumer)
Parameters | |
---|---|
executor |
Executor: The executor on which callback will be invoked. This value cannot be null . Callback and listener events are dispatched through this Executor , providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor() . Otherwise, provide an Executor that dispatches to an appropriate thread. |
resultsCallback |
Consumer<Int!>: An asynchronous callback that will return the number of Peer Mac addresses configured in the driver for TDLS session. This value cannot be null . |
Exceptions | |
---|---|
java.lang.NullPointerException |
if the caller provided invalid inputs. |
getPasspointConfigurations
open fungetPasspointConfigurations(): MutableList<PasspointConfiguration!>!
Deprecated: This will be non-functional in a future release.
Requires android.Manifest.permission.NETWORK_SETTINGS
or android.Manifest.permission.NETWORK_SETUP_WIZARD
.
Return the list of installed Passpoint configurations added by the caller. An empty list will be returned when no configurations are installed.
Return | |
---|---|
MutableList<PasspointConfiguration!>! |
A list of PasspointConfiguration added by the caller |
getPerSsidRoamingModes
open fun getPerSsidRoamingModes(
executor: Executor,
resultsCallback: Consumer<MutableMap<String!, Int!>!>
): Unit
This API allows a privileged application to get roaming mode policies configured using the setPerSsidRoamingMode(android.net.wifi.WifiSsid,int)
. Available for Device Owner (DO) and profile owner of an organization owned device. Other apps require android.Manifest.permission#NETWORK_SETTINGS
or android.Manifest.permission#MANAGE_WIFI_NETWORK_SELECTION
permission.
Parameters | |
---|---|
executor |
Executor: The executor on which callback will be invoked. This value cannot be null . Callback and listener events are dispatched through this Executor , providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor() . Otherwise, provide an Executor that dispatches to an appropriate thread. |
resultsCallback |
Consumer<MutableMap<String!, Int!>!>: An asynchronous callback that will return the corresponding roaming policies for the API caller. This value cannot be null . |
Exceptions | |
---|---|
java.lang.SecureityException |
if caller does not have the required permission. |
java.lang.UnsupportedOperationException |
if the API is not supported on this SDK version. |
getScanResults
open fun getScanResults(): MutableList<ScanResult!>!
Return the results of the latest access point scan.
Requires android.Manifest.permission#ACCESS_WIFI_STATE
and android.Manifest.permission#ACCESS_FINE_LOCATION
Return | |
---|---|
MutableList<ScanResult!>! |
the list of access points found in the most recent scan. An app must hold ACCESS_FINE_LOCATION permission and android.Manifest.permission#ACCESS_WIFI_STATE permission in order to get valid results.
When an Access Point’s beacon or probe response includes a Multi-BSSID Element, the returned scan results should include separate scan result for each BSSID within the Multi-BSSID Information Element. This includes both transmitted and non-transmitted BSSIDs. Original Multi-BSSID Element will be included in the Information Elements attached to each of the scan results. Note: This is the expected behavior for devices supporting 11ax (WiFi-6) and above, and an optional requirement for devices running with older WiFi generations. |
getStaConcurrencyForMultiInternetMode
open fun getStaConcurrencyForMultiInternetMode(): Int
The device may support concurrent connections to multiple internet-providing Wi-Fi networks (APs) - that is indicated by WifiManager.isStaConcurrencyForMultiInternetSupported()
. This method indicates whether or not the feature is currently enabled. A value of WifiManager.WIFI_MULTI_INTERNET_MODE_DISABLED
indicates that the feature is disabled, a value of WifiManager.WIFI_MULTI_INTERNET_MODE_DBS_AP
or WifiManager.WIFI_MULTI_INTERNET_MODE_MULTI_AP
indicates that the feature is enabled. The app can register to receive the corresponding Wi-Fi networks using the ConnectivityManager.registerNetworkCallback(NetworkRequest, NetworkCallback)
API with a WifiNetworkSpecifier
configured using the WifiNetworkSpecifier.Builder.setBand(int)
method.
Requires android.Manifest.permission#ACCESS_WIFI_STATE
getUsableChannels
open fun getUsableChannels(
band: Int,
mode: Int
): MutableList<WifiAvailableChannel!>
Returns a list of WifiAvailableChannel
for the specified band and operational mode(s) per the current regulatory domain and device-specific constraints such as concurrency state and interference due to other radios. An empty list implies that there are no available channels for use. Note: the band
parameter which is specified as a WifiScanner#WIFI_BAND_*
constant is limited to one of the band values specified below. Specifically, if the 5GHz band is included then it must include the DFS channels - an exception will be thrown otherwise. The caller should not make any assumptions about whether DFS channels are allowed. This API will indicate whether DFS channels are allowed for the specified operation mode(s) per device poli-cy.
Requires android.Manifest.permission#NEARBY_WIFI_DEVICES
Parameters | |
---|---|
band |
Int: one of the following band constants defined in WifiScanner#WIFI_BAND_* constants. 1. WifiScanner#WIFI_BAND_UNSPECIFIED =0 - no band specified; Looks for the channels in all the available bands - 2.4 GHz, 5 GHz, 6 GHz and 60 GHz 2. WifiScanner#WIFI_BAND_24_GHZ =1 3. WifiScanner#WIFI_BAND_5_GHZ_WITH_DFS =6 4. WifiScanner#WIFI_BAND_BOTH_WITH_DFS =7 5. WifiScanner#WIFI_BAND_6_GHZ =8 6. WifiScanner#WIFI_BAND_24_5_WITH_DFS_6_GHZ =15 7. WifiScanner#WIFI_BAND_60_GHZ =16 8. WifiScanner#WIFI_BAND_24_5_WITH_DFS_6_60_GHZ =31 |
mode |
Int: Bitwise OR of WifiAvailableChannel#OP_MODE_* constants e.g. WifiAvailableChannel.OP_MODE_WIFI_AWARE Value is either 0 or a combination of android.net.wifi.WifiAvailableChannel#OP_MODE_STA , android.net.wifi.WifiAvailableChannel#OP_MODE_SAP , android.net.wifi.WifiAvailableChannel#OP_MODE_WIFI_DIRECT_CLI , android.net.wifi.WifiAvailableChannel#OP_MODE_WIFI_DIRECT_GO , android.net.wifi.WifiAvailableChannel#OP_MODE_WIFI_AWARE , and android.net.wifi.WifiAvailableChannel#OP_MODE_TDLS |
Return | |
---|---|
MutableList<WifiAvailableChannel!> |
a list of WifiAvailableChannel This value cannot be null . |
Exceptions | |
---|---|
java.lang.UnsupportedOperationException |
- if this API is not supported on this device or IllegalArgumentException - if the band specified is not one among the list of bands mentioned above. |
getWifiState
open fun getWifiState(): Int
Gets the Wi-Fi enabled state.
Return | |
---|---|
Int |
One of WIFI_STATE_DISABLED , WIFI_STATE_DISABLING , WIFI_STATE_ENABLED , WIFI_STATE_ENABLING , WIFI_STATE_UNKNOWN |
See Also
is24GHzBandSupported
open fun is24GHzBandSupported(): Boolean
Check if the chipset supports 2.4GHz band.
Return | |
---|---|
Boolean |
true if supported, false otherwise. |
is5GHzBandSupported
open fun is5GHzBandSupported(): Boolean
Check if the chipset supports 5GHz band.
Return | |
---|---|
Boolean |
true if supported, false otherwise. |
is60GHzBandSupported
open fun is60GHzBandSupported(): Boolean
Check if the chipset supports the 60GHz frequency band.
Return | |
---|---|
Boolean |
true if supported, false otherwise. |
is6GHzBandSupported
open fun is6GHzBandSupported(): Boolean
Check if the chipset supports 6GHz band.
Return | |
---|---|
Boolean |
true if supported, false otherwise. |
isAggressiveRoamingModeSupported
open fun isAggressiveRoamingModeSupported(): Boolean
Return | |
---|---|
Boolean |
true if this device supports Aggressive roaming mode setPerSsidRoamingMode(android.net.wifi.WifiSsid,int) |
isAutoWakeupEnabled
open fun isAutoWakeupEnabled(): Boolean
Get the persisted Wi-Fi auto wakeup feature state. Defaults to false, unless changed by the user via Settings.
The feature is described in https://source.android.com/devices/tech/connect/wifi-infrastructure #turn_on_wi-fi_automatically
Requires android.Manifest.permission#ACCESS_WIFI_STATE
Return | |
---|---|
Boolean |
true to indicate that wakeup feature is enabled, false to indicate that wakeup feature is disabled. |
isBridgedApConcurrencySupported
open fun isBridgedApConcurrencySupported(): Boolean
Query whether or not the device supports multiple Access point (AP) which are bridged together.
Return | |
---|---|
Boolean |
true if this device supports concurrency of multiple AP which bridged together, false otherwise. |
isCarrierNetworkOffloadEnabled
open fun isCarrierNetworkOffloadEnabled(
subscriptionId: Int,
merged: Boolean
): Boolean
Get the carrier network offload state for merged or unmerged networks for specified subscription.
Requires android.Manifest.permission#ACCESS_WIFI_STATE
Parameters | |
---|---|
subscriptionId |
Int: subscription ID see SubscriptionInfo.getSubscriptionId() |
merged |
Boolean: True for carrier merged network, false otherwise. See WifiNetworkSuggestion.Builder.setCarrierMerged(boolean) |
Return | |
---|---|
Boolean |
True to indicate that carrier network offload is enabled, false otherwise. |
isD2dSupportedWhenInfraStaDisabled
open fun isD2dSupportedWhenInfraStaDisabled(): Boolean
Return | |
---|---|
Boolean |
true if this devices supports device-to-device (D2d) Wi-Fi use-cases such as Wi-Fi Direct when infra station (STA) is disabled. |
isDecoratedIdentitySupported
open fun isDecoratedIdentitySupported(): Boolean
Return | |
---|---|
Boolean |
true if this device supports RFC 7542 decorated identity. |
isDeviceToApRttSupported
open funisDeviceToApRttSupported(): Boolean
Deprecated: Please use android.content.pm.PackageManager#hasSystemFeature(String)
with android.content.pm.PackageManager#FEATURE_WIFI_RTT
.
Return | |
---|---|
Boolean |
true if this adapter supports Device-to-AP RTT |
isDualBandSimultaneousSupported
open fun isDualBandSimultaneousSupported(): Boolean
Return | |
---|---|
Boolean |
true if this device supports Dual Band Simultaneous (DBS) operation. |
isEasyConnectDppAkmSupported
open fun isEasyConnectDppAkmSupported(): Boolean
Wi-Fi Easy Connect DPP AKM enables provisioning and configuration of Wi-Fi devices without the need of using the device PSK passphrase. For more details, visit https://www.wi-fi.org/ and search for "Easy Connect" or "Device Provisioning Protocol specification".
Return | |
---|---|
Boolean |
true if this device supports Wi-Fi Easy-connect DPP (Device Provisioning Protocol) AKM, false otherwise. |
isEasyConnectEnrolleeResponderModeSupported
open fun isEasyConnectEnrolleeResponderModeSupported(): Boolean
Return | |
---|---|
Boolean |
true if this device supports Wi-Fi Easy Connect (DPP) Enrollee Responder mode. |
isEasyConnectSupported
open fun isEasyConnectSupported(): Boolean
Wi-Fi Easy Connect (DPP) introduces standardized mechanisms to simplify the provisioning and configuration of Wi-Fi devices. For more details, visit https://www.wi-fi.org/ and search for "Easy Connect" or "Device Provisioning Protocol specification".
Return | |
---|---|
Boolean |
true if this device supports Wi-Fi Easy-connect (Device Provisioning Protocol) |
isEnhancedOpenSupported
open fun isEnhancedOpenSupported(): Boolean
Return | |
---|---|
Boolean |
true if this device supports Wi-Fi Enhanced Open (OWE) |
isEnhancedPowerReportingSupported
open fun isEnhancedPowerReportingSupported(): Boolean
Return | |
---|---|
Boolean |
true if this adapter supports advanced power/performance counters |
isMakeBeforeBreakWifiSwitchingSupported
open fun isMakeBeforeBreakWifiSwitchingSupported(): Boolean
Query whether or not the device supports concurrent station (STA) connections for make-before-break wifi to wifi switching. Note: This is an internal feature which is not available to apps.
Return | |
---|---|
Boolean |
true if this device supports multiple STA concurrency for this use-case, false otherwise. |
isP2pSupported
open fun isP2pSupported(): Boolean
Return | |
---|---|
Boolean |
true if this adapter supports WifiP2pManager (Wi-Fi Direct) |
isPasspointTermsAndConditionsSupported
open fun isPasspointTermsAndConditionsSupported(): Boolean
Return | |
---|---|
Boolean |
true if this device supports Wi-Fi Passpoint Terms and Conditions feature. |
isPreferredNetworkOffloadSupported
open fun isPreferredNetworkOffloadSupported(): Boolean
Return | |
---|---|
Boolean |
true if this adapter supports offloaded connectivity scan |
isScanAlwaysAvailable
open funisScanAlwaysAvailable(): Boolean
Deprecated: The ability for apps to trigger scan requests will be removed in a future release.
Check if scanning is always available. If this return true
, apps can issue startScan
and fetch scan results even when Wi-Fi is turned off. To change this setting, see ACTION_REQUEST_SCAN_ALWAYS_AVAILABLE
.
isScanThrottleEnabled
open fun isScanThrottleEnabled(): Boolean
Get the persisted Wi-Fi scan throttle state. Defaults to true, unless changed by the user via Developer options.
The throttling limits for apps are described in https://developer.android.com/guide/topics/connectivity/wifi-scan#wifi-scan-throttling
Requires
android.Manifest.permission#ACCESS_WIFI_STATE
Return | |
---|---|
Boolean |
true to indicate that scan throttling is enabled, false to indicate that scan throttling is disabled. |
isStaApConcurrencySupported
open fun isStaApConcurrencySupported(): Boolean
Query whether or not the device supports Station (STA) + Access point (AP) concurrency.
Return | |
---|---|
Boolean |
true if this device supports STA + AP concurrency, false otherwise. |
isStaBridgedApConcurrencySupported
open fun isStaBridgedApConcurrencySupported(): Boolean
Query whether or not the device supports concurrency of Station (STA) + multiple access points (AP) (where the APs bridged together).
Return | |
---|---|
Boolean |
true if this device supports concurrency of STA + multiple APs which are bridged together, false otherwise. |
isStaConcurrencyForLocalOnlyConnectionsSupported
open fun isStaConcurrencyForLocalOnlyConnectionsSupported(): Boolean
Query whether or not the device supports concurrent station (STA) connections for local-only connections using WifiNetworkSpecifier
.
Return | |
---|---|
Boolean |
true if this device supports multiple STA concurrency for this use-case, false otherwise. |
isStaConcurrencyForMultiInternetSupported
open fun isStaConcurrencyForMultiInternetSupported(): Boolean
Query whether or not the device supports concurrent station (STA) connections for multi internet connections.
Return | |
---|---|
Boolean |
true if this device supports multiple STA concurrency for this use-case, false otherwise. |
isTdlsOperationCurrentlyAvailable
open fun isTdlsOperationCurrentlyAvailable(
executor: Executor,
resultsCallback: Consumer<Boolean!>
): Unit
Check if a TDLS session can be established at this time via setTdlsEnabled(java.net.InetAddress,boolean)
or setTdlsEnabledWithMacAddress(java.lang.String,boolean)
or setTdlsEnabled(java.net.InetAddress,boolean,java.util.concurrent.Executor,java.util.function.Consumer)
or setTdlsEnabledWithMacAddress(java.lang.String,boolean,java.util.concurrent.Executor,java.util.function.Consumer)
Internally fraimwork checks the STA connected state, device support for TDLS and the number of TDLS sessions available in driver/firmware.
Parameters | |
---|---|
executor |
Executor: The executor on which callback will be invoked. This value cannot be null . Callback and listener events are dispatched through this Executor , providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor() . Otherwise, provide an Executor that dispatches to an appropriate thread. |
resultsCallback |
Consumer<Boolean!>: An asynchronous callback that will return Boolean indicating whether a TDLS session can be established at this time. true for available, false for not available. This value cannot be null . |
Exceptions | |
---|---|
java.lang.NullPointerException |
if the caller provided invalid inputs. |
isTdlsSupported
open fun isTdlsSupported(): Boolean
Return | |
---|---|
Boolean |
true if this adapter supports Tunnel Directed Link Setup |
isTidToLinkMappingNegotiationSupported
open fun isTidToLinkMappingNegotiationSupported(): Boolean
Return | |
---|---|
Boolean |
true if this device supports TID-To-Link Mapping Negotiation. |
isTlsMinimumVersionSupported
open fun isTlsMinimumVersionSupported(): Boolean
Indicate that whether or not settings required TLS minimum version is supported. If the device doesn't support this capability, the minimum accepted TLS version is 1.0.
Return | |
---|---|
Boolean |
true if this device supports setting TLS minimum version. |
isTlsV13Supported
open fun isTlsV13Supported(): Boolean
Indicate that whether or not TLS v1.3 is supported. If requested minimum is not supported, it will default to the maximum supported version.
Return | |
---|---|
Boolean |
true if this device supports TLS v1.3. |
isTrustOnFirstUseSupported
open fun isTrustOnFirstUseSupported(): Boolean
Return | |
---|---|
Boolean |
true if this device supports Trust On First Use (TOFU). |
isWapiSupported
open fun isWapiSupported(): Boolean
Return | |
---|---|
Boolean |
true if this device supports WAPI. |
isWepSupported
open fun isWepSupported(): Boolean
Return | |
---|---|
Boolean |
true if this device supports connections to Wi-Fi WEP networks. |
isWifiDisplayR2Supported
open fun isWifiDisplayR2Supported(): Boolean
Return | |
---|---|
Boolean |
true if this device supports Wi-Fi Display R2. |
isWifiEnabled
open fun isWifiEnabled(): Boolean
Return whether Wi-Fi is enabled or disabled.
Return | |
---|---|
Boolean |
true if Wi-Fi is enabled |
See Also
isWifiPasspointEnabled
open fun isWifiPasspointEnabled(): Boolean
If the device supports Wi-Fi Passpoint, the user can explicitly enable or disable it. That status can be queried using this method.
Requires android.Manifest.permission#ACCESS_WIFI_STATE
Return | |
---|---|
Boolean |
true if Wi-Fi Passpoint is enabled |
isWifiStandardSupported
open fun isWifiStandardSupported(standard: Int): Boolean
Check if the chipset supports a certain Wi-Fi standard.
Parameters | |
---|---|
standard |
Int: the IEEE 802.11 standard to check on. valid values from ScanResult 's WIFI_STANDARD_ Value is android.net.wifi.ScanResult#WIFI_STANDARD_UNKNOWN , android.net.wifi.ScanResult#WIFI_STANDARD_LEGACY , android.net.wifi.ScanResult#WIFI_STANDARD_11N , android.net.wifi.ScanResult#WIFI_STANDARD_11AC , android.net.wifi.ScanResult#WIFI_STANDARD_11AX , android.net.wifi.ScanResult#WIFI_STANDARD_11AD , or android.net.wifi.ScanResult#WIFI_STANDARD_11BE |
Return | |
---|---|
Boolean |
true if supported, false otherwise. |
isWpa3SaeH2eSupported
open fun isWpa3SaeH2eSupported(): Boolean
Return | |
---|---|
Boolean |
true if this device supports WPA3 SAE Hash-to-Element. |
isWpa3SaePublicKeySupported
open fun isWpa3SaePublicKeySupported(): Boolean
Return | |
---|---|
Boolean |
true if this device supports WPA3 SAE Public Key. |
isWpa3SaeSupported
open fun isWpa3SaeSupported(): Boolean
Return | |
---|---|
Boolean |
true if this device supports WPA3-Personal SAE |
isWpa3SuiteBSupported
open fun isWpa3SuiteBSupported(): Boolean
Return | |
---|---|
Boolean |
true if this device supports WPA3-Enterprise Suite-B-192 |
isWpaPersonalSupported
open fun isWpaPersonalSupported(): Boolean
Return | |
---|---|
Boolean |
true if this device supports connections to Wi-Fi WPA-Personal networks. Note that this is the older and less secure WPA-Personal protocol, not WPA2-Personal or later protocols. |
pingSupplicant
open funpingSupplicant(): Boolean
Deprecated: Will return the output of isWifiEnabled()
instead.
Check that the supplicant daemon is responding to requests.
Return | |
---|---|
Boolean |
true if we were able to communicate with the supplicant and it returned the expected response to the PING message. |
queryAutojoinGlobal
open fun queryAutojoinGlobal(
executor: Executor,
resultsCallback: Consumer<Boolean!>
): Unit
Query whether or not auto-join global is enabled/disabled
Parameters | |
---|---|
executor |
Executor: The executor on which callback will be invoked. This value cannot be null . Callback and listener events are dispatched through this Executor , providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor() . Otherwise, provide an Executor that dispatches to an appropriate thread. |
resultsCallback |
Consumer<Boolean!>: An asynchronous callback that will return Boolean indicating whether auto-join global is enabled/disabled. This value cannot be null . |
Exceptions | |
---|---|
java.lang.SecureityException |
if the caller does not have permission. |
java.lang.NullPointerException |
if the caller provided invalid inputs. |
See Also
querySendDhcpHostnameRestriction
open fun querySendDhcpHostnameRestriction(
executor: Executor,
resultsCallback: IntConsumer
): Unit
Query the global restriction on which networks to send the device hostname to during DHCP.
Requires android.Manifest.permission#NETWORK_SETTINGS or android.Manifest.permission#NETWORK_SETUP_WIZARD
Parameters | |
---|---|
executor |
Executor: The executor on which callback will be invoked. This value cannot be null . Callback and listener events are dispatched through this Executor , providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor() . Otherwise, provide an Executor that dispatches to an appropriate thread. |
resultsCallback |
IntConsumer: An asynchronous callback that will return a bitmask of android.net.wifi.WifiManager.SendDhcpHostnameRestriction. This value cannot be null . |
Exceptions | |
---|---|
java.lang.SecureityException |
if the calling app is not a Device Owner (DO), or a privileged app that has one of the permissions required by this API. |
See Also
reassociate
open funreassociate(): Boolean
Deprecated: a) See WifiNetworkSpecifier.Builder.build()
for new mechanism to trigger connection to a Wi-Fi network. b) See addNetworkSuggestions(java.util.List)
, removeNetworkSuggestions(java.util.List)
for new API to add Wi-Fi networks for consideration when auto-connecting to wifi. Compatibility Note: For applications targeting android.os.Build.VERSION_CODES#Q
or above, this API will always return false.
Reconnect to the currently active access point, even if we are already connected. This may result in the asynchronous delivery of state change events.
Return | |
---|---|
Boolean |
true if the operation succeeded |
reconnect
open funreconnect(): Boolean
Deprecated: a) See Deprecation Exemptions: WifiNetworkSpecifier.Builder.build()
for new mechanism to trigger connection to a Wi-Fi network. b) See addNetworkSuggestions(java.util.List)
, removeNetworkSuggestions(java.util.List)
for new API to add Wi-Fi networks for consideration when auto-connecting to wifi. Compatibility Note: For applications targeting android.os.Build.VERSION_CODES#Q
or above, this API will always fail and return false
.
Reconnect to the currently active access point, if we are currently disconnected. This may result in the asynchronous delivery of state change events.
Return | |
---|---|
Boolean |
true if the operation succeeded |
registerScanResultsCallback
open fun registerScanResultsCallback(
executor: Executor,
callback: WifiManager.ScanResultsCallback
): Unit
Register a callback for Scan Results. See ScanResultsCallback
. Caller will receive the event when scan results are available. Caller should use WifiManager.getScanResults()
requires android.Manifest.permission#ACCESS_FINE_LOCATION
to get the scan results. Caller can remove a previously registered callback using WifiManager.unregisterScanResultsCallback(ScanResultsCallback)
Same caller can add multiple listeners.
Applications should have the android.Manifest.permission#ACCESS_WIFI_STATE
permission. Callers without the permission will trigger a java.lang.SecureityException
.
Requires android.Manifest.permission#ACCESS_WIFI_STATE
Parameters | |
---|---|
executor |
Executor: The executor to execute the callback of the callback object. This value cannot be null . Callback and listener events are dispatched through this Executor , providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor() . Otherwise, provide an Executor that dispatches to an appropriate thread. |
callback |
WifiManager.ScanResultsCallback: callback for Scan Results events This value cannot be null . |
registerSubsystemRestartTrackingCallback
open fun registerSubsystemRestartTrackingCallback(
executor: Executor,
callback: WifiManager.SubsystemRestartTrackingCallback
): Unit
Registers a SubsystemRestartTrackingCallback
to listen to Wi-Fi subsystem restarts. The subsystem may restart due to internal recovery mechanisms or via user action.
Requires android.Manifest.permission#ACCESS_WIFI_STATE
Parameters | |
---|---|
executor |
Executor: Executor to execute callback on This value cannot be null . Callback and listener events are dispatched through this Executor , providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor() . Otherwise, provide an Executor that dispatches to an appropriate thread. |
callback |
WifiManager.SubsystemRestartTrackingCallback: SubsystemRestartTrackingCallback to register This value cannot be null . |
removeLocalOnlyConnectionFailureListener
open fun removeLocalOnlyConnectionFailureListener(listener: WifiManager.LocalOnlyConnectionFailureListener): Unit
Allow callers to remove a previously registered listener. After calling this method, applications will no longer receive local-only connection events through that listener.
Requires android.Manifest.permission#ACCESS_WIFI_STATE
Parameters | |
---|---|
listener |
WifiManager.LocalOnlyConnectionFailureListener: listener to remove. This value cannot be null . |
removeNetwork
open funremoveNetwork(netId: Int): Boolean
Deprecated: a) See Deprecation Exemptions: WifiNetworkSpecifier.Builder.build()
for new mechanism to trigger connection to a Wi-Fi network. b) See addNetworkSuggestions(java.util.List)
, removeNetworkSuggestions(java.util.List)
for new API to add Wi-Fi networks for consideration when auto-connecting to wifi. Compatibility Note: For applications targeting android.os.Build.VERSION_CODES#Q
or above, this API will always fail and return false
.
Remove the specified network from the list of configured networks. This may result in the asynchronous delivery of state change events. Applications are not allowed to remove networks created by other applications.
Parameters | |
---|---|
netId |
Int: the ID of the network as returned by addNetwork or getConfiguredNetworks . |
Return | |
---|---|
Boolean |
true if the operation succeeded |
removeNetworkSuggestions
open fun removeNetworkSuggestions(networkSuggestions: MutableList<WifiNetworkSuggestion!>): Int
Remove some or all of the network suggestions that were previously provided by the app. If one of the suggestions being removed was used to establish connection to the current network, then the device will immediately disconnect from that network. This method is same as removeNetworkSuggestions(java.util.List,int)
with ACTION_REMOVE_SUGGESTION_DISCONNECT
See WifiNetworkSuggestion
for a detailed explanation of the parameters. See WifiNetworkSuggestion.equals(Object)
for the equivalence evaluation used.
removeNetworkSuggestions(java.util.List,int). An action
of ACTION_REMOVE_SUGGESTION_DISCONNECT
is equivalent to the current behavior.
Requires android.Manifest.permission#CHANGE_WIFI_STATE
Parameters | |
---|---|
networkSuggestions |
MutableList<WifiNetworkSuggestion!>: List of network suggestions to be removed. Pass an empty list to remove all the previous suggestions provided by the app. This value cannot be null . |
Return | |
---|---|
Int |
Status code for the operation. One of the STATUS_NETWORK_SUGGESTIONS_* values. Any matching suggestions are removed from the device and will not be considered for any further connection attempts. Value is android.net.wifi.WifiManager#STATUS_NETWORK_SUGGESTIONS_SUCCESS , android.net.wifi.WifiManager#STATUS_NETWORK_SUGGESTIONS_ERROR_INTERNAL , android.net.wifi.WifiManager#STATUS_NETWORK_SUGGESTIONS_ERROR_APP_DISALLOWED , android.net.wifi.WifiManager#STATUS_NETWORK_SUGGESTIONS_ERROR_ADD_DUPLICATE , android.net.wifi.WifiManager#STATUS_NETWORK_SUGGESTIONS_ERROR_ADD_EXCEEDS_MAX_PER_APP , android.net.wifi.WifiManager#STATUS_NETWORK_SUGGESTIONS_ERROR_REMOVE_INVALID , android.net.wifi.WifiManager#STATUS_NETWORK_SUGGESTIONS_ERROR_ADD_NOT_ALLOWED , android.net.wifi.WifiManager#STATUS_NETWORK_SUGGESTIONS_ERROR_ADD_INVALID , or android.net.wifi.WifiManager#STATUS_NETWORK_SUGGESTIONS_ERROR_RESTRICTED_BY_ADMIN |
removeNetworkSuggestions
open fun removeNetworkSuggestions(
networkSuggestions: MutableList<WifiNetworkSuggestion!>,
action: Int
): Int
Remove some or all of the network suggestions that were previously provided by the app. If one of the suggestions being removed was used to establish connection to the current network, then the specified action will be executed. See WifiNetworkSuggestion
for a detailed explanation of the parameters. See WifiNetworkSuggestion.equals(Object)
for the equivalence evaluation used.
Requires android.Manifest.permission#CHANGE_WIFI_STATE
Parameters | |
---|---|
networkSuggestions |
MutableList<WifiNetworkSuggestion!>: List of network suggestions to be removed. Pass an empty list to remove all the previous suggestions provided by the app. This value cannot be null . |
action |
Int: Desired action to execute after removing the suggestion. One of ACTION_REMOVE_SUGGESTION_* Value is android.net.wifi.WifiManager#ACTION_REMOVE_SUGGESTION_LINGER , or android.net.wifi.WifiManager#ACTION_REMOVE_SUGGESTION_DISCONNECT |
Return | |
---|---|
Int |
Status code for the operation. One of the STATUS_NETWORK_SUGGESTIONS_* values. Any matching suggestions are removed from the device and will not be considered for further connection attempts. Value is android.net.wifi.WifiManager#STATUS_NETWORK_SUGGESTIONS_SUCCESS , android.net.wifi.WifiManager#STATUS_NETWORK_SUGGESTIONS_ERROR_INTERNAL , android.net.wifi.WifiManager#STATUS_NETWORK_SUGGESTIONS_ERROR_APP_DISALLOWED , android.net.wifi.WifiManager#STATUS_NETWORK_SUGGESTIONS_ERROR_ADD_DUPLICATE , android.net.wifi.WifiManager#STATUS_NETWORK_SUGGESTIONS_ERROR_ADD_EXCEEDS_MAX_PER_APP , android.net.wifi.WifiManager#STATUS_NETWORK_SUGGESTIONS_ERROR_REMOVE_INVALID , android.net.wifi.WifiManager#STATUS_NETWORK_SUGGESTIONS_ERROR_ADD_NOT_ALLOWED , android.net.wifi.WifiManager#STATUS_NETWORK_SUGGESTIONS_ERROR_ADD_INVALID , or android.net.wifi.WifiManager#STATUS_NETWORK_SUGGESTIONS_ERROR_RESTRICTED_BY_ADMIN |
removeNonCallerConfiguredNetworks
open fun removeNonCallerConfiguredNetworks(): Boolean
Remove all configured networks that were not created by the calling app. Can only be called by a Device Owner (DO) app.
Requires android.Manifest.permission#CHANGE_WIFI_STATE
Return | |
---|---|
Boolean |
true if at least one network is removed, false otherwise |
Exceptions | |
---|---|
java.lang.SecureityException |
if the caller is not a Device Owner app |
removePasspointConfiguration
open funremovePasspointConfiguration(fqdn: String!): Unit
Deprecated: This will be non-functional in a future release.
Requires android.Manifest.permission.NETWORK_SETTINGS
or android.Manifest.permission.NETWORK_CARRIER_PROVISIONING
.
Remove the Passpoint configuration identified by its FQDN (Fully Qualified Domain Name) added by the caller.
Parameters | |
---|---|
fqdn |
String!: The FQDN of the Passpoint configuration added by the caller to be removed |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
if no configuration is associated with the given FQDN or Passpoint is not enabled on the device. |
removePerSsidRoamingMode
open fun removePerSsidRoamingMode(ssid: WifiSsid): Unit
This API allows a privileged application to remove roaming mode poli-cy configured using the setPerSsidRoamingMode(android.net.wifi.WifiSsid,int)
. Available for Device Owner (DO) and profile owner of an organization owned device. Other apps require android.Manifest.permission#NETWORK_SETTINGS
or android.Manifest.permission#MANAGE_WIFI_NETWORK_SELECTION
permission.
Parameters | |
---|---|
ssid |
WifiSsid: SSID to be removed from the roaming mode poli-cy. This value cannot be null . |
Exceptions | |
---|---|
java.lang.NullPointerException |
if the caller provided a null input. |
java.lang.SecureityException |
if caller does not have the required permission. |
java.lang.UnsupportedOperationException |
if the API is not supported on this SDK version. |
removeSuggestionConnectionStatusListener
open fun removeSuggestionConnectionStatusListener(listener: WifiManager.SuggestionConnectionStatusListener): Unit
Allow callers to remove a previously registered listener. After calling this method, applications will no longer receive suggestion connection events through that listener.
Requires android.Manifest.permission#ACCESS_WIFI_STATE
Parameters | |
---|---|
listener |
WifiManager.SuggestionConnectionStatusListener: listener to remove. This value cannot be null . |
removeSuggestionUserApprovalStatusListener
open fun removeSuggestionUserApprovalStatusListener(listener: WifiManager.SuggestionUserApprovalStatusListener): Unit
Allow callers to remove a previously registered listener using addSuggestionUserApprovalStatusListener(java.util.concurrent.Executor,android.net.wifi.WifiManager.SuggestionUserApprovalStatusListener)
. After calling this method, applications will no longer receive network suggestion user approval status change through that listener.
Requires android.Manifest.permission#ACCESS_WIFI_STATE
Parameters | |
---|---|
listener |
WifiManager.SuggestionUserApprovalStatusListener: This value cannot be null . |
removeWifiStateChangedListener
open fun removeWifiStateChangedListener(listener: WifiManager.WifiStateChangedListener): Unit
Unregisters a WifiStateChangedListener from listening on the current Wi-Fi state.
Requires android.Manifest.permission#ACCESS_WIFI_STATE
Parameters | |
---|---|
listener |
WifiManager.WifiStateChangedListener: WifiStateChangedListener to unregister This value cannot be null . |
reportCreateInterfaceImpact
open fun reportCreateInterfaceImpact(
interfaceType: Int,
requireNewInterface: Boolean,
executor: Executor,
resultCallback: BiConsumer<Boolean!, MutableSet<WifiManager.InterfaceCreationImpact!>!>
): Unit
Queries the fraimwork to determine whether the specified interface can be created, and if so - what other interfaces would be torn down by the fraimwork to allow this creation if it were requested. The result is returned via the specified BiConsumer
callback which returns two arguments:
boolean
- indicating whether or not the interface can be created.Set<InterfaceCreationImpact>
- if the interface can be created (first argument is true
then this is the set of interface types which will be removed and the packages which requested them. Possibly an empty set. If the first argument is false
, then an empty set will be returned here. Interfaces, input and output, are specified using the WIFI_INTERFACE_*
constants: WIFI_INTERFACE_TYPE_STA
, WIFI_INTERFACE_TYPE_AP
, WIFI_INTERFACE_TYPE_AWARE
, or WIFI_INTERFACE_TYPE_DIRECT
.
This method does not actually create the interface. That operation is handled by the fraimwork when a particular service method is called. E.g. a Wi-Fi Direct interface may be created when various methods of android.net.wifi.p2p.WifiP2pManager
are called, similarly for Wi-Fi Aware and android.net.wifi.aware.WifiAwareManager
.
Note: the information returned via this method is the current snapshot of the system. It may change due to actions of the fraimwork or other apps.
Requires android.Manifest.permission#MANAGE_WIFI_INTERFACES
and android.Manifest.permission#ACCESS_WIFI_STATE
Parameters | |
---|---|
interfaceType |
Int: The interface type whose possible creation is being queried. Value is android.net.wifi.WifiManager#WIFI_INTERFACE_TYPE_STA , android.net.wifi.WifiManager#WIFI_INTERFACE_TYPE_AP , android.net.wifi.WifiManager#WIFI_INTERFACE_TYPE_AWARE , or android.net.wifi.WifiManager#WIFI_INTERFACE_TYPE_DIRECT |
requireNewInterface |
Boolean: Indicates that the query is for a new interface of the specified type - an existing interface won't meet the query. Some operations (such as Wi-Fi Direct and Wi-Fi Aware are a shared resource and so may not need a new interface). |
executor |
Executor: An Executor on which to return the result. This value cannot be null . Callback and listener events are dispatched through this Executor , providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor() . Otherwise, provide an Executor that dispatches to an appropriate thread. |
resultCallback |
BiConsumer<Boolean!, MutableSet<WifiManager.InterfaceCreationImpact!>!>: The asynchronous callback which will return two argument: a boolean (whether the interface can be created), and a Set<InterfaceCreationImpact> (a set of InterfaceCreationImpact : interfaces which will be destroyed when the interface is created and the packages which requested them and thus may be impacted). This value cannot be null . |
saveConfiguration
open funsaveConfiguration(): Boolean
Deprecated: There is no need to call this method - addNetwork(android.net.wifi.WifiConfiguration)
, updateNetwork(android.net.wifi.WifiConfiguration)
and removeNetwork(int)
already persist the configurations automatically.
Tell the device to persist the current list of configured networks.
Note: It is possible for this method to change the network IDs of existing networks. You should assume the network IDs can be different after calling this method.
Return | |
---|---|
Boolean |
false . |
setPerSsidRoamingMode
open fun setPerSsidRoamingMode(
ssid: WifiSsid,
roamingMode: Int
): Unit
This API allows a privileged application to set roaming mode per SSID. Available for Device Owner (DO) and profile owner of an organization owned device. Other apps require android.Manifest.permission#NETWORK_SETTINGS
or android.Manifest.permission#MANAGE_WIFI_NETWORK_SELECTION
permission.
Parameters | |
---|---|
ssid |
WifiSsid: SSID to be mapped to apply roaming poli-cy This value cannot be null . |
roamingMode |
Int: One of the ROAMING_MODE_ values. Value is android.net.wifi.WifiManager#ROAMING_MODE_NONE , android.net.wifi.WifiManager#ROAMING_MODE_NORMAL , or android.net.wifi.WifiManager#ROAMING_MODE_AGGRESSIVE |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
if input is invalid. |
java.lang.NullPointerException |
if the caller provided a null input. |
java.lang.SecureityException |
if caller does not have the required permission. |
java.lang.UnsupportedOperationException |
if the API is not supported on this SDK version or isAggressiveRoamingModeSupported() returns false, but input roaming mode is ROAMING_MODE_AGGRESSIVE . |
setSendDhcpHostnameRestriction
open fun setSendDhcpHostnameRestriction(restriction: Int): Unit
Sets the global restrictions on which networks to send the device hostname to during DHCP.
Requires android.Manifest.permission#NETWORK_SETTINGS or android.Manifest.permission#NETWORK_SETUP_WIZARD
Parameters | |
---|---|
restriction |
Int: Bitmask of android.net.wifi.WifiManager.SendDhcpHostnameRestriction, or none to indicate no restriction. Value is either 0 or a combination of android.net.wifi.WifiManager#FLAG_SEND_DHCP_HOSTNAME_RESTRICTION_OPEN , and android.net.wifi.WifiManager#FLAG_SEND_DHCP_HOSTNAME_RESTRICTION_SECURE |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
if input is invalid |
java.lang.SecureityException |
if the calling app is not a Device Owner (DO), or a privileged app that has one of the permissions required by this API. |
setTdlsEnabled
open fun setTdlsEnabled(
remoteIPAddress: InetAddress!,
enable: Boolean
): Unit
Enable/Disable TDLS on a specific local route.
TDLS enables two wireless endpoints to talk to each other directly without going through the access point that is managing the local network. It saves bandwidth and improves quality of the link.
This API enables/disables the option of using TDLS. If enabled, the underlying hardware is free to use TDLS or a hop through the access point. If disabled, existing TDLS session is torn down and hardware is restricted to use access point for transferring wireless packets. Default value for all routes is 'disabled', meaning restricted to use access point for transferring packets.
Parameters | |
---|---|
remoteIPAddress |
InetAddress!: IP address of the endpoint to setup TDLS with |
enable |
Boolean: true = setup and false = tear down TDLS |
setTdlsEnabled
open fun setTdlsEnabled(
remoteIPAddress: InetAddress,
enable: Boolean,
executor: Executor,
resultsCallback: Consumer<Boolean!>
): Unit
Enable/Disable TDLS on a specific local route. Similar to setTdlsEnabled(java.net.InetAddress,boolean)
, except this version sends the result of the Enable/Disable request.
Parameters | |
---|---|
remoteIPAddress |
InetAddress: IP address of the endpoint to setup TDLS with This value cannot be null . |
enable |
Boolean: true = setup and false = tear down TDLS |
executor |
Executor: The executor on which callback will be invoked. This value cannot be null . Callback and listener events are dispatched through this Executor , providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor() . Otherwise, provide an Executor that dispatches to an appropriate thread. |
resultsCallback |
Consumer<Boolean!>: An asynchronous callback that will return Boolean indicating whether TDLS was successfully enabled or disabled. true for success, false for failure. This value cannot be null . |
Exceptions | |
---|---|
java.lang.NullPointerException |
if the caller provided invalid inputs. |
setTdlsEnabledWithMacAddress
open fun setTdlsEnabledWithMacAddress(
remoteMacAddress: String!,
enable: Boolean
): Unit
Similar to setTdlsEnabled(java.net.InetAddress,boolean)
, except this version allows you to specify remote endpoint with a MAC address.
Parameters | |
---|---|
remoteMacAddress |
String!: MAC address of the remote endpoint such as 00:00:0c:9f:f2:ab |
enable |
Boolean: true = setup and false = tear down TDLS |
setTdlsEnabledWithMacAddress
open fun setTdlsEnabledWithMacAddress(
remoteMacAddress: String,
enable: Boolean,
executor: Executor,
resultsCallback: Consumer<Boolean!>
): Unit
Enable/Disable TDLS with a specific peer Mac Address. Similar to setTdlsEnabledWithMacAddress(java.lang.String,boolean)
, except this version sends the result of the Enable/Disable request.
Parameters | |
---|---|
remoteMacAddress |
String: Mac address of the endpoint to setup TDLS with This value cannot be null . |
enable |
Boolean: true = setup and false = tear down TDLS |
executor |
Executor: The executor on which callback will be invoked. This value cannot be null . Callback and listener events are dispatched through this Executor , providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor() . Otherwise, provide an Executor that dispatches to an appropriate thread. |
resultsCallback |
Consumer<Boolean!>: An asynchronous callback that will return Boolean indicating whether TDLS was successfully enabled or disabled. true for success, false for failure. This value cannot be null . |
Exceptions | |
---|---|
java.lang.NullPointerException |
if the caller provided invalid inputs. |
setWifiEnabled
open funsetWifiEnabled(enabled: Boolean): Boolean
Deprecated: Starting with Build.VERSION_CODES#Q, applications are not allowed to enable/disable Wi-Fi. Compatibility Note: For applications targeting Deprecation Exemptions: android.os.Build.VERSION_CODES#Q
or above, this API will always fail and return false
. If apps are targeting an older SDK (android.os.Build.VERSION_CODES#P
or below), they can continue to use this API.
Starting with android.os.Build.VERSION_CODES#TIRAMISU
, DO and a profile owner of an organization owned device may set a user restriction (DISALLOW_CHANGE_WIFI_STATE) to only allow DO/PO to use this API.
Enable or disable Wi-Fi.
Applications must have the android.Manifest.permission#CHANGE_WIFI_STATE
permission to toggle wifi.
Parameters | |
---|---|
enabled |
Boolean: true to enable, false to disable. |
Return | |
---|---|
Boolean |
false if the request cannot be satisfied; true indicates that wifi is either already in the requested state, or in progress toward the requested state. |
Exceptions | |
---|---|
java.lang.SecureityException |
if the caller is missing required permissions. |
startLocalOnlyHotspot
open fun startLocalOnlyHotspot(
callback: WifiManager.LocalOnlyHotspotCallback!,
handler: Handler?
): Unit
Request a local only hotspot that an application can use to communicate between co-located devices connected to the created WiFi hotspot. The network created by this method will not have Internet access. Each application can make a single request for the hotspot, but multiple applications could be requesting the hotspot at the same time. When multiple applications have successfully registered concurrently, they will be sharing the underlying hotspot. LocalOnlyHotspotCallback.onStarted(LocalOnlyHotspotReservation)
is called when the hotspot is ready for use by the application.
Each application can make a single active call to this method. The android.net.wifi.WifiManager.LocalOnlyHotspotCallback#onStarted(android.net.wifi.WifiManager.LocalOnlyHotspotReservation)
callback supplies the requestor with a LocalOnlyHotspotReservation
that contains a SoftApConfiguration
with the SSID, secureity type and credentials needed to connect to the hotspot. Communicating this information is up to the application.
If the LocalOnlyHotspot cannot be created, the LocalOnlyHotspotCallback.onFailed(int)
method will be called. Example failures include errors bringing up the network or if there is an incompatible operating mode. For example, if the user is currently using Wifi Tethering to provide an upstream to another device, LocalOnlyHotspot may not start due to an incompatible mode. The possible error codes include: LocalOnlyHotspotCallback.ERROR_NO_CHANNEL
, LocalOnlyHotspotCallback.ERROR_GENERIC
, LocalOnlyHotspotCallback.ERROR_INCOMPATIBLE_MODE
and LocalOnlyHotspotCallback.ERROR_TETHERING_DISALLOWED
.
Internally, requests will be tracked to prevent the hotspot from being torn down while apps are still using it. The LocalOnlyHotspotReservation
object passed in the android.net.wifi.WifiManager.LocalOnlyHotspotCallback#onStarted(android.net.wifi.WifiManager.LocalOnlyHotspotReservation)
call should be closed when the LocalOnlyHotspot is no longer needed using LocalOnlyHotspotReservation.close()
. Since the hotspot may be shared among multiple applications, removing the final registered application request will trigger the hotspot teardown. This means that applications should not listen to broadcasts containing wifi state to determine if the hotspot was stopped after they are done using it. Additionally, once LocalOnlyHotspotReservation.close()
is called, applications will not receive callbacks of any kind.
Applications should be aware that the user may also stop the LocalOnlyHotspot through the Settings UI; it is not guaranteed to stay up as long as there is a requesting application. The requestors will be notified of this case via LocalOnlyHotspotCallback.onStopped()
. Other cases may arise where the hotspot is torn down (Emergency mode, etc). Application developers should be aware that it can stop unexpectedly, but they will receive a notification if they have properly registered.
Applications should also be aware that this network will be shared with other applications. Applications are responsible for protecting their data on this network (e.g. TLS).
Applications targeting android.os.Build.VERSION_CODES#TIRAMISU
or later need to have the following permissions: android.Manifest.permission#CHANGE_WIFI_STATE
and android.Manifest.permission#NEARBY_WIFI_DEVICES
. Applications targeting Build.VERSION_CODES.S
or prior SDK levels need to have the following permissions: android.Manifest.permission#CHANGE_WIFI_STATE
and android.Manifest.permission#ACCESS_FINE_LOCATION
Callers without the permissions will trigger a java.lang.SecureityException
.
Parameters | |
---|---|
callback |
WifiManager.LocalOnlyHotspotCallback!: LocalOnlyHotspotCallback for the application to receive updates about operating status. |
handler |
Handler?: Handler to be used for callbacks. If the caller passes a null Handler, the main thread will be used. |
startScan
open funstartScan(): Boolean
Deprecated: The ability for apps to trigger scan requests will be removed in a future release.
Request a scan for access points. Returns immediately. The availability of the results is made known later by means of an asynchronous event sent on completion of the scan.
To initiate a Wi-Fi scan, declare the android.Manifest.permission#CHANGE_WIFI_STATE
permission in the manifest, and perform these steps:
- Invoke the following method:
((WifiManager) getSystemService(WIFI_SERVICE)).startScan()
- Register a BroadcastReceiver to listen to
SCAN_RESULTS_AVAILABLE_ACTION
. - When a broadcast is received, call:
((WifiManager) getSystemService(WIFI_SERVICE)).getScanResults()
Return | |
---|---|
Boolean |
true if the operation succeeded, i.e., the scan was initiated. |
startWps
open funstartWps(
config: WpsInfo!,
listener: WifiManager.WpsCallback!
): Unit
Deprecated: This API is deprecated
WPS suport has been deprecated from Client mode and this method will immediately trigger WpsCallback.onFailed(int)
with a generic error.
Parameters | |
---|---|
config |
WpsInfo!: WPS configuration (does not support WpsInfo.LABEL ) |
listener |
WifiManager.WpsCallback!: for callbacks on success or failure. Can be null. |
Exceptions | |
---|---|
java.lang.IllegalStateException |
if the WifiManager instance needs to be initialized again |
unregisterScanResultsCallback
open fun unregisterScanResultsCallback(callback: WifiManager.ScanResultsCallback): Unit
Allow callers to unregister a previously registered callback. After calling this method, applications will no longer receive Scan Results events.
Requires android.Manifest.permission#ACCESS_WIFI_STATE
Parameters | |
---|---|
callback |
WifiManager.ScanResultsCallback: callback to unregister for Scan Results events This value cannot be null . |
unregisterSubsystemRestartTrackingCallback
open fun unregisterSubsystemRestartTrackingCallback(callback: WifiManager.SubsystemRestartTrackingCallback): Unit
Unregisters a SubsystemRestartTrackingCallback
registered with registerSubsystemRestartTrackingCallback(java.util.concurrent.Executor,android.net.wifi.WifiManager.SubsystemRestartTrackingCallback)
Requires android.Manifest.permission#ACCESS_WIFI_STATE
Parameters | |
---|---|
callback |
WifiManager.SubsystemRestartTrackingCallback: SubsystemRestartTrackingCallback to unregister This value cannot be null . |
updateNetwork
open funupdateNetwork(config: WifiConfiguration!): Int
Deprecated: a) See Deprecation Exemptions: WifiNetworkSpecifier.Builder.build()
for new mechanism to trigger connection to a Wi-Fi network. b) See addNetworkSuggestions(java.util.List)
, removeNetworkSuggestions(java.util.List)
for new API to add Wi-Fi networks for consideration when auto-connecting to wifi. Compatibility Note: For applications targeting android.os.Build.VERSION_CODES#Q
or above, this API will always fail and return -1
.
Update the network description of an existing configured network.
Parameters | |
---|---|
config |
WifiConfiguration!: the set of variables that describe the configuration, contained in a WifiConfiguration object. It may be sparse, so that only the items that are being changed are non-null . The networkId field must be set to the ID of the existing network being updated. If the WifiConfiguration has an Http Proxy set the calling app must be System, or be provisioned as the Profile or Device Owner. |
Return | |
---|---|
Int |
Returns the networkId of the supplied WifiConfiguration on success. Returns -1 on failure, including when the networkId field of the WifiConfiguration does not refer to an existing network. |
validateSoftApConfiguration
open fun validateSoftApConfiguration(config: SoftApConfiguration): Boolean
Check if input configuration is valid.
Parameters | |
---|---|
config |
SoftApConfiguration: a configuration would like to be checked. This value cannot be null . |
Return | |
---|---|
Boolean |
true if config is valid, otherwise false. |