/**@class android.net.wifi.WifiConfiguration
implements android.os.Parcelable
@extends java.lang.Object
A class representing a configured Wi-Fi network, including the
security configuration.
@deprecated Use {@link android.net.wifi.WifiNetworkSpecifier.Builder} to create {@link NetworkSpecifier} and
{@link android.net.wifi.WifiNetworkSuggestion.Builder} to create {@link android.net.wifi.WifiNetworkSuggestion}. This will become a
system use only object in the future.
*/
var WifiConfiguration = {
/**{@hide} */
ssidVarName : "ssid",
/**{@hide} */
bssidVarName : "bssid",
/**{@hide} */
pskVarName : "psk",
/**{@hide} */
wepKeyVarNames : "null",
/**{@hide} */
wepTxKeyIdxVarName : "wep_tx_keyidx",
/**{@hide} */
priorityVarName : "priority",
/**{@hide} */
hiddenSSIDVarName : "scan_ssid",
/**{@hide} */
pmfVarName : "ieee80211w",
/**{@hide} */
updateIdentiferVarName : "update_identifier",
/**{@hide} */
INVALID_NETWORK_ID : "-1",
/**{@hide} */
LOCAL_ONLY_NETWORK_ID : "-2",
/**@hide */
SECURITY_TYPE_OPEN : "0",
/**@hide */
SECURITY_TYPE_WEP : "1",
/**@hide */
SECURITY_TYPE_PSK : "2",
/**@hide */
SECURITY_TYPE_EAP : "3",
/**@hide */
SECURITY_TYPE_SAE : "4",
/**@hide */
SECURITY_TYPE_EAP_SUITE_B : "5",
/**@hide */
SECURITY_TYPE_OWE : "6",
/**@hide */
UNKNOWN_UID : "-1",
/** The ID number that the supplicant uses to identify this
network configuration entry. This must be passed as an argument
to most calls into the supplicant.
*/
networkId : "null",
/** The current status of this network configuration entry.
@see Status
*/
status : "null",
/** The network's SSID. Can either be a UTF-8 string,
which must be enclosed in double quotation marks
(e.g., {@code "MyNetwork"}), or a string of
hex digits, which are not enclosed in quotes
(e.g., {@code 01a243f405}).
*/
SSID : "null",
/** When set, this network configuration entry should only be used when
associating with the AP having the specified BSSID. The value is
a string in the format of an Ethernet MAC address, e.g.,
<code>XX:XX:XX:XX:XX:XX</code> where each <code>X</code> is a hex digit.
*/
BSSID : "null",
/** 2GHz band.
@hide
*/
AP_BAND_2GHZ : "0",
/** 5GHz band.
@hide
*/
AP_BAND_5GHZ : "1",
/** Device is allowed to choose the optimal band (2Ghz or 5Ghz) based on device capability,
operating country code and current radio conditions.
@hide
*/
AP_BAND_ANY : "-1",
/** The band which AP resides on
-1:Any 0:2G 1:5G
By default, 2G is chosen
@hide
*/
apBand : "null",
/** The channel which AP resides on,currently, US only
2G 1-11
5G 36,40,44,48,149,153,157,161,165
0 - find a random available channel according to the apBand
@hide
*/
apChannel : "null",
/** Pre-shared key for use with WPA-PSK. Either an ASCII string enclosed in
double quotation marks (e.g., {@code "abcdefghij"} for PSK passphrase or
a string of 64 hex digits for raw PSK.
<p/>
When the value of this key is read, the actual key is
not returned, just a "*" if the key has a value, or the null
string otherwise.
*/
preSharedKey : "null",
/** Four WEP keys. For each of the four values, provide either an ASCII
string enclosed in double quotation marks (e.g., {@code "abcdef"}),
a string of hex digits (e.g., {@code 0102030405}), or an empty string
(e.g., {@code ""}).
<p/>
When the value of one of these keys is read, the actual key is
not returned, just a "*" if the key has a value, or the null
string otherwise.
@deprecated Due to security and performance limitations, use of WEP networks
is discouraged.
*/
wepKeys : "null",
/**Default WEP key index, ranging from 0 to 3.
@deprecated Due to security and performance limitations, use of WEP networks
is discouraged. */
wepTxKeyIndex : "null",
/** Priority determines the preference given to a network by {@code wpa_supplicant}
when choosing an access point with which to associate.
@deprecated This field does not exist anymore.
*/
priority : "null",
/** This is a network that does not broadcast its SSID, so an
SSID-specific probe request must be used for scans.
*/
hiddenSSID : "null",
/** This is a network that requries Protected Management Frames (PMF).
@hide
*/
requirePMF : "null",
/** Update identifier, for Passpoint network.
@hide
*/
updateIdentifier : "null",
/** The set of key management protocols supported by this configuration.
See {@link android.net.wifi.WifiConfiguration.KeyMgmt} for descriptions of the values.
Defaults to WPA-PSK WPA-EAP.
*/
allowedKeyManagement : "null",
/** The set of security protocols supported by this configuration.
See {@link android.net.wifi.WifiConfiguration.Protocol} for descriptions of the values.
Defaults to WPA RSN.
*/
allowedProtocols : "null",
/** The set of authentication protocols supported by this configuration.
See {@link android.net.wifi.WifiConfiguration.AuthAlgorithm} for descriptions of the values.
Defaults to automatic selection.
*/
allowedAuthAlgorithms : "null",
/** The set of pairwise ciphers for WPA supported by this configuration.
See {@link android.net.wifi.WifiConfiguration.PairwiseCipher} for descriptions of the values.
Defaults to CCMP TKIP.
*/
allowedPairwiseCiphers : "null",
/** The set of group ciphers supported by this configuration.
See {@link android.net.wifi.WifiConfiguration.GroupCipher} for descriptions of the values.
Defaults to CCMP TKIP WEP104 WEP40.
*/
allowedGroupCiphers : "null",
/** The set of group management ciphers supported by this configuration.
See {@link android.net.wifi.WifiConfiguration.GroupMgmtCipher} for descriptions of the values.
*/
allowedGroupManagementCiphers : "null",
/** The set of SuiteB ciphers supported by this configuration.
To be used for WPA3-Enterprise mode.
See {@link android.net.wifi.WifiConfiguration.SuiteBCipher} for descriptions of the values.
*/
allowedSuiteBCiphers : "null",
/** The enterprise configuration details specifying the EAP method,
certificates and other settings associated with the EAP.
*/
enterpriseConfig : "null",
/** Fully qualified domain name of a Passpoint configuration
*/
FQDN : "null",
/** Name of Passpoint credential provider
*/
providerFriendlyName : "null",
/** Flag indicating if this network is provided by a home Passpoint provider or a roaming
Passpoint provider. This flag will be {@code true} if this network is provided by
a home Passpoint provider and {@code false} if is provided by a roaming Passpoint provider
or is a non-Passpoint network.
*/
isHomeProviderNetwork : "null",
/** Roaming Consortium Id list for Passpoint credential; identifies a set of networks where
Passpoint credential will be considered valid
*/
roamingConsortiumIds : "null",
/** @hide
This network configuration is visible to and usable by other users on the
same device.
*/
shared : "null",
/** @hide
dhcp server MAC address if known
*/
dhcpServer : "null",
/** @hide
default Gateway MAC address if known
*/
defaultGwMacAddress : "null",
/** @hide
last time we connected, this configuration had validated internet access
*/
validatedInternetAccess : "null",
/** @hide
The number of beacon intervals between Delivery Traffic Indication Maps (DTIM)
This value is populated from scan results that contain Beacon Frames, which are infrequent.
The value is not guaranteed to be set or current (Although it SHOULDNT change once set)
Valid values are from 1 - 255. Initialized here as 0, use this to check if set.
*/
dtimInterval : "null",
/** Flag indicating if this configuration represents a legacy Passpoint configuration
(Release N or older). This is used for migrating Passpoint configuration from N to O.
This will no longer be needed after O.
@hide
*/
isLegacyPasspointConfig : "null",
/** @hide
Uid of app creating the configuration
*/
creatorUid : "null",
/** @hide
Uid of last app issuing a connection related command
*/
lastConnectUid : "null",
/** @hide
Uid of last app modifying the configuration
*/
lastUpdateUid : "null",
/** @hide
Universal name for app creating the configuration
see {@link PackageManager#getNameForUid(int)}
*/
creatorName : "null",
/** @hide
Universal name for app updating the configuration
see {@link PackageManager#getNameForUid(int)}
*/
lastUpdateName : "null",
/** @hide
Status of user approval for connection
*/
userApproved : "null",
/**@hide */
INVALID_RSSI : "null",
/** @hide
User hasn't specified if connection is okay
*/
USER_UNSPECIFIED : "0",
/** @hide
User has approved this for connection
*/
USER_APPROVED : "1",
/** @hide
User has banned this from connection
*/
USER_BANNED : "2",
/** @hide
Waiting for user input
*/
USER_PENDING : "3",
/** @hide
Number of reports indicating no Internet Access
*/
numNoInternetAccessReports : "null",
/** @hide
For debug: date at which the config was last updated
*/
updateTime : "null",
/** @hide
For debug: date at which the config was last updated
*/
creationTime : "null",
/** The WiFi configuration is expected not to have Internet access (e.g., a wireless printer, a
Chromecast hotspot, etc.). This will be set if the user explicitly confirms a connection to
this configuration and selects "don't ask again".
@hide
*/
noInternetAccessExpected : "null",
/** This Wifi configuration is expected for OSU(Online Sign Up) of Passpoint Release 2.
@hide
*/
osu : "null",
/** @hide
Last time the system was connected to this configuration.
*/
lastConnected : "null",
/** @hide
Last time the system was disconnected to this configuration.
*/
lastDisconnected : "null",
/** Set if the configuration was self added by the framework
This boolean is cleared if we get a connect/save/ update or
any wifiManager command that indicate the user interacted with the configuration
since we will now consider that the configuration belong to him.
@hide
*/
selfAdded : "null",
/** Set if the configuration was self added by the framework
This boolean is set once and never cleared. It is used
so as we never loose track of who created the
configuration in the first place.
@hide
*/
didSelfAdd : "null",
/** Peer WifiConfiguration this WifiConfiguration was added for
@hide
*/
peerWifiConfiguration : "null",
/** @hide
Indicate that a WifiConfiguration is temporary and should not be saved
nor considered by AutoJoin.
*/
ephemeral : "null",
/** Indicate whther the network is trusted or not. Networks are considered trusted
if the user explicitly allowed this network connection.
@hide
*/
trusted : "null",
/** This Wifi configuration is created from a {@link android.net.wifi.WifiNetworkSuggestion}
@hide
*/
fromWifiNetworkSuggestion : "null",
/** This Wifi configuration is created from a {@link android.net.wifi.WifiNetworkSpecifier}
@hide
*/
fromWifiNetworkSpecifier : "null",
/** Indicates if the creator of this configuration has expressed that it
should be considered metered.
@see #isMetered(WifiConfiguration, WifiInfo)
@hide
*/
meteredHint : "null",
/**{@hide} */
METERED_OVERRIDE_NONE : "0",
/**{@hide} */
METERED_OVERRIDE_METERED : "1",
/**{@hide} */
METERED_OVERRIDE_NOT_METERED : "2",
/** Indicates if the end user has expressed an explicit opinion about the
meteredness of this network, such as through the Settings app.
<p>
This should always override any values from {@link #meteredHint} or
{@link android.net.wifi.WifiInfo#getMeteredHint()}.
@see #isMetered(WifiConfiguration, WifiInfo)
@hide
*/
meteredOverride : "null",
/** @hide
Setting this value will force scan results associated with this configuration to
be included in the bucket of networks that are externally scored.
If not set, associated scan results will be treated as legacy saved networks and
will take precedence over networks in the scored category.
*/
useExternalScores : "null",
/** @hide
Number of time the scorer overrode a the priority based choice, when comparing two
WifiConfigurations, note that since comparing WifiConfiguration happens very often
potentially at every scan, this number might become very large, even on an idle
system.
*/
numScorerOverride : "null",
/** @hide
Number of time the scorer overrode a the priority based choice, and the comparison
triggered a network switch
*/
numScorerOverrideAndSwitchedNetwork : "null",
/** @hide
Number of time we associated to this configuration.
*/
numAssociation : "null",
/** @hide
Use factory MAC when connecting to this network
*/
RANDOMIZATION_NONE : "0",
/** @hide
Generate a randomized MAC once and reuse it for all connections to this network
*/
RANDOMIZATION_PERSISTENT : "1",
/** @hide
Level of MAC randomization for this network
*/
macRandomizationSetting : "null",
/**@hide
Boost given to RSSI on a home network for the purpose of calculating the score
This adds stickiness to home networks, as defined by:
- less than 4 known BSSIDs
- PSK only
- TODO: add a test to verify that all BSSIDs are behind same gateway
*/
HOME_NETWORK_RSSI_BOOST : "5",
/** @hide
RecentFailure member
*/
recentFailure : "null",
/** @hide
Linked Configurations: represent the set of Wificonfigurations that are equivalent
regarding roaming and auto-joining.
The linked configuration may or may not have same SSID, and may or may not have same
credentials.
For instance, linked configurations will have same defaultGwMacAddress or same dhcp server.
*/
linkedConfigurations : "null",
/**Implement the Parcelable interface {@hide} */
CREATOR : "null",
/**
@param {Number} securityType One of the security types from {@link SecurityType}.
@param securityType One of the security types from {@link SecurityType}.
*/
setSecurityParams : function( ) {},
/**
@hide The WiFi configuration is considered to have no internet access for purpose of autojoining
if there has been a report of it having no internet access, and, it never have had
internet access in the past.
*/
hasNoInternetAccess : function( ) {},
/**The WiFi configuration is expected not to have Internet access (e.g., a wireless printer, a
Chromecast hotspot, etc.). This will be set if the user explicitly confirms a connection to
this configuration and selects "don't ask again".
@hide
*/
isNoInternetAccessExpected : function( ) {},
/**
@hide Indicate that a WifiConfiguration is temporary and should not be saved
nor considered by AutoJoin.
*/
isEphemeral : function( ) {},
/**Blend together all the various opinions to decide if the given network
should be considered metered or not.
@hide
*/
isMetered : function( ) {},
/**
@hide Returns true if this WiFi config is for an open network.
*/
isOpenNetwork : function( ) {},
/**
@param {Object {MacAddress}} mac MacAddress to check
@param mac MacAddress to check
@return {Boolean} true if mac is good to use
*/
isValidMacAddressForRandomization : function( ) {},
/**
@hide Returns Randomized MAC address to use with the network.
If it is not set/valid, creates a new randomized address.
If it can't generate a valid mac, returns the default MAC.
*/
getOrCreateRandomizedMacAddress : function( ) {},
/**Returns MAC address set to be the local randomized MAC address.
Depending on user preference, the device may or may not use the returned MAC address for
connections to this network.
<p>
Information is restricted to Device Owner, Profile Owner, and Carrier apps
(which will only obtain addresses for configurations which they create). Other callers
will receive a default "02:00:00:00:00:00" MAC address.
*/
getRandomizedMacAddress : function( ) {},
/**
@param {Object {MacAddress}} mac MacAddress to change into
@param mac MacAddress to change into
*/
setRandomizedMacAddress : function( ) {},
/**
@hide
@return {Object {android.net.wifi.WifiConfiguration.NetworkSelectionStatus}} network selection status
*/
getNetworkSelectionStatus : function( ) {},
/**Set the network selection status
@hide
*/
setNetworkSelectionStatus : function( ) {},
/**Identify if this configuration represents a Passpoint network
*/
isPasspoint : function( ) {},
/**Helper function, identify if a configuration is linked
@hide
*/
isLinked : function( ) {},
/**Helper function, idenfity if a configuration should be treated as an enterprise network
@hide
*/
isEnterprise : function( ) {},
/**
*/
toString : function( ) {},
/**{@hide}
*/
getPrintableSsid : function( ) {},
/**
@hide
*/
userApprovedAsString : function( ) {},
/**Get an identifier for associating credentials with this config
@param {Object {WifiConfiguration}} current configuration contains values for additional fields
that are not part of this configuration. Used
when a config with some fields is passed by an application.
@throws IllegalStateException if config is invalid for key id generation
@hide
*/
getKeyIdForCredentials : function( ) {},
/**
@hide
*/
getAuthType : function( ) {},
/**
@hide return the string used to calculate the hash in WifiConfigStore
and uniquely identify this WifiConfiguration
*/
configKey : function( ) {},
/**
@hide return the SSID + security type in String format.
*/
getSsidAndSecurityTypeString : function( ) {},
/**
@hide get configKey, force calculating the config string
*/
configKey : function( ) {},
/**
@hide
*/
getIpConfiguration : function( ) {},
/**
@hide
*/
setIpConfiguration : function( ) {},
/**
@hide
*/
getStaticIpConfiguration : function( ) {},
/**
@hide
*/
setStaticIpConfiguration : function( ) {},
/**
@hide
*/
getIpAssignment : function( ) {},
/**
@hide
*/
setIpAssignment : function( ) {},
/**
@hide
*/
getProxySettings : function( ) {},
/**
@hide
*/
setProxySettings : function( ) {},
/**Returns the HTTP proxy used by this object.
@return {Object {android.net.ProxyInfo}} a {@link ProxyInfo httpProxy} representing the proxy specified by this
WifiConfiguration, or {@code null} if no proxy is specified.
*/
getHttpProxy : function( ) {},
/**Set the {@link ProxyInfo} for this WifiConfiguration. This method should only be used by a
device owner or profile owner. When other apps attempt to save a {@link android.net.wifi.WifiConfiguration}
with modified proxy settings, the methods {@link android.net.wifi.WifiManager#addNetwork} and
{@link android.net.wifi.WifiManager#updateNetwork} fail and return {@code -1}.
@param {Object {ProxyInfo}} httpProxy {@link ProxyInfo} representing the httpProxy to be used by this
WifiConfiguration. Setting this to {@code null} will explicitly set no
proxy, removing any proxy that was previously set.
@exception IllegalArgumentException for invalid httpProxy
*/
setHttpProxy : function( ) {},
/**
@hide
*/
setProxy : function( ) {},
/**Implement the Parcelable interface {@hide}
*/
describeContents : function( ) {},
/**
@hide
*/
setPasspointManagementObjectTree : function( ) {},
/**
@hide
*/
getMoTree : function( ) {},
/**Implement the Parcelable interface {@hide}
*/
writeToParcel : function( ) {},
/**Serializes the object for backup
@hide
*/
getBytesForBackup : function( ) {},
/**Deserializes a byte array into the WiFiConfiguration Object
@hide
*/
getWifiConfigFromBackup : function( ) {},
};