Badge Keeper

Badge Keeper iOS library will help add achievement system to your app easily.

Getting Started

To integrate Badge Keeper library into your iOS project, install with CocoaPods

platform :ios, '7.0'
pod 'BadgeKeeper'

Usage

Import header

#import <BadgeKeeper/BadgeKeeper.h>

Basic Initialization

[BadgeKeeper instance].projectId       = @"Project Id from admin panel";
[BadgeKeeper instance].userId          = @"Your client id";
[BadgeKeeper instance].shouldLoadIcons = YES; // default is NO

That's all settings that need to be configured.

Callbacks

There are four callbacks that we will use to receive results from Badge Keeper service:

// 1 - Returns array of BKAchievement elements
typedef void (^BKAchievementsResponseCallback)(NSArray *achievements);

// 2 - Returns array of BKUserAchievement elements
typedef void (^BKUserAchievementsResponseCallback)(NSArray *achievements);

// 3 - Returns array of BKUnlockedAchievement elements
typedef void (^BKAchievementsUnlockedCallback)(NSArray *achievements);

// 4 - Returns error code and error message if something goes wrong
typedef void (^BKFailureResponseCallback)(int code, NSString *message);

Get project achievements (no userId required)

[[BadgeKeeper instance]
    getProjectAchievementsWithSuccess:^(NSArray *achievements) {
        // Returns array of BKAchievement elements
    }
    withFailure:^(int code, NSString *message) {
        // Returns error code and error message if something goes wrong
    }];

Get user achievements

[[BadgeKeeper instance]
    getUserAchievementsWithSuccess:^(NSArray *achievements) {
        // Returns array of BKUserAchievement elements
    }
    withFailure:^(int code, NSString *message) {
        // Returns error code and error message if something goes wrong
    }];

Post user variables and validate completed achievements

[[BadgeKeeper instance] preparePostValue:0 forKey:@"key"];
[[BadgeKeeper instance]
    postPreparedValuesWithSuccess:^(NSArray *achievements) {
       // Returns array of BKUnlockedAchievement elements
    }
    withFailure:^(int code, NSString *message) {
        // Returns error code and error message if something goes wrong
    }];

Increment user variables and validate completed achievements

[[BadgeKeeper instance] prepareIncrementValue:1 forKey:@"key"];
[[BadgeKeeper instance]
    incrementPreparedValuesWithSuccess:^(NSArray *achievements) {
       // Returns array of BKUnlockedAchievement elements
    }
    withFailure:^(int code, NSString *message) {
        // Returns error code and error message if something goes wrong
    }];

Requirements

• Xcode 6.0 or later.
• iOS 7 or later.

License

Copyright 2015 Badge Keeper

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.