Cordova Plugin Extension

Common interface and reusable code, as dependency of other plugins
Liming Xie1.0.60
platforms: android,ios
$ cordova plugin add com.rjfun.cordova.extension

Cordova Plugin Common Extension

Extend the Cordova plugin base class with adapter interface.

Plugin written based on this interface, may also be reused for Unity, Cocos2d-X, and other frameworks.


Make Cordova Plugins reusable.

To use mobile device native functionalities and integrate 3rd-party SDKs, mobile developers are writting hundreds plugins for Cordova, Unity, Cocos2d-X, and other frameworks.

Can they be reused? Yes, it's possible.

Cordova plugin manager is bridging function call between javascript and native languages, actually, it can be ported to bridge with C, C++, C#, then it can be reused for Unity, Cocos2d-X and other frameworks.


How it works ?

Android implementation:

public interface PluginAdapterDelegate {
    // context
    public Activity getActivity();
    public View getView();
    // send message from plugin to container on events
    public void fireEvent(String obj, String eventName, String jsonData);
    // send call result
    public void sendPluginResult(PluginResult result, CallbackContext context);

public class CordovaPluginExt extends CordovaPlugin implements PluginAdapterDelegate {
    protected PluginAdapterDelegate adapter = null;

iOS implementation:

@protocol PluginAdapterDelegate <NSObject>
    // context
- (UIView*) getView;
- (UIViewController*) getViewController;
    // send message from plugin to container on events
- (void) fireEvent:(NSString*)obj event:(NSString*)eventName withData:(NSString*)jsonStr;
    // send call result
- (void) sendPluginResult:(CDVPluginResult*)result to:(NSString*)callbackId;

@interface CDVPluginExt : CDVPlugin <PluginAdapterDelegate>
@property(nonatomic, retain) id<PluginAdapterDelegate> adapter;

Other platform:

Not implemented yet.

How to Use?

This plugin is used as dependency of other plugins, for plugin developers only.

In your plugin.xml, add it as dependency:

<dependency id="com.rjfun.cordova.extension"/>

Inherit Cordova Plugin Ext:

Plugin for Android:

import com.rjfun.cordova.ext.*;

// your plugin class
public class YourPluginClass extends CordovaPluginExt {
    // implement the method, call the API defined in PluginAdapterDelegate
    public boolean execute(String action, JSONArray inputs, CallbackContext callbackContext) throws JSONException;

Plugin for iOS:

#import "CDVCordovaExt.h"

// your plugin class
@interface YourPluginClass : CDVPluginExt
    // implement the method, call the API defined in PluginAdapterDelegate
- (void) your_method:(CDVInvokedUrlCommand *)command;

Related Projects

To use the plugin in other frameworks, following plugin managers are required.


This project is created by Raymond Xie.

If you are interested in this project, welcome to join and contribute.