Walkme.Sdk.Maui.Android
1.2.3
dotnet add package Walkme.Sdk.Maui.Android --version 1.2.3
NuGet\Install-Package Walkme.Sdk.Maui.Android -Version 1.2.3
<PackageReference Include="Walkme.Sdk.Maui.Android" Version="1.2.3" />
<PackageVersion Include="Walkme.Sdk.Maui.Android" Version="1.2.3" />
<PackageReference Include="Walkme.Sdk.Maui.Android" />
paket add Walkme.Sdk.Maui.Android --version 1.2.3
#r "nuget: Walkme.Sdk.Maui.Android, 1.2.3"
#:package Walkme.Sdk.Maui.Android@1.2.3
#addin nuget:?package=Walkme.Sdk.Maui.Android&version=1.2.3
#tool nuget:?package=Walkme.Sdk.Maui.Android&version=1.2.3
WalkMe.Maui
A .NET MAUI bridge/plugin for the WalkMe Android SDK.
NuGet package (targets net8.0-android):
- Walkme.Sdk.Maui.Android — plugin surface (
IWalkMe, managed models wrappingWalkMeSDK; C# namespaceWalkMe.Maui) plus the Android bindings and WalkMe.aarembedded in the same package.
Install (consumers)
dotnet add package Walkme.Sdk.Maui.Android
Or add a PackageReference to Walkme.Sdk.Maui.Android in your MAUI Android app. You do not need a separate Bindings package or to build the WalkMe AAR yourself.
Prerequisites (building this repo)
- .NET 8+ SDK
- MAUI and Android workloads:
dotnet workload install maui android - A JDK compatible with the Android workload
Building and packing
dotnet restore
dotnet build
dotnet pack
OkHttp 5.1.0 is a NuGet dependency: Square.OkHttp3.LoggingInterceptor 5.1.0.2 brings Square.OkHttp3.JVM and Square.OkIO.JVM 3.15.0 (or a newer Square.OkIO.JVM already in the app, when that package supports this TFM). Do not also reference Square.OkHttp3 or Square.OkHttp3.Android; those ship okhttp-android, which duplicates okhttp-jvm. Koin 3.5.6 and Lottie 6.4.0 are embedded. No maintained .NET binding matches those artifacts.
Do not reference both Walkme.Sdk.Maui.Android and Walkme.Sdk.Editor.Maui.Android in the same app — use one or the other.
What's wrapped
IWalkMe mirrors the native WalkMeSDK singleton:
Start, Stop, Restart, SetUserId, SetLanguage, SetVariable, SetEventUserVars,
SetTenantId, StartItemById, DismissItem, SendEvent, plus ItemPresented /
ItemDismissed / ItemAction / AnalyticsEventSent C# events.
using WalkMe.Maui;
var options = new WalkMeStartOptions
{
SystemGuid = "<YOUR_SYSTEM_GUID>",
Environment = "Production",
DataCenter = WalkMeDataCenter.Prod,
};
CrossWalkMe.Default.Start(options); // after the host Activity exists
Or via DI: builder.UseWalkMe() in MauiProgram.cs and inject IWalkMe.
Known risk areas
WalkMeSDK.Instance— Kotlinobject; this binding always usesWalkMeSDK.Instance!.Xxx(...).WalkmeDataCentermapping — sealed class cases mapped inToNativeat the bottom ofWalkMeImplementation.cs. If generated names differ after an SDK bump, adjust that method only.
Transforms/Metadata.xml is the place for binding fixups if needed.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0-android34.0 is compatible. net9.0-android was computed. net10.0-android was computed. |
-
net8.0-android34.0
- GoogleGson (>= 2.13.2)
- Microsoft.Maui.Controls (>= 8.0.91)
- Square.OkHttp3.LoggingInterceptor (>= 5.1.0.2)
- Xamarin.AndroidX.Biometric (>= 1.1.0.30)
- Xamarin.AndroidX.ConstraintLayout (>= 2.2.1.3)
- Xamarin.AndroidX.Room.Room.Ktx (>= 2.7.2.1)
- Xamarin.AndroidX.Room.Runtime (>= 2.7.2.1)
- Xamarin.Kotlin.StdLib (>= 2.2.10)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.