Integration

The FollowAnalytics SDK Xamarin component provides full bindings to the FollowAnalytics SDK for use in Visual Studio. With this component, Xamarin developers can target both iOS and Android devices with access to the full scope of the FollowAnalytics SDK, all while remaining in the C#/.NET ecosystem.

This document will cover app setup and the component installation process, as well as basic integration steps for iOS and Android.

For more information, please read the iOS and Android FollowAnalytics SDK documentations.

Installation

Download the FollowAnalytics SDK from the developer portal.

iOS

To install the iOS part of the SDK, follow these steps:

1. Right Click on project References.
2. Choose the .Net Assembly tab.
3. Go to Browse...
4. Add FollowAnalyticsSDK.iOS.dll to your iOS Xamarin project References.

Android

To install the Android part of the SDK, add FollowAnalyticsSDK.Android.dll to your References folder available in Android Xamarin project.

Initialize with your API keys

iOS

• In your AppDelegate.cs add at the top:

using FollowAnalyticsSDK;

• In the method FinishedLaunching, right after the loadApplication, add:

public override bool FinishedLaunching(UIApplication application, NSDictionary launchOptions)
{
    ...
    FollowAnalytics.Configuration configuration = new FollowAnalytics.Configuration((obj) =>
    {
        obj.apiKey = "YOUR_API_KEY";
        obj.isVerbose = true;                            //Optional, false by default
        obj.archiveInAppMessages = false;               //Optional, true if you want to archive your inApp message in the app
        obj.archivePushMessages = false;                //Optional, true if you want to archive your push message in the app
        obj.isDataWalletEnabled = false;                //Optional, true if you want to receive new data wallet if exist
        obj.crashReportingEnabled = true;               //Optional, false if you don't want to receive crash report
        obj.maxBackgroundTimeWithinSession = 120;       //Optional, you can change it for a value in [15,3600]
        obj.optInAnalyticsDefault = true;               //Optional, false if you don't want to receive logs
        obj.onDataWalletPolicyChange = { };              //Optional
        obj.onIncomingDeepLink = delegate(IDictionary<string,string> parameters, string actionIdentifier, string actionTitle) =>   // Optional
        {
            // YOUR_IMPLEMENTATION
        };
        obj.onConsoleLog = delegate(string message, FollowAnalytics.Severity severity, string[] tags)   // Optional
        {
            // YOUR_IMPLEMENTATION
        };
        obj.onNotificationTapped = delegate(Uri url, IDictionary<string,string> parameters)  // Optional
        {
            // YOUR_IMPLEMENTATION
            // To open received URL you can use this code :
            if (url != null)
            {
                UIApplication.SharedApplication.OpenUrl(url);
            }
        };
        obj.onNotificationReceived = delegate(FollowAnalytics.Message message)  // Optional
        {
            // YOUR_IMPLEMENTATION

            // The message is an object that contain :

            // bool isRead;
            // bool isPush;
            // bool isSilent;
            // bool isInApp;
            // string identifier;
            // DateTime dateReceived;
            // string campaignId;
            // string messageType;
            // string title;
            // string body;
            // string url;
            // string layout;
            // string deepLinkUrl;
            // IDictionary parameters;
            // IDictionary rawData;

            // you need to check nullability of attributes


            // To open received URL you can use this code :
            if (message.DeepLinkUrl != null)
            {
                UIApplication.SharedApplication.OpenUrl(message.DeepLinkUrl);
            }
        };
    });
    FollowAnalytics.iOS.Init(configuration, launchOptions);
    ...
}

Android

To initialize FollowAnalytics SDK, you need to configure FollowAnalytics SDK by creating the Configuration and setting the api key.

Create a class that extends Application and call FollowAnalytics.Android.Init(Context context, FollowAnalytics.Configuration configuratio) in the onCreate() method of your class.

This is necessary to have the SDK initialized in all cases: either when app is launched by the user, or when the Android OS wakes the app (for example, at push notification receiving).

Open your Application subclass, or create a new one, and add the following lines to override the onCreate method:

using System;
using Android.App;
using Android.Util;
using Android.Runtime;
using FollowAnalyticsSDK;

namespace FollowAnalyticsSDK.Android.Sample {
    [Application(Label = "@string/app_name")]
    public class MyApplication : Application {
        public MyApplication(IntPtr handle, JniHandleOwnership ownerShip) : base(handle, ownerShip) {
        }

