cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jso...@apache.org
Subject cordova-plugin-dialogs git commit: CB-7977 Mention deviceready in plugin docs
Date Wed, 12 Nov 2014 17:42:48 GMT
Repository: cordova-plugin-dialogs
Updated Branches:
  refs/heads/master 23bebf96f -> 06a1dea0a


CB-7977 Mention deviceready in plugin docs


Project: http://git-wip-us.apache.org/repos/asf/cordova-plugin-dialogs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-plugin-dialogs/commit/06a1dea0
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-dialogs/tree/06a1dea0
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-dialogs/diff/06a1dea0

Branch: refs/heads/master
Commit: 06a1dea0a50cfa8cbf1dcdd837672706fccf907e
Parents: 23bebf9
Author: Josh Soref <jsoref@blackberry.com>
Authored: Thu Nov 6 17:10:15 2014 -0500
Committer: Josh Soref <jsoref@blackberry.com>
Committed: Wed Nov 12 12:42:14 2014 -0500

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


http://git-wip-us.apache.org/repos/asf/cordova-plugin-dialogs/blob/06a1dea0/doc/index.md
----------------------------------------------------------------------
diff --git a/doc/index.md b/doc/index.md
index c929cb0..442849c 100644
--- a/doc/index.md
+++ b/doc/index.md
@@ -19,7 +19,15 @@
 
 # org.apache.cordova.dialogs
 
-This plugin provides access to some native dialog UI elements.
+This plugin provides access to some native dialog UI elements
+via a global `navigator.notification` object.
+
+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.notification);
+    }
 
 ## Installation
 


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


Mime
View raw message