Return-Path: X-Original-To: apmail-cordova-commits-archive@www.apache.org Delivered-To: apmail-cordova-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id A32EACCF9 for ; Thu, 7 Aug 2014 17:28:27 +0000 (UTC) Received: (qmail 82528 invoked by uid 500); 7 Aug 2014 17:28:26 -0000 Delivered-To: apmail-cordova-commits-archive@cordova.apache.org Received: (qmail 82426 invoked by uid 500); 7 Aug 2014 17:28:26 -0000 Mailing-List: contact commits-help@cordova.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@cordova.apache.org Delivered-To: mailing list commits@cordova.apache.org Received: (qmail 82325 invoked by uid 99); 7 Aug 2014 17:28:26 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 07 Aug 2014 17:28:26 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id D0B029C2F41; Thu, 7 Aug 2014 17:28:25 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: ldeluca@apache.org To: commits@cordova.apache.org Date: Thu, 07 Aug 2014 17:28:28 -0000 Message-Id: <69ad89ee193941c8bc7e257d62c055f7@git.apache.org> In-Reply-To: <29c76e848d7b4d958418d17fe263bc7a@git.apache.org> References: <29c76e848d7b4d958418d17fe263bc7a@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [4/5] git commit: CB-7249cordova-plugin-vibration documentation translation: cordova-plugin-vibration CB-7249cordova-plugin-vibration documentation translation: cordova-plugin-vibration 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/098128c4 Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-vibration/tree/098128c4 Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-vibration/diff/098128c4 Branch: refs/heads/master Commit: 098128c49d0c57473d113dd90fd80566e24000d3 Parents: cf2a5af Author: Lisa Seacat DeLuca Authored: Thu Aug 7 12:58:41 2014 -0400 Committer: Lisa Seacat DeLuca Committed: Thu Aug 7 12:58:41 2014 -0400 ---------------------------------------------------------------------- doc/index.md | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 64 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cordova-plugin-vibration/blob/098128c4/doc/index.md ---------------------------------------------------------------------- diff --git a/doc/index.md b/doc/index.md index c517ce5..20cede8 100644 --- a/doc/index.md +++ b/doc/index.md @@ -27,6 +27,7 @@ This plugin provides a way to vibrate the device. ## Supported Platforms +navigator.vibrate
navigator.notification.vibrate - Amazon Fire OS - Android @@ -38,7 +39,65 @@ navigator.notification.vibrate navigator.notification.vibrateWithPattern,
navigator.notification.cancelVibration - Android -## notification.vibrate +## 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) + +-__time__: Milliseconds to vibrate the device. _(Number)_ + +####Example + + // 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) + + navigator.vibrate(8000); // will be truncated to 5000 + +###Vibrate with a pattern (Android 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]); + +###Cancel vibration (not supported in iOS) + +Immediately cancels any currently running vibration. + + navigator.vibrate(0) + +or + + navigator.vibrate([]) + +Passing in a parameter of 0 or an empty array will cancel any vibrations. + +## *notification.vibrate (deprecated) Vibrates the device for a given amount of time. @@ -58,7 +117,7 @@ Vibrates the device for a given amount of time. navigator.notification.vibrate(); navigator.notification.vibrate(2500); // 2500 is ignored -## notification.vibrateWithPattern +## *notification.vibrateWithPattern (deprecated) Vibrates the device with a given pattern. @@ -80,8 +139,10 @@ Vibrates the device with a given pattern. // (do not repeat) navigator.notification.vibrateWithPattern([0, 100, 100, 200, 100, 400, 100, 800]); -## notification.cancelVibration +## *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