For Gradle version 6.7 and below

Copied// Add the following to your project's root build.gradle file.

allprojects {
   repositories {
      google()
      mavenCentral()
      // ...
      maven { url 'https://maven.zohodl.com' }
   }
}

For Gradle version 6.8 and above

Copied// Add the following to your settings.gradle file.

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        // Add the Zoho Maven URL here
        maven { url = uri("https://maven.zohodl.com") }
    }
}

Copied// Add the following to your settings.gradle file.

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        // Add the Zoho Maven URL here
        maven { url 'https://maven.zohodl.com' }
    }
}

Platform configuration (mandatory)

iOS

1. Update your Info.plist

Add the required keys and descriptions for your application in the Info.plist file. These are necessary for the SDK to work correctly and comply with iOS requirements.

• Open Xcode workspace

Copied 

open ios/Runner.xcworkspace 

• In Xcode’s Project navigator, expand Runner and locate Info.plist under the Runner folder.
• Add only the usage description keys you need, then save and rebuild the app.

2. Configure background mode capability for CallKit

When integrating salesiq_mobilisten_calls, enable the appropriate Background Modes in Xcode so CallKit can properly show incoming and ongoing calls, even when your app runs in the background. 

This setup ensures your app can display CallKit’s call UI and handle calls seamlessly in the background.

Enable background modes for CallKit

• Open Xcode and select your app target.
• Navigate to the Signing & Capabilities tab.
• Click + Capability and add Background Modes.
• Under Background Modes options, check:
  • Background fetch
  • Audio, AirPlay, and Picture in Picture

Android

1. Lifecycle Callback

Copied 

<application
    android:label="@string/app_name"
    android:icon="@drawable/ic_launcher"
    android:name="<package_name>.MyFlutterApplication">    

Copiedimport io.flutter.app.FlutterApplication;
import com.zoho.salesiq.mobilisten.calls.plugin.MobilistenCallsPlugin;
import com.zohosalesiq.plugin.MobilistenPlugin;

public class MyFlutterApplication extends FlutterApplication {

        //...
 
       @Override
        public void onCreate() {
                MobilistenPlugin.registerCallbacks(this);
                MobilistenCallsPlugin.registerCallbacks(this);
                super.onCreate();
        }
}

This is essential as it enables Mobilisten to track activity's lifecycles and other listener callbacks on the app's startup to show the launcher and other important user behaviors.

Note: If you already have a custom Application class, ensure to "import com.zohosalesiq.plugin.MobilistenPlugin;" and call "MobilistenPlugin.registerCallbacks(this);" before invoking "super.onCreate()".

2. Permissions

Mobilisten

Mobilisten Calls

Generate App and Access keys

Once the SDK is integrated and the necessary permissions are configured, generate the App Key and Access Key for the required platform(s) to initialise Mobilisten.

Note: A separate app and access key are required for iOS and Android.

iOS

Copiedimport 'dart:io' show Platform;
import 'package:salesiq_mobilisten/salesiq_mobilisten.dart';
// If you use the Calls add-on, keep the import below; otherwise remove it.
import 'package:salesiq_mobilisten_calls/salesiq_mobilisten_calls.dart';
/// Initialize Mobilisten SDK.
/// Call this once at app startup (application wakeup place), e.g., before runApp().
Future<void> initMobilisten() async {
  // Hardcoded here only as placeholders:
  const iosAppKey        = 'YOUR_IOS_APP_KEY';
  const iosAccessKey     = 'YOUR_IOS_ACCESS_KEY';
  const androidAppKey    = 'YOUR_ANDROID_APP_KEY';
  const androidAccessKey = 'YOUR_ANDROID_ACCESS_KEY';

  // Platform check: pick the correct keys per platform
  final appKey    = Platform.isIOS ? iosAppKey : androidAppKey;
  final accessKey = Platform.isIOS ? iosAccessKey : androidAccessKey;

  ZohoSalesIQ.init(appKey, accessKey).then((_) {
 // Mobilisten instelized successfully
}).catchError((error){
   // Mobilisten not instelized successfully
});
}

Note: To display the chat launcher (floating button) by default in your app UI, use the following snippet

Copied 

import 'package:salesiq_mobilisten/launcher.dart';
ZohoSalesIQ.launcher.show(VisibilityMode.always);  

Platform configuration (optional)

Proguard Configuration (Minifying App)

In some versions of the Android Gradle plugin, the R8 compiler exhibits aggressive behavior that removes some essential classes necessary for the SDK to function as expected. To handle this, we have added specific pro-guard rules within our Mobilisten SDK to preserve these crucial classes during the build process. If you have enabled ProGuard(minifyEnabled) R8, then please add the following rules in your proguard-rules.pro file in your project/android folder.

Copied 

-dontwarn kotlinx.parcelize.Parcelize

Backup Codes

If your app has enabled backup and you have your own backup rules or some of your other dependencies have them, then all these steps below are mandatory for App data backup to Google. Since Android doesn’t support manifest merging, all backup rules must be combined into a single file, which you’ll need to reference in your app’s AndroidManifest.xml.

To complete this setup,

1. Create XML files called merged_backup_rules.xml and merged_data_extraction_rules.xml in the res/xml/ directory. Example: android/app/src/main/res/xml.
2. Add your rules with our Mobilisten rules to your app and verify that everything is functioning as expected.

merged_data_extraction_rules.xml

Copied<?xml version="1.0" encoding="utf-8"?>
<data-extraction-rules>

    <cloud-backup>      
        <!-- Your own/other library's rules -->
        <exclude domain="sharedpref" path="sample-data"/>
        <exclude domain="database" path="sample.db"/>

        <!-- Mobilisten rules -->
        <exclude
            domain="sharedpref"
            path="siq_encrypted_shared_preference_entries.xml" />
        <exclude
            domain="sharedpref"
            path="siq_session.xml" />
        <exclude
            domain="sharedpref"
            path="siq_permission.xml" />
        <exclude
            domain="database"
            path="siq_mobilisten.db" />
        <exclude
            domain="database"
            path="mobilisten_zoho_salesiq.db" />
    </cloud-backup>

    <device-transfer>
        <!-- Your own/other library's rules -->
        <exclude domain="sharedpref" path="sample-data"/>
        <exclude domain="database" path="sample.db"/>         
    </device-transfer>
</data-extraction-rules>

Also, ensure to map it in your AndroidManifest.xml.

Copied 

android:dataExtractionRules="@xml/merged_data_extraction_rules" 
android:fullBackupContent="@xml/merged_backup_rules"'
tools:replace="android:fullBackupContent,android:dataExtractionRules,android:allowBackup"