#define ENGAGE_BASE_URL (@"YOUR ENGAGE POD API URL")
#define ENGAGE_CLIENT_ID (@"YOUR CLIENT ID GOES HERE")
#define ENGAGE_SECRET (@"YOUR SECRET GOES HERE")
#define ENGAGE_REFRESH_TOKEN (@"YOUR REFRESH TOKEN HERE")
#define ENGAGE_LIST_ID (@"YOUR LIST ID")

[EngageSDK initializeSDKClient:ENGAGE_CLIENT_ID secret:ENGAGE_SECRET token:ENGAGE_REFRESH_TOKEN host:ENGAGE_BASE_URL engageDatabaseListId:ENGAGE_LIST_ID];

UBFManager *ubfManager = [UBFManager sharedInstance];

@interface UBFWeatherAugmentationPlugin : NSObject <UBFAugmentationPluginProtocol>

-(BOOL)processSyncronously;
-(BOOL)isSupplementalDataReady;
-(UBF*)process:(UBF*)ubfEvent;

@end

@implementation UBFWeatherAugmentationPlugin

-(id)init {
    self = [super init];
    if (self) {
        //Custom init logic
    }
    return self;
}

-(BOOL)processSyncronously {
    return YES; //Other plugins depend on this Plugins output for processing
}

-(BOOL)isSupplementalDataReady {
    // Your logic to decide if the data needed for the plugin to process is ready or not. Lets assume our fake weather data is.
    return YES;
}

-(UBF*)process:(UBF*)ubfEvent {
    if (ubfEvent) {
        [ubfEvent setAttribute:@"Temperatue In Celsius" value:@"100"];
        [ubfEvent setAttribute:@"Temperatue In Fahrenheit" value:@"212"];
    }
    return ubfEvent;
}

@end

[[UBFManager sharedInstance] trackEvent:[UBF goalCompleted:@"LISTENED TO MVSTERMIND" params:nil]];

[[UBFManager sharedInstance] trackEvent:[UBF goalAbandoned:@"LISTENED TO MVSTERMIND" params:nil]];

[[UBFManager sharedInstance] trackEvent:[UBF namedEvent:@"PLAYER LOADED" params:@{ @"Event Source View" : @"HomeViewController", @"Event Tags" : @"MVSTERMIND,Underground" }]];

XMLAPIManager *xmlapiManager = [XMLAPIManager sharedInstance];

// Conveniently calls addRecipient and stores anonymousId within EngageConfig
[[XMLAPIManager sharedInstance] createAnonymousUserToList:ENGAGE_LIST_ID success:^(ResultDictionary *ERXML) {
    if ([ERXML isSuccess]) {
        NSLog(@"SUCCESS");
    }
    else {
        NSLog(@"%@",[ERXML faultString]);
    }
} failure:^(NSError *error) {
    NSLog(@"SERVICE FAIL");
}];

XMLAPI *selectRecipientData = [XMLAPI selectRecipientData:@"[email protected]" list:ENGAGE_LIST_ID];

[[XMLAPIManager sharedInstance] postXMLAPI:selectRecipientData success:^(ResultDictionary *ERXML) {
        if ([ERXML isSuccess]) {
            NSLog(@"SUCCESS");
            // VERY IMPORTANT!!!
            // Universal Behaviors reads this value
            [EngageConfig storeMobileUserId:[ERXML valueForShortPath:@"RecipientId"]];
        }
        else {
            NSLog(@"%@",[ERXML faultString]);
        }
    } failure:^(NSError *error) {
        NSLog(@"SERVICE FAIL");
    }];

