Latest 0.0.4
Homepage https://github.com/blondie-inc/blondie-flow-sdk-ios
License GNU General Public License v3.0
Platforms ios 8.0, requires ARC
Authors

Blondie SDK

Get started on integrating the Blondie into your native iOS app through these guides:

Installation

Install Blondie to perform automations right from your iOS app. The Blondie SDK for iOS library supports iOS 8.x and upwards.

Step 1 – Install Blondie SDK

Before you start, you need to make sure you have an access to the Blondie. Then you have three options:

Option 1: CocoaPods (pending)

Add Blondie SDK to your Podfile and run pod install

target :YourTargetName do
  pod 'Blondie'
end

Option 2. Carthage (pending)

  1. Add github "blondie-inc/blondie-sdk-ios" to your Cartfile.
  2. Run carthage update.
  3. Go to your Xcode project’s "General" settings. Drag Blondie.framework from Carthage/Build/iOS to the "Embedded Binaries" section.

Option 3: Install Blondie manually

Download Blondie SDK for iOS and extract the zip.

Go to your Xcode project’s "General" settings. Drag Blondie.framework to the "Embedded Binaries" section. Make sure “Copy items if needed” is selected and click Finish.

Step 3 – Initialize Blondie

First, you’ll need to get your Blondie Flow ID and an API key. To find these, just add an SDK trigger to your Blondie Flow.

Then initialize Blondie SDK by importing Library and adding the following to your application delegate:

Objective-C:

@import Blondie;

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [Blondie setApiKey:@"<Your JWT API Key>"];
}

Swift:

import Blondie 

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
     Blondie.setApiKey("<Your JWT API Key>")
}

Configuration

Here’s how to configure Blondie for iOS:

Select an environment

You can select the Blondie Flow environment to use. It is very handy when you need to test a particular feature before rolling out to production.

By default we select production environment, but you can always change it by calling one of:

Objective-C:

[Blondie useDevelopmentEnvironment];
[Blondie useTestEnvironment];
[Blondie useProductionEnvironment];

Swift:

Blondie.useDevelopmentEnvironment()
Blondie.useTestEnvironment()
Blondie.useProductionEnvironment()

Use a custom Blondie Flow instance

In order to integrate Blondie SDK with a custom Blondie Flow instance you can set the base url by calling:

Objective-C:

[Blondie setBaseUrl:@"https://custom.flow.url"];

Swift:

Blondie.setBaseUrl("https://custom.flow.url")

Disable offline mode

By default Blondie SDK works both in both online and offline mode. In order to work without an internet connection, Blondie SDK keeps a queue of events to sync when the connection becomes available again.

You can disable that behaviour by calling:

Objective-C:

[Blondie disableOfflineMode];

Swift:

Blondie.disableOfflineMode()

Disable auto retries

By default Blondie SDK performs automatic retries if an error occurs during a request to the Blondie Flow, so that you don’t need to worry about missing an event.

You can disable that behaviour by calling:

Objective-C:

[Blondie disableAutoRetries];

Swift:

Blondie.disableAutoRetries()

Tracking events

You can log events in Blondie that record what users do in your app and when they do it. For example, you could record the data a user submitted in your mobile app, and when they submitted it.

Objective-C:

[Blondie triggerEventWithName:@"Short Form Submitted" metaData: @{
  @"amount": @1234,
  @"customer": @{
    @"phone": @"+3712654321",
    @"email": @"[email protected]"
  }
}];

Swift:

Blondie.triggerEvent(
  withName: "Short Form Submitted", 
  metaData: [
    "amount": 1234,
    "customer": [
      "phone": "+3712654321",
      "email": "[email protected]"
    ]
  ]
)

Latest podspec

{
    "name": "Blondie",
    "version": "0.0.4",
    "summary": "Blondie Flow SDK built for Objective-C/Swift based mobile applications",
    "authors": {
        "Blondie Consulting": "[email protected]"
    },
    "homepage": "https://github.com/blondie-inc/blondie-flow-sdk-ios",
    "license": {
        "type": "GNU General Public License v3.0"
    },
    "platforms": {
        "ios": "8.0"
    },
    "source": {
        "git": "https://github.com/blondie-inc/blondie-flow-sdk-ios.git",
        "tag": "v0.0.4"
    },
    "source_files": [
        "Classes",
        "SDK/Blondie/**/*.{h,m}"
    ],
    "requires_arc": true
}

Pin It on Pinterest

Share This