cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jso...@apache.org
Subject [2/2] cordova-plugin-camera git commit: CB-7977 Mention deviceready in plugin docs
Date Wed, 12 Nov 2014 17:36:50 GMT
CB-7977 Mention deviceready in plugin docs


Project: http://git-wip-us.apache.org/repos/asf/cordova-plugin-camera/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-plugin-camera/commit/032531ae
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-camera/tree/032531ae
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-camera/diff/032531ae

Branch: refs/heads/master
Commit: 032531ae77cb00bd77b547ed2708c4eff123deb4
Parents: fb4cff9
Author: Josh Soref <jsoref@blackberry.com>
Authored: Thu Nov 6 17:02:58 2014 -0500
Committer: Josh Soref <jsoref@blackberry.com>
Committed: Thu Nov 6 17:34:12 2014 -0500

----------------------------------------------------------------------
 doc/index.md | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-plugin-camera/blob/032531ae/doc/index.md
----------------------------------------------------------------------
diff --git a/doc/index.md b/doc/index.md
index 48c8e5a..0aee1e6 100644
--- a/doc/index.md
+++ b/doc/index.md
@@ -19,9 +19,16 @@
 
 # org.apache.cordova.camera
 
-This plugin provides an API for taking pictures and for choosing images from
+This plugin defines a global `navigator.camera` object, which provides an API for taking
pictures and for choosing images from
 the system's image library.
 
+Although the object is attached to the global scoped `navigator`, it is not available until
after the `deviceready` event.
+
+    document.addEventListener("deviceready", onDeviceReady, false);
+    function onDeviceReady() {
+        console.log(navigator.camera);
+    }
+
 ## Installation
 
     cordova plugin add org.apache.cordova.camera


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org


Mime
View raw message