VibrationDevice class

Applies to Windows Phone only

Vibrates the phone.

Syntax


public sealed class VibrationDevice

Attributes

[MarshalingBehavior(Agile)]
[Version(0x06020000)]

Members

The VibrationDevice class has these types of members:

Methods

The VibrationDevice class has these methods. It also inherits methods from the Object class.

MethodDescription
Cancel Stops the vibration of the phone.
GetDefault Gets an instance of the VibrationDevice class.
Vibrate Vibrates the phone for the specified duration (from 0 to 5 seconds).

 

Remarks

Windows Phone devices include a vibration controller. Your app can vibrate the phone for up to 5 seconds to notify the user of an important event.

Use the vibration feature in moderation. Do not rely on the vibration feature for critical notifications, because the user can disable vibration.

To test an app that uses the vibration controller effectively, you have to test it on a physical device. The emulator cannot simulate vibration and does not provide any audible or visual feedback that vibration is occurring.

An app that is running in the background cannot vibrate the phone. If your code tries to use vibration while the app is running in the background, nothing happens, but no exception is raised. If you want to vibrate the phone while your app is running in the background, you have to implement a toast notification.

Examples

You vibrate the phone by calling the Vibrate method of the VibrationDevice class.

  1. Import the Windows.Phone.Devices.Notification namespace.

    using Windows.Phone.Devices.Notification;
  2. Get a reference to the vibration controller by calling the static GetDefault method of the VibrationDevice class.

    VibrationDevice testVibrationDevice = VibrationDevice.GetDefault();
  3. Start the vibration by calling the Vibrate method of the VibrationDevice class. Specify the duration as a TimeSpan value.

    testVibrationDevice.Vibrate(TimeSpan.FromSeconds(3));
  4. If necessary, stop the vibration by calling the Cancel method of the VibrationDevice class.

    testVibrationDevice.Cancel();

Requirements

Minimum supported client

None supported [Windows Store apps only]

Minimum supported server

None supported [Windows Store apps only]

Minimum supported phone

Windows Phone 8

Namespace

Windows.Phone.Devices.Notification
Windows::Phone::Devices::Notification [C++]

Metadata

Windows.winmd

See also

Object

 

 

Community Additions

ADD
Show:
© 2014 Microsoft