Integrate Whatfix Mobile SDK with Xamarin Android
- 10 Oct 2023
- 2 Minutes To Read
-
Print
-
DarkLight
-
PDF
Integrate Whatfix Mobile SDK with Xamarin Android
- Updated On 10 Oct 2023
- 2 Minutes To Read
-
Print
-
DarkLight
-
PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
To create Whatfix Mobile in-app experiences on your Xamarin Android apps, you need to first set up Whatfix Mobile. You can add the Whatfix Mobile SDK provided for Xamarin Android apps to the source code of your app and then create and publish content.
Integration steps for Xamarin Android app
Use the following steps to integrate the Whatfix Mobile SDK in your Xamarin Android project:
your title goes here
Ensure that you complete both the steps, to create and test the in-app experience in your integrated build.
Step 1: Integrate Whatfix Mobile SDK
a. Add the Whatfix Mobile Xamarin SDK dependency
Add the Whatfix Mobile Xamarin Library package from nuget.
Add the LeapXamarinLib.Android package from nuget to the Packages in your Android specific project.
your title goes here
For more information on the latest version of the Xamarin Android project, see Xamarin Android Changelog.
b. Start the Whatfix Mobile SDK
using IS.Leap.Android.Aui;
namespace YourApp
{
[Activity(Label = "@string/app_name", Theme = "@style/AppTheme.NoActionBar", MainLauncher = true)]
public class MainActivity : AppCompatActivity
{
protected override void OnCreate(Bundle savedInstanceState)
{
base.OnCreate(savedInstanceState);
Leap.Start("<YOUR_API_KEY>");
}
}
}
Step 2: Enable Creator mode in your app
To create in-app experiences in the Whatfix Mobile Studio, you have to enable the Creator mode in your app. This is done by integrating the Whatfix Mobile Creator SDK.
a. Add dependencies
your title goes here
- The Whatfix Mobile Creator Plugin must be removed before the app goes live on the Play Store.
- While both Whatfix Mobile Creator SDK and Whatfix Mobile SDK need to be integrated in the development and testing versions, the production version should only have the Whatfix Mobile SDK.
Add the Whatfix Mobile Xamarin Creator package from nuget.
Add LeapXamarinLib.Android.Creator package from nuget to the Packages in your Android specific project.
your title goes here
- If you are using Xamarin.Forms, then ensure that its version is 5.0.0.2125 and above.
- If the version of Xamarin.Forms is 5.0.0.2083 and lower, ensure that you add Xamarin.AndroidX.Core (Version 1.6.0).
your title goes here
For more information on the latest version of the Xamarin Android project, see Xamarin Android Changelog.
b. Start the Whatfix Mobile Creator SDK
using IS.Leap.Android.Creator;
namespace YourApp
{
[Activity(Label = "@string/app_name", Theme = "@style/AppTheme.NoActionBar", MainLauncher = true)]
public class MainActivity : AppCompatActivity
{
protected override void OnCreate(Bundle savedInstanceState)
{
base.OnCreate(savedInstanceState);
LeapCreator.Start("<YOUR_API_KEY>");
}
}
}
Proguard Rules
If you are using Proguard for your builds, use the following rules in your proguard-rules.pro file,
-dontwarn is.leap.android.**
-keep class is.leap.android.** {*;}
If you are using Android Gradle Plugin (AGP) version 8.0 or newer, it may be necessary to include specific OkHttp rules in your proguard-rules.pro file. This step is crucial to ensure the proper execution of release builds, as the LeapCreator SDK relies on the OkHttp library. The required rules are as following:
#For Okhttp
-dontwarn okhttp3.internal.platform.**
-dontwarn org.conscrypt.**
-dontwarn org.bouncycastle.**
-dontwarn org.openjsse.**
For more information, see Okhttp R8 / ProGuard.
After integrating the code, you can start creating your in-app experience using Whatfix Mobile.
Was this article helpful?