react-native/Libraries/Vibration/VibrationIOS.ios.js

45 lines
1.1 KiB
JavaScript

/**
* Copyright (c) 2015-present, Facebook, Inc.
* All rights reserved.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree. An additional grant
* of patent rights can be found in the PATENTS file in the same directory.
*
* @providesModule VibrationIOS
* @flow
*/
'use strict';
var RCTVibration = require('NativeModules').Vibration;
var invariant = require('fbjs/lib/invariant');
/**
* NOTE: `VibrationIOS` is being deprecated. Use `Vibration` instead.
*
* The Vibration API is exposed at `VibrationIOS.vibrate()`. On iOS, calling this
* function will trigger a one second vibration. The vibration is asynchronous
* so this method will return immediately.
*
* There will be no effect on devices that do not support Vibration, eg. the iOS
* simulator.
*
* Vibration patterns are currently unsupported.
*/
var VibrationIOS = {
/**
* @deprecated
*/
vibrate: function() {
invariant(
arguments[0] === undefined,
'Vibration patterns not supported.'
);
RCTVibration.vibrate();
}
};
module.exports = VibrationIOS;