        public override void OnCreate() {
            base.OnCreate();

            FollowAnalytics.Configuration mConfig = new MyConfiguration(); // Configuration class created
            FollowAnalytics.Android.Init(this, mConfig);

        }
    }
}

If you just created an Application subclass, remember to declare it in your AndroidManifest.xml file:

<application
    android:name=".MyApplication"
/>

Custom Configuration

In order to customize the behavior of FollowAnalytics SDK, it is possible to change the default configuration.

You can customize Opt-Out analytics and Datawallet.

In order to achieve this, you need to :

• create a class that extends to FollowAnalytics.Configuration with the attributes that are necessary to be changed and override call backs :

using FollowAnalyticsSDK;

namespace FollowAnalyticsSDK.Android.Sample
{
    public class MyConfiguration : FollowAnalytics.Configuration
    {
        public MyConfiguration() {
            this.ApiKey = "YOUR_API_KEY";
            this.IsDataWalletEnabled = false;                //Optional, true if you want to receive new data wallet if exist
            this.OptInAnalyticsDefault = true;               //Optional, false if you don't want to receive logs
            this.ArchiveInAppMessages = false                //Optional, true if you want to archive your inApp message in the app
            this.ArchivePushMessages = false;                //Optional, true if you want to archive your push message in the app
            this.IsVerbose = false;                          //Optional, true if you want all the debug logs
            this.MaxBackgroundTimeWithinSession = 120;       //Optional, you can change it for a value in [15,3600]
            this.DataWalletDefaultPolicyPath = "";           //Optional, to determine the path of your local dataWallet policy
        }

        public override void OnDataWalletPolicyChanged()    // Optional, called when a new significant version of dataWallet policy is available
        {
            // YOUR_IMPLEMENTATION
        }

        public override void OnConsoleLog(string p0, Com.Followanalytics.FollowAnalytics.Severity p1, string[] p2) // Optional, called when new logs are made internally in FollowAnalytics SDK
        {
            // YOUR_IMPLEMENTATION
        }

        public override void OnNotificationReceived(Com.Followanalytics.FollowAnalytics.IMessage p0) // Optional, called when new app received a notification
        {
            // YOUR_IMPLEMENTATION

            // The message is an object that contain :

            // string Body
            // string Id
            // string CampaignId
            // string ReceivedDate
            // string IsRead
            // string MessageType
            // string Title
            // string DeepLinkUrl
            // bool IsPush
            // bool IsSilentPush
            // Map<String, String> Params

        }
    }
}

Now, FollowAnalytics SDK will start by default with the value associated in the customized configuration class.

Necessary project capabilities

iOS

Add a push certificate for notifications

FollowAnalytics requires a valid p12 or p8 certificate in order to communicate with Apple Push Notification Services (APNS). This certificate is generated for a unique Application Identifier (App ID).

Generate and import a .p12 push certificate

To generate your push certificate:

1. Connect to your developer portal, and go to the App IDs.

2. Click on your Application Identifier to edit your app configuration if it exist or Create a new App ID by clicking in the + button in the top of page.

3. In the list of Capabilities, check the Push Notifications box

4. Click Edit to display the window for Apple Push Notification service SSL Certificates

5. Create a certificate by clicking the Create button

6. Upload your Certificate Signing Request (create a Certificate Signing Request here) and click continue

7. Click Download button to create your certificate, open the Keychain Assistant app and locate that certificate

8. From the Keychain Assistant app, click the certificate line and export the .p12 file by right-clicking on the profile below the certificate. Enter a password for your certificate.

9. Go to the Administration page, upload the .p12 file and enter the password you've entered on the previous step.

Do not forget to ensure your provisioning profile has the Push Notifications service enabled by expanding it from the list in your developer portal.

Generate and import a .p8 server Key

To generate your server key (p8)

1. Connect to your developer portal.

2. Click on your Keys tab.

3. Click in the + button in the top of page to add a new Key.

4. Add a Key Name.

5. Check the Apple Push Notification service (APNs)

6. Click Continue.

7. Download the .p8 file. (You must download the p8 file in this step because this is your unique chance to download it)

8. Go to the Identifiers Tab.

9. Click on your Application Identifier to edit your app configuration if it exist or Create a new App ID by clicking in the + button in the top of page.

10. In the list of Capabilities, check the Push Notifications box

