Quick Start

This walkthrough shows you how to add Unflow to your iOS application and add your first carousel

What is Unflow?

Unflow provides a collaborative editor where marketing teams at mobile apps can design and deliver engaging in-app content to their users instantly. With our SDK, there is no need to involve engineering or wait on app store release cycles to deliver content. You can read more about how Unflow fits into your app or you can register to start building.

1. Setting Up Your Account

Before you begin it is important that you have already spoken to our team and have setup your app. This is the only way to generate an API token that will be needed to authenticate requests from your app. Anyone in your company can setup your account but you may need a technical team member to help you set it up inside your app.

2. Installation

Unflow for iOS can be installed either via CocoaPods or Swift Package Manager.

Swift Package Manager

You can add Unflow to you app using Swift Package Manager – an easy way to add Packages (third-party dependencies) to your Xcode project. In Xcode, go to File > Swift Packages > Add Package Dependency... and specify the repository URL of the Unflow library:

Set the version rule to Up to next major – the latest version of Unflow can be found in the releases section of our iOS SDK repo on Github. Finally, choose the target you want to use it in. The library should have been added to the Swift Package Dependencies section and you should be able to import it now.

3. Configuration


Enabling Logging

Be sure to enable and view debug logs before filing a ticket with Unflow Support.

As detailed in the sample code above, debug logs can be enabled or disabled by setting the enableLogging property when configuring Unflow.

Debug logs will provide detailed log output in XCode for what is going on behind the scenes and should be the first thing you check if your app is behaving unexpectedly, and also to confirm there aren't any unhandled warnings or errors.

4. Displaying Content

Unflow supports both SwiftUI and UIKit apps. Please find instructions to include the Opener UI for your app below.

Swift UI

By default we'll render our banner view. This will be scrollable if multiple Screens are live, but full width if only a single Screen exists.