cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ste...@apache.org
Subject cordova-plugin-vibration git commit: CB-8653 Updated Readme
Date Sat, 14 Mar 2015 02:46:04 GMT
Repository: cordova-plugin-vibration
Updated Branches:
  refs/heads/master f45e3855c -> 22ce5bd2b


CB-8653 Updated Readme


Project: http://git-wip-us.apache.org/repos/asf/cordova-plugin-vibration/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-plugin-vibration/commit/22ce5bd2
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-vibration/tree/22ce5bd2
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-vibration/diff/22ce5bd2

Branch: refs/heads/master
Commit: 22ce5bd2ba93be88b13b3f72958a4603d256784d
Parents: f45e385
Author: Steve Gill <stevengill97@gmail.com>
Authored: Fri Mar 13 19:45:51 2015 -0700
Committer: Steve Gill <stevengill97@gmail.com>
Committed: Fri Mar 13 19:45:51 2015 -0700

----------------------------------------------------------------------
 README.md    | 156 +++++++++++++++++++++++++++++++++++++++++++++++-
 doc/index.md | 175 ------------------------------------------------------
 2 files changed, 154 insertions(+), 177 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-plugin-vibration/blob/22ce5bd2/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 412d7d8..842e771 100644
--- a/README.md
+++ b/README.md
@@ -17,9 +17,161 @@
          under the License.
 -->
 
