Skip to content

Latest commit

 

History

History
133 lines (87 loc) · 4.07 KB

README.md

File metadata and controls

133 lines (87 loc) · 4.07 KB
Raw

Connect Android SDK

Overview

The Connect Android SDK allows you to embed Finicity Connect anywhere you want within your own mobile applications.

Compatibility

The Connect Android SDK supports the following Android versions.

  • Android 5.0 (Lollipop) or later

  • minSdkVersion 21 or later

  • Android Gradle Plugin v3.4.0 or greater required

  • Gradle 5.1.1 or greater required

Step 1 - Add Finicity's JFrog Artifactory repository to your project

The Connect Android SDK is now available thru Finicity's JFrog Artifactory account for distribution. To download and integrate the SDK into your android project add the following lines into your build.gradle file(s).

repositories {
    maven { url "https://finicity.jfrog.io/artifactory/finicity-connect-gradle-release-local" }
}

dependencies {
    implementation 'com.finicity.connect:connect-sdk:+'
}

Step 2 - For projects using AndroidX:

Open the gradle.properties file and set android.enableJetifier to true.

Step 3 - Update Android application settings

Add internet permissions to your AndroidManifest.xml file.

<uses-permission android:name="android.permission.INTERNET">

Step 4 - Add code to start the Connect SDK

The Connect class contains a start method that when called, starts an activity with the supplied event handler. The SDK only allows a single instance of the Connect activity to run. If you start Connect while a Connect activity is already running, a RuntimeException is thrown.

Connect Class

The Connect Android SDK’s main component is the Connect class that contains a static start method, which runs an activity that connects with the EventHandler.

Java
public static void start(Context context, String connectUrl, EventHandler eventHandler)

Kotlin
fun start(context: Context, connectUrl: String?, eventHandler: EventHandler?)
Argument Description
context The Android Context is referenced by Connect when an activity starts.
connectUrl The SDK loads the Connect URL.
eventHandler A class implementing the EventHandler interface.

See Generate 2.0 Connect URL APIs

EventHandler Interface

Throughout Connect’s flow, events about the state of the web application are sent as JSONObjects to the EventHandler methods.

NOTE: The onUserEvent handler will not return anything unless you’re specifically targeting Connect 2.0.

Java
public interface EventHandler {
    void onLoad();
    void onCancel(JSONObject cancelEvent);
    void onDone(JSONObject doneEvent);
    void onError(JSONObject errorEvent);
    void onRoute(JSONObject routeEvent);
    void onUser(JSONObject userEvent);
}

Kotlin
interface EventHandler {
    fun onLoad()
    fun onCancel(cancelEvent: JSONObject?)
    fun onDone(doneEvent: JSONObject?)
    fun onError(errorEvent: JSONObject?)
    fun onRoute(routeEvent: JSONObject?)
    fun onUser(userEvent: JSONObject?)
}
Event Description
onLoad Sent when the Connect web page is loaded and ready to display
onCancel Sent when the user cancels the Connect application
onDone Sent when the user successfully completes the Connect appliction
onError Sent when there is an error during the Connect application
onRoute Sent when the user navigates to a new route or screen in Connect
onUser Called when a user performs an action. User events provide visibility into what action a user could take within the Connect application

Manually stop a connect activity

The Connect activity will automatically finish on done, cancel, and error events.

You can manually finish a Connect activity by invoking:

Connect.finishCurrentActivity()

Process Restarts

Android sometimes stops your application’s process and restarts it when your application is re-focused. If this happens, the Connect activity automatically finishes when the application resumes. If you want Connect to run again, call the start method. See Connect Class.