Updated Branches: refs/heads/master 27f5921ca -> b1dd2d36b
Updating Android onReset docs and adding iOS ones. Project: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/commit/b1dd2d36 Tree: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/tree/b1dd2d36 Diff: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/diff/b1dd2d36 Branch: refs/heads/master Commit: b1dd2d36b91bd7ebd37fe48f19257d0e75a19f52 Parents: 12d3a68 Author: Braden Shepherdson <bra...@chromium.org> Authored: Thu Sep 27 11:40:25 2012 -0400 Committer: Braden Shepherdson <bra...@chromium.org> Committed: Thu Sep 27 11:40:25 2012 -0400 ---------------------------------------------------------------------- .../edge/guide/plugin-development/android/index.md | 2 +- docs/en/edge/guide/plugin-development/ios/index.md | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/b1dd2d36/docs/en/edge/guide/plugin-development/android/index.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/plugin-development/android/index.md b/docs/en/edge/guide/plugin-development/android/index.md index df32af9..13ee533 100644 --- a/docs/en/edge/guide/plugin-development/android/index.md +++ b/docs/en/edge/guide/plugin-development/android/index.md @@ -26,7 +26,7 @@ file. A plugin will consist of at least a single Java class that extends the `Plugin` class. A plugin **must** have a method called `execute` that must return a `PluginResult` object. In addition to this, there is a best practice that the plugin should handle pause and resume events, and should handle message passing between plugins. -Plugins with long-running requests or internal state should implement the `onReset()` method as well. This method is run when the `WebView` navigates to a new page or refreshes, which reloads the Javascript. +Plugins with long-running requests, background activity (e.g. playing media), listeners or internal state should implement the `onReset()` method as well. This method is run when the `WebView` navigates to a new page or refreshes, which reloads the Javascript. ## Plugin Class Mapping http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/b1dd2d36/docs/en/edge/guide/plugin-development/ios/index.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/plugin-development/ios/index.md b/docs/en/edge/guide/plugin-development/ios/index.md index 4d1891d..5d1b447 100644 --- a/docs/en/edge/guide/plugin-development/ios/index.md +++ b/docs/en/edge/guide/plugin-development/ios/index.md @@ -31,6 +31,8 @@ The JavaScript portion of a plugin always uses the `cordova.exec` method as foll This will marshall a request from the UIWebView to the iOS native side, more or less boiling down to calling the `action` method on the `service` class, with the arguments passed in the `args` Array. +Plugins with long-running requests, background activity (e.g. playing media), listeners or internal state should implement the `onReset` method and stop or clean up those activities. This method is run when the `UIWebView` navigates to a new page or refreshes, which reloads the Javascript. + The plugin must be added to `Plugins` key (a Dictionary) of the `Cordova.plist` file in your Cordova-iOS application's project folder. <key>service_name</key> @@ -172,4 +174,4 @@ The **old (deprecated)** signature is: - (void) myMethod:(NSMutableArray*)arguments withDict:(NSMutableDictionary*)options; -The options parameter for the Objective-C plugin method is being deprecated, and it should not be used. For legacy reasons - the last JavaScript object passed in the args Array will be passed in as the options dictionary of the method in Objective-C. You must make sure that any JavaScript object that is passed in as an element in the args array occurs as the last item in the Array, if not it will throw off the array index of all subsequent parameters of the Array in Objective-C. Only one JavaScript object is supported for the options dictionary, and only the last one encountered will be passed to the native method. It is because of these error-prone reasons that they are being deprecated. \ No newline at end of file +The options parameter for the Objective-C plugin method is being deprecated, and it should not be used. For legacy reasons - the last JavaScript object passed in the args Array will be passed in as the options dictionary of the method in Objective-C. You must make sure that any JavaScript object that is passed in as an element in the args array occurs as the last item in the Array, if not it will throw off the array index of all subsequent parameters of the Array in Objective-C. Only one JavaScript object is supported for the options dictionary, and only the last one encountered will be passed to the native method. It is because of these error-prone reasons that they are being deprecated.
