185 lines
5.2 KiB
Markdown
185 lines
5.2 KiB
Markdown
|
<!---
|
||
|
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.
|
||
|
-->
|
||
|
|
||
|
# cordova-plugin-vibration
|
||
|
|
||
|
このプラグインに準拠 W3C 振動仕様 http://www.w3.org/TR/vibration/
|
||
|
|
||
|
このプラグインは、デバイスを振動させる方法を提供します。
|
||
|
|
||
|
このプラグインは `navigator.vibrate` などのグローバル オブジェクトを定義します.
|
||
|
|
||
|
グローバル スコープでは使用できませんまで `deviceready` イベントの後です。
|
||
|
|
||
|
document.addEventListener("deviceready", onDeviceReady, false);
|
||
|
function onDeviceReady() {
|
||
|
console.log(navigator.vibrate);
|
||
|
}
|
||
|
|
||
|
|
||
|
## インストール
|
||
|
|
||
|
cordova plugin add cordova-plugin-vibration
|
||
|
|
||
|
|
||
|
## サポートされているプラットフォーム
|
||
|
|
||
|
navigator.vibrate,
|
||
|
navigator.notification.vibrate - Amazon Fire OS - Android - BlackBerry 10 - Firefox OS - iOS - Windows Phone 7 and 8
|
||
|
|
||
|
navigator.notification.vibrateWithPattern,
|
||
|
navigator.notification.cancelVibration - Android - Windows Phone 8
|
||
|
|
||
|
## 振動 (推奨)
|
||
|
|
||
|
この関数は、渡されたパラメーターに基づいて 3 つのさまざまな機能。
|
||
|
|
||
|
### 標準を振動します。
|
||
|
|
||
|
一定の時間のため、デバイスが振動します。
|
||
|
|
||
|
navigator.vibrate(time)
|
||
|
|
||
|
|
||
|
または
|
||
|
|
||
|
navigator.vibrate([time])
|
||
|
|
||
|
|
||
|
-**time**: ミリ秒、デバイスを振動させる。*(数)*
|
||
|
|
||
|
#### 例
|
||
|
|
||
|
// Vibrate for 3 seconds
|
||
|
navigator.vibrate(3000);
|
||
|
|
||
|
// Vibrate for 3 seconds
|
||
|
navigator.vibrate([3000]);
|
||
|
|
||
|
|
||
|
#### iOS の癖
|
||
|
|
||
|
* **時間**: 指定された時間を無視し、時間の事前に設定された量のために振動します。
|
||
|
|
||
|
navigator.vibrate(3000); // 3000 is ignored
|
||
|
|
||
|
#### Windows とブラックベリー癖
|
||
|
|
||
|
* **時間**: 5000 (5 秒) は、最大時間と最小時間は 1 ms
|
||
|
|
||
|
navigator.vibrate(8000); // will be truncated to 5000
|
||
|
|
||
|
### (人造人間と Windows のみ) パターンで振動します。
|
||
|
|
||
|
特定のパターンを持つデバイスが振動します。
|
||
|
|
||
|
navigator.vibrate(pattern);
|
||
|
|
||
|
|
||
|
* **パターン**: シーケンスの継続時間 (ミリ秒単位) をオンまたはオフ、バイブします。*(数字の配列)*
|
||
|
|
||
|
#### 例
|
||
|
|
||
|
// 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 癖
|
||
|
|
||
|
* 既定の期間の振動で戻る vibrate(pattern) の滝
|
||
|
|
||
|
### [キャンセル] 振動 (iOS ではサポートされていません)
|
||
|
|
||
|
すぐに、現在実行中の振動をキャンセルします。
|
||
|
|
||
|
navigator.vibrate(0)
|
||
|
|
||
|
|
||
|
または
|
||
|
|
||
|
navigator.vibrate([])
|
||
|
|
||
|
|
||
|
または
|
||
|
|
||
|
navigator.vibrate([0])
|
||
|
|
||
|
|
||
|
0 のパラメーターを渡して、空の配列、または 0 の値の 1 つの要素を持つ配列は任意振動がキャンセルされます。
|
||
|
|
||
|
## *notification.vibrate (非推奨)
|
||
|
|
||
|
一定の時間のため、デバイスが振動します。
|
||
|
|
||
|
navigator.notification.vibrate(time)
|
||
|
|
||
|
|
||
|
* **time**: ミリ秒、デバイスを振動させる。*(数)*
|
||
|
|
||
|
### 例
|
||
|
|
||
|
// Vibrate for 2.5 seconds
|
||
|
navigator.notification.vibrate(2500);
|
||
|
|
||
|
|
||
|
### iOS の癖
|
||
|
|
||
|
* **時間**: 指定された時間を無視し、時間の事前に設定された量のために振動します。
|
||
|
|
||
|
navigator.notification.vibrate();
|
||
|
navigator.notification.vibrate(2500); // 2500 is ignored
|
||
|
|
||
|
|
||
|
## *notification.vibrateWithPattern (非推奨)
|
||
|
|
||
|
特定のパターンを持つデバイスが振動します。
|
||
|
|
||
|
navigator.notification.vibrateWithPattern(pattern, repeat)
|
||
|
|
||
|
|
||
|
* **pattern**: シーケンスの継続時間 (ミリ秒単位) をオンまたはオフ、バイブします。*(数字の配列)*
|
||
|
* **repeat**: 省略可能な配列のインデックスのパターン (でしょう) を繰り返す取り消されるまで、繰り返しを開始するまたは反復なし (既定値) の場合は-1。*(数)*
|
||
|
|
||
|
### 例
|
||
|
|
||
|
// 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 (非推奨)
|
||
|
|
||
|
すぐに、現在実行中の振動をキャンセルします。
|
||
|
|
||
|
navigator.notification.cancelVibration()
|
||
|
|
||
|
|
||
|
* 注 - w3c の仕様を配置、ため主演メソッドがフェーズ アウトされます。
|