// Conveniently links anonymous user record with the primary user record according to the mergeColumn
[[XMLAPIManager sharedInstance] updateAnonymousToPrimaryUser:[EngageConfig primaryUserId]
                                                   list:ENGAGE_LIST_ID
                                      primaryUserColumn:@"CONTACT_ID"
                                            mergeColumn:@"MERGE_CONTACT_ID"
                                                success:^(ResultDictionary *ERXML) {
                                                    if ([[ERXML valueForShortPath:@"SUCCESS"] boolValue]) {
                                                        NSLog(@"SUCCESS");
                                                    }
                                                    else {
                                                        NSLog(@"%@",[ERXML valueForShortPath:@"Fault.FaultString"]);
                                                    }
                                                } failure:^(NSError *error) {
                                                    NSLog(@"SERVICE FAIL");
                                                }];

/**
 * Checks if the mobile user id has been configured yet.  If not
 * and the 'enableAutoAnonymousTracking' flag is set to true it is auto generated
 * using either the {@link EngageDefaultUUIDGenerator} or
 * the generator configured as the 'mobileUserIdGeneratorClassName'.  If
 * 'enableAutoAnonymousTracking' is 'NO' you are responsible for
 * manually setting the id using {@code EngageConfig#storeMobileUserId}.
 * <p/>
 * Once we have a mobile user id (generated or manually set) a new recipient is
 * created with the mobile user id.
 * <p/>
 * On successful completion of this method the EngageConfig will contain the
 * mobile user id and new recipient id.
 *
 * @param didSucceed custom behavior to run on success of this method
 * @param didFail custom behavior to run on failure of this method
 */
-(void)setupRecipientWithSuccess:(void (^)(SetupRecipientResult* result))didSucceed
                         failure:(void (^)(SetupRecipientFailure* failure))didFail;

[[MobileIdentityManager sharedInstance] setupRecipientWithSuccess:^(SetupRecipientResult *result) {

    NSString *messageFormat = @"Recipient Id: %@\nMobile User Id: %@";
    NSString *message = [NSString stringWithFormat:messageFormat, [result recipientId], [EngageConfig mobileUserId]];
    NSLog(@"%@", message);

    // do any other custom behavior

} failure:^(SetupRecipientFailure *failure) {
    NSLog(@"Setup Recipient failure");

    // do any other custom behavior
}];

/**
 * Checks for an existing recipient with all the specified ids.  If a matching recipient doesn't exist
 * the currently configured recipient is updated with the searched ids.  If an existing recipient
 * does exist the two recipients are merged and the engage app config is switched to the existing
 * recipient.
 * <p/>
 * When recipients are merged a history of the merged recipients is recorded.  By default it uses the
 * Mobile User Id, Merged Recipient Id, and Merged Date columns, however if you prefer to store
 * the merge history in a separate AuditRecord table you can set you EngageConfig.plist properties accordingly.
 * <p/>
 * WARNING: The merge process is not currently transactional.  If this method errors the data is likely to
 * be left in an inconsistent state.
 *
 * @param fieldsToIds Dictionary of column name to id value for that column.  Searches for an
 *                             existing recipient that contains ALL of the columns in the dictionary.
 *                             <p/>
 *                             Examples:
 *                             - Key: facebook_id, Value: 100
 *                             - Key: twitter_id, Value: 9999
 * @param didSucceed custom behavior to run on success of this method
 * @param didFail custom behavior to run on failure of this method
 */
 -(void)checkIdentityForIds:(NSDictionary *)fieldsToIds
                   success:(void (^)(CheckIdentityResult* result))didSucceed
                   failure:(void (^)(CheckIdentityFailure* failure))didFail;

[[MobileIdentityManager sharedInstance] checkIdentityForIds:@{ @"facebook_id" : @"fbuser" } success:^(CheckIdentityResult *result) {

    NSString *newRecipientId = [result recipientId];
    NSString *mergedRecipientId = [result mergedRecipientId];
    NSString *mobileUserId = [result mobileUserId];

    NSString *messageFormat = @"Current recipient id: %@\nMerged recipient id: %@\nMobile user id: %@";
    NSString *message = [NSString stringWithFormat:messageFormat, newRecipientId, mergedRecipientId, mobileUserId];
    NSLog(@"%@", message);

    // do any other custom behavior

} failure:^(CheckIdentityFailure *failure) {
    NSLog(@"Check Identity failure");

    // do any other custom behavior
}];

