[CB-862] Document Plugin Authoring - ASF JIRA

XML

Word

Printable

JSON

Parent task for creating a set of guides for plugin authoring.

Will need a bunch of sub-tasks for each native platform's plugin authoring guide. Also a JS guide.

Question:

One open question: how to handle versioning in this case? I.e. a 1.7 plugin authoring guide vs. a 2.0 guide.

Plugin Name:

Cordova Echo

JavaScript Interface:

window.echo(<string>, <callback>);

Usage Example:

window.echo("Hello...hello...hello...hello...", function(value) {
    // `value` is "Hello...hello...hello...hello..."
    alert(value);
});

Inner Working Details:

The string to echo should be passed through exec and into the native implementation.
The native code should then call the success callback.
If an empty string is provided, the native code should call the error callback.
The plugin should define a default error callback with the argument "Nothing to echo."
The JavaScript error callback should then invoke the success callback with the error value.

1.	Android Plugin Authoring Guide	Closed	Filip Maj
2.	Bada Plugin Authoring Guide	Closed	Anis Kadri
3.	BlackBerry Plugin Authoring Guide	Closed	Tim Kim
4.	iOS Plugin Authoring Guide	Closed	Shazron Abdullah
5.	webOS Plugin Authoring Guide	Closed	Herm Wong
6.	Windows Phone Plugin Authoring Guide	Closed	Jesse MacFadyen