michael@0: <!---
michael@0:     Licensed to the Apache Software Foundation (ASF) under one
michael@0:     or more contributor license agreements.  See the NOTICE file
michael@0:     distributed with this work for additional information
michael@0:     regarding copyright ownership.  The ASF licenses this file
michael@0:     to you under the Apache License, Version 2.0 (the
michael@0:     "License"); you may not use this file except in compliance
michael@0:     with the License.  You may obtain a copy of the License at
michael@0: 
michael@0:       http://www.apache.org/licenses/LICENSE-2.0
michael@0: 
michael@0:     Unless required by applicable law or agreed to in writing,
michael@0:     software distributed under the License is distributed on an
michael@0:     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
michael@0:     KIND, either express or implied.  See the License for the
michael@0:     specific language governing permissions and limitations
michael@0:     under the License.
michael@0: -->
michael@0: 
michael@0: # org.apache.cordova.vibration
michael@0: 
michael@0: Ce plugin s'aligne avec le W3C vibration spécification http://www.w3.org/TR/vibration/
michael@0: 
michael@0: Ce plugin permet de vibrer l'appareil.
michael@0: 
michael@0: ## Installation
michael@0: 
michael@0:     cordova plugin add org.apache.cordova.vibration
michael@0:     
michael@0: 
michael@0: ## Plates-formes prises en charge
michael@0: 
michael@0: Navigator.VIBRATE  
michael@0: Navigator.notification.VIBRATE - Amazon Fire OS - Android - BlackBerry 10 - Firefox OS - iOS - Windows Phone 7 et 8
michael@0: 
michael@0: navigator.notification.vibrateWithPattern,  
michael@0: navigator.notification.cancelVibration - Android
michael@0: 
michael@0: ## vibrer (recommandée)
michael@0: 
michael@0: Cette fonction a trois différentes fonctionnalités basées sur les paramètres passés à elle.
michael@0: 
michael@0: ### Norme vibrer
michael@0: 
michael@0: Vibre l'appareil pendant un certain temps.
michael@0: 
michael@0:     navigator.vibrate(time)
michael@0:     
michael@0: 
michael@0: ou
michael@0: 
michael@0:     navigator.vibrate([time])
michael@0:     
michael@0: 
michael@0: -**temps**: millisecondes à vibrer l'appareil. *(Nombre)*
michael@0: 
michael@0: #### Exemple
michael@0: 
michael@0:     // Vibrate for 3 seconds
michael@0:     navigator.vibrate(3000);
michael@0:     
michael@0:     // Vibrate for 3 seconds
michael@0:     navigator.vibrate([3000]);
michael@0:     
michael@0: 
michael@0: #### iOS Quirks
michael@0: 
michael@0: *   **temps**: ne tient pas compte de la durée spécifiée et vibre pendant un temps prédéterminé.
michael@0:     
michael@0:     navigator.vibrate(3000); // 3000 is ignored
michael@0: 
michael@0: #### Windows et les bizarreries de Blackberry
michael@0: 
michael@0: *   **temps**: temps Max est 5000ms (5 s) et heure min est de 1 ms
michael@0:     
michael@0:     navigator.vibrate(8000); // will be truncated to 5000
michael@0: 
michael@0: ### Vibrer avec un motif (Android et Windows uniquement)
michael@0: 
michael@0: Vibre l'appareil avec un motif donné
michael@0: 
michael@0:     navigator.vibrate(pattern);   
michael@0:     
michael@0: 
michael@0: *   **modèle**: séquence de la durée (en millisecondes) pour lequel activer ou désactiver le vibreur. *(Tableau de nombres)*
michael@0: 
michael@0: #### Exemple
michael@0: 
michael@0:     // Vibrate for 1 second
michael@0:     // Wait for 1 second
michael@0:     // Vibrate for 3 seconds
michael@0:     // Wait for 1 second
michael@0:     // Vibrate for 5 seconds
michael@0:     navigator.vibrate([1000, 1000, 3000, 1000, 5000]);
michael@0:     
michael@0: 
michael@0: ### Annuler les vibrations (ne pas de prise en charge d'iOS)
michael@0: 
michael@0: Immédiatement annule des vibrations en cours d'exécution.
michael@0: 
michael@0:     navigator.vibrate(0)
michael@0:     
michael@0: 
michael@0: ou
michael@0: 
michael@0:     navigator.vibrate([])
michael@0:     
michael@0: 
michael@0: ou
michael@0: 
michael@0:     navigator.vibrate([0])
michael@0:     
michael@0: 
michael@0: En passant un paramètre de 0, un tableau vide, ou un tableau contenant un seul élément de valeur 0 annulera toute vibration.
michael@0: 
michael@0: ## *notification.VIBRATE (obsolète)
michael@0: 
michael@0: Vibre l'appareil pendant un certain temps.
michael@0: 
michael@0:     navigator.notification.vibrate(time)
michael@0:     
michael@0: 
michael@0: *   **temps**: millisecondes à vibrer l'appareil. *(Nombre)*
michael@0: 
michael@0: ### Exemple
michael@0: 
michael@0:     // Vibrate for 2.5 seconds
michael@0:     navigator.notification.vibrate(2500);
michael@0:     
michael@0: 
michael@0: ### iOS Quirks
michael@0: 
michael@0: *   **temps**: ne tient pas compte de la durée spécifiée et vibre pendant un temps prédéterminé.
michael@0:     
michael@0:         navigator.notification.vibrate();
michael@0:         navigator.notification.vibrate(2500);   // 2500 is ignored
michael@0:         
michael@0: 
michael@0: ## *notification.vibrateWithPattern (obsolète)
michael@0: 
michael@0: Vibre l'appareil avec un modèle donné.
michael@0: 
michael@0:     navigator.notification.vibrateWithPattern(pattern, repeat)
michael@0:     
michael@0: 
michael@0: *   **modèle**: séquence de la durée (en millisecondes) pour lequel activer ou désactiver le vibreur. *(Tableau de nombres)*
michael@0: *   **répéter**: optionnel index dans le tableau de configuration à laquelle commencer à répéter (répétera jusqu'à annulation), ou -1 pour aucune répétition (par défaut). *(Nombre)*
michael@0: 
michael@0: ### Exemple
michael@0: 
michael@0:     // Immediately start vibrating
michael@0:     // vibrate for 100ms,
michael@0:     // wait for 100ms,
michael@0:     // vibrate for 200ms,
michael@0:     // wait for 100ms,
michael@0:     // vibrate for 400ms,
michael@0:     // wait for 100ms,
michael@0:     // vibrate for 800ms,
michael@0:     // (do not repeat)
michael@0:     navigator.notification.vibrateWithPattern([0, 100, 100, 200, 100, 400, 100, 800]);
michael@0:     
michael@0: 
michael@0: ## *notification.cancelVibration (obsolète)
michael@0: 
michael@0: Immédiatement annule des vibrations en cours d'exécution.
michael@0: 
michael@0:     navigator.notification.cancelVibration()
michael@0:     
michael@0: 
michael@0: * Remarque : en raison de l'alignement avec les spécifications w3c, les méthodes étoilées seront progressivement