The Cello SDK for Android enables you to add a referral program into your Android app. With a plug-n-play mobile component, your users can easily share their invite link with their friends and network using mobile sharing options convenient for them, receive rewards and get paid out.

​
Installation

You can install Cello for Android using Gradle or manually. A basic installation takes around 15 minutes but will take a little longer if you want to customize the way the Cello Referral Component is launched.

​
Compatibility

Cello SDK for Android is compatible with API 21 and up.

​
SDK size

The size of Cello for Android once installed varies depending on your app’s configuration. Around 7MB is the average size increase we would expect to see if you’re minifying your app correctly.

​
Setup

Install Cello to see and give your users the option to spread the word from your Android app. Cello for Android supports API 21 and above. Note: We recommend using the latest available compileSdkVersion.

​
Install Cello

Add the following dependency to your app’s build.gradle file:

​
Groovy (or Kotlin DSL)

dependencies {
    implementation("so.cello.android:cello-sdk:0.9.1")
}
Also, ensure that Maven Central is added to your root build.gradle: 
allprojects {
    repositories {
        mavenCentral()
    }
}

​
Choose an Environment

In your Cello SDK setup, you have the flexibility to select the environment in which your application will run. This feature is especially useful for different stages of development, such as testing in a development or staging environment before going live in production. The available environments are:
  • prod (Production) – default
  • sandbox (Sandbox)

​
Configuration Steps

In your Android project, open or create res/values/config.xml, then add: 
<?xml version="1.0" encoding="utf-8"?>
<resources>
    <string name="cello_env">prod</string>
</resources>
To change the environment, simply replace the value of cello_env. For instance, to set the environment to sandbox: 
<string name="cello_env">sandbox</string>
Save and rebuild your project to apply. Using this configuration, the Cello SDK will adapt to the specified environment, allowing for more controlled development and testing processes.

​
Initialize Cello

In this step, you will need your product ID and a token you have generated for the user, similar when implementing the web based Referral component. Then, initialize Cello by calling the following in the onCreate() method of your application class: 
Cello.initialize(this, "YOUR_PRODUCT_ID", token)
Note: If you don’t currently implement a custom application, you’ll need to create one. A custom application looks like this:

​
Kotlin

class CustomApplication : Application() {
    override fun onCreate() {
        super.onCreate()
        Cello.initialize(this, "YOUR_PRODUCT_ID", token)
    }
}

​
Java

public class CustomApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        Cello.initialize(this, "YOUR_PRODUCT_ID", token);
    }
}
Note: Cello SDK must be initialized inside the application onCreate() method. Initializing anywhere else will result in the SDK not behaving as expected and could even result in the host app crashing.

​
Customize the Cello Referral Component

The Cello SDK allows for various levels of customization to better fit into your app’s design and flow. One of the main components you might want to customize is the Referral component You have two options to launch the referral component:

​
Default Launcher

If you choose to go with the default launcher, you can call the showFab() method from the Cello SDK to present a Floating Action Button (FAB) within your app. This FAB is pre-styled but may not perfectly match your app’s look and feel. 
Cello.client().showFab()

​
Custom Launcher

If the default launcher does not fit your needs, you can implement your own custom launcher. This could be any UI element like a button, menu item, or even a gesture. To open the Referral component using a custom launcher, you can call Cello.openWidget(). 
Cello.client().openWidget()
Example using Compose: 
Button(onClick = { Cello.client().openWidget() }) {
    Text("Open Referral")
}

​
Android API

​
Cello.initialize()

Initializes the Cello referral component.
NameTypeDescriptionRequired
activityActivityThis is the reference to the MainActivityYes
productIdStringIdentifier of the product your users will referYes
tokenStringAccess token generated for the given userYes
productUserDetailsProductUserDetailsProduct user detailsNo
import com.cello.cello_sdk.ProductUserDetails

val productUserDetails = ProductUserDetails(
    firstName = "John",
    lastName = "Doe",
    fullName = "John Doe", 
    email = "john.doe@example.com"
)

Cello.initialize(this, "YOUR_PRODUCT_ID", token, productUserDetails = productUserDetails)

​
Cello.showFab()

Shows the Floating action button or bookmark that launches the Referral Component 
Cello.client().showFab()

​
Cello.hideFab()

Hides the Floating action button or bookmark that launches the Referral Component 
Cello.client().hideFab()

​
Cello.openWidget()

Opens the referral component. 
Cello.client().openWidget()

​
Cello.hideWidget()

Hides the referral component. 
Cello.client().hideWidget()

​
Cello.getActiveUcc()

A method to get an active ucc and invite link for the currently logged in user. 
val result = Cello.client().getActiveUcc()

​
getCampaignConfig()

Returns campaign config values for the currently logged-in user. 
let result = Cello.client().getCampaignConfig()

​
Returns

​
campaignConfig
object
The campaign config object:

​
Cello.changeLanguage()

A method to change the language of the Referral component at runtime without re-initialising it. 
Cello.client().changeLanguage("de")

​
Cello.shutdown()

Shuts down connection to Cello and unmounts the component 
Cello.client().shutdown()