11. Go to the Administration page, upload the .p8 file and click in Proceed.

12. Enter your Key ID and Issuer Key. You can find you Key ID in the Keys tab in the developer account and the Issuer Key is you team ID and you can find it by clicking in the View Membership in the developer account also.

Do not forget to ensure your provisioning profile has the Push Notifications service enabled by expanding it from the list in your developer portal.

After that, you need to go to your project in Visual Studio :

1. Open your info.plist file

2. Enable Background Modes

3. Check Remote Notification and Background fetch

4. Open your Entitlements.plist

5. Scroll down

6. Check the push notification capabily

Finnaly, you need to add a call to registerForPush following the initialization line you added previously:

FollowAnalytics.RequestNotificationCenterDefaultAuthorisation();

Android

The FollowAnalytics SDK supports push notifications based on Firebase Cloud Messaging. If you haven't done so already, you will need to create/add a Firebase Project in Firebase Console in order to continue the following steps.

1. Add the required Packages to your project

   Xamarin.Firebase.Common
   Xamarin.Firebase.Iid
   Xamarin.Firebase.Messaging
   

2. Add those FCM Receiver tags to your manifest

   <receiver android:name="com.google.firebase.iid.FirebaseInstanceIdInternalReceiver" android:exported="false" />
   <receiver android:name="com.google.firebase.iid.FirebaseInstanceIdReceiver" android:exported="true" android:permission="com.google.android.c2dm.permission.SEND">
     <intent-filter>
       <action android:name="com.google.android.c2dm.intent.RECEIVE" />
       <action android:name="com.google.android.c2dm.intent.REGISTRATION" />
       <category android:name="${applicationId}" />
     </intent-filter>
   </receiver>
   

3. Create a class that extends to FirebaseInstanceIdService and override the method OnTokenRefresh:

   using Android.App;
   using Firebase.Iid;
   using Android.Util;
   using FollowAnalyticsSDK;
   
   namespace FollowAnalyticsSDK.Android.Sample
   {
       [Service]
       [IntentFilter(new[] { "com.google.firebase.INSTANCE_ID_EVENT" })]
       public class MyFirebaseIIDService : FirebaseInstanceIdService
       {
           const string TAG = "MyFirebaseIIDService";
           public override void OnTokenRefresh()
           {
               var refreshedToken = FirebaseInstanceId.Instance.Token;
               Log.Debug(TAG, "Refreshed token: " + refreshedToken);
               FollowAnalytics.Android.SetPushToken(refreshedToken);
               ...
           }
       }
   }
   

4. Add the FirebaseInstanceIdService service tag in your AndroidManifest application file by changing the value associated with android:name. In order to do this, you need to retrieve the value associated to the name of the Android Callable Wrapper for your custom implementation. The easiest way to get the value at runtime, is to implement the following code:

   //import the namespace in your activity
   using Android.Util;
   
   //implement this code in one of the lifecycle method of your activity
   Log.Debug("FA","The MyFirebaseIIDService name is : " + Java.Lang.Class.FromType(typeof(<ABSOLUTE_PATH_OF_THE_CLASS>.<NAME_OF_THE_FIREBASE_INSTANCE_ID_SERVICE>)).Name);
   

   For instance:

   Log.Debug("FA", "The MyFirebaseIIDService name is : " + Java.Lang.Class.FromType(typeof(MyFirebaseIIDService)).Name);
   

   This will output a similar result, at runtime, in the Logcat console:

   FA  D  The MyFirebaseIIDService name is : md56f33aca13e7603ac857c2a0fb45b66ab.MyFirebaseIIDService
   

   Finally, copy the result and paste it to android:name value as shown below:

   <service android:name="md56f33aca13e7603ac857c2a0fb45b66ab.MyFirebaseIIDService" android:exported="true">
           <intent-filter>
               <action android:name="com.google.firebase.INSTANCE_ID_EVENT" />
           </intent-filter>
       </service>
   

5. Do not forget to add those next lines of code inside of OnTokenRefresh method :

   var refreshedToken = FirebaseInstanceId.Instance.Token; // Function that retrieves a FCM token
   FollowAnalytics.Android.SetPushToken(refreshedToken); // Function that pass the FCM token retrieved to FollowAnalytics SDK
   

