Getting started with CapacitorJS SDK

Follow the documentation on how to use Medallia Experience Orchestration CapacitorJS SDK.

Before you begin (version 1.0.1)

Capacitor requirements:
- Capacitor Android 5.5.1
- Capacitor iOS 5.5.1
- Capacitor Core 5.5.1
iOS requirements:
- Minimum deployment target 12.0
- Xcode 15+
- Base iOS version 17.0
Android requirements:
- Android 7.0 - 12.0 (API levels 24 - 31)
- Android Gradle Plugin 8.0+
- Gradle 8.0+
- Java 17
- Kotlin 1.9.10+

Registration of Medallia's NPM

To register Medallias NPM, please add the following registry to your ~/.npmrc files:

@medallia:registry=https://repository.medallia.com/artifactory/api/npm/public-npm

Installation of the MXO CapacitorJS SDK

Install the Medallia Experience Orchestration SDK using NPM. Navigate to your App's root folder and run the following command:

npm install @medallia/mxo-capacitor-js-sdk
npx cap sync

If iOS and/or Android has not been added to your project, add them using the following commands as described in the Capacitor documentation for iOS and Android:

npm install @capacitor/ios
npx cap add ios
npm install @capacitor/android
npx cap add android
npx cap sync

Configuration of the MXO CapacitorJS SDK

To configure the Medallia Experience Orchestration CapacitorJS SDK, see Configuring CapacitorJS SDK.

Removal of the MXO CapacitorJS SDK

To remove the MXO CapacitorJS SDK from your app, execute the following command in your Terminal:

npm uninstall @medallia/mxo-capacitor-js-sdk
npx cap sync