APXOR iOS SDK Manual Integration Guide

Getting started with Apxor iOS SDK

Plugin Name	Latest Version	Release Date
ApxoriOSSDK-Core	263	25-02-2021
ApxoriOSSDK-WYSIWYG	108	26-10-2020
ApxoriOSSDK-CE	128	01-12-2020
ApxoriOSSDK-RTA	158	18-02-2021
ApxoriOSSDK-Survey	118	08-11-2020

Plugin Name	Description
ApxoriOSSDK-Core	The Core Plugin is responsible for the basic event tracking

Download the above and Unzip to find ApxorSDK.framework directory

Adding Apxor SDK to your project

Add ApxorSDK.framework to your "Frameworks, Libraries and Embedded Content" list.
(for xcode < 11, under “Embedded Binaries”)
Also add the libsqlite3.dylib (or libsqlite3.0.tbd) library to the same list.
Under build settings tab, in "Other Linker Flags", add -ObjC , if not already present.

Add Apxor script

Add the following in the Run script phase in your build phases.

# Script to strip unwanted architectures

APP_PATH="${TARGET_BUILD_DIR}/${WRAPPER_NAME}"

find "$APP_PATH" -name '*[A][Pp][Xx]*.framework' -type d | while read -r FRAMEWORK
do
FRAMEWORK_EXECUTABLE_NAME=$(defaults read "$FRAMEWORK/Info.plist" CFBundleExecutable)
FRAMEWORK_EXECUTABLE_PATH="$FRAMEWORK/$FRAMEWORK_EXECUTABLE_NAME"
echo "Executable is $FRAMEWORK_EXECUTABLE_PATH"

EXTRACTED_ARCHS=()

for ARCH in $ARCHS
do
echo "Extracting $ARCH from $FRAMEWORK_EXECUTABLE_NAME"
lipo -extract "$ARCH" "$FRAMEWORK_EXECUTABLE_PATH" -o "$FRAMEWORK_EXECUTABLE_PATH-$ARCH"
EXTRACTED_ARCHS+=("$FRAMEWORK_EXECUTABLE_PATH-$ARCH")
done

echo "Merging extracted architectures: ${ARCHS}"
lipo -o "$FRAMEWORK_EXECUTABLE_PATH-merged" -create "${EXTRACTED_ARCHS[@]}"
rm "${EXTRACTED_ARCHS[@]}"

echo "Replacing original executable with thinned version"
rm "$FRAMEWORK_EXECUTABLE_PATH"
mv "$FRAMEWORK_EXECUTABLE_PATH-merged" "$FRAMEWORK_EXECUTABLE_PATH"

done

Note

Make sure the "Run Script" phase is placed after "Embedded Frameworks"

Build Phases Order

Initialize Apxor iOS SDK

To Auto initialize SDK (Recommended), add the following inside your application plist file.
Open your application's Info.plist as source code.
Copy paste the below piece of code, to create an entry for ApxorSDK.

<key>Apxor</key>
<dict>
    <key>Core</key>
    <string>{YOUR_APP_ID}</string>
    <key>APXSurveyPlugin</key>
    <true/>
    <key>APXRTAPlugin</key>
    <true/>
    <key>APXWYSIWYGPlugin</key>
    <true/>
</dict>

To manually initialize SDK (Not Recommended), call ApxorSDK.initialize method in your Applicaiton class

//...
#import "ApxorSDK/ApxorSDK.h"

@implementation AppDelegate

- (BOOL)application:(UIApplication*)application didFinishLaunchingWithOptions:(NSDictionary*)launchOptions
{
    [ApxorSDK initializeApxorWithID:@"<YOUR_APP_ID>"];
    // ... your code
}

Note

To get your app ID, please email us at contact@apxor.com

Your plist should look something like this

Plist with Apxor Entry

Plugins Integration

Add the libraries to your application's "Frameworks, Libraries and Embedded Content" list. (Click on the plugin name to download)
Apxor provides you two easy to use plugins for your Actions. They are:

Plugin Name	Description
APXSurveyPlugin	This Plugin helps you create contextual surveys to capture your users' feedback, ratings, etc.
APXRTAPlugin	This Plugin helps you create real time actions.

Make sure to add the following dependency plugins as well,

Plugin Name	Description
CE	The Secret Sauce
APXWYSIWYGPlugin	The WYSIWYG Plugin allows you to preview your configured actions onto your device in real time

Add the following to your application's Info.plist inside Apxor entry, for each plugin.

<key>APXSurveyPlugin</key>
<true/>
<key>APXRTAPlugin</key>
<true/>
<key>APXWYSIWYGPlugin</key>
<true/>

Note

The APXWYSIWYGPlugin is only for debug purposes, make sure to remove it for non-debug builds.

Ensuring ApxorSDK is initialised successfully

Lookout for the following log

SDK Init Logs

Note

ApxorSDK uploads data when the app is minimized to the background. If you are running from XCode (simulators or devices), do not stop the app, just press on the "home" button in order for data to be uploaded.

API Guide

Read API Guide here