Verint-XM Cordova Sample App

Prerequisites

Clone this repo and change to the SampleApp directory:

$ git clone https://github.com/foreseecode/verint-xm-cordova-sample
$ cd verint-xm-cordova-sample/SampleApp/

The instructions below will assume you've successsfully cloned the project and navigated to the SampleApp directory.

Plugin Installation

Adding from Github

$ cordova plugin add https://github.com/foreseecode/verint-xm-cordova-plugin

Adding from Github for a specific branch

$ cordova plugin add https://github.com/foreseecode/verint-xm-cordova-plugin#develop

Adding for local development

Clone the repo dir and prepare for use

$ git clone https://github.com/foreseecode/verint-xm-cordova-plugin
$ cd verint-xm-cordova-plugin
$ npm install

Then return to your sample app and add the plugin using the path to the plugin repo you just checked out:

$ cordova plugin add <PATH_TO_REPO_DIR>/verint-xm-cordova-plugin --nofetch

Android Installation

1. Connect an Android device or start an emulator

2. Set up the required environment variables

   You will need to authenticate with GitHub Packages to download our native Android library. To do so, you'll need a personal key which can be generated from your GitHub account by following the instructions. The token will need the read:packages permission.

   Once you have that key, you should set two environment variables on your machine: GITHUB_USERNAME for your username, and GITHUB_PERSONAL_KEY for your personal key. Those environment variables will be picked up by the plugin's /build.gradle file.

   See Getting Started guide for more information.

3. Install the platform

   $ cordova platform add android

4. Prepare:

   $ cordova prepare

5. Build and run:

   $ cordova run android

iOS Installation

1. Install the platform

   $ cordova platform add ios

2. Prepare:

   $ cordova prepare

3. The above commands will in most cases run pod install automatically, but if not (check their output), then the command can be run manually:

   cd platforms/ios
   pod install --repo-update
   cd ../..
   

4. Select a development team (see Running on an iOS Device, below)

5. Build and run:

   $ cordova run ios

Running on an iOS Device

In order to run on iOS, you'll need to select a valid development team, which you can set up using the build.json file in the root of the project.

1. Open Keychain Manager
2. Right click your development certificate and select Get info...
3. Copy the value in Common name
4. Paste it over the codeSigningIdentity in your build.json
5. Open your provisioning profile and copy the UUID
6. Paste it over the provisioningProfile in your build.json
7. Add your development team ID into the developmentTeam in your build.json
8. Run $ cordova run ios

Example commands

Here are some commands that can be run from the Verint-XM Cordova Plugin:

cordova.plugins.verint.xm.start(null, this.onSuccess, this.onError);
cordova.plugins.verint.xm.start(configJSON, this.onSuccess, this.onError);
cordova.plugins.verint.xm.checkEligibility(this.onSuccess, this.onError);
cordova.plugins.verint.xm.showInvite("android_app_QA", this.onSuccess, this.onError);
cordova.plugins.verint.xm.resetState(this.onSuccess, this.onError);

License

Apache License, Version 2.0 https://www.apache.org/licenses/LICENSE-2.0

Known Issues

Minimum SDK version (iOS)

There is currently an issue with the iOS minimum SDK version, which will be fixed, according to Cordova support:
https://issues.apache.org/jira/browse/CB-13597

Minimum SDK version (Android)

There is currently an issue with the Android minimum SDK version, which will be fixed, according to the official Cordova blog:
http://disq.us/p/1oqjjtg

Issues running on simulator

If you see one of the following error messages:

Error: Unhandled error. ('[ios-sim] Could not boot simulator 6075A271-091D-4BC8-86AA-58479762FC21\n')

or

Error: Unhandled error. ('[ios-sim] An error was encountered processing the command (domain=FBSOpenApplicationServiceErrorDomain, code=1):\n' +
  'Simulator device returned an error for the requested operation.\n' +
  'The request was denied by service delegate (SBMainWorkspace) for reason: Unspecified ("null").\n' +
  'Underlying error (domain=FBSOpenApplicationServiceErrorDomain, code=1):\n' +
  '\tThe request to open "com.verint.xm.cordova.sample" failed.\n' +
  '\tThe request was denied by service delegate (SBMainWorkspace) for reason: Unspecified ("null").\n')

It's possible that Cordova is defaulting to a broken simulator instance. You can work around this issue by specifying a specific simulator to use, e.g.

cordova run ios --target "iPhone-14-Pro-Max" --emulator

You can get a list of all the available simulators by running xcrun simctl list.

It's important to use the name from the Device Types list, which includes the hyphens.