Versions Compared

Key

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

...

  • iOS: Appoxee plugin support iOS7 iOS8 and above

Prerequisites

  • Node and PhoneGap CLI installed on your mac.
  • Cordova 5.0.0 and above
  • Appoxee Cordova plugin 1.5.0.

Integration - Phase 1

  • Download the plugin
  • Add the plugin with the following command:

...


Code Block
languagebash
titleCordova CLI
cd Path/To/My/PhonegapProject
cordova plugin add /path/to/location/of/plugin

Versions 1.5.0 and above.

title
Code Block
languagebash
Cordova CLI
cd Path/To/My/PhonegapProject
cordova plugin add /path/to/location/of/plugin


        OR, indicate if Android applications should open landing pages inside, or outside the application.

**** Do to Cordova way of working, it is recommended to keep the default setting of landing pages to open outside of the application. Using the non default configuration of opening landing pages inside the app will lead to cases where the landing page will not be rendered due to initialisation issues  ****

Code Block
languagebash
titleCordova CLI
cd Path/To/My/PhonegapProject
cordova plugin add /path/to/location/of/plugin --variable APX_OPEN_URL_INTERNAL='no' 
/* pass 'no' or 'yes' when adding the plugin to indicate if on Android, landing pages should be opened inside or outside the application. */

...

iOS  - No need to explicitly engage the plugin via your JavaScript code.

  • iOS 1.3.1 and above

Add to your application plist file the "appoxee_sdk_key" with a string value of your application SDK key.

No need to explicitly call the AppoxeePlugin.engage() methodLocate AppoxeeConfig.plist on the Cordova Xcode project file structure (File should be located under 'Resources' folder on 'Xcode's project navigator).

Code Block
languagexmlbash
titleapplicationAppoxeeConfig.plist location
<key>appoxee_sdk_key</key>
<string>the_sdk_key</string>
  • iOS 1.5.0 and above

Locate AppoxeeConfig.plist on the Cordova Xcode project file structure.

...

~/CORDOVA_PROJECT_NAME/APPLICATION_NAME/platforms/ios/

...

XCODE_APP_NAME/Resources/AppoxeeConfig.plist
  1. Enter your SDK key.
  2. Choose the Appoxee environment to work against.
  3. Choose if landing pages open inside, or outside the application.

**** Do to Cordova way of working, it is recommended to keep the default setting of landing pages to open outside of the application. Using the non default configuration of opening landing pages inside the app will lead to cases where the landing page will not be rendered due to initialisation issues  ****

Code Block
languagexml
titleapplication.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>123456789.00</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>

...