com.tplmaps3d.sdk.location

Class FusedLocationHelper

java.lang.Object

com.tplmaps3d.sdk.location.FusedLocationHelper

public class FusedLocationHelper
extends java.lang.Object

Utility class to provide some help while implementing Google's FusedLocationAPI

Since:

Jan, 2017

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	lastLocationReqStarted
static boolean	locationButtonClicked
static boolean	locationUpdatesEnabled
static int	REQUEST_CODE_LAST_LOCATION
static int	REQUEST_CODE_LOCATION_UPDATES

Constructor Summary

Constructors

Constructor and Description
FusedLocationHelper(android.content.Context context, TPLLocationListener listener) Constructor to new initialize and instance of FusedLocationHelper class

Method Summary

Modifier and Type	Method and Description
Config	config() Get Config to modify/set location configurations
void	enableLocationUpdates(boolean enable) Set Location Updates on/off (true/false) for continuous updates.
TPLLocationListener	getListener()
boolean	getLocationUpdatesEnabled()
MapController.MyLocationArg	getMyLocationArg()
void	initiateLastLocationRequest()
boolean	isFirstFix()
void	locationLogic(boolean isLastLocation, android.location.Location location) Function make sure the TPLLocationListener's callbacks
void	onActivityResult(int requestCode, int resultCode, android.content.Intent data)
void	onDestroy()
void	onPause()
void	onRequestPermissionsResult(int requestCode, java.lang.String[] permissions, int[] grantResults) Callback for the result from requesting permissions.
void	onResume()
void	onStart()
void	onStop()
void	resetLocationSettingsDialogPrefs() Resets Location Settings Dialog preference to re-appear Dialog
void	setFirstFix(boolean value)
void	setMyLocationArg(MapController.MyLocationArg arg)
void	startGettingLocation(boolean isLastLocationRequest) Check if the device's location settings are adequate for the app's needs using the LocationServices.getSettingsClient(Activity) method, with the results provided by LocationSettingsResponse and started tracking location OR fetch last location based on isRequestForLastLocation flag, when resolved.
void	stopLocationUpdates() Stop location updates

Methods inherited from class java.lang.Object

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

Field Detail

REQUEST_CODE_LAST_LOCATION

public static final int REQUEST_CODE_LAST_LOCATION

See Also:

Constant Field Values

REQUEST_CODE_LOCATION_UPDATES

public static final int REQUEST_CODE_LOCATION_UPDATES

See Also:

Constant Field Values

lastLocationReqStarted

public static boolean lastLocationReqStarted

locationButtonClicked

public static boolean locationButtonClicked

locationUpdatesEnabled

public static boolean locationUpdatesEnabled

Constructor Detail

FusedLocationHelper

public FusedLocationHelper(android.content.Context context,
                           TPLLocationListener listener)

Constructor to new initialize and instance of FusedLocationHelper class

Parameters:

context - Context of referenced class

listener - an instance of interface TPLLocationListener

Method Detail

setMyLocationArg

public void setMyLocationArg(MapController.MyLocationArg arg)

getMyLocationArg

public MapController.MyLocationArg getMyLocationArg()

config

public Config config()

Get Config to modify/set location configurations

Returns:

Config

onRequestPermissionsResult

public void onRequestPermissionsResult(int requestCode,
                                       @NonNull
                                       java.lang.String[] permissions,
                                       @NonNull
                                       int[] grantResults)

Callback for the result from requesting permissions. This method is invoked for every call on androidx.fragment.app.FragmentActivity#requestPermissions(String[], int).

Note: It is possible that the permissions request interaction with the user is interrupted. In this case you will receive empty permissions and results arrays which should be treated as a cancellation.

For more description: ActivityCompat.OnRequestPermissionsResultCallback.onRequestPermissionsResult(int, String[], int[])}

See Also:

androidx.fragment.app.FragmentActivity#requestPermissions(String[], int)

getListener

public TPLLocationListener getListener()

locationLogic

public void locationLogic(boolean isLastLocation,
                          android.location.Location location)

Function make sure the TPLLocationListener's callbacks

Parameters:

isLastLocation - pass true if the provided location is for TPLLocationListener.onLastLocationRequest(Location) method, otherwise false for location updates callback methods

location - Location object

onStart

public void onStart()

onResume

public void onResume()

onStop

public void onStop()

onPause

public void onPause()

setFirstFix

public void setFirstFix(boolean value)

isFirstFix

public boolean isFirstFix()

onDestroy

public void onDestroy()

startGettingLocation

public void startGettingLocation(boolean isLastLocationRequest)

Check if the device's location settings are adequate for the app's needs using the LocationServices.getSettingsClient(Activity) method, with the results provided by LocationSettingsResponse and started tracking location OR fetch last location based on isRequestForLastLocation flag, when resolved.

Parameters:

isLastLocationRequest - Pass true to get last location and false to get location updates

resetLocationSettingsDialogPrefs

public void resetLocationSettingsDialogPrefs()

Resets Location Settings Dialog preference to re-appear Dialog

enableLocationUpdates

public void enableLocationUpdates(boolean enable)

Set Location Updates on/off (true/false) for continuous updates. Along with location functions

NOTE: Method will work only with MapController.setMyLocationEnabled(boolean)'s call.

Parameters:

enable - boolean true/false

getLocationUpdatesEnabled

public boolean getLocationUpdatesEnabled()

initiateLastLocationRequest

public void initiateLastLocationRequest()

stopLocationUpdates

public void stopLocationUpdates()

Stop location updates

onActivityResult

public void onActivityResult(int requestCode,
                             int resultCode,
                             android.content.Intent data)