Get started

Here you will know how to set up 1Flow library on Fluter cross-platform apps. Setting up 1Flow for your Flutter app is easy and you can do it by following steps.

Prerequisites

Flutter SDK

For Android:

A device or emulator with Google Play services installed and up-to-date.
Android Studio.

For iOS:

XCode
An iOS device such as an iPhone or an iPad

1. Add the SDK

Create your Flutter application if you haven't already, see the Flutter guide and setup it by following the given instructions.

Open pubspec.yaml and add the following dependencies::

yaml
dependencies:
      flutter_1flow_sdk: ^2023.9.19

Open a Terminal window in your flutter project directory and type:

shell
flutter pub get

2. Setup

For iOS

Navigate to the ios directory and install pods

shell
cd ios

pod install

💡

Make sure you have configured the deployment target to iOS 11.0 or higher, since Flutter creates new iOS apps with 9.0 deployment target. Open *.xcworkspace from ios folder, change the deployment target to 11.0 and re-run pod install.

For Android

Include the below repository to your project's build.gradle file:

java
allprojects{
	repositories{
        google()
        jcenter()
        maven{url 'https://jitpack.io'}
    }
}

Add dependency to your app's build.gradle file:

java
defaultConfig {
				....
				minSdkVersion 21
    }
dependencies {
		....
    implementation "com.github.1Flow-Inc:1flow-android-sdk:2023.9.19"
}

4. Configure

Open your Flutter Application’s lib/main.dart and write the following code in main()

dart
// Add this line to import 1Flow at the top of the file
import 'package:flutter_1flow_sdk/flutter_1flow_sdk.dart';

void main() {
  runApp(MyApp());
  // Add this line to configure 1Flow
  OneFlow.configure('your-project-api-key');
}

💡

Note: you need to replace your-project-api-key with your actual project API key. Click here and navigate to Project Settings → API keys section.

Optional: If you want to configure 1Flow UI with non-system font then use below code to configure custom font for survey UI

dart
// Add this line to import 1Flow at the top of the file
import 'package:flutter_1flow_sdk/flutter_1flow_sdk.dart';

void main() {
  runApp(MyApp());
  // Add this line to configure 1Flow
  OneFlow.configure('your-project-api-key'); 

  //For iOS Only
  OneFlow.useFont(fontFamily: "Courier New");

  // For Android Only (This font file should exist at "/android/app/src/main/assets/fonts/pacifico.ttf"
  OneFlow.useFont(path: "fonts/pacifico.ttf"); 

  // For iOS & Android Both (This font file should exist at "/android/app/src/main/assets/fonts/pacifico.ttf"
  OneFlow.useFont(fontFamily: "Courier New", path: "fonts/pacifico.ttf");
}

fontFamily and path are optional. you can pass null if you want to restore it to default system font.

4. Log user (optional)

If your app or website does not need the user to sign in, then you can skip to step 4 - Log events.

If your app requires the user to register an account and sign in, you can call a method to bind the user with 1Flow. This way, you'll be able to connect the data with your internal records.

Whenever the user has signed in, you can call OneFlow.logUser() to pass the user identifier, along with any other parameters you'd like to store with us (such as email, full name, etc.), to 1Flow.

dart
// import 1Flow SDK
import 'package:flutter_1flow_sdk/flutter_1flow_sdk.dart';

try {
	OneFlow.logUser('12345', { 'firstName': 'steve', 'lastName': 'jobs', 'number': 123456 });
} on PlatformException {
  print('logUser: error occured');
}

Here, parameters is optional. pass nil if you don't want any parameters to send with the user.

5. Start Flow

You can manually start any active flow (published, currently turned on) in your project by calling the startFlow method. This wouldn’t work if you turn off the flow or haven’t published it yet.

💡

Advanced tip: Calling this manually would ignore any target audience filters you set for the survey or announcement flow. As long as the flow is found in your current project and is in active status, it will show immediately.

dart
import 'package:flutter_1flow_sdk/flutter_1flow_sdk.dart';

try {
        OneFlow.startFlow("flow_id");
      } on PlatformException {
      print('startFlow: error occured');
    }

6. Track events

Events are central to 1Flow. An Event is a marker in the code to track a key moment in the user flow - like when the user just created an account, completed some action, made a purchase or rejected an offer. We recommend you track at least 4-5 events to better understand the user journey.

dart
import 'package:flutter_1flow_sdk/flutter_1flow_sdk.dart';

try {
	OneFlow.recordEventName('custom', { 'product': 'test', 'price': 123.9 });
//  OR
OneFlow.recordEventName('custom');
} on PlatformException {
  print('recordEventName: error occured');
}

Here, parameters is optional. pass nil if you don't want any parameters to send with the event.

💡

Advanced tip: Events can be used to trigger surveys, and if you pass in relevant info about the user action (such as the id of the content they just consumed, name of the offer just shown to them, etc.), then you can enrich the survey response with valuable context using our webhooks.

⚠️

Icon Missing: If you are using flutter_1flow_sdk along with flutter_launcher_icons package, it might be possible that app icons start disappearing. To fix problem you simply need to delete ic_launcher.xml file from your app → src → main → res → mipmap-anydpi-v26 folder.

📢

Notes: Parameters in Log User and Track Events will support the Dictionary of these Data Types: String, Int, Double and Float. To pass the Date, You may convert it to the String as expected format but We recommend using a timestamp. It will be more helpful to set up trigger rules for this parameter across all platforms on 1Flow Dashboard. Parameters other than these types will be skipped.

6. Check for success

Build and run your application. Go to 1Flow dashboard - if the implementation is successful, then this banner should disappear when we receive data from your device:

Show your first survey

Now that you've successfully installed 1Flow into your app, it's time to create your first survey.

If you've already created a survey and published it (survey shows up in the "In Progress" section of the dashboard), run the app and trigger the event to happen, you should see the survey show up when the event is fired.