Latest 0.1.1
Homepage https://github.com/vendasta/BeaconKit-iOS-Release
License Copyright Copyright 2016 Vendasta, Inc. All rights reserved.
Platforms ios 9.0, requires ARC
Dependencies AFNetworking, EstimoteSDK
Authors

Vendasta BeaconKit

Requirements

Designed for iOS 9.0 and above

Installation

BeaconKit is available through CocoaPods. To install
it, simply add the following line to your Podfile:

pod "Vendasta-BeaconKit"

Objective-C

Use #import <Vendasta-BeaconKit/BeaconKit.h> in your implementation files.

Swift

In Swift, you need to add #import <Vendasta-BeaconKit/BeaconKit.h> to an Objective-C Bridging Header instead:

  • right-click on the "Support Files" group in the navigator, and choose "New Fileā€¦"
  • pick a "Header File" from the "iOS – Source" section, and save it as "ObjCBridge.h"
  • add the #import <Vendasta-BeaconKit/BeaconKit.h> line to the newly created file
  • select your project in the navigator and go to "Build Settings"
  • look for the "Objective-C Bridging Header" setting and set it to ${PROJECT_NAME}/ObjCBridge.h

Usage

Launch Beacon Manager

Instantiate the beacon manager and start monitoring for checkins.

VNBeaconManager* manager = [VNBeaconManager sharedInstance];

manager.delegate = self;

Authentication

Using the assigned key, start the authentication sequence.

[manager startupWithKey:@"<my-key>"];

Depending on the status, the following delegates will be called:

- (void)didAuthenticate;

- (void)didFailAuthenticationWithError:(NSError *)error;

Monitor Checkins

Implement the following VNBeaconManagerDelegate methods:

- (void)didCheckinToVenueWithId:(NSString *)venueId;

- (void)didCheckoutToVenueWithId:(NSString *)venueId;

Coupons

Retrieve coupons for the venue a customer has encountered. The response is an array of VNCoupon objects.

+ (void)couponsForVenue:(NSString* )venueId success:(void (^)(NSArray* result))success failure:(void (^)(NSError* error))failure;

Venue Profile

Get more information about a given venue, the response is a VNVenue object.

+ (void)profile:(NSString* )venueId success:(void (^)(VNVenue* result))success failure:(void (^)(NSError* error))failure;

Author

Vendasta, [email protected]

License

BeaconKit is available under the MIT license.

Latest podspec

{
    "name": "Vendasta-BeaconKit",
    "version": "0.1.1",
    "summary": "A short description of BeaconKit.",
    "license": {
        "type": "Copyright",
        "text": "      Copyright 2016 Vendasta, Inc. All rights reserved.n"
    },
    "authors": {
        "Vendasta": "[email protected]"
    },
    "homepage": "https://github.com/vendasta/BeaconKit-iOS-Release",
    "description": "BeaconKit",
    "requires_arc": true,
    "source": {
        "git": "https://github.com/vendasta/BeaconKit-iOS-Release.git",
        "tag": "0.1.1"
    },
    "platforms": {
        "ios": "9.0"
    },
    "ios": {
        "preserve_paths": "Vendasta-BeaconKit.framework",
        "public_header_files": "Vendasta-BeaconKit.framework/Versions/A/Headers/*.h",
        "vendored_frameworks": "Vendasta-BeaconKit.framework"
    },
    "dependencies": {
        "AFNetworking": [
            "~> 3.1"
        ],
        "EstimoteSDK": [
            "~> 4.1.0"
        ]
    }
}

Pin It on Pinterest

Share This