MRTriggerManager Class Reference
Inherits from | NSObject |
---|---|
Declared in | MRTriggerManager.h |
Overview
Object that monitors for Meridian proximity beacons and provides subscription-based delegate callbacks as events occur
subscriptions
Array of subscriptions that the manager is currently monitoring for
@property (nonatomic, readonly, nullable, strong) NSArray<MRTriggerSubscription*> *subscriptions
Declared In
MRTriggerManager.h
delegate
Delegate object that will receive callbacks regarding the current subscriptions
@property (nonatomic, readwrite, nullable, weak) id<MRTriggerManagerDelegate> delegate
Declared In
MRTriggerManager.h
running
True if the manager is actively scanning for Meridian proximity iBeacons
@property (nonatomic, readonly, assign) BOOL running
Declared In
MRTriggerManager.h
backgroundEnabled
If set, the manager will make a best effort to continue providing delegate callbacks while the app is in the background Note: By default iOS apps are very limited with what they are allowed to do in the background and for how long. Depending on various factors, callbacks may be delayed or not occur at all while the app is in the background
@property (nonatomic, readwrite, assign) BOOL backgroundEnabled
Declared In
MRTriggerManager.h
– initWithLocationID:delegate:
Initialize an MRTriggerManager for the given Meridian Location ID, optionally assigning a delegate
- (instancetype)initWithLocationID:(NSString *)locationID delegate:(nullable id<MRTriggerManagerDelegate>)delegate
Parameters
locationID |
Meridian Editor location ID for the location that contains the beacons this manager will range for |
---|---|
delegate |
optional delegate to receive event callbacks from the manager instance |
Declared In
MRTriggerManager.h
– subscribe:
Add the given MRTriggerSubscription to the list of subscriptions this manager monitors while running. If there is a previous subscription with a matching name, the new subscription will be ignored
- (void)subscribe:(MRTriggerSubscription *)subscription
Parameters
subscription |
A previously initialized MRTriggerSubscription representing beacons the delegate will receive callbacks about |
---|
Declared In
MRTriggerManager.h
– unsubscribe:
Remove an MRTriggerSubscription with the given name from the list of subscriptions this manager monitors while running
- (void)unsubscribe:(NSString *)subscriptionName
Parameters
subscriptionName |
Name of an MRTriggerSubscription in the subscriptions array |
---|
Declared In
MRTriggerManager.h
– reset:
Reset an MRTriggerSubscription with the given name. This nil’s the lastTriggered field and takes it out of cooldown.
- (void)reset:(NSString *)subscriptionName
Parameters
subscriptionName |
Name of an MRTriggerSubscription in the subscriptions array |
---|
Declared In
MRTriggerManager.h
– start
Start ranging for Meridian proximity beacons that match the subscriptions array
- (void)start
Declared In
MRTriggerManager.h