// create a resource encapsulating your request to select by email address
XMLAPI *selectRecipientData = [XMLAPI selectRecipientData:@"[email protected]" list:ENGAGE_LIST_ID];

[[XMLAPIManager sharedInstance] postXMLAPI:selectRecipientData success:^(ResultDictionary *ERXML) {
    // SUCCESS = TRUE
    if ([ERXML isSuccess]) {
        NSLog(@"SUCCESS");
    }
    // SUCCESS = FALSE
    // This is a specific XMLAPI failure, status 2xx
    else {
        NSLog(@"%@",[ERXML faultString]);
    }
} failure:^(NSError *error) {
    // This is a status > 400
    NSLog(@"SERVICE FAIL");
}];

XMLAPI *selectRecipientData = [XMLAPI resourceNamed:XMLAPI_OPERATION_SELECT_RECIPIENT_DATA
                                             params:@{
                               @"LIST_ID" : @"45654",
                               @"EMAIL" : @"[email protected]",
                               @"COLUMNS" : @{ @"Customer Id" : @"123-45-6789" } }];

XMLAPI *selectRecipientData = [XMLAPI resourceNamed:XMLAPI_OPERATION_SELECT_RECIPIENT_DATA];
[selectRecipientData addParams:@{ @"LIST_ID" : @"45654", @"EMAIL" : @"[email protected]" }];
[selectRecipientData addColumns:@{ @"Customer Id" : @"123-45-6789" }];

XMLAPI *selectRecipientData = [XMLAPI resourceNamed:XMLAPI_OPERATION_SELECT_RECIPIENT_DATA params:@{@"RECIPIENT_ID" : @"702003"}];

XMLAPI *selectRecipientData = [XMLAPI selectRecipientData:@"[email protected]" list:@"45654"];

- (void)application:(UIApplication *)application didReceiveLocalNotification:(UILocalNotification *)notification {
    [[UBFManager sharedInstance] handleLocalNotificationReceivedEvents:notification withParams:nil];
}

- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)pushNotification  {
    [[UBFManager sharedInstance] handlePushNotificationReceivedEvents:pushNotification];
}

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {

    if (launchOptions != nil) {
        // Launched from push notification or local notification
        NSDictionary *notification = nil;
        if ([launchOptions objectForKey:UIApplicationLaunchOptionsRemoteNotificationKey]) {
            notification = [launchOptions objectForKey:UIApplicationLaunchOptionsRemoteNotificationKey];
        } else if ([launchOptions objectForKey:UIApplicationLaunchOptionsLocalNotificationKey]) {
            notification = [launchOptions objectForKey:UIApplicationLaunchOptionsLocalNotificationKey];
        } else {
            //Other application logic
        }

        [[UBFManager sharedInstance] handleNotificationOpenedEvents:notification];
    }
}

- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url sourceApplication:(NSString *)sourceApplication annotation:(id)annotation {
    NSURL *ubfEventUid = [[UBFManager sharedInstance] handleExternalURLOpenedEvents:url];
}

Silverpop://campaign/TestCurrentCampaign?CampaignEndTimeStamp=1419465600    //Campaign Name set to "TestCurrentCampaign" and Expires on December 25th 2014 at 12AM
Silverpop://campaign/TestCurrentCampaign   //Campaign Name set to "TestCurrentCampaign" and Expires 1 Day after the URL is opened in the application
Silverpop://campaign/TestCurrentCampaign?CampaignEndTimeStamp=30931200    //Campaign Name set to "TestCurrentCampaign" and Expires on December 25th 1970 at 12AM. So campaign is never activated

[[UBFManager sharedInstance] postEventCache];