SDK Integration

Goal

This topic covers an automatic integration (basic) where you just need to add one method to your project & plist configuration file.

For manual method that gives you greater control, and lets you override behaviour see Manual Integration - Objective-C or Manual Integration - Swift.

Procedure

1. Add import statement

Objective-C

Open your AppDelegate.m file, and add the following import statement:

#import <AppoxeeSDK/AppoxeeSDK.h>

Swift

Add to your Objective-C bridging header the following import statement

#import <AppoxeeSDK/AppoxeeSDK.h>

2. Create AppoxeeConfig.plist file in your project.

Enter your SDK Key (SDK Key that was created when your App was configured in the system)
If you are a european based customer, set the is_eu flag to true
If you want landing page to open as an overlay, set open_landing_page_inside_app to true

AppoxeeConfiguration.plist

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
    <dict>
        <key>sdk</key>
        <dict>
            <key>sdk_key</key>
            <string></string>
            <key>is_eu</key> <!-- Optional, indicate if account is EU / US -->
            <false/>
            <key>open_landing_page_inside_app</key> <!-- Optional, indicate if landing page should open inside the app or via Safari -->
            <false/>
        </dict>
    </dict>
</plist>

3. For an automatic integration (basic), add the following implementation to the method named: application:didFinishLaunchingWithOptions:

Objective-C

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
    // Method takes into consideration a valid AppoxeeConfig.plist file in your application.
    [[Appoxee shared] engageAndAutoIntegrateWithLaunchOptions:launchOptions andDelegate:nil];
    return YES;
}

Swift

func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
     
    // Method takes into consideration a valid AppoxeeConfig.plist file in your application.
    Appoxee.shared()?.engageAndAutoIntegrateWithLaunchOptions(launchOptions, andDelegate: nil)
     
    return true
}

Push Token

Please note that the "Request Push notification permission" dialog will be called on first app lunch. In order to show the dialog based on your own logic refer to : Request Notification at Best Time