6. Create a class that extends to FirebaseMessagingService and override the method OnMessageReceived:

   using Android.App;
   using Android.Content;
   using Firebase.Messaging;
   using FollowAnalyticsSDK;
   
   namespace FollowAnalyticsSDK.Android.Sample
   {
       [Service]
       [IntentFilter(new[] { "com.google.firebase.MESSAGING_EVENT" })]
       public class MyFirebaseMessagingService : FirebaseMessagingService
       {
           public override void OnMessageReceived(RemoteMessage message)
           {
               FollowAnalytics.Android.ProcessFirebaseMessage(Application.Context, message);
           }
       }
   
   }
   

7. Add the FirebaseMessagingService service tag in your AndroidManifest application file by changing the value associated with android:name. In order to do this, you need to retrieve the value associated to the name of the Android Callable Wrapper for your custom implementation. The easiest way to get the value at runtime, is to implement the following code:

   //import the namespace in your activity
   using Android.Util;
   
   //implement this code in one of the lifecycle method of your activity
   Log.Debug("FA","The MyFirebaseMessagingService name is : " + Java.Lang.Class.FromType(typeof(<ABSOLUTE_PATH_OF_THE_CLASS>.<NAME_OF_THE_FIREBASE_MESSAGING_SERVICE>)).Name);
   

   For instance:

   Log.Debug("FA", "The MyFirebaseMessagingService name is : " + Java.Lang.Class.FromType(typeof(MyFirebaseMessagingService)).Name);
   

   This will output a similar result, at runtime, in the Logcat console:

   FA  D  The MyFirebaseMessagingService name is : md56f33aca13e7603ac857c2a0fb45b66ab.MyFirebaseMessagingService
   

   Finally, copy the result and paste it to android:name value as shown below:

   <service android:name="md56f33aca13e7603ac857c2a0fb45b66ab.MyFirebaseMessagingService">
           <intent-filter>
               <action android:name="com.google.firebase.MESSAGING_EVENT" />
           </intent-filter>
       </service>
   

8. Do not forget to add the next lines of code inside of OnMessageReceived method :

   FollowAnalytics.Android.ProcessFirebaseMessage(Application.Context, message); // Pass the push notification to FollowAnalytics SDK
   

9. Download the google-services.json file in your Firebase Project and add it to your Xamarin Project.

10. Set the GoogleServicesJson as action to your google-services.json by right clicking the file.

11. Finally, do not forget to copy the FCM Server key token (available through Firebase Console in your project settings).

    

    and paste it to our platform in the application's administration.

    

    Verify your Google Services configuration

    Be sure to check the configuration of Google Services as they have to be the following if you want the FollowAnalytics SDK and Firebase to work.

    • The JSON for Google Services in your application is correct. Compare if it is the same as the one in Firebase (which you can download from the Firebase Console)

Define the URL scheme

To allow users to retrieve their device ID for campaign testing and tagging plan debugging, you need to define a URL scheme in your iOS and Android projects.

iOS

1. Make sure that the Rivets component is installed. If not, install with NuGet.

2. Open your app's Info.plist file, and under the Advanced tab, in the URL Types section, add a new URL Type like:

   

3. Make sure that the bundle ID of your app appears in the URL Schemes field as shown in the screenshot (where com.follow-apps.followme.inHouse needs to be replaced).

Android

1. Edit your AndroidManifest.xml file to add this:

<activity android:name="com.followapps.android.internal.activities.DeviceIdActivity" >
    <intent-filter>
        <action android:name="android.intent.action.VIEW" />
        <category android:name="android.intent.category.DEFAULT" />
        <category android:name="android.intent.category.BROWSABLE" />
        <data
            android:host="followanalytics.com"
            android:path="/deviceId"
            android:scheme="%YOUR_APP_PACKAGE_NAME%" />
    </intent-filter>
</activity>

1. Replace %YOUR_APP_PACKAGE_NAME% with the Android package name of your app.

Analytics

App tags

The SDK allows you to implement log events and errors in your code. The following methods that you can call with the SDK are the following:

FollowAnalytics.LogEvent(string eventName);
FollowAnalytics.LogEvent(string eventName, string details);
FollowAnalytics.LogEvent(string eventName, IDictionary<string, string> details);

FollowAnalytics.LogError(string eventName);
FollowAnalytics.LogError(string eventName, string details);
FollowAnalytics.LogError(string eventName, IDictionary<string, string> details);

