MRTriggerSubscription Class Reference
| Inherits from | NSObject |
|---|---|
| Conforms to | NSSecureCoding |
| Declared in | MRTriggerSubscription.h |
Overview
Subscription that can be used in conjunction with MRTriggerManager to be informed when a device is in range of Meridian proximity beacons
name
Name of the subscription to help differentiate MRTriggerManager callbacks (required) When using multiple subscriptions, names must be unique
@property (nonatomic, readonly, nonnull, copy) NSString *nameDeclared In
MRTriggerSubscription.h
beacons
Array of beacon objects. When the device is in range of any beacon in this array the MRTriggerManager will inform its delegate If this is null, the MRTriggerManager will listen for all Meridian iBeacons associated with its location
@property (nonatomic, readonly, nullable, strong) NSArray<MRBeacon*> *beaconsDeclared In
MRTriggerSubscription.h
cooldown
In order to reduce the frequency of MRTriggerManager callbacks, a per-subscription cooldown can be set. This value is the minimum number of seconds between TriggerManager callbacks
@property (nonatomic, readwrite, assign) NSTimeInterval cooldownDeclared In
MRTriggerSubscription.h
rssi
Minimum beacon RSSI required before a MRTriggerManager callback is initiated. (Value should be between -1 and -99)
@property (nonatomic, readwrite, assign) NSInteger rssiDeclared In
MRTriggerSubscription.h
lastTriggered
The last time this subscription resulted in a MRTriggerManager delegate callback
@property (nonatomic, readonly, nullable, copy) NSDate *lastTriggeredDeclared In
MRTriggerSubscription.h
inCooldown
True if there is a cooldown set for this subscription and it is greater than the number of seconds since the last trigger
@property (nonatomic, readonly, assign) BOOL inCooldownDeclared In
MRTriggerSubscription.h
+ subscriptionWithName:beacons:cooldown:rssi:
Create a named subscription for an array of beacons
+ (instancetype)subscriptionWithName:(NSString *)name beacons:(NSArray<MRBeacon*> *)beacons cooldown:(NSTimeInterval)cooldown rssi:(NSInteger)rssiParameters
name |
Name of the subscription, must be unique when using multiple subscriptions |
|---|---|
beacons |
Array of MRBeacon objects representing Meridian proximity beacons you wish to listen for |
cooldown |
The minimum number of seconds between MRTriggerManager callbacks for this subscription |
rssi |
Minimum beacon RSSI required before an MRTriggerManager callback is initiated. (Value should be between -1 and -99 with -99 allowing in all readings) |
Declared In
MRTriggerSubscription.h
+ allBeaconsSubscriptionWithName:cooldown:rssi:
Create a named subscription for all Meridian proximity beacons in the location
+ (instancetype)allBeaconsSubscriptionWithName:(NSString *)name cooldown:(NSTimeInterval)cooldown rssi:(NSInteger)rssiParameters
name |
Name of the subscription, must be unique when using multiple subscriptions |
|---|---|
cooldown |
The minimum number of seconds between MRRTriggerManager callbacks for this subscription |
rssi |
Minimum beacon RSSI required before an MRTriggerManager callback is initiated. (Value should be between -1 and -99 with -99 allowing in all readings) |
Declared In
MRTriggerSubscription.h