Quick Start

This walkthrough shows you how to add Unflow to your Android 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 Android is available on Maven and can be included via Gradle.

build.gradle



3. Configure the SDK

Only use your public API key to configure Unflow

You can get your public API key from the app settings on the dashboard.

Once you've installed the Unflow SDK for your app, it's time to initialize and configure it.

You should only configure Unflow once, usually early in your application lifecycle. After configuration, the same instance is used throughout your app by accessing the shared singleton in the SDK.

Kotlin



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 Logcat 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

The SDK includes all the components necessary to integrate Unflow into your UI.

The default screen opener is a banner rail. The contents of the banner can be scrolled if multiple openers are present. An example is included below.



Unflow banner stack
Unflow banner stack



The code sample below shows how the Unflow opener can be easily interwoven as a plug-and-play component within your existing UI to display content.

Jetpack Compose
XML