-# org.apache.cordova.vibration
+# cordova-plugin-vibration
 
 [![Build Status](https://travis-ci.org/apache/cordova-plugin-vibration.svg)](https://travis-ci.org/apache/cordova-plugin-vibration)
 
-Plugin documentation: [doc/index.md](doc/index.md)
+This plugin aligns with the W3C vibration specification http://www.w3.org/TR/vibration/
 
+This plugin provides a way to vibrate the device.
+
+This plugin defines global objects including `navigator.vibrate`.
+
+Although in the global scope, they are not available until after the `deviceready` event.
+
+    document.addEventListener("deviceready", onDeviceReady, false);
+    function onDeviceReady() {
+        console.log(navigator.vibrate);
+    }
+
+## Installation
+
+    cordova plugin add cordova-plugin-vibration
+
+## Supported Platforms
+
+navigator.vibrate,<br />
+navigator.notification.vibrate
+- Amazon Fire OS
+- Android
+- BlackBerry 10
+- Firefox OS
+- iOS
+- Windows Phone 7 and 8
+
+navigator.notification.vibrateWithPattern,<br />navigator.notification.cancelVibration
+- Android
+- Windows Phone 8
+
+## vibrate (recommended)
+
+This function has three different functionalities based on parameters passed to it.
+
+###Standard vibrate
+
+Vibrates the device for a given amount of time.
+
+    navigator.vibrate(time)
+
+or
+
+    navigator.vibrate([time])
+
+
+-__time__: Milliseconds to vibrate the device. _(Number)_
+
+####Example
+
+    // Vibrate for 3 seconds
+    navigator.vibrate(3000);
+
+    // Vibrate for 3 seconds
+    navigator.vibrate([3000]);
+
+####iOS Quirks
+
+- __time__: Ignores the specified time and vibrates for a pre-set amount of time.
+
+    navigator.vibrate(3000); // 3000 is ignored
+
+####Windows and Blackberry Quirks
+
+- __time__: Max time is 5000ms (5s) and min time is 1ms
+
+    navigator.vibrate(8000); // will be truncated to 5000
+
+###Vibrate with a pattern (Android and Windows only)
+Vibrates the device with a given pattern
+
+    navigator.vibrate(pattern);   
+
+- __pattern__: Sequence of durations (in milliseconds) for which to turn on or off the vibrator.
_(Array of Numbers)_
+
+####Example
+
+    // Vibrate for 1 second
+    // Wait for 1 second
+    // Vibrate for 3 seconds
+    // Wait for 1 second
+    // Vibrate for 5 seconds
+    navigator.vibrate([1000, 1000, 3000, 1000, 5000]);
+
+####Windows Phone 8 Quirks
+
+- vibrate(pattern) falls back on vibrate with default duration
+
+###Cancel vibration (not supported in iOS)
+
+Immediately cancels any currently running vibration.
+
+    navigator.vibrate(0)
+
+or
+
+    navigator.vibrate([])
+
+or
+
+    navigator.vibrate([0])
+
+Passing in a parameter of 0, an empty array, or an array with one element of value 0 will
cancel any vibrations.
+
+## *notification.vibrate (deprecated)
+
+Vibrates the device for a given amount of time.
+
+    navigator.notification.vibrate(time)
+
+- __time__: Milliseconds to vibrate the device. _(Number)_
+
+### Example
+
+    // Vibrate for 2.5 seconds
+    navigator.notification.vibrate(2500);
+
+### iOS Quirks
+
+- __time__: Ignores the specified time and vibrates for a pre-set amount of time.
+
+        navigator.notification.vibrate();
+        navigator.notification.vibrate(2500);   // 2500 is ignored
+
+## *notification.vibrateWithPattern (deprecated)
+
+Vibrates the device with a given pattern.
+
+    navigator.notification.vibrateWithPattern(pattern, repeat)
+
+- __pattern__: Sequence of durations (in milliseconds) for which to turn on or off the vibrator.
_(Array of Numbers)_
+- __repeat__: Optional index into the pattern array at which to start repeating (will repeat
until canceled), or -1 for no repetition (default). _(Number)_
+
+### Example
+
+    // Immediately start vibrating
+    // vibrate for 100ms,
+    // wait for 100ms,
+    // vibrate for 200ms,
+    // wait for 100ms,
+    // vibrate for 400ms,
+    // wait for 100ms,
+    // vibrate for 800ms,
+    // (do not repeat)
+    navigator.notification.vibrateWithPattern([0, 100, 100, 200, 100, 400, 100, 800]);
+
+## *notification.cancelVibration (deprecated)
+
+Immediately cancels any currently running vibration.
+
+    navigator.notification.cancelVibration()
+
+*Note - due to alignment with w3c spec, the starred methods will be phased out

http://git-wip-us.apache.org/repos/asf/cordova-plugin-vibration/blob/22ce5bd2/doc/index.md
----------------------------------------------------------------------
diff --git a/doc/index.md b/doc/index.md
deleted file mode 100644
index 7bfff54..0000000
--- a/doc/index.md
+++ /dev/null
@@ -1,175 +0,0 @@
-<!---
-    Licensed to the Apache Software Foundation (ASF) under one
-    or more contributor license agreements.  See the NOTICE file
-    distributed with this work for additional information
-    regarding copyright ownership.  The ASF licenses this file
-    to you under the Apache License, Version 2.0 (the
-    "License"); you may not use this file except in compliance
-    with the License.  You may obtain a copy of the License at
-
-      http://www.apache.org/licenses/LICENSE-2.0
-
-    Unless required by applicable law or agreed to in writing,
-    software distributed under the License is distributed on an
-    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-    KIND, either express or implied.  See the License for the
-    specific language governing permissions and limitations
-    under the License.
--->
-
-# org.apache.cordova.vibration
-
-This plugin aligns with the W3C vibration specification http://www.w3.org/TR/vibration/
-
-This plugin provides a way to vibrate the device.
-
-This plugin defines global objects including `navigator.vibrate`.
-
-Although in the global scope, they are not available until after the `deviceready` event.
-
-    document.addEventListener("deviceready", onDeviceReady, false);
-    function onDeviceReady() {
-        console.log(navigator.vibrate);
-    }
-
-## Installation
-
-    cordova plugin add org.apache.cordova.vibration
-
-## Supported Platforms
-
-navigator.vibrate,<br />
-navigator.notification.vibrate
-- Amazon Fire OS
-- Android
-- BlackBerry 10
-- Firefox OS
-- iOS
-- Windows Phone 7 and 8
-
-navigator.notification.vibrateWithPattern,<br />navigator.notification.cancelVibration
-- Android
-- Windows Phone 8
-
-## vibrate (recommended)
-
-This function has three different functionalities based on parameters passed to it.
-
-###Standard vibrate
-
-Vibrates the device for a given amount of time.
-
-    navigator.vibrate(time)
-
-or
-
-    navigator.vibrate([time])
-
-
--__time__: Milliseconds to vibrate the device. _(Number)_
-
-####Example
-
-    // Vibrate for 3 seconds
-    navigator.vibrate(3000);
-
-    // Vibrate for 3 seconds
-    navigator.vibrate([3000]);
-
-####iOS Quirks
-
-- __time__: Ignores the specified time and vibrates for a pre-set amount of time.
-
-    navigator.vibrate(3000); // 3000 is ignored
-
-####Windows and Blackberry Quirks
-
-- __time__: Max time is 5000ms (5s) and min time is 1ms
-
-    navigator.vibrate(8000); // will be truncated to 5000
-
-###Vibrate with a pattern (Android and Windows only)
-Vibrates the device with a given pattern
-
-    navigator.vibrate(pattern);   
-
-- __pattern__: Sequence of durations (in milliseconds) for which to turn on or off the vibrator.
_(Array of Numbers)_
-
-####Example
-
-    // Vibrate for 1 second
-    // Wait for 1 second
-    // Vibrate for 3 seconds
-    // Wait for 1 second
-    // Vibrate for 5 seconds
-    navigator.vibrate([1000, 1000, 3000, 1000, 5000]);
-
-####Windows Phone 8 Quirks
-
-- vibrate(pattern) falls back on vibrate with default duration
-
-###Cancel vibration (not supported in iOS)
-
-Immediately cancels any currently running vibration.
-
-    navigator.vibrate(0)
-
-or
-
-    navigator.vibrate([])
-
-or
-
-    navigator.vibrate([0])
-
-Passing in a parameter of 0, an empty array, or an array with one element of value 0 will
cancel any vibrations.
-
-## *notification.vibrate (deprecated)
-
-Vibrates the device for a given amount of time.
-
-    navigator.notification.vibrate(time)
-
-- __time__: Milliseconds to vibrate the device. _(Number)_
-
-### Example
-
-    // Vibrate for 2.5 seconds
-    navigator.notification.vibrate(2500);
-
-### iOS Quirks
-
-- __time__: Ignores the specified time and vibrates for a pre-set amount of time.
-
-        navigator.notification.vibrate();
-        navigator.notification.vibrate(2500);   // 2500 is ignored
-
-## *notification.vibrateWithPattern (deprecated)
-
-Vibrates the device with a given pattern.
-
-    navigator.notification.vibrateWithPattern(pattern, repeat)
-
-- __pattern__: Sequence of durations (in milliseconds) for which to turn on or off the vibrator.
_(Array of Numbers)_
-- __repeat__: Optional index into the pattern array at which to start repeating (will repeat
until canceled), or -1 for no repetition (default). _(Number)_
-
-### Example
-
-    // Immediately start vibrating
-    // vibrate for 100ms,
-    // wait for 100ms,
-    // vibrate for 200ms,
-    // wait for 100ms,
-    // vibrate for 400ms,
-    // wait for 100ms,
-    // vibrate for 800ms,
-    // (do not repeat)
-    navigator.notification.vibrateWithPattern([0, 100, 100, 200, 100, 400, 100, 800]);
-
-## *notification.cancelVibration (deprecated)
-
-Immediately cancels any currently running vibration.
-
-    navigator.notification.cancelVibration()
-
-*Note - due to alignment with w3c spec, the starred methods will be phased out


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


Mime
View raw message