Airwatch-sdk-plugin NPM

airwatch-sdk-plugin

Use this document to install the VMware Workspace One SDK Plugin for Apache Cordova. The plugin helps enterprise app developers add enterprise- grade security, conditional access, and compliance capabilities to mobile applications.

Supported Components

This plugin works with the listed component versions.

Workspace ONE UEM Console 2206+ (may need to be higher depending on specific features)
Android 5.0+ (for Android SDK component) / API level 21 OR above / Android Studio with the Gradle Android Build System (Gradle) 3.3.0 or later / Workspace ONE Intelligent Hub for Android version 23.11 or later
iOS and iPadOS 15 or later (for iOS SDK component) / Xcode 14.3.0 or later

Initial Setup

Please find the Prerequisites for using the Workspace One SDK Plugin for Apache Cordova.

Installation

To install the plugin, type cordova plugin add airwatch-sdk-plugin at the command line. This should be added before any other plugin is added to the app. Note: The download from NPM, usually takes 2-3 minutes on average, over high speed internet connection.

Additional Setup

iOS

Add following code in AppDelegate

-(BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options
{
  //Add following code for posting Notification for URL
  NSNotification *info = [[NSNotification alloc]initWithName:@"UIApplicationOpenURLOptionsSourceApplicationKey" object:url userInfo:options];
  [[NSNotificationCenter defaultCenter] postNotification:info];
  
  return YES;
}

Initialization

The plugin auto-starts on both Android and iOS devices and it automatically starts the Workspace One SDK. After startup, the functions are available in the window.plugins.airwatch object. No other initialization is required to use the documented functions.

To receive events from the SDK, an event listener must be initialized. See "Events" below.

Initialization of the SDK adds the listed features to your application, depending on the configurations set in the SDK profile in the Workspace One UEM Console.

Application level passcode
Application level tunneling of network traffic
Integrated authentication / single sign on
Data loss prevention
- Disable Screenshot (Android only)
- Restrict open-in for documents, web links, and email to approved applications only Restrict copy/paste (SDK provides flag value)
- Restrict access to app when device is offline
Branding of VMware AirWatch splash screens when SDK application is launched on device

Feature Implementation

Please follow document at implementation.

Quick Example

On deviceready, please set the SDK event listener: window.plugins.airwatch.setSDKEventListener(sdkEventCallback) . The sdkEventCallback is a function that takes two arguments: 1. A string that holds the name of the event fired. 2. An object that contains the additional info on the event function sdkEventCallback(event, info).

function sdkEventCallback(event, info)
{
    /* Check (event === "initSuccess") before using sdk functionalities */
}

Release Notes

Latest versions of Workspace ONE SDKs (24.1.0 for iOS and 24.01 for Android).

Workspace One SDK Documentation

For further details about the Workspace One SDK, navigate to Workspace-ONE-SDK and select the required platform, SDK version and Workspace ONE UEM console version.