keepallsimple / VENPromotionsManager

iOS Library to perform location & time-based promotions.

VENPromotionsManager

VENPromotionsManager enables easy definition, management and control of in-app location based promotions including the following:

• Define promotion action events along with trigger locations and active date intervals
• Check for location based promotions on a background timer (optional)
• Use an included location service built on a CLLocationManager or a custom location service

Demo

Installation

You can install VENPromotionsManager in your project by using CocoaPods:

pod 'VENPromotionsManager', '~> 0.2.0'

Usage

First create one (or more) promotion(s)

CLLocation *appleHQLocation = [[CLLocation alloc] initWithLatitude:37.3318 longitude:-122.0312];

VPLPromotion *promotion1 = [[VPLPromotion alloc] initWithCenter:appleHQLocation
                                                          range:3000 //in meters
                                                      startDate:[NSDate distantPast]
                                                        endDate:[NSDate distantFuture]
                                        showOnceUserDefaultsKey:kUserDefaultsKey //userDefaultsKey to persist trigger history
                                                         action:^{
                                                                 //Implement code to launch promotion here
                                                             }];

Then start the promotions manager with an array of the created promotion(s)

[VPLPromotionsManager startWithPromotions:@[promotion1,promotion2,promotion3]
                            locationTypes:VPLLocationTypeGPSRequestPermission
                          locationService:nil //custom location service. use nil if you plan to use the included CLLocationManger.
                      withRefreshInterval:600 //in seconds
                  withMultipleTriggerType:VPLMultipleTriggerOnRefreshTypeTriggerOnce];

The VPLPromotionsManager is a singleton object and will display any valid location based promotions. It checks for a valid promotion every 10 minutes. By supplying a userdefaults key, you gurantee a user will not see a repeat promotion on subsequent launches.

Contributing

We'd love to see your ideas for improving VENPromotionsManager! The best way to contribute is by submitting a pull request. We'll do our best to respond to your patch as soon as possible. You can also submit a new Github issue if you find bugs or have questions.

Please make sure to follow our general coding style and add test coverage for new features!

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Added some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request