Skip to content

Latest commit

 

History

History
157 lines (112 loc) · 5.89 KB

xamarin_forms-android.md

File metadata and controls

157 lines (112 loc) · 5.89 KB
Raw

Xamarin Forms Android

Note

The following integration instructions are relevant for SDK 3.0 or higher.
Follow our migration instructions to upgrade from SDK 2.x to 3.0 or refer to our 2.x integration instruction.

Important

Requirements:

  • .NET 4
  • Xamarin.Forms version 5.0.0.2612 or higher
  • Kotlin version 1.9.0 or higher
  • Target Android Version 13.0 or higher

Step 1. Install Pendo SDK

  1. In Visual Studio Solution Explorer, right-click on your shared project, then select "Add" - > "Add NuGet Packages…".
  2. Search for: pendo-xamarin-forms with latest version.
  3. Press Add Package.

  4. Using ProGuard / R8

  • If you are using ProGuard, the rules that need to be added to ProGuard can be found here: pendo-proguard.cfg.

  • If you are using ProGuard(D8/DX only) to perform compile-time code optimization, and have {Android SDK Location}/tools/proguard/proguard-android-optimize.txt, add !code/allocation/variable to the -optimizations line in your app/proguard-rules.pro file. The optimizations line should look like this:
    -optimizations *other optimizations*,!code/allocation/variable

Step 2. Pendo SDK integration

Note

The API Key can be found in your Pendo Subscription Settings in App Details.

  1. Open the shared project App.xaml.cs

    Add the following under 'using':

    using PendoSDKXamarin;

namespace ExampleApp
{
    public partial class App : Application
    {
        private static IPendoInterface pendo = DependencyService.Get<IPendoInterface>();
        
        ...

    }
}

    In the protected override void OnStart() method, add the following code:

    protected override void OnStart()
{
   string apiKey = "YOUR_API_KEY_HERE";
   pendo.Setup(apiKey);

   ...
}

  2. Start the visitor's session in the page where your visitor is being identified (e.g. login, register, etc.).

    using PendoSDKXamarin;

namespace ExampleApp
{
    class ExampleLoginClass
    {
    ...
    private static IPendoInterface Pendo = DependencyService.Get<IPendoInterface>();

    public void MethodExample()
    {
        
        ...

        var visitorId = "VISITOR-UNIQUE-ID";
        var accountId = "ACCOUNT-UNIQUE-ID";

        var visitorData = new Dictionary<string, object>
        {
            { "age", 27 },
            { "country", "USA" }
        };

        var accountData = new Dictionary<string, object>
        {
            { "Tier", 1 },
            { "Size", "Enterprise" }
        };

        pendo.StartSession(visitorId, accountId, visitorData, accountData);
        
        ...
    }

    ...

}

    visitorId: a user identifier (e.g. John Smith)
    visitorData: the user metadata (e.g. email, phone, country, etc.)
    accountId: an affiliation of the user to a specific company or group (e.g. Acme inc.)
    accountData : the account metadata (e.g. tier, level, ARR, etc.)

    This code ends the previous mobile session (if applicable), starts a new mobile session and retrieves all guides based on the provided information.

Tip

To begin a session for an anonymous visitor, pass null or an empty string "" as the visitor id. You can call the startSession API more than once and transition from an anonymous session to an identified session (or even switch between multiple identified sessions).

Step 3. Mobile device connectivity for tagging and testing

Note

The Scheme ID can be found in your Pendo Subscription Settings in App Details.

This step enables page tagging and guide testing capabilities.

Add the following activity to the application AndroidManifest.xml in the <Application> tag:

<activity android:name="sdk.pendo.io.activities.PendoGateActivity" android:launchMode="singleInstance" android:exported="true">
    <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:scheme="YOUR_SCHEME_ID_HERE"/>
    </intent-filter>
</activity>

Step 4. Verify installation

  1. Test using Visual Studio:
    Run the app.
    Review the Android Studio logcat and look for the following message:
    Pendo SDK was successfully integrated and connected to the server.
  2. In the Pendo UI, go to Settings>Subscription Settings.
  3. Select the Applications tab and then your application.
  4. Select the Install Settings tab and follow the instructions under Verify Your Installation to ensure you have successfully integrated the Pendo SDK.
  5. Confirm that you can see your app as Integrated under subscription settings.

Developer documentation

  • API documentation available here.

Troubleshooting