Use the eventName as the unique identifier of your tag. Use the details section to add specific details or context. Events can be renamed later: the name that you give to your event here can be overridden in the FollowAnalytics UI.

The details field can either be a String or a Hash, so that you can associated multiple key-values for additional context.

For instance, logging the appearance of a view could be done the following way:

FollowAnalytics.LogEvent("Product view", "Product reference");

var options = new Dictionary<string, string>();
options["product_id"] = "ABCD123";
options["product_category"] = "Jeans";
FollowAnalytics.LogEvent("Add product to cart", options);

User ID and attributes

User ID

If users can sign in somewhere in your application, you can specify their identifier to the SDK. This way, you will be able to relate crashes to specific users, link your users between FollowAnalytics and your CRM, and more.

It is recommended to use a cryptographic number that uniquely ties your customer to you.

To register the user identifier, use:

FollowAnalytics.SetUserId("1547521wed2155w57e02dwe574");

If you want to remove the user identifier (in case of a sign out for instance) use the following method:

FollowAnalytics.SetUserId(null);

At any moment, you can retrieve the current user ID this way:

string user_id = FollowAnalytics.GetUserId(); // returns null if there is no user id

Predefined attributes

The SDK allows to set values for both custom and predefined attributes.

For predefined attributes, the SDK has the following properties:

FollowAnalytics.UserAttributes.SetFirstName("Peter");
FollowAnalytics.UserAttributes.SetLastName("Jackson");
FollowAnalytics.UserAttributes.SetCity("San Francisco");
FollowAnalytics.UserAttributes.SetRegion("California");
FollowAnalytics.UserAttributes.SetCountry("USA");
FollowAnalytics.UserAttributes.SetGender(FollowAnalytics.Gender.Male);
FollowAnalytics.UserAttributes.SetEmail("mail@mail.com");
FollowAnalytics.UserAttributes.SetDateOfBirth(DateTime.Today);
FollowAnalytics.UserAttributes.SetProfilePictureUrl("https://picture/picture");

They are "predefined" in the sense that they will be attached to default fields on your user profiles.

To unset an attribute, set it to null. For instance :

FollowAnalytics.UserAttributes.SetFirstName(null);

Custom attributes

Set a custom attribute

To set your custom attributes, you can use methods that are adapted for each type:

FollowAnalytics.UserAttributes.SetNumber("key_number", 1);
FollowAnalytics.UserAttributes.SetNumber("key_double", 32.428);
FollowAnalytics.UserAttributes.SetDate("key_date", DateTime.Today);
FollowAnalytics.UserAttributes.SetDateTime("key_dateTime", Date.Now);
FollowAnalytics.UserAttributes.SetString("key_string", "string");
FollowAnalytics.UserAttributes.SetBoolean("key_bool", true);

For example, to set the user's job:

FollowAnalytics.UserAttributes.SetString("job", "Taxi driver");

Delete a custom attribute value

You can clear the value of an attribute using its key. For instance, to delete the user's job:

FollowAnalytics.UserAttributes.Clear("job");

Set of Attributes

You can add or remove an item to or from a set of attributes.

To add an item:

FollowAnalytics.UserAttributes.AddToSet("fruits", "apple");

To add several items:

FollowAnalytics.UserAttributes.AddToSet("fruits", "orange", "banana");

To remove an item:

FollowAnalytics.UserAttributes.RemoveFromSet("fruits", "orange");

And to clear a set:

FollowAnalytics.UserAttributes.ClearSet("fruits");

Opt-Out Analytics

All data collected before the user has opted-out is preserved within FollowAnalytics servers. This means that a user having opted-out will still receive campaigns based on data acquired before opting out (previous campaigns, existing segments, etc). The opt-in state is persisted between app starts (unless storage of the app is emptied).

To inspect and set the opt-out state, call the following methods on FollowAnalytics class:

FollowAnalytics.SetOptInAnalytics(bool optInAnalytics);
FollowAnalytics.GetOptInAnalytics();

Please see additional doc in the new FollowAnalytics and FollowAnalyticsConfiguration interface for more details.

Additionally, if the opt-in by default policy doesn't suit your use case you can change it by setting the optInAnalyticsDefault on FollowAnalyticsConfiguration.

bool optInAnalyticsDefault;

GDPR

You can record when the user expresses his demand to access or delete his personal data by calling one of the following methods:

FollowAnalytics.GDPR.RequestToAccessMyData();
FollowAnalytics.GDPR.RequestToAccessMyData();

