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: Este plugin se alinea con la vibración W3C especificación http://www.w3.org/TR/vibration/
michael@0: 
michael@0: Este plugin proporciona una manera de vibrar el dispositivo.
michael@0: 
michael@0: ## Instalación
michael@0: 
michael@0:     cordova plugin add org.apache.cordova.vibration
michael@0:     
michael@0: 
michael@0: ## Plataformas soportadas
michael@0: 
michael@0: Navigator.Vibrate  
michael@0: Navigator.Notification.Vibrate - Amazon fuego OS - sistema operativo Android - BlackBerry 10 - Firefox - iOS - Windows Phone 7 y 8
michael@0: 
michael@0: navigator.notification.vibrateWithPattern,  
michael@0: navigator.notification.cancelVibration - Android
michael@0: 
michael@0: ## vibrar (recomendado)
michael@0: 
michael@0: Esta función tiene tres diferentes funcionalidades basadas en los parámetros pasados a él.
michael@0: 
michael@0: ### Estándar de vibrar
michael@0: 
michael@0: Vibra el dispositivo para una cantidad dada de tiempo.
michael@0: 
michael@0:     navigator.vibrate(time)
michael@0:     
michael@0: 
michael@0: o
michael@0: 
michael@0:     navigator.vibrate([time])
michael@0:     
michael@0: 
michael@0: -**tiempo**: milisegundos a vibrar el dispositivo. *(Número)*
michael@0: 
michael@0: #### Ejemplo
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 rarezas
michael@0: 
michael@0: *   **time**: ignora el tiempo especificado y vibra por un tiempo preestablecido.
michael@0:     
michael@0:     navigator.vibrate(3000); // 3000 is ignored
michael@0: 
michael@0: #### Windows y rarezas de Blackberry
michael@0: 
michael@0: *   **tiempo**: tiempo máximo es 5000ms (5s) y min tiempo 1ms
michael@0:     
michael@0:     navigator.vibrate(8000); // will be truncated to 5000
michael@0: 
michael@0: ### Vibrar con un patrón (Android y Windows solamente)
michael@0: 
michael@0: Vibra el dispositivo con un patrón determinado
michael@0: 
michael@0:     navigator.vibrate(pattern);   
michael@0:     
michael@0: 
michael@0: *   **patrón**: secuencia de duraciones (en milisegundos) que desea activar o desactivar el vibrador. *(Matriz de números)*
michael@0: 
michael@0: #### Ejemplo
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: ### Cancelar vibración (no soportada en iOS)
michael@0: 
michael@0: Inmediatamente se cancela cualquier vibración actualmente en ejecución.
michael@0: 
michael@0:     navigator.vibrate(0)
michael@0:     
michael@0: 
michael@0: o
michael@0: 
michael@0:     navigator.vibrate([])
michael@0:     
michael@0: 
michael@0: o
michael@0: 
michael@0:     navigator.vibrate([0])
michael@0:     
michael@0: 
michael@0: Pasando en un parámetro de 0, una matriz vacía o una matriz con un elemento de valor 0 se cancelará cualquier vibraciones.
michael@0: 
michael@0: ## *Notification.Vibrate (obsoleto)
michael@0: 
michael@0: Vibra el dispositivo para una cantidad dada de tiempo.
michael@0: 
michael@0:     navigator.notification.vibrate(time)
michael@0:     
michael@0: 
michael@0: *   **tiempo**: milisegundos a vibrar el dispositivo. *(Número)*
michael@0: 
michael@0: ### Ejemplo
michael@0: 
michael@0:     // Vibrate for 2.5 seconds
michael@0:     navigator.notification.vibrate(2500);
michael@0:     
michael@0: 
michael@0: ### iOS rarezas
michael@0: 
michael@0: *   **time**: ignora el tiempo especificado y vibra por un tiempo preestablecido.
michael@0:     
michael@0:         navigator.notification.vibrate();
michael@0:         navigator.notification.vibrate(2500);   // 2500 is ignored
michael@0:         
michael@0: 
michael@0: ## *Notification.vibrateWithPattern (obsoleto)
michael@0: 
michael@0: Vibra el dispositivo con un patrón determinado.
michael@0: 
michael@0:     navigator.notification.vibrateWithPattern(pattern, repeat)
michael@0:     
michael@0: 
michael@0: *   **patrón**: secuencia de duraciones (en milisegundos) que desea activar o desactivar el vibrador. *(Matriz de números)*
michael@0: *   **repito**: índice opcional en la matriz de patrón en el cual comenzar repitiendo (se repite hasta que se cancele), o -1 para la no repetición (por defecto). *(Número)*
michael@0: 
michael@0: ### Ejemplo
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 (obsoleto)
michael@0: 
michael@0: Inmediatamente se cancela cualquier vibración actualmente en ejecución.
michael@0: 
michael@0:     navigator.notification.cancelVibration()
michael@0:     
michael@0: 
michael@0: * Nota: debido a la alineación con la especificación del w3c, los métodos favoritos a ser eliminados