VibrationDevice Class

Reference

Definition

Namespace:: Windows.Phone.Devices.Notification

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Vibrates the phone.

public ref class VibrationDevice sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Phone.PhoneContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class VibrationDevice final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Phone.PhoneContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class VibrationDevice

Public NotInheritable Class VibrationDevice

Inheritance: Object Platform::Object IInspectable VibrationDevice

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute

Windows requirements

Device family	Windows Mobile Extension SDK (introduced in 10.0.10240.0)
API contract	Windows.Phone.PhoneContract (introduced in v1.0)

Examples

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

Import the Windows.Phone.Devices.Notification namespace.

using Windows.Phone.Devices.Notification;

Get a reference to the vibration controller by calling the static GetDefault method of the VibrationDevice class.

VibrationDevice testVibrationDevice = VibrationDevice.GetDefault();

Start the vibration by calling the Vibrate method of the VibrationDevice class. Specify the duration as a TimeSpan value.

testVibrationDevice.Vibrate(TimeSpan.FromSeconds(3));

If necessary, stop the vibration by calling the Cancel method of the VibrationDevice class.

testVibrationDevice.Cancel();

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.

Methods

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

Applies to

Share via