Adding the MobileFirst Foundation SDK to Xamarin Applications

improve this page | report issue


Adding the MobileFirst Native SDK

Follow the instructions below to add the MobileFirst Native SDK to a new or existing Xcode project, and to register the application to the MobileFirst Server.

Before you start, make sure that the MobileFirst Server is running.
If using a locally installed server: From a Command-line window, navigate to the server’s folder and run the command: ./

Creating an application

Create a Xamarin solution using Xamarin Studio or Visual Studio or use an existing one.

Adding the SDK

  1. The MobileFirst Native SDK is provided via Nuget Gallery/Repository .
  2. To import MobileFirst packages, use the NuGet package manager. NuGet is the package manager for the Microsoft development platform, including .NET. The NuGet client tools provide the ability to produce and use packages. The NuGet Gallery is the central package repository used by all package authors and users. Right click on the Packages directory, select Add packages and in the search option, search for IBM MobileFirst Platform. Choose IBM.MobileFirstPlatformFoundation and IBM.MobileFirstPlatformFoundationPush . Adding sdk from
  3. Click Add packages. This action installs the Mobile Foundation Native SDK and its dependencies. Adding sdk from

Registering the application

  1. Load the MobileFirst Operations Console.
  2. Click the New button next to Applications to register a new application and follow the on-screen instructions.
  3. Android and iOS applications have to be registered separately. This ensures both the Android application and iOS application can connect successfully to the server. The registration details for Android and iOS applications can be found in the AndroidManifest.xml and Info.plist respectively.
  4. After the application is registered, navigate to the application’s Configuration Files tab and copy or download the mfpclient.plist and file. Follow the onscreen instructions to add the file to your project.

Completing the setup process


  1. Right-click the Xamarin iOS project and select Add files... Browse and find the mfpclient.plist to the root of the project. Choose Copy file to project if prompted.
  2. Right-click the mfpclient.plist file and select Build action.Choose Content.

  1. Right-click the Assets folder of Xamarin Android project and select Add files... Browse and find the to the folder. Choose Copy file to project if prompted.
  2. Right-click the file and select Build action.Choose Android asset.

Referencing the SDK

Whenever you want to use the MobileFirst Native SDK, make sure that you import the Mobile Foundation framework:


using Worklight;


using MobileFirst.Xamarin.iOS;


using Worklight.Xamarin.Android;

Updating the MobileFirst Native SDK

To update the MobileFirst Native SDK with the latest release, update the version of the SDK via the Nuget Gallery.

Generated MobileFirst Native SDK artifacts


This file defines the client-side properties used for registering your iOS app on the MobileFirst Server.

Property Description Example values
protocol The communication protocol with the MobileFirst Server. http or https
host The host name of the MobileFirst Server.
port The port of the MobileFirst Server. 9080
wlServerContext The context root path of the application on the MobileFirst Server. /mfp/
languagePreferences Sets the default language for client sdk system messages. en

Tutorials to follow next

With the MobileFirst Native SDK now integrated, you can now:

Inclusive terminology note: The Mobile First Platform team is making changes to support the IBM® initiative to replace racially biased and other discriminatory language in our code and content with more inclusive language. While IBM values the use of inclusive language, terms that are outside of IBM's direct influence are sometimes required for the sake of maintaining user understanding. As other industry leaders join IBM in embracing the use of inclusive language, IBM will continue to update the documentation to reflect those changes.
Last modified on July 01, 2020