{"componentChunkName":"component---src-templates-markdown-template-jsx","path":"/developers/client-sdks/maui/getting-started/","result":{"data":{"pageMetadata":{"title":"Getting Started","path":"/developers/client-sdks/maui/getting-started/","sourceCode":null,"metadataParent":{"title":".NET MAUI","path":"/developers/client-sdks/maui/","sourceCode":"https://github.com/mParticle/mparticle-maui-sdk","hasVersionPicker":null,"metadataChildren":[{"title":"Getting Started","path":"/developers/client-sdks/maui/getting-started/","order":1,"label":null},{"title":"Identity","path":"/developers/client-sdks/maui/identity/","order":2,"label":null}],"metadataParent":{"title":"Client SDKs","path":"/developers/client-sdks/","metadataChildren":[{"title":"Alexa","path":"/developers/client-sdks/alexa/","order":1,"label":null},{"title":".NET MAUI","path":"/developers/client-sdks/maui/","order":null,"label":null},{"title":"AMP","path":"/developers/client-sdks/amp/","order":null,"label":null},{"title":"Android","path":"/developers/client-sdks/android/","order":null,"label":null},{"title":"Cordova","path":"/developers/client-sdks/cordova/","order":null,"label":null},{"title":"Direct Url Routing","path":"/developers/client-sdks/direct-url-routing/","order":null,"label":null},{"title":"Flutter","path":"/developers/client-sdks/flutter/","order":null,"label":null},{"title":"iOS","path":"/developers/client-sdks/ios/","order":null,"label":null},{"title":"React Native","path":"/developers/client-sdks/react-native/","order":null,"label":null},{"title":"Roku","path":"/developers/client-sdks/roku/","order":null,"label":null},{"title":"Unity","path":"/developers/client-sdks/unity/","order":null,"label":null},{"title":"Web","path":"/developers/client-sdks/web/","order":null,"label":null},{"title":"Xbox","path":"/developers/client-sdks/uwp/","order":null,"label":null}],"metadataParent":{"title":"Developers","path":"/developers/","metadataChildren":[{"title":"API Credential Management","path":"/developers/credential-management/","order":null,"label":null},{"title":"API References","path":"/developers/apis/","order":null,"label":null},{"title":"Client SDKs","path":"/developers/client-sdks/","order":null,"label":null},{"title":"Guides","path":"/developers/guides/","order":null,"label":null},{"title":"Media SDKs","path":"/developers/media-sdks/","order":null,"label":null},{"title":"Quickstart","path":"/developers/quickstart/","order":null,"label":null},{"title":"Server SDKs","path":"/developers/server-sdks/","order":null,"label":null},{"title":"The Developer's Guided Journey to mParticle","path":"/developers/developersjourney/","order":null,"label":null},{"title":"Tools","path":"/developers/tools/","order":null,"label":null}],"metadataParent":null}}}},"markdownRemark":{"html":"

mParticle’s .NET MAUI SDK is compatible with iOS and Android apps. The SDK consists of two .NET libraries (net10.0-ios and net10.0-android) that wrap mParticle’s native iOS and Android SDKs. It supports iOS 18+ and Android API 34+.

\n

This SDK targets .NET 10 and replaces the legacy Xamarin SDK. See Microsoft’s policy around the end of support for Xamarin.

\n

\n \n \n \n \n \n \n \n Installation

\n

This SDK is distributed via the public NuGet gallery: https://www.nuget.org/packages/mParticle.MAUI/.

\n

Add the package to your MAUI project:

\n
dotnet add package mParticle.MAUI
\n

Alternatively, add the NuGet package through the Visual Studio Add Package dialog. See here for a detailed walkthrough on using NuGet with Visual Studio.

\n

\n \n \n \n \n \n \n \n Initialize the SDK

\n

The SDK must be initialized with your mParticle workspace key and secret prior to use. This call should be placed in your Xamarin or MAUI application initialization, as early as possible:

\n
 //use the correct workspace API key and secret for iOS and Android\n string key = \"REPLACE WITH iOS APP KEY\";\n string secret = \"REPLACE WITH iOS APP SECRET\";\n\nMParticle.Instance.Initialize(new MParticleOptions()\n{\n    InstallType = InstallType.KnownUpgrade,\n    Environment = Environment.Development,\n    ApiKey = key,\n    ApiSecret = secret,\n    IdentifyRequest = new IdentityApiRequest()\n    {\n        UserIdentities = new Dictionary<UserIdentity, string>() {\n        //{ UserIdentity.Yahoo, \"tom@yahoo.com\" },\n        { UserIdentity.IOSAdvertiserId, \"C56A4180-65AA-42EC-A945-5FD21DEC0538\" },\n        { UserIdentity.CustomerId, \"Other Identity\" }\n    },\n        UserAliasHandler = ((previousUser, newUser) => newUser.SetUserAttributes(previousUser.GetUserAttributes()))\n    },\n    DevicePerformanceMetricsDisabled = false,\n    IdDisabled = false,\n    UploadInterval = 650,\n    SessionTimeout = 50,\n    LogLevel = LogLevel.INFO,\n    ConfigMaxAgeSeconds = 60,\n    AttributionListener = new AttributionListener()\n    {\n        OnAttributionError = error => Console.WriteLine(\"AttributionError\\n\" + \"Error Message = \" + error.Message + \"\\nService Provider = \" + error.ServiceProviderId),\n        OnAttributionResult = result => Console.WriteLine(\"AttributionResult\\n\" + \"LinkUrl = \" + result.LinkUrl + \"\\nParameters\" + result.Parameters + \"\\nService Provider\" + result.ServiceProviderId)\n    },\n    LocationTracking = new LocationTracking(\"GPS\", 100, 350, 22),\n    PushRegistration = new PushRegistration()\n    {\n        AndroidSenderId = \"12345-abcdefg\",\n        AndroidInstanceId = \"android-secret-instance-id\",\n        IOSToken = \"09876654321qwerty\"\n    }\n});
\n

\n \n \n \n \n \n \n \n Usage

\n

\n \n \n \n \n \n \n \n Events

\n

The Xamarin and MAUI SDK simply provides bindings for mParticle’s iOS and Android SDKs. Refer to the underlying SDK docs for full details on Events. See below for basic implementation examples for MAUI, which all new implementations should be using.

\n

\n \n \n \n \n \n \n \n App Events

\n
MParticle.Instance.LogEvent(\"AppEvent of type navigation\", EventType.Navigation, new Dictionary<string, string>() { { \"Cool\", \"Beans\" } });
\n

\n \n \n \n \n \n \n \n Commerce Events

\n
var product = new Product(\"Chicken\", \"SomeSku\", 123.43, 22.14) { Brand = \"mybrand\", Category = \"mycategory\", CouponCode = \"mycoupon\", Variant = \"myvariant\", Position = 12, customAttributes = new Dictionary<string, string>() { { \"Tk1\", \"Tv1\" }, { \"Tk2\", \"Tv2\" } } };\nvar product2 = new Product(\"Noodles\", \"CoolSku\", 12.4, 52.4) { Brand = \"mybrand2\", Category = \"mycategory2\", CouponCode = \"mycoupon2\", Variant = \"myvariant2\", Position = 3, customAttributes = new Dictionary<string, string>() { { \"NTk1\", \"NTv1\" }, { \"NTk2\", \"NTv2\" } } };\nvar products = new Product[] { product, product2 };\nvar transactionAttributes = new TransactionAttributes(\"transactionId123\") { Affiliation = \"Some Affiliation\", CouponCode = \"Winner\", Revenue = 400.21, Tax = 434.98, Shipping = 5.13 };\n\nMParticle.Instance.LogCommerceEvent(new CommerceEvent(ProductAction.AddToCart, products) { Currency = \"AUD\" });\nMParticle.Instance.LogCommerceEvent(new CommerceEvent(ProductAction.Purchase, products, transactionAttributes) { CustomAttributes = new Dictionary<string, string> { { \"TestCommerceAttr\", \"TestCommerceVal\" } } });
\n

\n \n \n \n \n \n \n \n Screen events

\n
MParticle.Instance.LogScreen(\"Home Screen\", new Dictionary<string, string>() { { \"EventAttributeKey\", \"EventAttributeValue\" } });
\n

\n \n \n \n \n \n \n \n Kit Integrations

\n

While most of mParticle’s integration are server side, several require additional client side libraries called kits. An mParticle Kit is composed of a class that typically wraps a 3rd-party SDK, and maps the mParticle API onto a that SDK’s API.

\n

If you’d like to use one of these client side kits simply follow Microsofts guide for creating .Net Android and iOS Binding Libraries.

","frontmatter":{"title":"Getting Started","order":1,"seoTitle":null,"seoDescription":null},"parent":{"__typename":"File","modifiedTime":"September 3, 2026"}}},"pageContext":{"slug":"/developers/client-sdks/maui/getting-started/"}},"staticQueryHashes":["2950460867"]}