A Marmalade wrapper for the the Kiip iOS and Android SDK's.
JavaScript C++ Objective-C Java C
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Docs
ExampleApplication
KiipSDK.framework
KiipSDKAndroid
KiipSDKResources.bundle
h
interface
lib
source
.gitignore
README.md
Readme.html
s3eKiip.mkf
s3eKiip.s4e
s3eKiip_android.mkb
s3eKiip_android_java.mkb
s3eKiip_build.mkf
s3eKiip_iphone.mkb
s3eKiip_windows.mkb

README.md

Overview

This extension has been built and tested with Marmalade 6.2, the iOS version will not link with earlier versions of Marmalade as it requires iOS 6

v 1.4 upgraded iOS SDK to 2.0.3 and Android SDK to 2.0.4. UDID submission problem solved on iOS

v 1.2 Upgraded to Kiip v2.0.2 v 1.0 Initial iOS and Android versions built using Kiip v2.1

Instructions for iOS

  • Integrating the s3eKiip extension

    • Create an account on http://www.kiip.me/ (also see docs.kiip.com)

    • Add your test device Mac address to your Kiip account to enable test content to be sent

    • In your mkb add the extension to the subprojects section.

      • You can either; copy this entire extension folder to your Marmalade extension folder, in which case add the below subprojects { s3eKiip }

      • Or you can include the extension mkf file using a relative path subprojects { ../s3eKiip.mkf }

    • Copy your app key and secret keys from the site into your source and call s3eKiipInitWithKeys() to initialise Kiip

    • To send a Moment use s3eKiipSaveMoment or s3eKiipSaveMomentWithValue - see Kiip documentation for more

    • Optionally install callbacks to keep track of Kiip completion - see h/s3ekiip.h

    • Optionally set or get Kiip properties such as the default email and dob - see h/s3ekiip.h

    • See the ExampleApplication for a simple working example

    • Notes:

      • As with any thrid party Marmalade extension s3eKiip can only be tested on a device. It is only linked at the deploy stage. It will be unavailable in the emulator.
      • Kiip expects the CFBundleShortVersionString

to be in your project plist to identify the version of your app, Marmalade won't set this up by default so to add it you need a custom plist. However if not present Kiip will fallback to the standard CFBundleString

which Marmalade will set. * The extension also requires the CoreTelephony, QuartzCore and SystemConfiguration iOS frameworks, these are added to the load linker for you by the extension mkf file.

	* The extension requires the KiipSDKResources.bundle folder to be included in the root of your build - this is handled for you in the extension mkf file.
  • Instructions for rebuilding the extension (not needed unless you want to maintain the extension)

    • To upgrade this extension to a newer Kiip SDK assuming the Kiip SDK interface is the same

      • Unpack the new SDK
      • Replace the Kiip.framework folder here with the new one
      • The expected structure inside the framework folder is for the headers to be at Kiip.framework/Headers
      • Locate and copy the Kiip library file from "Kiip.framework/KiipSDK" to "lib/iphone"
      • To be clear KiipSDK is a file not a folder, it is a library file without the .a extension
      • Rename it in lib/iphone to libKiipSDK.a - it has to be exactly this name as the Marmalade linker will prefix "lib" and add ".a".
      • Copy the KiipSDKResources.bundle folder from KiipSDK.framework\Resources into this folder (the root of the extension)
      • On a mac in a terminal window cd into this folder and do "mkb s3eKiip_iphone.mkb --arm" all on one line.

      Instructions for iOS testing after updating

  • To test if the update works provided that you've updated the Kiip iOS sdk

     *	Under /ExampleApplication open s3eKiipExample.mkb
     	*	Xcode project will open up
     
     *	Run the project in Release GCC ARM
     	*	it may crash after first few seconds, this is normal
     
     *	Open Marmalade's DeployTool
     
     *	Select deploy_config.py under /ExampleApplication/build_s3ekiipexample_xcode
     
     *	choose ARM GCC Release, hit "Next >"
     
     *	choose Default, hit "Next >"
     
     *	choose iOS(iPhone, iPad, iPod), hit "Next >" and "Next >"
     
     *	choose correct provisioning profile, hit "Next >"
     
     *	choose Package and Install and hit Deploy All
     
     *	choose ARM GCC Release, hit "Next >"
     
     *	install resulting IPA on test device
    

Instructions for Android

  • Integrating the s3eKiip extension

    • Create an account on http://www.kiip.me/ (also see docs.kiip.com)

    • Add your test device Mac address to your Kiip account to enable test content to be sent

    • In your mkb add the extension to the subprojects section.

      • You can either; copy this entire extension folder to your Marmalade extension folder, in which case add the below subprojects { s3eKiip }

      • Or you can include the extension mkf file using a relative path subprojects { ../s3eKiip.mkf }

    • On Android we need to use a customized AndroidManifest.xml file to permit using a custom Application class:

      • Copy the default AndroidManifest.xml file (from the ExampleApplication) into your project

        [ Alternatively you can copy the AndroidManifest.xml from the Marmalade SDK (s3e\deploy\plugins\android folder) and edit it to include the following additional text in the Application section: android:name="com.s3eKiipExt.MainApplication" ]

      • Copy the ExtraAppManifests.txt file (from the ExampleApplication) into your project

      • Copy your app key and secret keys from the site into the ExtraAppManifests.txt

      • In the Deploy tool go to the Android Specific Options tab and in the advanced section set the following settings: Android Manifest : set to point to the AndroidManifest.xml above Android Application Manifest Snippet: set to point to the ExtraAppManifests.txt above

    • To send a Moment use s3eKiipSaveMoment or s3eKiipSaveMomentWithValue - see Kiip documentation for more

    • Optionally set or get Kiip properties such as the default email and dob - see h/s3ekiip.h

    • See the ExampleApplication for a simple working example

    • Notes:

      • As with any thrid party Marmalade extension s3eKiip can only be tested on a device. It is only linked at the deploy stage. It will be unavailable in the emulator.
      • The extension also requires the KiipSDK.jar, the Kiip res folder and android-support-v4.jar , which are added to the load linker for you by the extension mkf file.
  • Instructions for rebuilding the extension (not needed unless you want to maintain the extension)

    • To upgrade this extension to a newer Kiip SDK assuming the Kiip SDK interface is the same
      • Unpack the new SDK
      • Replace the KiipSDK.jar and the res folder in KiipSDKAndroid folder with the newer versions
      • Double click on the s3eKiip_android.mkb file in the root of the s3eKiip folder
      • Double click on the s3eKiip_android_java.mkb file in the root of the s3eKiip folder