org.microg.nlp.api

Class WiFiBackendHelper

java.lang.Object

org.microg.nlp.api.AbstractBackendHelper

org.microg.nlp.api.WiFiBackendHelper

public class WiFiBackendHelper
extends AbstractBackendHelper

Utility class to support backends that use Wi-Fis for geolocation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WiFiBackendHelper.Listener Interface to listen for Wi-Fi scan results.
static class	WiFiBackendHelper.WiFi Represents a generic Wi-Fi scan result.

Nested classes/interfaces inherited from class org.microg.nlp.api.AbstractBackendHelper

AbstractBackendHelper.State

Field Summary

Fields inherited from class org.microg.nlp.api.AbstractBackendHelper

context, currentDataUsed, state, TAG

Constructor Summary

Constructors

Constructor and Description
WiFiBackendHelper(android.content.Context context, WiFiBackendHelper.Listener listener) Create a new instance of WiFiBackendHelper.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getRequiredPermissions()
java.util.Set<WiFiBackendHelper.WiFi>	getWiFis()
void	onClose() Call this in AbstractBackendService.onClose().
void	onOpen() Call this in AbstractBackendService.onOpen().
void	onUpdate() Call this in LocationBackendService.update().
void	setIgnoreNomap(boolean ignoreNomap) Sets whether to ignore the "_nomap" flag on Wi-Fi SSIDs or not.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WiFiBackendHelper

public WiFiBackendHelper(android.content.Context context,
                         WiFiBackendHelper.Listener listener)

Create a new instance of WiFiBackendHelper. Call this in Service.onCreate().

Throws:

java.lang.IllegalArgumentException - if either context or listener is null.

Method Detail

setIgnoreNomap

public void setIgnoreNomap(boolean ignoreNomap)

Sets whether to ignore the "_nomap" flag on Wi-Fi SSIDs or not.

Usually, Wi-Fis whose SSID end with "_nomap" are ignored for geolocation. This behaviour can be suppressed by setIgnoreNomap(false).

Default is true.

onOpen

public void onOpen()

Call this in AbstractBackendService.onOpen().

Overrides:

onOpen in class AbstractBackendHelper

onClose

public void onClose()

Call this in AbstractBackendService.onClose().

Overrides:

onClose in class AbstractBackendHelper

onUpdate

public void onUpdate()

Call this in LocationBackendService.update().

Overrides:

onUpdate in class AbstractBackendHelper

getRequiredPermissions

public java.lang.String[] getRequiredPermissions()

Overrides:

getRequiredPermissions in class AbstractBackendHelper

getWiFis

public java.util.Set<WiFiBackendHelper.WiFi> getWiFis()

Returns:

the latest scan result.