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.

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

1. Right Click on project References.

   

2. Choose Edit References ....

   

3. Choose the .Net Assembly tab.

   

4. Go to Browse...

   

5. Add FollowAnalyticsSDK.iOS.dll to your iOS Xamarin project References and FollowAnalyticsSDK.Android.dll to your Android Xamarin project References.

   

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
    });
    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.

In order to achieve this, you need to :

• Create a class that extends to FollowAnalytics.Configuration with the parameters that are necessary to be changed and override call backs.
• The basic configuration should have at least the ApiKey parameter. All other parameters are optional :

using FollowAnalyticsSDK;

namespace FollowAnalyticsSDK.Android.Sample
{
    public class MyConfiguration : FollowAnalytics.Configuration
    {
        public MyConfiguration() {
            this.ApiKey = "YOUR_API_KEY";
        }
    }
}

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

Setting up push notifications

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).

After generating a .p12 push certificate or a .p8 server Key, 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.iOS.RequestNotificationAuthorization();

Enable quiet notifications

Since iOS 12, Apple introduced a way to receive non-interruptive notifications before the user grants notification authorization. These are notification delivered quietly (no sound, no banner) and that are only displayed in the Notification Center.

You can allow your app to receive quiet notifications from FollowAnalytics as soon as it's installed on the user's device. To do so, just call requestProvisionalNotificationAuthorization in the FinishedLaunching method of your app delegate, after the SDK initialization call.

FollowAnalytics.RequestProvisionalNotificationAuthorization();

Android

Reminders

In order to make sure that your custom notifications logo will be properly displayed on every device, you should have all these files in your project :

Implementation and setup

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 (version >= 71.1610.4)
   • Xamarin.Firebase.Iid (version >= 71.1710.4)
   • Xamarin.Firebase.Messaging (version >= 71.1740.4)

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 FirebaseMessagingService and override the methods OnMessageReceived and OnNewToken:

   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);
           }
   
           public override void OnNewToken(string token)
           {
           FollowAnalytics.Android.SetPushToken(token);
           }
       }
   
   }
   

4. 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>
   

5. 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
   

6. Also do not forget to add this line of code inside of OnNewToken method :

   FollowAnalytics.Android.SetPushToken(token); // Function that pass the FCM token retrieved to FollowAnalytics SDK
   

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

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

8. 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

Notification Service Extension Framework

Rich notifications are notifications with embedded rich media (images, GIFs, videos). When defining a Push campaign on the platform, you can add a rich media to the notification.

A badge is the number displayed on the icon of the app, indicating to the user that the app has new information. On the platform, you can set by how much the badge is to be increased or decreased at the notification reception on the user's device. This is defined as the badge increment in the Campaign Editor.

The SDK allows your app to receive rich notifications and to manage badges thanks to the FANotificationExtension notification service extension framework. In this section, we will see how to install and use this extension framework by:

• Adding a Notification Service Extension target
• Installing from CocoaPods or manually
• Setting an App Group for both app and extension targets
• Configuring the SDK to work with the extension
• Implementing the extension
• Managing badges

Add the Notification Service Extension

To handle rich notification you need to implement Notification Service Extension .

Install FANotificationExtension

To install the FANotificationExtension SDK, follow these steps:

1. Right Click on project References.

   

2. Choose Edit References ....

   

3. Choose the .Net Assembly tab.

   

4. Go to Browse...

   

5. Add FANotificationExtension.dll to your Service Extension Xamarin project References.

   

Set an App Group for both app and extension targets

To let host application and notification service extension communicate, you need to create an AppGroup which will be shared between them.

Configuring the SDK to work with the extension

First, make sure you have set the proper App Group for the app target:

The appGroup parameter should be specified in the configuration init of the SDK:

FollowAnalytics.Configuration configuration = new FollowAnalytics.Configuration((obj) =>
{
...
    obj.appGroup = @"group.your.identifier";
});

Implement the Notification Service Extension

First, make sure you have set the proper App Group for the extension target:

Copy and paste the following implementation in the NotificationService file of the extension you created

using System;
using Foundation;
using UserNotifications;


namespace FollowMeExtension
{
    [Register("NotificationService")]
    public class NotificationService : UNNotificationServiceExtension
    {
        Action<UNNotificationContent> ContentHandler { get; set; }
        UNMutableNotificationContent BestAttemptContent { get; set; }

