Walkme.Sdk.Maui.iOS 1.2.3

WalkMe SDK for .NET MAUI (iOS)

Walkme.Sdk.Maui.iOS binds the WalkMe iOS SDK (player, without the Editor / Power Mode) for .NET MAUI apps. The package is self-contained — the required Lottie framework is bundled, so no extra setup is needed.

The public API is kept aligned with the Android package (Walkme.Sdk.Maui.Android): the same IWalkMe surface, CrossWalkMe.Default accessor, UseWalkMe() DI extension, WalkMeStartOptions, and C# events — so consumer code is the same across platforms.

For the WalkMe Editor (Power Mode) binding, use Walkme.Sdk.Editor.Maui.iOS instead. An app references one or the other, not both.

Requirements

• iOS 14.0 or later
• .NET 8 or later — the package targets net8.0-ios and is consumable by .NET 8, 9, and 10 iOS apps

Installation

dotnet add package Walkme.Sdk.Maui.iOS

What's wrapped

IWalkMe (namespace WalkMe.Maui):

IsStarted, Start, Stop, Restart, SetUserId, SetLanguage, SetVariable, SetEventUserVars, SetTenantId, StartItemById, DismissItem, SendEvent, plus ItemPresented / ItemDismissed / AnalyticsEventSent C# events.

WalkMeStartOptions: SystemGuid (required), Environment (default "Production"), DataCenter (default WalkMeDataCenter.Prod), AnalyticsEnabled (default true), LocalLogsEnabled (default false).

WalkMeDataCenter: presets Prod, Eu, Us01, Eu01, or WalkMeDataCenter.Custom("value") for a custom region string.

Usage

using WalkMe.Maui;

var options = new WalkMeStartOptions
{
    SystemGuid = "<YOUR_SYSTEM_GUID>",
    Environment = "Production",
    DataCenter = WalkMeDataCenter.Prod,
};

CrossWalkMe.Default.ItemPresented += (_, e) =>
    Console.WriteLine($"WalkMe item shown: {e.ItemInfo.ItemId}");

CrossWalkMe.Default.AnalyticsEventSent += (_, e) =>
    Console.WriteLine($"WalkMe event: {e.EventName}");

CrossWalkMe.Default.Start(options);

Or via DI: builder.UseWalkMe() in MauiProgram.cs, then inject IWalkMe.

Platform differences from Android (by design)

• No Start(Activity, options) overload — iOS has no host Activity; use Start(options).
• No ItemAction event — the native iOS SDK does not expose an item-action callback. ItemPresented, ItemDismissed, and AnalyticsEventSent are available.
• DataCenter is fully supported. It maps to the native @objc bridge WalkMeStartOptions.dataCenterValue.

Support

• WalkMe Help Center
• Email: support@walkme.com

License

Commercial software. Use is subject to your agreement with WalkMe.