The SDK will record all requests and send them to FollowAnalytics servers as soon as network conditions allow it. The SDK remembers pending requests between app restarts.

Campaigns

Deep-linking: URL, Parameters

Campaigns created through FollowAnalytics allow to deep link to content in your app. You can either use an App Link, or use key-value parameters that are forwarded to your code.

App Links

Version 4.1.0 of the SDK introduced the possibility to use direct App Links like twitter://messages, which will send you to the corresponding screen inside the Twitter application.

You're able to access the functionality by enabling the Deep Linking switch in our UI, when creating a campaign. There you'll find the field App Link that expects you to enter these types of URL schemas. It can either be an URL schema to an external application or for your own application.

Deep-linking parameters

In FollowAnalytics campaigns, you can specify deep-linking parameters, e.g. in your push messages or for in-app button actions.

These parameters are given to the developer's code by the SDK. It is then up to the developer to implement the deep-linking in the app (specific path of screens, format of the arguments, etc.).

iOS

To handle url opening in your app, you have to implement your expected behavior in the OpenUrl iOS callback of your AppDelegate :

public bool OpenUrl(UIApplication app, NSUrl url, NSDictionary options)
{
    // YOUR_IMPLEMENTATION (redirection to specific view)
    return true;
}

Up to 6.1.2 Xamarin SDK version, you used OnIncomingDeepLink (parameters, actionIdentifier, actionTitle) for deepLink parameters wich is deprecated since 6.2.0.

Since 6.2.0, there are tow new callbacks to handle Url and Parameters :

onNotificationTapped

To handle url or custom parameters received after a notification is tapped, your Configuration object must contain the obj.onNotificationTapped callback with your expected behavior:

FollowAnalytics.Configuration configuration = new FollowAnalytics.Configuration((obj) =>
{
    ...
    obj.onNotificationTapped = delegate(Uri url, IDictionary<string,string> parameters)
    {
        // YOUR_IMPLEMENTATION
        // To open received URL you can use this code :
        if (url != null)
        {
            UIApplication.SharedApplication.OpenUrl(url);
        }
    }
});

The onNotificationTapped callback handles the tap on:

• Scheduled Push notifications
• Contextual Push notifications

onNotificationReceived

In order to receive the custom parameters sent within a Push Notification or an In App message payload, your Configuration object must contain the obj.onNotificationReceived callback with your expected behavior:

FollowAnalytics.Configuration configuration = new FollowAnalytics.Configuration((obj) =>
{
    ...
    obj.onNotificationReceived = delegate(FollowAnalytics.Message message)
    {
        // YOUR_IMPLEMENTATION

        // Message argument fields you can access :

        // bool isRead;
        // bool isPush;
        // bool isSilent;
        // bool isInApp;
        // string identifier;
        // DateTime dateReceived;
        // string campaignId;
        // string messageType;
        // string title;
        // string body;
        // string url;
        // string layout;
        // string deepLinkUrl;
        // IDictionary parameters;
        // IDictionary rawData;

    }
});

The onNotificationReceived callback handles the reception of:

• Scheduled Push notifications when app is in foreground
• Contextual Push notifications when app is in foreground
• Silent Push notifications when app is in foreground or background

Android

In FollowAnalytics campaigns through our platform, you can specify deep-linking parameters, e.g. in your push messages or for in-app button actions.

These parameters are given to the developer's code by the SDK. It is then up to the developer to implement the deep-linking in the app (specific path of screens, format of the arguments, etc.).

To obtain these parameters, you can extend the FollowAnalytics.DefaultMessageHandler class, like in the following example:

//import the namespace
using System.Collections.Generic;
using Android.Content;

....
public class CustomMessageHandler : FollowAnalytics.DefaultMessageHandler
{
    public override void OnInAppMessageClicked(Context context, string buttonText, IDictionary<string, string> p2){
        base.OnInAppMessageClicked(p0,p1,p2);

        //Write code to process information
    }

    public override void OnPushMessageClicked(Context context, string url, IDictionary<string, string> parameters){
        base.OnPushMessageClicked(context, url, parameters);

        //Write code to process information
    }

    public override void OnPushMessageClicked(Context context, IDictionary<string, string> parameters){
        base.OnPushMessageClicked(context, parameters);

        //Write code to process information
    }
}

