Kotlin Push SDK

Add mavenCentral() repository

Add mavenCentral() repository to your root build gradle.

1
// place the below snippet in your project gradle file
2
allprojects {
3
    repositories {
4
        ...
5
        mavenCentral()
6
    }
7
}

Add Android dependencies

Add Android dependencies inside the app build gradle by adding the below line inside dependencies

1
implementation 'io.fyno.kotlin-sdk:kotlin-sdk:0.0.4'

Initialize Fyno SDK in Your Android App

To integrate Fyno Android SDK, initialise Fyno SDK in MainActivity/MainApplication inside onCreate method.

1
class MyApplication : Application() {
2
3
    override fun onCreate() {
4
        ...
5
        FynoSdk.initialize(context, workspace_id, api_key)
6
        super.onCreate()
7
    }
8
}
9
//Initilize
10
FynoSdk.initialize(context, Workspace_Id, Api_Key)
11
12
//Register for push
13
FynoSdk.registerPush("Xiaomi_App_Id", "Xiaomi_App_Key", "Xiaomi_Push_Region", "Fyno_Integration_Id")
14
15
//Identify user on login
16
FynoSdk.identify("Distinct_Id")

Fyno Core: Establish Context & User Profiling

Fyno Core initialises the context between your android application and Fyno, which has all the required configurations needed for FynoSDK, FynoPush and FynoCallback to work and helps with profiling the users as well.

1. Adding Dependencies: Add following line inside dependencies in app build gradle

   project_name/app/build.gradle

   1
   dependencies{
   2
       ...
   3
       implementation 'io.fyno.kotlin-sdk:core:0.0.5'
   4
   }

2. Initialisation: Fyno Core SDK is responsible for initialising the context to save Fyno configurations and user profiling.

   • To initialise Fyno SDK you have to call FynoCore.initialize(this, "WSID", "APIKEY")
   • When a user logs in, to create a user profile, call FynoUser.identify("Distinct_Id")

Fyno Push: Handle and Amplify Push Notifications

Fyno Push handles incoming push notification requests from Fyno and renders the customised push message with different templates as configured in Fyno platform. This library takes care of Push Amplification, if enabled.

1. Adding Dependencies: Add following line inside dependencies in app build gradle. Also, download the google-services.json from Firebase console and place it in the root folder as per FCM Documentations

   project_name/app/build.gradle

   1
   dependencies{
   2
       ...
   3
       implementation 'io.fyno.kotlin-sdkk:pushlibrary:0.0.4'
   4
   }

2. Initialisation: Fyno Push SDK is responsible for handling push rendering and push amplification.

   • To initialise Fyno Push you are required to use FynoCore you have to call FynoCore.initilize(this, "WSID", "APIKEY")
   • To initialize push, call FynoPush.registerPush method
   • Push Amplification: To make use of push amplification follow Mi Push Documentation to implement Xiaomi push
   kotlin

   1
   //register push
   2
   FynoPush.registerPush("Xiaomi_App_Id", "Xiaomi_App_Key", "Xiaomi_Push_Region", "Fyno_Integration_Id")
   3
   //register push without amplification
   4
   FynoPush.registerFcm("Fyno_Integration_id")

Fyno Callback: Track Push Notification Status

Fyno Push SDK is responsible for sending push callbacks to Fyno by calling FynoCallback.updateStatus method. The above method required 2 required parameters and 1 optional parameter

1. callback_url - Required parameter - You can get the callback_urlfrom the notification additional payload if the notification triggered from Fyno.

2. status - Required parameter - status of the push notification to be notified to Fyno. It is of type MessageStatus. The possible message statuses that you can receive are:

   • MessageStatus.RECEIVED
   • MessageStatus.OPENED
   • MessageStatus.CLICKED
   • MessageStatus.DISMISSED

3. Additional parameters - optional parameters, like device details can be captured here.

   kotlin

   1
   //Updating notification status to Fyno
   2
   FynoCallback.updateStatus("Callback_URL", "Message_Status", "Additional_Data")