braze-android-sdk/com.braze.managers/BrazeGeofenceManager

BrazeGeofenceManager

class BrazeGeofenceManager(context: Context, apiKey: String, val brazeManager: IBrazeManager, configurationProvider: BrazeConfigurationProvider, serverConfigStorageProvider: ServerConfigStorageProvider, internalIEventMessenger: IEventMessenger) : IGeofenceManager, IBrazeGeofenceLocationUpdateListener

Constructors

constructor(context: Context, apiKey: String, brazeManager: IBrazeManager, configurationProvider: BrazeConfigurationProvider, serverConfigStorageProvider: ServerConfigStorageProvider, internalIEventMessenger: IEventMessenger)

Types

Companion

object Companion

Properties

brazeGeofenceApi

@VisibleForTesting

val brazeGeofenceApi: BrazeGeofenceApi

brazeGeofenceReEligibilityManager

@VisibleForTesting

var brazeGeofenceReEligibilityManager: BrazeGeofenceReEligibilityManager

brazeGeofences

@VisibleForTesting

val brazeGeofences: MutableList<BrazeGeofence>

brazeLocationApi

@VisibleForTesting

val brazeLocationApi: BrazeLocationApi

brazeManager

val brazeManager: IBrazeManager

geofenceRequestLocation

@VisibleForTesting

var geofenceRequestLocation: IBrazeLocation?

geofenceStorageSharedPreferences

@VisibleForTesting

val geofenceStorageSharedPreferences: SharedPreferences

geofenceTransitionPendingIntent

@VisibleForTesting

val geofenceTransitionPendingIntent: PendingIntent?

isGeofencesEnabled

@VisibleForTesting

var isGeofencesEnabled: Boolean

maxNumToRegister

@VisibleForTesting

var maxNumToRegister: Int

Functions

analyticsEnabledForGeofenceId

@VisibleForTesting

fun analyticsEnabledForGeofenceId(geofenceId: String, geofenceTransitionType: GeofenceTransitionType): Boolean

configureFromServerConfig

open override fun configureFromServerConfig(serverConfig: ServerConfig)

getBrazeGeofenceForGeofenceId

@VisibleForTesting

fun getBrazeGeofenceForGeofenceId(geofenceId: String): BrazeGeofence?

initializeGeofences

fun initializeGeofences()

Performs the setup required to initialize Geofences on the device, including registering Geofences on the device. when location permissions are granted to the app by the user.

isGeofencesEnabledFromEnvironment

@VisibleForTesting

fun isGeofencesEnabledFromEnvironment(context: Context): Boolean

Together with GeofenceUtils.getGeofencesEnabledFromServerConfig determines whether the geofence feature is enabled for the current app run. Both checks must be satisfied for geofences to be enabled.

onLocationRequestComplete

open override fun onLocationRequestComplete(location: IBrazeLocation?)

Informs the BrazeGeofenceManager about the result of the last single location request.

postGeofenceReport

open override fun postGeofenceReport(geofenceId: String, transitionType: GeofenceTransitionType)

registerGeofences

open override fun registerGeofences(geofenceList: List<BrazeGeofence>)

registerGeofencesWithGooglePlay

@VisibleForTesting

fun registerGeofencesWithGooglePlay(geofenceList: List<BrazeGeofence>, geofenceRequestIntent: PendingIntent)

requestGeofenceRefresh

open override fun requestGeofenceRefresh(location: IBrazeLocation)

open override fun requestGeofenceRefresh(ignoreRateLimit: Boolean)

requestSingleLocationUpdateFromGooglePlay

@VisibleForTesting

fun requestSingleLocationUpdateFromGooglePlay()

Requests a single location update from Google Play Services.

setUpGeofences

@VisibleForTesting

fun setUpGeofences(reRegisterGeofences: Boolean)

If reRegisterGeofences is true, re-registers geofences with Google Play Services.

tearDownGeofences

@VisibleForTesting

fun tearDownGeofences(geofenceRequestIntent: PendingIntent?)

Unregister all Braze geofences from Google Play Services and delete all locally stored geofences. This method should only be used when geofences are newly disabled via server config.

unregisterGeofences

open override fun unregisterGeofences()