cordova-plugin-openwith

This plugin for Apache Cordova registers your app to handle files and text.

Overview

This plugin lists your app in the Send to... section for files or text, on both Android and iOS. It is based on cc.fovea.cordova.openwith, but with less of a focus on images and without any UI on iOS.

:warning: Work in progress This documentation isn't adjusted completely yet so take care when using this. Also we didn't focus on making this super configurable yet, so it is more adjusted to our needs.

Table of Contents

• Background
• Installation
• Usage
• API
• License

Background

iOS and Android each have their own ways of handing over files to an app. This plugin abstracts them behind a single and simplified interface. It does not expose all subtleties of each system, be this should be enough for 99% of people. Are you the 1% that needs more? Fork and PR if it makes sense, or ask for help.

The plugin's API mostly follows Android's terminology.

Below is a short introduction to how the technology works on Android and iOS.

Android

On Android, the app defines, in its AndroidManifest.xml file, the mime type of file types it can handle. Wildcard are accepted, so image/* can be used to accept all images regardless of the sub-type. The app also defines the type of actions accepted for this file types. By default, only the SEND event is declared by the plugin. Other events that can be of interest are SEND_MULTIPLE and VIEW.

When a user sends a file to your app, the system provides an Intent to the application. An Intent is just an abstract description of an operation to be performed. This Intent defines an action and can be linked with internal URIs to one or more files through the "stream" property attached to the intent. Starting Android 4.4 KitKat, ClipData was introduced to mimick a sort of Clipboard used to exchange data between apps. Both methods are supported.

If you are interested to learn more, the documentations for Intent.ACTION_SEND, ClipData and the Clipboard Framework are good places to start.

iOS

On iOS, there are many ways apps can communicate. This plugin uses a Share Extension. This is a particular type of App Extension which intent is, as Apple puts it: "to post to a sharing website or share content with others".

A share extension can be used to share any type of content. You have to define which you want to support using an Universal Type Identifier (or UTI). For a full list of what your options are, please check Apple's System-Declared UTI.

As with all extensions, the flow of events is expected to be handled by a small app, external to your Cordova App but bundled with it. When installing the plugin, we will add a new target called ShareExtension to your XCode project which implements this Extension App. The Extension and the Cordova App live in different processes and can only communicate with each other using inter-app communication methods.

When a user posts some content using the Share Extension, the content will be stored in a Shared User-Preferences Container. To enable this, the Cordova App and Share Extension should define a group and add both the app and extension to it, manually. At the moment, it seems like it's not possible to automate the process. You can read more about this here.

Once the data is in place in the Shared User-Preferences Container, the Share Extension will open the Cordova App by calling a Custom URL Scheme. This seems a little borderline as Apple tries hard to prevent this from being possible, but brave iOS developers always find solutions... So as for now there is one and it seems like people got their app pass the review process with it. The recommended solution is be to implement the posting logic in the Share Extension, but this doesn't play well with Cordova Apps architecture...

On the Cordova App side, the plugin checks listens for app start or resume events. When this happens, it looks into the Shared User-Preferences Container for any content to share and report it to the javascript application.

Installation

cordova plugin add github:zenkit/cordova-plugin-openwith \
  --variable IOS_URL_SCHEME=myuniqueopenwithdemo

| variable | example | notes | | ------------------------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ANDROID_MIME_TYPE | image/* | Android only Mime type of documents you want to share (wildcards accepted) | | IOS_URL_SCHEME | uniquelonglowercase | iOS only Any random long string of lowercase alphabetical characters | | IOS_UNIFORM_TYPE_IDENTIFIER | public.image | iOS only UTI of documents you want to share (check Apple's System-Declared UTI) | | IOS_GROUP_IDENTIFIER | group.my.app.id | iOS only Custom app group name. Default is group.<YOUR_APP_BUNDLE_ID>.shareextension. | | SHAREEXT_PROVISIONING_PROFILE | 9dfsdf-.... | iOS only Developer account teamId | | SHAREEXT_DEVELOPMENT_TEAM | 00B000A09l | iOS only UUID of provisioning profile for singing |

iOS Setup

After having installed the plugin, with the ios platform in place, 1 operation needs to be done manually: setup the App Group on both the Cordova App and the Share Extension.

1. Open the xcodeproject for your application
2. Select the root element of your project navigator (the left-side pane)
3. Select the target of your application
4. Select capabilities
5. Scroll down to App Groups
6. Make sure it's ON
7. Create and activate an App Group called: group.<YOUR_APP_BUNDLE_ID>.shareextension
8. Repeat the previous five steps for the ShareExtension target.

You might also have to select a Team for both the App and Share Extension targets, make sure to select the same.

Build, XCode might complain about a few things to setup that it will fix for you (creation entitlements files, etc).

Usage

document.addEventListener("deviceready", setupOpenwith, false);

function setupOpenwith() {
  // Increase verbosity if you need more logs
  //cordova.openwith.setVerbosity(cordova.openwith.DEBUG);

  // Initialize the plugin
  cordova.openwith.init(initSuccess, initError);

  function initSuccess() {
    console.log("init success!");
  }
  function initError(err) {
    console.log("init failed: " + err);
  }

  // Define your file handler
  cordova.openwith.addHandler(myHandler);

  function myHandler(intent) {
    console.log("intent received");

    console.log("  action: " + intent.action); // type of action requested by the user
    console.log("  exit: " + intent.exit); // if true, you should exit the app after processing

    for (var i = 0; i < intent.items.length; ++i) {
      var item = intent.items[i];
      console.log("  type: ", item.type); // mime type
      console.log("  uri:  ", item.uri); // uri to the file, probably NOT a web uri

      // some optional additional info
      console.log("  text: ", item.text); // text to share alongside the item, iOS only
      console.log("  name: ", item.name); // suggested name of the image, iOS 11+ only
      console.log("  utis: ", item.utis);
      console.log("  path: ", item.path); // path on the device, generally undefined
    }

    // ...
    // Here, you probably want to do something useful with the data
    // ...
    // An example...

    if (intent.items.length > 0) {
      cordova.openwith.load(intent.items[0], function(data, item) {
        // data is a long base64 string with the content of the file
        console.log("the item weights " + data.length + " bytes");
        uploadToServer(item);

        // "exit" when done.
        // Note that there is no need to wait for the upload to finish,
        // the app can continue while in background.
        if (intent.exit) {
          cordova.openwith.exit();
        }
      });
    } else {
      if (intent.exit) {
        cordova.openwith.exit();
      }
    }
  }
}

Check out the demo project for a functional example.

API

cordova.openwith.setVerbosity(level)

Change the verbosity level of the plugin.

level can be set to:

• cordova.openwith.DEBUG for maximal verbosity, log everything.
• cordova.openwith.INFO for the default verbosity, log interesting stuff only.
• cordova.openwith.WARN for low verbosity, log only warnings and errors.
• cordova.openwith.ERROR for minimal verbosity, log only errors.

cordova.openwith.addHandler(handlerFunction)

Add an handler function, that will get notified when a file is received.

Handler function

The signature for the handler function is function handlerFunction(intent). See below for what an intent is.

Intent

intent describe the operation to perform, toghether with the associated data. It has the following fields:

• action: the desired action. see below for possible values.
• exit: true if the app should exit after processing.
• items: an array containing one or more data descriptor.

Action

Here are the possible actions.

• cordova.openwith.SEND: when the user wants to send the file(s)
• cordova.openwith.VIEW: when the user wants to view the file(s)

Data descriptor

A data descriptor describe one file. It is a javascript object with the following fields:

• uri: uri to the file.
  • probably NOT a web uri, use load() if you want the data from this uri.
• type: the mime type.
• text: text entered by the user when sharing (iOS only)
• name: suggested file name, generally undefined.
• path: path on the device, generally undefined.
• utis: list of UTIs the file belongs to (iOS only).
• base64: a long base64 string with the content of the file.
  • might be undefined until load() has been called and completed successfully.

cordova.openwith.load(dataDescriptor, loadSuccessCallback, loadErrorCallback)

Load data for an item. dataDescriptor is an item in an intent's items list, see the section about addHandler() above for details.

loadSuccessCallback: function (base64, dataDescriptor)

When data has been successfully loaded, loadSuccessCallback will be called. It is expected to have the following signature: function (base64, dataDescriptor)

base64 is a long string containing the data. dataDescriptor is the loaded dataDescriptor, extended to contain the base64 field.

loadErrorCallback: function (err, dataDescriptor)

Called when data can't be loaded.

cordova.openwith.exit()

Attempt to return the the calling app when sharing is done. Your app will be backgrounded, it should be able to finish the upload.

On iOS, this call might have no effects. The plugin needs to recognize the app you are sharing from in order to send you back to it. The user can still select the "Back-to-app" button visible on the top left. Make sure your UI shows the user that he can now safely go back to what he was doing.

On Android, the app will be backgrounded no matter what.

License

MIT