Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

 

Code Block
#import <AppoxeeSDK/AppoxeeSDK.h>

 

Swift

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

#import

 

Code Block
#import <AppoxeeSDK/AppoxeeSDK.h>

 

2. Create AppoxeeConfig.plist file in your project.

Mandatory

...

  1. Enter your SDK Key (SDK Key that was created when your App was configured in the system)
  2. Set the is_eu flag to YES or NO ( please contact your PS validate which DC you are hosted on)

      ...

      Image Removed

      ...

        1. NO - Data Center is located in US
        2. YES - Data Center is located in EU
        3. Please note that if the above flag does not match your DC environment you will see the following error in your Xcode console

          Code Block
          [Appoxee Debug] Application Activated
          [Appoxee Error] Network protocol error with HTTP code: 403
          [Appoxee Error] Network protocol error with HTTP code: 403

      Optional

      • If you want landing page to open inside the app, set open_landing_page_inside_app to true

      Image Added

       

      AppoxeeConfig.plist

       

      Code Block
      <?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 
      
      <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
      
      <dict>
      	<key>sdk</key>
      	<dict>
      		<key>app_id</key>
      		<string>262733</string>
      		<key>sdk_key</key>
      		<string>5b5f210528ecdd.73d33566</string>
      		<key>is_eu</key>
      		<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
      key>
      		<false/>
      		<key>apx_open_url_internal</key>
      		<string>YES</string>
      	</dict>
      </dict>
      </plist>

       

       

       

      Info
      titleAdditional Behaviours that can be Applied

      Push Permission Auth Dialog:

      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 for Appoxee Standalone

      Handle Foreground Notifications:

      From OS 10, you can decided whether notifications will be displayed when app is in the foreground. Default behaviour will be that notifications are not displayed when app is in the foreground, see details on Handle Foreground Notifications for Appoxee Standalone

      Becoming UNUserNotificationCenterDelegate:

      If you choose to become UNUserNotificationCenterDelegate, it will require you to forward its delegate methods to Appoxee.See details on Becoming UNUserNotificationCenterDelegate for Appoxee Standalone