[jira] [Commented] (CB-862) Document Plugin Authoring

["Filip Maj (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/CB-862?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13417714#comment-13417714 ] 

Filip Maj commented on CB-862:
------------------------------

The top-level article has been updated to add the JavaScript interface for the echo plugin, as well as a JavaScript overview.
                
> Document Plugin Authoring
> -------------------------
>
>                 Key: CB-862
>                 URL: https://issues.apache.org/jira/browse/CB-862
>             Project: Apache Cordova
>          Issue Type: Improvement
>          Components: Docs
>            Reporter: Filip Maj
>            Assignee: Filip Maj
>             Fix For: 2.0.0
>
>
> 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:*
> {noformat}
> window.echo("Hello...hello...hello...hello...", function(value) {
>     // `value` is "Hello...hello...hello...hello..."
>     alert(value);
> });
> {noformat}
> *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.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira