public static class WiseFy.generator
+extends java.lang.Object
+Modifier and Type | +Method and Description | +
---|---|
WiseFy |
+getSmarts()
+Mandatory - To build and return a WiseFy instance
+ |
+
WiseFy.generator |
+logging(boolean loggingEnabled)
+Non-mandatory - To enable/disable logging for the WiseFy instance
+ |
+
com.isupatches.wisefy.WiseFy.GetSmarts |
+withContext(android.content.Context context)
+Mandatory - The context to get a WiFi and Connectivity manager
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public com.isupatches.wisefy.WiseFy.GetSmarts withContext(android.content.Context context)+
context
- - The activity or application context
+ WithContext
public WiseFy.generator logging(boolean loggingEnabled)+
loggingEnabled
- - If logging is enabled or disabled
+ GetSmarts
public WiseFy getSmarts()+
public class WiseFy
+extends java.lang.Object
+WiseFy.withContext
Modifier and Type | +Class and Description | +
---|---|
static class |
+WiseFy.withContext
+Static class for builder pattern
+
+ Implements builder interfaces #
+Logging #GetSmarts |
+
Modifier and Type | +Field and Description | +
---|---|
android.net.ConnectivityManager |
+mConnectivityManager |
+
android.net.wifi.WifiManager |
+mWifiManager |
+
static int |
+WIFI_MANAGER_FAILURE |
+
static int |
+WISE_MANAGER_FAILURE |
+
Modifier and Type | +Method and Description | +
---|---|
int |
+addOpenNetwork(java.lang.String ssid)
+To add an open network to the user's configured network list
+ |
+
int |
+addWEPNetwork(java.lang.String ssid,
+ java.lang.String password)
+To add a WEP network to the user's configured network list
+ |
+
int |
+addWPA2Network(java.lang.String ssid,
+ java.lang.String password)
+To add a WPA2 network to the user's configured network list
+ |
+
int |
+calculateBars(int rssiLevel,
+ int targetNumberOfBars)
+To convert an RSSI level for a network to a number of bars
+ |
+
int |
+compareSignalLevel(int rssi1,
+ int rssi2)
+To compare the signal strength of two networks
+ |
+
boolean |
+connectToNetwork(java.lang.String ssidToConnectTo,
+ int timeoutInMillis)
+Used to connect to a network
+
+ Gets a list of saved networks, connects/reconnects to the given ssid, and then calls waitToConnectToSSID to verify connectivity
+ |
+
boolean |
+disableWifi()
+To disable Wifi on a user's device
+ |
+
boolean |
+disconnectFromCurrentNetwork()
+To disconnect the user from their current network
+ |
+
boolean |
+enableWifi()
+To enable Wifi on a user's device
+ |
+
android.net.wifi.WifiInfo |
+getCurrentNetwork()
+To retrieve the user's current network
+ |
+
java.util.List<android.net.wifi.ScanResult> |
+getNearbyAccessPoints(boolean filterDuplicates)
+To retrieve a list of nearby access points
+
+ *NOTE* Setting filterDuplicates to true will not return SSIDs with a weaker signal strength (will always take the highest)
+ |
+
java.util.List<android.net.wifi.WifiConfiguration> |
+getSavedNetworks()
+To retrieve a list of saved networks on a user's device
+ |
+
boolean |
+isDeviceConnectedToMobileNetwork()
+To check if the device is connected to a mobile network
+ |
+
boolean |
+isDeviceConnectedToMobileOrWifiNetwork()
+To check if the device is connected to a mobile or wifi network
+ |
+
boolean |
+isDeviceConnectedToSSID(java.lang.String ssid)
+To check if the device is connected to a given SSID
+
+ Used by connectToNetwork
+ |
+
boolean |
+isDeviceConnectedToWifiNetwork()
+To check if the device is connected to a wifi network
+ |
+
boolean |
+isLoggingEnabled()
+To query if logging is enabled or disabled for a WiseFy instance
+ |
+
boolean |
+isNetworkInConfigurationList(java.lang.String ssid)
+To check if an SSID is in the list of configured networks
+ |
+
boolean |
+isNetworkSecure(android.net.wifi.ScanResult scanResult)
+To check and return if a network is secure (WEP/PSK/EAP capabilities)
+ |
+
boolean |
+isWifiEnabled()
+To check if Wifi is enabled on the device or not
+ |
+
boolean |
+removeNetwork(java.lang.String ssidToRemove)
+To remove a configured network
+ |
+
java.lang.String |
+searchForSSID(java.lang.String ssidToSearchFor,
+ int timeoutInMillis)
+To search local networks and return the first one that contains a given ssid (non-case sensitive)
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public static final int WISE_MANAGER_FAILURE+
public static final int WIFI_MANAGER_FAILURE+
public android.net.ConnectivityManager mConnectivityManager+
public android.net.wifi.WifiManager mWifiManager+
public int addOpenNetwork(java.lang.String ssid)+
ssid
- - The ssid of the open network you want to addpublic int addWEPNetwork(java.lang.String ssid, + java.lang.String password)+
ssid
- - The ssid of the WEP network you want to addpassword
- - The password for the WEP network being addedpublic int addWPA2Network(java.lang.String ssid, + java.lang.String password)+
ssid
- - The ssid of the WPA2 network you want to addpassword
- - The password for the WPA2 network being addedpublic int calculateBars(int rssiLevel, + int targetNumberOfBars)+
rssiLevel
- - The signal strength of the networktargetNumberOfBars
- - How many bars or levels there will be totalpublic int compareSignalLevel(int rssi1, + int rssi2)+
rssi1
- - The signal strength of network 1rssi2
- - The signal strength of network 2public boolean connectToNetwork(java.lang.String ssidToConnectTo, + int timeoutInMillis)+
ssidToConnectTo
- - The ssid to connect/reconnect totimeoutInMillis
- - The number of milliseconds to continue waiting for the device to connect to the given SSIDpublic boolean disableWifi()+
public boolean disconnectFromCurrentNetwork()+
public boolean enableWifi()+
public android.net.wifi.WifiInfo getCurrentNetwork()+
public java.util.List<android.net.wifi.ScanResult> getNearbyAccessPoints(boolean filterDuplicates)+
filterDuplicates
- - If you want to exclude SSIDs with that same name that have a weaker signal strengthpublic java.util.List<android.net.wifi.WifiConfiguration> getSavedNetworks()+
public boolean isDeviceConnectedToMobileNetwork()+
public boolean isDeviceConnectedToMobileOrWifiNetwork()+
public boolean isDeviceConnectedToSSID(java.lang.String ssid)+
ssid
- - The SSID to check if the device is attached topublic boolean isDeviceConnectedToWifiNetwork()+
public boolean isNetworkInConfigurationList(java.lang.String ssid)+
ssid
- - The SSID to check and see if it's in the list of configured networkspublic boolean isNetworkSecure(android.net.wifi.ScanResult scanResult)+
scanResult
- - The network to see if it is securepublic boolean isWifiEnabled()+
public boolean removeNetwork(java.lang.String ssidToRemove)+
ssidToRemove
- - The ssid of the network you want to remove from the configured network listpublic java.lang.String searchForSSID(java.lang.String ssidToSearchFor, + int timeoutInMillis)+
ssidToSearchFor
- - The ssid to search fortimeoutInMillis
- - The number of milliseconds to keep searching for the SSIDpublic boolean isLoggingEnabled()+
public static class WiseFy.withContext
+extends java.lang.Object
+Logging
#GetSmarts
Constructor and Description | +
---|
withContext(android.content.Context context)
+Mandatory - The public constructor for the builder that requires a context
+ |
+
Modifier and Type | +Method and Description | +
---|---|
WiseFy |
+getSmarts()
+Mandatory - To build and return a WiseFy instance
+
+ Must be called after withContext
+
+#withContext(Context) |
+
WiseFy.withContext |
+logging(boolean loggingEnabled)
+Optional - Builder method that enables/disables logging for a WiseWy instance
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public withContext(android.content.Context context)+
context
- - The activity or application context to get a WifiConfiguration and
+ ConnectivityManager instancepublic WiseFy getSmarts()+
#withContext(Context)
public WiseFy.withContext logging(boolean loggingEnabled)+
loggingEnabled
- - If logging is enabled or disabled for an instance
+ Logging
Class | +Description | +
---|---|
WiseFy | +
+ Main class to manipulate and query network settings on an Android device
+
+ Uses the builder pattern for creation -
+WiseFy.withContext |
+
WiseFy.withContext | +
+ Static class for builder pattern
+
+ Implements builder interfaces #
+Logging #GetSmarts |
+
public class GetManagerUtil
+extends java.lang.Object
+Modifier and Type | +Method and Description | +
---|---|
android.net.ConnectivityManager |
+getConnectivityManager(android.content.Context context)
+To get a Connectivity manger instance from an activity's context.
+ |
+
static GetManagerUtil |
+getInstance() |
+
android.net.wifi.WifiManager |
+getWiFiManager(android.content.Context context)
+To get a WiFi manger instance from an activity's context.
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public static GetManagerUtil getInstance()+
public android.net.ConnectivityManager getConnectivityManager(android.content.Context context)+
context
- - The context to use to retrieve a connectivity manager via getSystemServiceConnectivityManager
,
+WiseFy
public android.net.wifi.WifiManager getWiFiManager(android.content.Context context)+
context
- - The context to use to retrieve a wifi manager via getSystemServiceWifiManager
,
+WiseFy
public class LogUtil
+extends java.lang.Object
+Modifier and Type | +Method and Description | +
---|---|
void |
+d(java.lang.String tag,
+ java.lang.String message,
+ boolean loggingEnabled) |
+
void |
+e(java.lang.String tag,
+ java.lang.String message,
+ boolean loggingEnabled) |
+
static LogUtil |
+getInstance() |
+
void |
+w(java.lang.String tag,
+ java.lang.String message,
+ boolean loggingEnabled) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public static LogUtil getInstance()+
public void d(java.lang.String tag, + java.lang.String message, + boolean loggingEnabled)+
public void w(java.lang.String tag, + java.lang.String message, + boolean loggingEnabled)+
public void e(java.lang.String tag, + java.lang.String message, + boolean loggingEnabled)+
public class SSIDUtil
+extends java.lang.Object
+Modifier and Type | +Method and Description | +
---|---|
java.lang.String |
+convertSSIDForConfig(java.lang.String ssid) |
+
static SSIDUtil |
+getInstance() |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Class | +Description | +
---|---|
GetManagerUtil | ++ |
LogUtil | ++ |
SSIDUtil | ++ |
public static class WiseFy.generator
+extends java.lang.Object
+Modifier and Type | +Method and Description | +
---|---|
WiseFy |
+getSmarts()
+Mandatory - To build and return a WiseFy instance
+ |
+
WiseFy.generator |
+logging(boolean loggingEnabled)
+Non-mandatory - To enable/disable logging for the WiseFy instance
+ |
+
com.isupatches.wisefy.WiseFy.GetSmarts |
+withContext(android.content.Context context)
+Mandatory - The context to get a WiFi and Connectivity manager
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public com.isupatches.wisefy.WiseFy.GetSmarts withContext(android.content.Context context)+
context
- - The activity or application context
+ WithContext
public WiseFy.generator logging(boolean loggingEnabled)+
loggingEnabled
- - If logging is enabled or disabled
+ GetSmarts
public WiseFy getSmarts()+
public class WiseFy
+extends java.lang.Object
+Modifier and Type | +Class and Description | +
---|---|
static class |
+WiseFy.generator
+Internal static class for builder pattern
+ |
+
Modifier and Type | +Field and Description | +
---|---|
android.net.ConnectivityManager |
+mConnectivityManager |
+
android.net.wifi.WifiManager |
+mWifiManager |
+
static int |
+WIFI_MANAGER_FAILURE |
+
static int |
+WISE_MANAGER_FAILURE |
+
Modifier and Type | +Method and Description | +
---|---|
int |
+addOpenNetwork(java.lang.String ssid)
+To add an open network to the user's configured network list
+ |
+
int |
+addWEPNetwork(java.lang.String ssid,
+ java.lang.String password)
+To add a WEP network to the user's configured network list
+ |
+
int |
+addWPA2Network(java.lang.String ssid,
+ java.lang.String password)
+To add a WPA2 network to the user's configured network list
+ |
+
int |
+calculateBars(int rssiLevel,
+ int targetNumberOfBars)
+To convert an RSSI level for a network to a number of bars
+ |
+
int |
+compareSignalLevel(int rssi1,
+ int rssi2)
+To compare the signal strength of two networks
+ |
+
boolean |
+connectToNetwork(java.lang.String ssidToConnectTo,
+ int timeoutInMillis)
+Used to connect to a network
+
+ Gets a list of saved networks, connects/reconnects to the given ssid, and then calls waitToConnectToSSID to verify connectivity
+ |
+
boolean |
+disableWifi()
+To disable Wifi on a user's device
+ |
+
boolean |
+disconnectFromCurrentNetwork()
+To disconnect the user from their current network
+ |
+
boolean |
+enableWifi()
+To enable Wifi on a user's device
+ |
+
android.net.wifi.WifiInfo |
+getCurrentNetwork()
+To retrieve the user's current network
+ |
+
java.util.List<android.net.wifi.ScanResult> |
+getNearbyAccessPoints(boolean filterDuplicates)
+To retrieve a list of nearby access points
+
+ *NOTE* Setting filterDuplicates to true will not return SSIDs with a weaker signal strength (will always take the highest)
+ |
+
java.util.List<android.net.wifi.WifiConfiguration> |
+getSavedNetworks()
+To retrieve a list of saved networks on a user's device
+ |
+
boolean |
+isDeviceConnectedToMobileNetwork()
+To check if the device is connected to a mobile network
+ |
+
boolean |
+isDeviceConnectedToMobileOrWifiNetwork()
+To check if the device is connected to a mobile or wifi network
+ |
+
boolean |
+isDeviceConnectedToSSID(java.lang.String ssid)
+To check if the device is connected to a given SSID
+
+ Used by connectToNetwork
+ |
+
boolean |
+isDeviceConnectedToWifiNetwork()
+To check if the device is connected to a wifi network
+ |
+
boolean |
+isLoggingEnabled()
+To query if logging is enabled or disabled for a WiseFy instance
+ |
+
boolean |
+isNetworkInConfigurationList(java.lang.String ssid)
+To check if an SSID is in the list of configured networks
+ |
+
boolean |
+isNetworkSecure(android.net.wifi.ScanResult scanResult)
+To check and return if a network is secure (WEP/PSK/EAP capabilities)
+ |
+
boolean |
+isWifiEnabled()
+To check if Wifi is enabled on the device or not
+ |
+
boolean |
+removeNetwork(java.lang.String ssidToRemove)
+To remove a configured network
+ |
+
java.lang.String |
+searchForSSID(java.lang.String ssidToSearchFor,
+ int timeoutInMillis)
+To search local networks and return the first one that contains a given ssid (non-case sensitive)
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public static final int WISE_MANAGER_FAILURE+
public static final int WIFI_MANAGER_FAILURE+
public android.net.ConnectivityManager mConnectivityManager+
public android.net.wifi.WifiManager mWifiManager+
public int addOpenNetwork(java.lang.String ssid)+
ssid
- - The ssid of the open network you want to addpublic int addWEPNetwork(java.lang.String ssid, + java.lang.String password)+
ssid
- - The ssid of the WEP network you want to addpassword
- - The password for the WEP network being addedpublic int addWPA2Network(java.lang.String ssid, + java.lang.String password)+
ssid
- - The ssid of the WPA2 network you want to addpassword
- - The password for the WPA2 network being addedpublic int calculateBars(int rssiLevel, + int targetNumberOfBars)+
rssiLevel
- - The signal strength of the networktargetNumberOfBars
- - How many bars or levels there will be totalpublic int compareSignalLevel(int rssi1, + int rssi2)+
rssi1
- - The signal strength of network 1rssi2
- - The signal strength of network 2public boolean connectToNetwork(java.lang.String ssidToConnectTo, + int timeoutInMillis)+
ssidToConnectTo
- - The ssid to connect/reconnect totimeoutInMillis
- - The number of milliseconds to continue waiting for the device to connect to the given SSIDpublic boolean disableWifi()+
public boolean disconnectFromCurrentNetwork()+
public boolean enableWifi()+
public android.net.wifi.WifiInfo getCurrentNetwork()+
public java.util.List<android.net.wifi.ScanResult> getNearbyAccessPoints(boolean filterDuplicates)+
filterDuplicates
- - If you want to exclude SSIDs with that same name that have a weaker signal strengthpublic java.util.List<android.net.wifi.WifiConfiguration> getSavedNetworks()+
public boolean isDeviceConnectedToMobileNetwork()+
public boolean isDeviceConnectedToMobileOrWifiNetwork()+
public boolean isDeviceConnectedToSSID(java.lang.String ssid)+
ssid
- - The SSID to check if the device is attached topublic boolean isDeviceConnectedToWifiNetwork()+
public boolean isNetworkInConfigurationList(java.lang.String ssid)+
ssid
- - The SSID to check and see if it's in the list of configured networkspublic boolean isNetworkSecure(android.net.wifi.ScanResult scanResult)+
scanResult
- - The network to see if it is securepublic boolean isWifiEnabled()+
public boolean removeNetwork(java.lang.String ssidToRemove)+
ssidToRemove
- - The ssid of the network you want to remove from the configured network listpublic java.lang.String searchForSSID(java.lang.String ssidToSearchFor, + int timeoutInMillis)+
ssidToSearchFor
- - The ssid to search fortimeoutInMillis
- - The number of milliseconds to keep searching for the SSIDpublic boolean isLoggingEnabled()+
Class | +Description | +
---|---|
WiseFy | ++ |
WiseFy.generator | +
+ Internal static class for builder pattern
+ |
+
public class GetManagerUtil
+extends java.lang.Object
+Modifier and Type | +Method and Description | +
---|---|
android.net.ConnectivityManager |
+getConnectivityManager(android.content.Context context)
+To get a Connectivity manger instance from an activity's context.
+ |
+
static GetManagerUtil |
+getInstance() |
+
android.net.wifi.WifiManager |
+getWiFiManager(android.content.Context context)
+To get a WiFi manger instance from an activity's context.
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public static GetManagerUtil getInstance()+
public android.net.ConnectivityManager getConnectivityManager(android.content.Context context)+
context
- - The context to use to retrieve a connectivity manager via getSystemServiceConnectivityManager
,
+WiseFy
public android.net.wifi.WifiManager getWiFiManager(android.content.Context context)+
context
- - The context to use to retrieve a wifi manager via getSystemServiceWifiManager
,
+WiseFy
public class LogUtil
+extends java.lang.Object
+Modifier and Type | +Method and Description | +
---|---|
void |
+d(java.lang.String tag,
+ java.lang.String message,
+ boolean loggingEnabled) |
+
void |
+e(java.lang.String tag,
+ java.lang.String message,
+ boolean loggingEnabled) |
+
static LogUtil |
+getInstance() |
+
void |
+w(java.lang.String tag,
+ java.lang.String message,
+ boolean loggingEnabled) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public static LogUtil getInstance()+
public void d(java.lang.String tag, + java.lang.String message, + boolean loggingEnabled)+
public void w(java.lang.String tag, + java.lang.String message, + boolean loggingEnabled)+
public void e(java.lang.String tag, + java.lang.String message, + boolean loggingEnabled)+
public class SSIDUtil
+extends java.lang.Object
+Modifier and Type | +Method and Description | +
---|---|
java.lang.String |
+convertSSIDForConfig(java.lang.String ssid) |
+
static SSIDUtil |
+getInstance() |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Class | +Description | +
---|---|
GetManagerUtil | ++ |
LogUtil | ++ |
SSIDUtil | ++ |
Modifier and Type | +Constant Field | +Value | +
---|---|---|
+
+public static final int |
+WIFI_MANAGER_FAILURE |
+-1 |
+
+
+public static final int |
+WISE_MANAGER_FAILURE |
+-1000 |
+
The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+Each annotation type has its own separate page with the following sections:
+Each enum has its own separate page with the following sections:
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object
. The interfaces do not inherit from java.lang.Object
.
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+These links take you to the next or previous class, interface, package, or related page.
+These links show and hide the HTML frames. All pages are available with or without frames.
+The All Classes link shows all classes and interfaces except non-static nested types.
+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
+The Constant Field Values page lists the static final fields and their values.
+#withContext(Context)
WiseFy.withContext
Logging
#GetSmarts
+ + diff --git a/javadoc/overview-summary.html b/javadoc/overview-summary.html new file mode 100644 index 00000000..37697032 --- /dev/null +++ b/javadoc/overview-summary.html @@ -0,0 +1,140 @@ + + + + + +
Package | +Description | +
---|---|
com.isupatches.wisefy | ++ |
com.isupatches.wisefy.util | ++ |