        protected NotificationService(IntPtr handle) : base(handle)
        {
            // Note: this .ctor should not contain any initialization logic.
        }

        public override void DidReceiveNotificationRequest(UNNotificationRequest request, Action<UNNotificationContent> contentHandler)
        {
            ContentHandler = contentHandler;
            BestAttemptContent = (UNMutableNotificationContent)request.Content.MutableCopy();

            FANotificationExtension.NotificationService.GetFAContentIfNeededWithRequest(request,
            BestAttemptContent, "group.your.identifier", (newContent) => {
            ContentHandler(newContent);
            });
        }

        public override void TimeWillExpire()
        {
            // Called just before the extension will be terminated by the system.
            // Use this as an opportunity to deliver your "best attempt" at modified content, otherwise the original push payload will be used.

            ContentHandler(BestAttemptContent);
        }
    }
}

Badge Management

Badges are the numbers displayed on the icon of the app, indicating to user that the app has new information. In order to enable badges management, add the following instruction just before the SDK initialization:

    FollowAnalytics.Badge.Enable()

FollowAnalytics.Badge class lets you set and get the badge value thanks to the following methods:

    FollowAnalytics.Badge.Set(Int) // Set the value of the icon badge number
    FollowAnalytics.Badge.UpdateBy(Int) // Update the value of the icon badge number
    FollowAnalytics.Badge.Get() // Get the value of the icon badge number
    FollowAnalytics.Badge.Clear() // Clear the icon badge number

Implement custom behavior on URL opening (iOS only)

From the FollowAnalytics platform, you can add URLs (website links or custom URL schemes) to your Push or InApp campaigns. By default, those links will be opened by the SDK, unless the shouldOpenURL callback is defined on the FollowAnalyticsConfiguration provided at SDK initialization.

You can handle links with your own URL opening logic by implementing the shouldOpenURL callback in FollowAnalyticsConfiguration. Use the return value of this callback to allow the SDK to actually open the URL or not:

• If return value is true the SDK will open the URL. Be careful that the SDK will not able to open Universal Links to your own website.

• If return value is false the SDK will not open the URL and it will be the your responsibility to implement the opening of the URL.

obj.shouldOpenUrl = delegate(Uri uri)
{
    // YOUR_IMPLEMENTATION

    // Returning `true` will tell the SDK to automatically open the URL.
    return true;
};

Opt-in Notifications

The FollowAnalytics SDK opt-in notifications status defines whether your app will receive notifications from your Push campaigns. Opt-in notifications is true by default, meaning notifications from your Push campaigns will be received by your app. This status is independent from the system notification authorization, which is also needed by your app to display notifications.

Thanks to this opt-in notifications status, you can implement a UI in your app to allow to choose whether to receive notifications, without the need to go to the system notification authorization settings. Note that the opt-in notifications status will have no effect if the system notification authorization is not allowed, and in this case, your app will not receive notifications from your Push campaigns, whatever the opt-in notifications status.

To update your app UI to reflect the current opt-in notifications status, use the GetOptInNotifications method:

public static bool GetOptInNotifications()

To update the current opt-in notifications status upon UI change, use the SetOptInNotifications method:

public static void SetOptInNotifications(bool state)

It's possible to set the opt-in notifications status to false at the SDK initialization by setting the optInNotificationsDefault parameter to false in the FollowAnalyticsConfiguration object passed to the initialization method. This is only used to set the default opt-in value at the first launch of the app. Note that calling the setOptInNotifications will persist the opt-in notifications status for all subsequent launch of your application, meaning optInNotificationsDefault will be ignored.

Interactive notifications

An Interactive Notification is a notification containing custom action buttons that the user can access by revealing the notification:

When tapped, an action button will:

• Close the notification.
• Eventually launch your application in the foreground, if you specified it explicitly when creating the action (See details below). Otherwise your app is not opened.
• Execute the custom behavior you implemented for the notification tap.

To create a campaign with Interactive Notifications:

• On the platform, create a Push Campaign and define a Category(iOS)/Action Key(Android) in the Interactive Notification section of the campaign editor. For our example, let's set this field to "NewContent".

• In your app, define the action names you want for your notification, we will call them actionIdentifiers. Those identifiers will be displayed as is on the platform in the Push Opened stats:

  const string ActionIdentifierDelete = "Delete";
  const string ActionIdentifierView = "View";
  const string ActionIdentifierRemind = "Remind me tomorrow";
  