If you chose to define a custom MessageHandler, you must declare it in your application on your AndroidManifest file as meta-data.

In order to do this, you need to retrieve the value associated to the name of the Android Callable Wrapper for your custom implementation.

The easiest way to get the value at runtime, is to implement the following code:

//import the namespace in your activity
using Android.Util;

//implement this code in one of the lifecycle method of your activity
Log.Debug("FA","The CustomMessageHandler name is : " + Java.Lang.Class.FromType(typeof(<ABSOLUTE_PATH_OF_THE_CLASS>.<NAME_OF_THE_CUSTOM_MESSAGE_HANDLER_CLASS>)).Name);

For instance:

Log.Debug("FA","The CustomMessageHandler name is : " + Java.Lang.Class.FromType(typeof(FollowAnalyticsSDK.Android.Sample.CustomMessageHandler)).Name);

This will output a similar result, at runtime, in the Logcat console:

FA  D  The CustomMessageHandler name is : md5dc1df9376dd70f35e4f0f156de0b2eea.CustomMessageHandler

Finally, copy the value and paste it to the attribute android:value in your <meta-data> tag.

For instance:

<application>
   [...]
    <meta-data android:name="com.followanalytics.deeplinking.handler" android:value="md5dc1df9376dd70f35e4f0f156de0b2eea.CustomMessageHandler"/>
   [...]
</application>

Consider to test those changes before removing the code which retrieves the value associated to the name of the Android Callable Wrapper.

Custom handling of rich campaigns

Rich campaigns can be handled directly by the application code, instead of being showed automatically by the SDK. The behavior is defined when creating the campaign, using the "automatically display content" switch.

iOS

For geofencing campaigns you need to enable geofence

FollowAnalytics.EnableGeofencing(true);

Pausing in-app campaigns

To prevent the SDK from displaying rich campaigns use the following method:

FollowAnalytics.InApp.PauseCampaignDisplay();

To resume the SDK from displaying rich campaigns use the following method:

FollowAnalytics.InApp.ResumeCampaignDisplay();

Data Wallet

Policy download and consent

Now that the Data Wallet is enabled, the SDK will automatically download the new policies as they are published. In order to deal with the currently known policy, call the API with the following methods:

DataWallet.Policy policy = FollowAnalytics.DataWallet.GetPolicy();  // gets the current policy

BOOL policyIsRead =  FollowAnalytics.DataWallet.isRead;  // true if the current policy is considered accepted

FollowAnalytics.DataWallet.SetIsRead(true);  // informs the SDK that the user has accepted the current policy

There could only be one active policy at a time. When a new policy becomes available online, the SDK will call on the main thread onDataWalletPolicyChange, callback set on the FollowAnalyticsConfiguration. To set this up before starting the SDK, include the following code:

iOS

FollowAnalytics.Configuration configuration = new FollowAnalytics.Configuration((obj) =>
{
    ...
    obj.isDataWalletEnabled = true;
    obj.onDataWalletPolicyChange = delegate () (optional)
    {
    };
});

Android

public class MyConfiguration : FollowAnalytics.Configuration
{

    ...

    public override bool IsDataWalletEnabled()
    {
        return true;
    }

    public override void OnDataWalletPolicyChanged()
    {
        Application.Context.StartActivity(typeof(PolicyActivity));
    }

}

At each major policy update, there needs to be consent from the client. When the user accepts a policy call [FollowAnalytics.dataWallet setIsRead:true] to mark the current policy as "read". In other words:

• If FollowAnalytics.DataWallet.isRead is false, the current policy major version has yet to be accepted by the user.
• If the current policy is accepted, FollowAnalytics.DataWallet.isRead becomes true.

The SDK records the major version of the current policy for future reference. By default, if no other configuration is present, the SDK will return a default policy with version 0.0. This policy is always read. You should check for version 0.0 and handle it appropriately.

Custom default policy

If you want to provide a custom default policy for your users, download the policy JSON file from the back office and add it to your app, then modify the configuration to use it as follows:

iOS

FollowAnalytics.Configuration configuration = new FollowAnalytics.Configuration((obj) =>
{
    obj.dataWalletDefaultPolicyPath = "YOUR_POLICY_PATH";
});

Android

public class MyConfiguration : FollowAnalytics.Configuration
{
    ...

    public override string GetDefaultPolicyFilePath()
    {
        return "YOUR_POLICY_PATH";
    }
}