Latest 1.0.9
License BSD
Platforms ios 8.0, requires ARC
Frameworks UIKit, Foundation, SystemConfiguration

Appunfold iOS SDK Integration Document

CocoaPods Compatible
Carthage Compatible

This guide will provide you with step by step details on how to integrate the SDK in just a few minutes. The following steps outline the integration process in details.

Steps to integrate the sdk to your Xcode – iOS project

Step 1 : Download the appunfold framework

Download the appunfold sdk from here

Alternatively you can clone the appunfold github repo

    git clone

The appunfold.framework is to be copied into your project folder.

Step 2 : Attach appunfold framework to your iOS project

  • Click on the project folder on the project navigator panel.
  • Click on the application under Targets and go to the General tab as shown in image below
  • Click on + button under Embedded Binaries as shown in image below.
  • Click on Add Other from the dialog that appears.
  • Select appunfold.framework from the project folder.
  • If prompted with a dialog that asks whether to copy the framework, click on Yes.

Step 3 : Initiate the appunfold framework

  • In your AppDelegate file, import the appunfold framework

    Swift :

    import appunfold


    #import <appunfold/appunfold.h>
  • In the didFinishLaunchingWithOptions: method initiate the appunfold sdk using the initMethod as shown below

    Swift :

    func application(_application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
      //Override point for customization after application launch.

    Objective-C :

    -(BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
      // Override point for customization after application launch.
      [[AppunfoldSDK sharedInstance] initWithAPIKey:@"<YOUR-API_KEY>"];

    Note – The API-KEY can be obtained from the integration page of your app in the appunfold dashboard.

Tracking User

You can track your user’s activity with our tools. For that to happen, you have to map user information. This mapping can by done by using following api:


                                      username  : "<username>", 
                                          email : "<email>", 
                                  andParameters : ["<param1>":"<value1>","<param2>":"<value2>"])

Objective C

    [[AppunfoldSDK sharedInstance] setUserWithId:@"<User-Id>"

This API identifies individual users and maps corresponding analytical data. All the parameters except userid are optional. You can add any number of parameters in the dictionary parameters provided in the api.

Please note that you have to intialise the AppunfoldSDK before using this API.


  • Help center Visibiity

    You can control the visibility of AppunfoldSDK’s help center by your code. It can be done using following api

    Swift :


    Objective C :

      [[AppunfoldSDK sharedInstance] showHelpCenter];
  • FAB Visibility

    To know if the FAB button is currently enabled for your application the following api can be used

    Swift :

      let x = AppunfoldSDK.sharedInstance().isFABEnabled() 
      // x will be `true` if fab is enabled; `false` if not

    Objective C :

      BOOL x = [[AppunfoldSDK sharedInstance] isFABEnabled];
      // x will be `YES` is fab is enabled; `NO` if not

    To enable/disable FAB the below mentioned API can be used

    Swift :


    Objective C :

      [[AppunfoldSDK sharedInstance] enableFAB:<YES/NO>];

Latest podspec

    "name": "Appunfold",
    "version": "1.0.9",
    "description": "Intelligent visual walkthroughs to handhold your users through workflows and new features.",
    "homepage": "",
    "platforms": {
        "ios": "8.0"
    "license": {
        "type": "BSD",
        "file": ""
    "authors": {
        "Aravind G S": "[email protected]"
    "source": {
        "git": "",
        "tag": "1.0.9"
    "vendored_frameworks": "SDK/appunfold.framework",
    "frameworks": [
    "requires_arc": true

Pin It on Pinterest

Share This