• On Android add action buttons to the notification by using the FollowAnalytics.NotificationBuilder.addAction(Context context, int icon, String actionLabel, String actionIdentifier) method in your implementation of the OnPushMessageNotificationBuilding() callback. The actionLabel argument is your localized String that represents your action button's text and the actionIdentifier should be used as a unique identifier for each of your action buttons. This identifier will be passed as an argument to the onPushMessageClicked callback, which will be called whenever an action button is clicked on, so you can identify which action button has been clicked on.

  An example of adding buttons to the notification on Android is available below. Please note how the "NewContent" field defined above is used.

  public override void OnPushMessageNotificationBuilding(Context context, Com.Followanalytics.FollowAnalytics.NotificationBuilder notificationBuilder, Com.Followanalytics.FollowAnalytics.IMessage message)
  {
      if (message.Category == "NewContent")
      {
          notificationBuilder.AddAction(context, Resource.Drawable.ic_menu_send, context.Resources.GetString(Resource.String.view), ActionIdentifierDelete);
          notificationBuilder.AddAction(context, Resource.Drawable.ic_menu_send, context.Resources.GetString(Resource.String.delete), ActionIdentifierView);
          notificationBuilder.AddAction(context, Resource.Drawable.ic_menu_send, context.Resources.GetString(Resource.String.remind_me), ActionIdentifierRemind);
      }
  }
  

• On iOS add action buttons to the notification by adding the following lines in your AppDelegate's FinishedLaunching method :

  var viewAction = UNNotificationAction.FromIdentifier(ActionIdentifierView, NSBundle.MainBundle.GetLocalizedString(ActionIdentifierView), UNNotificationActionOptions.Foreground);
  var deleteAction = UNNotificationAction.FromIdentifier(ActionIdentifierDelete, NSBundle.MainBundle.GetLocalizedString(ActionIdentifierDelete), UNNotificationActionOptions.Destructive);
  var remindMeAction = UNNotificationAction.FromIdentifier(ActionIdentifierRemind, NSBundle.MainBundle.GetLocalizedString(ActionIdentifierRemind), UNNotificationActionOptions.Destructive);
  
  var actions = new UNNotificationAction[] { viewAction, deleteAction, remindMeAction};
  
  var category = UNNotificationCategory.FromIdentifier("NewContent", actions, new string[] { }, UNNotificationCategoryOptions.CustomDismissAction);
  var notificationCenter = UNUserNotificationCenter.Current;
  notificationCenter.SetNotificationCategories(new NSSet<UNNotificationCategory>(category));
  

  Note that the notification action title is a localized version of the actionIdentifier, while the platform displays the actionIdentifier as is in the Push Opened stats.

Implement custom behavior on notification tap

iOS

You can implement a custom behavior when the user taps on a notification by implementing the onNotificationTapped callback in FollowAnalyticsConfiguration. This allows you to perform specific actions when a notification is tapped:

obj.onNotificationTapped = delegate(FollowAnalytics.NotificationInfo notification, string actionIdentifier)
{
    // YOUR_IMPLEMENTATION
    // To open received URL you can use this code :
    if (notification.url != null) {
        UIApplication.SharedApplication.OpenUrl(notification.url);
    }
};

The SDK passes some Push campaign information to your app through this callback thanks to the notificationInfo argument , The NotificationInfo is an object with the following attributes :

While the actionIdentifier argument provides information about which notification button has been tapped :

The actionIdentifier is a String containing the identifier for the tap action. It can be either : - FANotificationDefaultActionIdentifier when user tapped on a regular notification, or on the default button of a category notification. - FANotificationDismissActionIdentifier when user tapped on the dismiss button of a category notification. - Your custom defined action identifier when user tapped on a custom button of a category notification.

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 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.

Implement custom behavior on Push reception

You can implement a custom behavior when the device receives a message from a Push campaign that contains custom parameters (i.e. at least one key/value pair). This can be used to fetch data from your server if a particular custom parameter is defined in the Push message. To do so, implement the onNotificationReceivedcallback in FollowAnalyticsConfiguration:

iOS

The call back need to be implemented in the configuration object in the AppDelegate class :

obj.onNotificationReceived = delegate(FollowAnalytics.NotificationInfo notification)
{
    // YOUR_IMPLEMENTATION

    // To open received URL you can use this code :
    if (notification.url != null) {
        UIApplication.SharedApplication.OpenUrl(notification.url);
    }
};

