Skip to content

CleverTap/clevertap-xamarin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CleverTap Xamarin Bindings SDK

👋 Introduction

The CleverTap Xamarin Bindings SDK for Mobile Customer Engagement and Analytics solutions.

For more information check out our website and documentation.

Supports

Xamarin Binding Library

  • Android - Use the CleverTap.Bindings.Android DLL file and add it to the References. This targets Xamarin.Android apps.
  • iOS - Use the DLL and add it to the Reference. This targets Xamarin.iOS apps.

.NET Binding Library

  • Android - Add CleverTap.DotNet.Android.Binding to NuGet Packages. This targets .NET 8.0+ Android and Multi-platform App UI (MAUI) apps.
  • iOS - Add CleverTap.DotNet.iOS.Binding to NuGet Packages. This targets .NET 8.0+ iOS and Multi-platform App UI (MAUI) apps.

🚀 Xamarin Installation and Quick Start

👨‍💻 Android Guide

  1. Install the SDK

    Use the CleverTap.Bindings.Android DLL file and add it to the References.

  2. Add Your CleverTap Credentials in AndroidManifest.xml

<meta-data
    android:name="CLEVERTAP_ACCOUNT_ID"
    android:value="Your CleverTap Account ID"/>

<meta-data
    android:name="CLEVERTAP_TOKEN"
    android:value="Your CleverTap Account Token"/>

<!-- IMPORTANT: To force use Google AD ID to uniquely identify  users, use the following meta tag. GDPR mandates that if you are using this tag, there is prominent disclousure to your end customer in their application. Read more about GDPR here - https://clevertap.com/blog/in-preparation-of-gdpr-compliance/ -->
<meta-data
    android:name="CLEVERTAP_USE_GOOGLE_AD_ID"
    android:value="1"/> 
  1. Enable Tracking by Adding Permissions
  • In your AndroidManifest.xml file, add the following snippet within the tags.
<application
    android:label="@string/app_name"
    android:icon="@drawable/ic_launcher"
    android:name="com.clevertap.android.sdk.Application">
  • Next add the snippet below in the same file, so the CleverTap Xamarin SDK can access the internet.
<!-- Required to allow the app to send events and user profile information -->
<uses-permission android:name="android.permission.INTERNET"/>

<!-- Recommended so that CleverTap knows when to attempt a network call -->
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
  1. Initialize the CleverTap SDK
CleverTapAPI cleverTapAPI = CleverTapAPI.GetDefaultInstance(Android.App.Application.Context);

For more information,

👩‍💻 iOS Guide

  1. Install the SDK

    Use the DLL and add it to the Reference

  2. Integrating the CleverTap SDK

    • Follow the integration instruction starting with Step 2 here.
    • Add CleverTap to your AppDelegate.cs and add the following snippet in FinishedLaunching method.
using CleverTapSDK;

public bool FinishedLaunching(UIApplication application, NSDictionary launchOptions)
{
    // Override point for customization after application launch.
    // If not required for your application you can safely delete this method

    CleverTap.AutoIntegrate();
    return true;
}

For more information,

🆕 Changelog

Refer to the CleverTap Xamarin SDK Change Log.

❓Questions

If you have questions or concerns, you can reach out to the CleverTap support team from the CleverTap Dashboard.

📄 License

CleverTap Xamarin SDK is MIT licensed, as found in the LICENSE file.