braze-android-sdk/com.braze.location/BrazeInternalLocationApi

BrazeInternalLocationApi

class BrazeInternalLocationApi : IBrazeLocationApi

An implementation of the location calls so that they are contained in a single, external module that clients don't need to include if they don't want location services.

Constructors

constructor()

Types

Companion

object Companion

Functions

getLastKnownGpsLocationIfValid

@VisibleForTesting

fun getLastKnownGpsLocationIfValid(locationManager: LocationManager): Location?

Returns the last known location from the LocationManager.GPS_PROVIDER, if not older than LAST_KNOWN_GPS_LOCATION_MAX_AGE_MS. Assumes that the Manifest.permission.ACCESS_FINE_LOCATION permission is present.

getSuitableLocationProvider

fun getSuitableLocationProvider(locationManager: LocationManager, allowedProviders: EnumSet<LocationProviderName>, hasFinePermission: Boolean, hasCoarsePermission: Boolean): String?

Determines the best location provider based on the permissions and list of providers allowed.

initWithContext

open override fun initWithContext(context: Context, allowedProviders: EnumSet<LocationProviderName>, appConfigurationProvider: BrazeConfigurationProvider)

Initialize the object with some external variables. This function should be called immediately after the object is created and should be called only once.

requestSingleLocationUpdate

open override fun requestSingleLocationUpdate(locationUpdateCallback: (location: IBrazeLocation) -> Unit): Boolean

Requests a location fix for the session on the device. Note that the return value of this method is used to start the Geofences process so be wary of early returning based on configuration that Geofences does not use.