Android

The call back need to be implemented in the custom configuration class that you created :

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

The SDK passes some Push campaign information to your app through this callback thanks to the message argument , The IMessage is an object with the following attributes :

Implement custom behavior on Native Alert button tap

iOS

You can implement a custom behavior when the user taps on a Native Alert button by implementing the onNativeInAppButtonTapped callback in the FollowAnalyticsConfiguration. This allows you to perform specific actions when a native alert button is tapped:

obj.onNativeInAppButtonTapped = delegate (FollowAnalytics.CustomButtonInfo customButton) {
    // YOUR_IMPLEMENTATION
};

The iOS SDK passes some Native Alert campaign information to your app through this callback thanks to the buttonInfo argument:

Android

The Android SDK allow to retreive parameters (key, value) sent in the Native Alert campaign through the callback OnInAppMessageClicked which need to be implemented in your CustomMessageHandler class :

//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
    }
}

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();

Archiving messages

FollowAnalytics SDK allows you to store campaigns's messages received by your app. This makes them available for custom usage, like building an inbox feature. Messages received by a device can be archived locally and accessed from the developer's code, formatted as a FollowAnalytics.Message. In order for you to enable the message archiving, you need to set the following Configuration properties at SDK initialization:

protected boolean archivePushMessages;
protected boolean archiveInAppMessages;

You will find below all the methods you need to handle all the archived Messages.

In the FollowAnalytics class you will find all necessary methods to manage all FollowAnalytics.Message objects that are archived. They are implemented by FollowAnalytics.InApp and FollowAnalytics.Push.

• The methods are the following on both Android and iOS

public static IList<Message> GetAll(); //Get all in-app messages
public static Message Get (string id);//Get an Message by its id
public static void Delete (string[] ids); //Delete an in-app message
public static void MarkAsRead (string[] ids); //Mark one or several Message as read
public static void MarkAsUnRead (string[] ids); //Mark one or several Message as unread

And here is a description of some of the Message attributes:

Common

Android

iOS

Disabling Swizzling (iOS only)

By default, the SDK swizzles your UIApplicationDelegate methods and your UNUserNotificationCenterDelegate methods. On the other hand, this swizziling can be disabled.

