getrollee_flutter_sdk 2.0.1

Rollee Connect Flutter SDK

Rollee Connect Flutter SDK

Rollee Connect Flutter SDK is a used for integrating Rollee Connect process into your app easily.

What it Supports?

Android SDK 19+ or 20+

iOS 11.0+

Usage

The RolleeConnect widget represents a view that you can integrate into your app's flow, with your customized configuration and callback handlers that are passed as its properties.

import 'package:getrollee_flutter_sdk/rollee_flutter_sdk.dart';

//...

RolleeConnect(
  config: const RolleeConnectConfig(
    token: "<YOUR-TOKEN-HERE>",
    sessionToken: "<THE-SESSION-TOKEN-HERE>",
  ),
  onCompleted: (result) {
    print("onCompleted $result");
  },
  onClose: (close) {
    print("onClose $close");
  },
  onLoginSuccess: (loginResult) {
    print("onLoginSuccess $loginResult");
  },
),

Callbacks

The RolleeConnect widget can be customized with many callbacks that let you trigger your users events during the Rollee Connect flow :

• When Rollee Connect's home page starts, the onHomeStarted callback will run.

• When Rollee Connect's terms page starts, the onTermsStarted callback will run.

• When Rollee Connect's search page starts, the onSearchStarted callback will run.

• When Rollee Connect's login page starts, the onLoginStarted callback will run.

• When Rollee Connect's login page fetching starts, the onFetchStarted callback will run.

• When a user logs in successfully to a data source in Rollee Connect, the onLoginSuccess callback will run.

• When Rollee Connect's connected page starts, the onConnected callback will run.

• When a user completes the Rollee Connect's flow successfully, the onCompleted callback will run.

• at any point of Rollee Connect's flow, if a user closes it without completing it, the onClose callback will run.

Configuration

To define a user Session on RolleeConnect, you must set a RolleeConnectConfig object to the config property, with providing its mandatory parameters:

• The user's sessionToken.

Example of the minimal configuration:

final config = RolleeConnectConfig(
   sessionToken: "<THE-SESSION-TOKEN-HERE>",
),

Customization via Rollee Dashboard

You can personalize the Rollee Connect flow to match your brand using the Rollee Dashboard. In the dashboard, you can create customizations—such as changing colors, logos, and other UI elements. Each customization is assigned a unique customization ID.

To apply a specific customization, add the customization_id as a query parameter to the sessionToken:

final config = RolleeConnectConfig(
   sessionToken: "<THE-SESSION-TOKEN-HERE>?customization_id=<YOUR-CUSTOMIZATION-ID>",
   setup: RolleeConnectConfigSetup(
     isProduction: true,
  ),
),

This will display the customized version of Rollee Connect that you configured in the dashboard for your users.

The setup properties are optional, not setting or ignoring them will make the SDK uses the default values instead.

But, when your app is going to production, don't forget to set the isProduction property to true.

API reference

Full API reference from here