Whatfix.Android 0.2.5

Integrate Whatfix SDK into your Xamarin.Android project

Prerequisites:

• Android Min SDK version: 19

Step 1: Obtain the packages from NuGet.

The package is available on NuGet on this Whatfix.

In your Xamarin.Android project, Right Click on Packages. Select Manage NuGet Packages in the context menu. Search for 'Whatfix.Android' in the search bar. Add the Whatfix package to the library.

Step 2: Select the version of the SDK

In the Nuget Package Installer, Select the latest version of the SDK in the New version dropdown.

Step 3: Add Initialize in MainActivity.cs file.

//Xamarin.Android

using Sdk.Whatfix;
using Sdk.Whatfix.Common;
using Sdk.Whatfix.Common.Model;

protected override void OnCreate(Bundle savedInstanceState)
{
    base.OnCreate(savedInstanceState);
    var app = new App();
    LoadApplication(app);
    WhatfixOptions whatfixOptions = new WhatfixOptions();
    SegmentationOptions segmentationOptions = new SegmentationOptions();
    Whatfix.Initialize(this, "<ent_name>", "<ent_id>", 
    AppType.Xamarin.Ordinal(), segmentationOptions, whatfixOptions);
    
    
    // IMP : To manage/detect screen changes
              app.PageAppearing += (s, e) =>
                {
                    if (!e.ToString().Contains("NavigationPage"))
                    {
                        Whatfix.ReInitScreen(e.ToString());
                    }
                };

                app.PageDisappearing += (s, e) =>
                {
                    if (!e.ToString().Contains("NavigationPage"))
                    {
                        Whatfix.DeInitScreen(e.ToString());
                    }
                };
}

Replace <ent_id> and <ent_name> with your Whatfix account ID. To get your ENT ID & ENT_NAME, email us at support@whatfix.com or get in touch with your Account Manager.

If the above screen change detection doesn’t give consistent events for all Pages. Replace with the below snippet:

 app.PageAppearing += (s, e) =>
                {
                    if (!e.ToString().Contains("NavigationPage"))
                    {
                      Whatfix.SetScreenId(e.ToString());
                    }
                };

                app.PageDisappearing += (s, e) =>
                {
                  //Do nothing
                };

Advanced Initialization Options

WhatfixOptions whatfixOptions = WhatfixOptions();
whatfixOptions.CdnHost = "cdn.whatfix.com"; // Add this option to set your custom host to serve whatfix content.Default is [cdn.whatfix.com](http://cdn.whatix.com/)
whatfixOptions.StartEditor = false; // Set this option to true only to invoke Whatfix Mobile editor directly on a custom callback.
whatfixOptions.DebugEnabled = true; // Set this option to true in order to enable all debug logs on Logcat
whatfixOptions.EditorDisabled = false; // Set this option to true in order to disable invocation of editor in the production builds

Extra (optional) configurations for Segmenting Whatfix content based on User info, Localisation, etc.

SegmentationOptions segmentationOptions = new SegmentationOptions();

segmentationOptions.LoggedInUserId = "john_doe"; // Add this option to set the current user id for analytics
segmentationOptions.LoggedInUserRole = "manager"; // Add this option to set the current user role from your app
segmentationOptions.Language = "fr"; // Add this option to set the current user language preference

IDictionary<string, string> map = new Dictionary<string, string>();
map.Add("xamarin_key", "xamarin_value");
segmentationOptions.CustomKeyValue = map; // Add this option to set custom window variables for advanced segmentation (e.g. `["user_type":"paid"]`)

Whatfix.RefreshWindowVariable(segmentationOptions); // segmentationOptions can be passed at initialize. If using at any other place  RefreshWindowVariable has to be called