FollowAnalytics.Configuration configuration = new FollowAnalytics.Configuration((obj) =>
{
    obj.swizzlingEnabled = enableSwizziling;
}

Required Methods

The required UIApplicationDelegate methods are:

1. didRegisterForRemoteNotificationsWithDeviceToken:

   Forwarding this method the SDK will be able to send the device token to the server for Push Notifications delivery.

   public override void RegisteredForRemoteNotifications(UIApplication application, NSData deviceToken)
   {
       FollowAnalytics.RegisterForRemoteNotifications(application, deviceToken);
   }
   

2. applicationDidEnterBackground:

   Forwarding this method the SDK will be able to calculate session duration, handle app badge number and detect campaign triggers.

   public override void DidEnterBackground(UIApplication application)
   {
       FollowAnalytics.DidEnterBackground(application);
   }
   

3. applicationWillEnterForeground:

   Forwarding this method the SDK will be able to synchronize campaigns, detect campaign triggers and present queued triggered campaigns.

   public override void WillEnterForeground(UIApplication application)
   {
       FollowAnalytics.WillEnterForeground(application);
   }
   

4. applicationDidBecomeActive:

   Forwarding this method the SDK will be able to calculate sessions durations and detect campaign triggers.

   public override void OnActivated(UIApplication application)
   {
       FollowAnalytics.OnActivated(application);
   }
   

5. applicationWillTerminate:

   Forwarding this method the SDK will be able to calculate sessions durations and handle app badge number.

   public override void WillTerminate(UIApplication application)
   {
       FollowAnalytics.WillTerminate(application);
   }
   

6. applicationDidReceiveMemoryWarning:

   Forwarding this method the SDK will be able to send statistics information.

   public override void ReceiveMemoryWarning(UIApplication application)
   {
       FollowAnalytics.ReceiveMemoryWarning(application);
   }
   

7. didReceiveRemoteNotification:

   Forwarding this method the SDK will be able to handle Push Notifications and In-App campaigns.

   public override void ReceivedRemoteNotification(UIApplication application, NSDictionary userInfo) {
       FollowAnalytics.ReceivedRemoteNotification(application, userInfo);
   }
   

8. handleActionWithIdentifierForRemoteNotification:

   Forwarding this method the SDK will be able to handle Push Notifications and In-App campaigns.

   public override void HandleAction(UIApplication application, String identifier, NSDictionary userInfo, Action completionHandler)
   {
       FollowAnalytics.HandleAction(application, identifier, userInfo, completionHandler);
   }
   

9. handleActionWithIdentifierForLocalNotification:

   Forwarding this method the SDK will be able to handle Notifications and In-App campaigns.

   public override void HandleAction(UIApplication application, String identifier, UILocalNotification LocalNotification, Action completionHandler)
   {
       FollowAnalytics.HandleAction(application, identifier, LocalNotification, completionHandler);
   }
   

10. handleOpenURL:

    If your application support iOS version less than 9.0.

    Forwarding this method the SDK will be able to present alerts about the current user status if the URL is related to this SDK.

    public override bool OpenUrl(UIApplication app, NSUrl url)
    {
        return FollowAnalytics.OpenUrl(app, url);
    }
    

11. openURLSourceApplication:

    If your application support iOS version less than 9.0.

    Forwarding this method the SDK will be able to present alerts about the current user status if the URL is related to this SDK.

    public override bool OpenUrl(UIApplication app, NSUrl url, string sourceApplication, NSObject annotation)
    {
        return FollowAnalytics.OpenUrl(app, url, sourceApplication, annotation);
    }
    

12. openURLOptions:

    Forwarding this method the SDK will be able to present alerts about the current user status if the URL is related to this SDK.

    public override bool OpenUrl(UIApplication app, NSUrl url, NSDictionary options)
    {
        return FollowAnalytics.OpenUrl(app, url, options);
    }
    

13. didReceiveLocalNotification:

    Forwarding this method the SDK will be able to handle In-App campaigns.

    public override void ReceivedLocalNotification(UIApplication application, UILocalNotification notification)
    {
        FollowAnalytics.ReceivedLocalNotification(application, notification);
    }
    

14. performFetchWithCompletionHandler:

    Forwarding this method the SDK will be able to close sessions and fetch contents.

    public override void PerformFetch(UIApplication application, Action<UIBackgroundFetchResult> completionHandler)
    {
        FollowAnalytics.PerformFetch(application, completionHandler);
    }
    

15. didReceiveRemoteNotificationFetchCompletionHandler:

    Forwarding this method the SDK will be able to synchronize campaigns, handle the badge icon and detect campaign triggers.

    public override void DidReceiveRemoteNotification(UIApplication application, NSDictionary userInfo, Action<UIBackgroundFetchResult> completionHandler)
    {
    
        FollowAnalytics.ReceivedRemoteNotification(application, userInfo, completionHandler);
    }
    

16. handleEventsForBackgroundURLSession:

    Forwarding this method the SDK will be able to synchronize campaigns, handle the badge icon and detect campaign triggers.

    public override void HandleEventsForBackgroundUrl(UIApplication application, string sessionIdentifier, Action completionHandler)
    {
        FollowAnalytics.HandleEventsForBackgroundUrl(application, sessionIdentifier, completionHandler);
    }
    

The required UNUserNotificationCenterDelegate methods are:

1. didReceiveNotificationResponse:

   Forwarding this method the SDK will be able to handle Push Notifications and In-App campaigns.

   public void DidReceiveNotificationResponse(UNUserNotificationCenter center, UNNotificationResponse response, Action completionHandler)
   {
       FollowAnalytics.DidReceiveNotificationResponse(center, response, completionHandler);
   }
   

2. willPresentNotification:

   Forwarding this method the SDK will be able to handle Push Notifications and In-App campaigns.

   public void WillPresentNotification(UNUserNotificationCenter center, UNNotification notification, Action<UNNotificationPresentationOptions> completionHandler)
   {
       FollowAnalytics.WillPresentNotification(center, notification, completionHandler);
   }
   

Configuration

To customize the SDK behavior, you must define your desired SDK parameters by setting the related properties values on the FollowAnalyticsConfiguration object passed to the SDK initialization method:

Common

iOS

Updating from older versions

Updating from 6.5 to 6.6

Android

• Now there is no more need to implement a class derived from FirebaseInstanceIdService. You have to delete this class and implement the OnNewToken method of your FirebaseMessagingService derived class. More details in the Setting up push notifications section.