In-app messaging

This feature empowers you to proactively engage users within your app by displaying targeted messages at specific contextually relevant moments. These timely interventions can prove highly effective in providing valuable information, promoting cross-selling and up-selling opportunities, and ultimately driving desired user actions on targeted screens or based on pre-defined app interactions.

The feature is available from Capillary SDK 1.4.0.

Installing using catalog

The recommended approach for integration is through a Version Catalog. For more information, refer to the documentation Installing with version catalog. After you configure the catalog, perform the following:

1. Add the dependency in the app/build.gradle file as shown below:

dependencies {
    // ...
    implementation("hydra.inapp")
}

dependencies {
…
 implementation("hydra.inapp")
  }

Installing using Artifact

To install in-app messaging, perform the following:

1. Add the dependency in the app/build.gradle file as shown below:

dependencies {
    // ...
    implementation("com.capillary:hydra-inapp:x.x.x")
}

dependencies {
…
 implementation("com.capillary:hydra-inapp:x.x.x")
}

Integration

Hydra SDK leverages a push notification mechanism to deliver in-app messages. For this functionality to work seamlessly, your app needs to have already integrated Hydra's push notification module.

In-app configuration

The Capillary SDK allows your app to specify a fallback image to display in case the image included in a notification payload fails to download. This ensures a consistent user experience even if unexpected network issues or server errors occur.

InAppConfig(@DrawableRes val defaultImage: Int)

In-app supported layouts

In-app message listeners

To receive callbacks for in-app messages, listeners should be added in the onCreate() of the Application class. Hydra offers the following listeners to hook into:

InApp Message Callback
Application has to register a InAppMessageListener to receive in-app message Callbacks.

📘

It is mandatory to add this listener once the hydra SDK is initialized to avail custom action for message click.

To get the inapp callback implement the OnMessageClickListener and register for the callback using HydraInAppUIHelper.getInstance().registerOnMessageClickListener

Example: User implementing OnMessageClickListener to receive the in-app message callback from the Hydra Sdk.

class ApplicationInAppMessageClickListener : OnMessageClickListener {  
  override fun onMessageClick(context: Context, cta: CTA): Boolean {  
       return super.onMessageClick(context, cta)  
   }  
}

Register the above callback in the onCreate of your application class after initialization of HydraApi

In the above callback method, “onMessageClick” returns Boolean to which application can return either true or false. If the function returns false, the action will be taken by the SDK and if returned true then custom action can be taken by the client app.

HydraInAppUIHelper.getInstance()  
   .registerOnMessageClickListener(ApplicationInAppMessageListener())