Reference GeofenceManager Class Reference

GeofenceManager

open class GeofenceManager : NSObject

extension GeofenceManager: CLLocationManagerDelegate

A singleton object that is responsible for handling geofence related data and events


                    
                    
                    manager

The native CLLocationManager

Declaration

Swift

public private(set) var manager: CLLocationManager!

locationEventListener
Listener for LocationManager.notificationName event
Declaration
Swift

open var locationEventListener: NSObjectProtocol?
clientEventsManager
The associated GeofenceClientEvents that handles client events
Declaration
Swift

public var clientEventsManager: GeofenceClientEvents?
lastKnownLocation
The last known location returned by LocationManager
Declaration
Swift

public private(set) var lastKnownLocation: CLLocation?

Init


                    
                    
                    shared

Singleton property

Declaration

Swift

public static let shared: GeofenceManager

isGeofencingEnabled
A boolean flag that returns the value of Configuration.shared.isGeofencingEnabled
Declaration
Swift

open var isGeofencingEnabled: Bool { get }
isLocationServicesAndGeofencingEnabled
A boolean flag that indicates whether the location services and geofencing is allowed
Declaration
Swift

open var isLocationServicesAndGeofencingEnabled: Bool { get }

Control methods

start()
Starts the GeofenceManager - validates the value of isGeofencingEnabled, adds listener for LocationManager.notificationName, event calls LocationManager.shared.checkAndRequestAuthorizationIfNeeded(), and listens for location updates, then will create regions based on the returned location
Declaration
Swift

open func start()
stop()
Stops the GeofenceManager - validates the value of isGeofencingEnabled, calls LocationManager.shared.stopReceivingLocationUpdates(), removes listener for LocationManager.notificationName event
Declaration
Swift

open func stop()

Region control methods

stopMonitoringAllRegions()
Calls stopMonitoring for each monitored CLRegion
Declaration
Swift

open func stopMonitoringAllRegions()
updateThresholdRegion(radius:)
Resets the radius of the monitored CLRegion
Declaration
Swift

open func updateThresholdRegion(radius: CLLocationDistance)
updateMonitoredRegions(places:)
Updates monitored regions based on the given [Place], monitors only up to 19 regions
Declaration
Swift

open func updateMonitoredRegions(places: [GeofencePlace])

Location Events

addEventListener()
Adds an event listener for LocationManager.notificationName event
Declaration
Swift

open func addEventListener()
removeEventListener()
Removes an event listener for LocationManager.notificationName event
Declaration
Swift

open func removeEventListener()
locationManager(_:didEnterRegion:)
Triggers a GeofenceClientEvents.tiggerClientEvent(in: CLRegion, event: Place.ClientEventType) given that LocationManager.shared.isAuthorized and GeofenceManager.isGeofencingEnabled are both true
Declaration
Swift

public func locationManager(_ manager: CLLocationManager, didEnterRegion region: CLRegion)
locationManager(_:didExitRegion:)
Triggers a GeofenceClientEvents.tiggerClientEvent(in: CLRegion, event: Place.ClientEventType) given that LocationManager.shared.isAuthorized aznd GeofenceManager.isGeofencingEnabled are both true
Declaration
Swift

public func locationManager(_ manager: CLLocationManager, didExitRegion region: CLRegion)