com.dff.cordova.plugin.location.utilities.helpers

Class PreferencesHelper

java.lang.Object

com.dff.cordova.plugin.location.utilities.helpers.PreferencesHelper

@Singleton
public class PreferencesHelper
extends java.lang.Object

Class to save and restore shared preferences.

Since:

06.12.2016

Constructor Summary

Constructors

Constructor and Description
PreferencesHelper(android.content.SharedPreferences mSharedPreferences)

Method Summary

Modifier and Type	Method and Description
boolean	getCanLocationBeCleared() Restore the state of "can Location be cleared"
int	getLocationMaxAge()
int	getMinAccuracy()
float	getMinDistance()
long	getMinTime()
java.lang.String	getReturnType()
java.lang.String	getStopID()
float	getStoreCustomDistance()
float	getStoredTotalDistance()
boolean	isLocationsMappingEnabled()
boolean	isServiceStarted()
void	restoreProperties() Restore saved properties from shared preference to the resources
boolean	setIsLocationsMappingEnabled(boolean isEnable)
boolean	setIsServiceStarted(boolean isStarted)
boolean	setLocationCanBeCleared(java.lang.Boolean state) Store a key/value in the shared preferences in order to make a state always available.
boolean	setLocationMaxAge(int maxAge)
boolean	setMinAccuracy(int minAccuracy)
boolean	setMinDistance(float minDistance)
boolean	setMinTime(long minTime)
boolean	setStopdID(java.lang.String stopdID)
void	storeProperties() Store saved properties from the resources into shared preference
boolean	storeTotalDistance(float distance)

Methods inherited from class java.lang.Object

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

Constructor Detail

PreferencesHelper

@Inject
public PreferencesHelper(android.content.SharedPreferences mSharedPreferences)

Method Detail

setLocationCanBeCleared

public boolean setLocationCanBeCleared(java.lang.Boolean state)

Store a key/value in the shared preferences in order to make a state always available.

Parameters:

state - the state to be stored true/false

Returns:

whether the state has been successfully stored

setMinTime

public boolean setMinTime(long minTime)

setMinDistance

public boolean setMinDistance(float minDistance)

setMinAccuracy

public boolean setMinAccuracy(int minAccuracy)

setLocationMaxAge

public boolean setLocationMaxAge(int maxAge)

setStopdID

public boolean setStopdID(java.lang.String stopdID)

setIsServiceStarted

public boolean setIsServiceStarted(boolean isStarted)

isServiceStarted

public boolean isServiceStarted()

setIsLocationsMappingEnabled

public boolean setIsLocationsMappingEnabled(boolean isEnable)

isLocationsMappingEnabled

public boolean isLocationsMappingEnabled()

storeTotalDistance

public boolean storeTotalDistance(float distance)

getCanLocationBeCleared

public boolean getCanLocationBeCleared()

Restore the state of "can Location be cleared"

Returns:

The state

getReturnType

public java.lang.String getReturnType()

getMinTime

public long getMinTime()

getMinDistance

public float getMinDistance()

getMinAccuracy

public int getMinAccuracy()

getLocationMaxAge

public int getLocationMaxAge()

getStoredTotalDistance

public float getStoredTotalDistance()

getStoreCustomDistance

public float getStoreCustomDistance()

getStopID

public java.lang.String getStopID()

storeProperties

public void storeProperties()

Store saved properties from the resources into shared preference

restoreProperties

public void restoreProperties()

Restore saved properties from shared preference to the resources