Android SDK

Prerequisites

• HCL CDP WriteKey
• HCL CDP Server URL

1. Getting the SDK
   In your build.gradle file, add the following dependency:

   implementation 'com.hclcdp.app.android:HCLCDP:1.0.0'

2. Add Google Play Services to your app

   Apps in the Google Play Store use the Google Advertising ID to uniquely identify devices. Therefore, to allow the HCL CDP SDK to use the Google Advertising ID, you need to integrate the Google Play Services.

   Open your app/build.gradle and add the below dependency under dependencies:

   implementation 'com.google.android.gms:play-services-base:17.6.0'
    implementation 'com.google.android.gms:play-services-ads-identifier:16.0.0'

3. Some Additional dependencies

   Open your app/build.gradle and add the below dependency under dependencies:

   //No need to add below two firebase dependencies if hcl push notifications are not required.
   implementation platform('com.google.firebase:firebase-bom:28.2.0')
   implementation 'com.google.firebase:firebase-messaging'
   implementation group: 'joda-time', name: 'joda-time', version: '2.10.10'
   implementation "androidx.lifecycle:lifecycle-extensions:2.2.0"
   implementation 'com.google.code.gson:gson:2.3.1'
   implementation 'org.apache.commons:commons-text:1.9'
   implementation "androidx.work:work-runtime:2.7.1"

   Manifest File Changes

   In the Package Explorer, open the AndroidManifest.xml file and make the following changes:

   <meta-data
    android:name="HCLCDP.WRITE_KEY"
    android:value="{WRITE_KEY}" />
   <meta-data
    android:name="HCLCDP.SERVER_URL"
    android:value="{SERVER_URL}" />
   <meta-data
    android:name="HCLCDP.DEBUG_MODE"
    android:value="{true/false}" />
   <meta-data
    android:name="HCLCDP.ENABLE_PUSH"
    android:value="{true/false}" />
   <meta-data
    android:name="HCLCDP.ENABLE_ANALYTICS"
    android:value="{true/false}" />

   Replace WRITE_KEY and SERVER_URL with original values that you receive from our HCL CDP Account Manager.

   DEBUG_MODE is used to show HCL CDP debug/error/info logs. Set this to false when going to production.

4. Initialize the Android App SDK
   Import the library for the classes you desire to use HCLCDPHelper library:

   import com.hclcdp.app.android.HCLCDPHelper;

   Add the below code to the onCreate method in your Application class:

   @Override
   protected void onCreate(Bundle savedInstanceState)
   {
    //your code
    //Initialize with HCLCDP write key
    HCLCDPHelper.getInstance(getApplicationContext()).init();
    //your code
   } 

5. Add Proguard Rules
   If your application uses Proguard, add following rule in proguard-rules.pro of your application.

   -keep class androidx.lifecycle.DefaultLifecycleObserver

HCL CDP sends push notifications to Android devices using Firebase Cloud Messaging.

Project-level build.gradle (/build.gradle):
buildscript {
 dependencies {
 // Add this line classpath
 'com.google.gms:google-services:4.3.3'
 }
}
App-level build.gradle (<project>/<app-module>/build.gradle):
dependencies {
 // Add this line compile
 'com.google.firebase:firebase-core:17.4.2'
} ...
// Add to the bottom of the fileapply plugin:
'com.google.gms.google-services'

<meta-data
 android:name="Hcl.NOTIFICATION_ICON"
 android:resource="{NOTIFICATION_ICON}" />
<meta-data
 android:name="Hcl.NOTIFICATION_ICON_SMALL"
 android:resource="{NOTIFICATION_ICON_SMALL}" />

<service
android:name="com.hclcdp.app.android.push.HCLFirebaseMessagingService">
 <intent-filter>
<action android:name="com.google.firebase.MESSAGING_EVENT"/>
</intent-filter>
</service>
<service
android:name="com.hclcdp.app.android.HCLFirebaseInstanceIdService">
<intent-filter>
<action android:name="com.google.firebase.INSTANCE_ID_EVENT"/>
</intent-filter>
</service>

<service
 android:name=com.hclcdp.app.android.push.HCLIntentService"
 android:exported="false"
>
</service>

HCLCDPHelper hclClient = HCLCDPHelper.getInstance(getApplicationContext());
//you need to provide the Activity in which you want to ask for permission.
hclClient.registerForPushNotifications(MainActivity.this, "title", "message");
//if you don't provide the title and message default values will be given.
hclClient.registerForPushNotifications(MainActivity.this);

HCLCDPHelper.getInstance(this).setDeviceIdToWebview(webView,domain);

Example:

HCLCDPHelper.getInstance(this).setDeviceIdToWebview(myWebsiteWebView,"https://xyz.com");

1. What is the Android version required to set up the HCL CDP Android App SDK?

Minimum Android 5.0 (minAppSDKVersion = API level 21)

2. Can HCL CDP Android App SDK be used with Kotlin?

Yes, our Android App SDK can be used with Kotlin as well.

3. Can I use the library with Maven?

No, you can use JitPack to use the SDK.

4. I need to check the logs. Where should I look?

We can filter with the string "HCL CDP" among the application logs.

5. How does the SDK handle different client/server errors?

It prints error messages for both client/server in the logs, but nothing will be visible to the end-user.

6. Which all Android permissions are required for the SDK to run smoothly?

android.permission.INTERNET

7. Does the SDK also support tracking events from wearables and TV that run on Android?

SDK is not yet tested for wearables. We have it in our Product Roadmap.