Language

NotificationChannel.VibrationEffect Property

Definition

Returns the VibrationEffect for notifications posted to this channel.

public Android.OS.VibrationEffect? VibrationEffect { [Android.Runtime.Register("getVibrationEffect", "()Landroid/os/VibrationEffect;", "", ApiSince=35)] get; [Android.Runtime.Register("setVibrationEffect", "(Landroid/os/VibrationEffect;)V", "", ApiSince=35)] set; }
[<get: Android.Runtime.Register("getVibrationEffect", "()Landroid/os/VibrationEffect;", "", ApiSince=35)>]
[<set: Android.Runtime.Register("setVibrationEffect", "(Landroid/os/VibrationEffect;)V", "", ApiSince=35)>]
member this.VibrationEffect : Android.OS.VibrationEffect with get, set

Property Value

the VibrationEffect set via setVibrationEffect(VibrationEffect), or the equivalent of the vibration set via setVibrationPattern(long[]). This value may be null.

Attributes

Remarks

Returns the VibrationEffect for notifications posted to this channel. The returned effect is derived from either the effect provided in the setVibrationEffect(VibrationEffect) method, or the equivalent vibration effect of the pattern set via the setVibrationPattern(long[]) method, based on setter method that was called last. The returned effect will be ignored in one of the following cases: vibration is not enabled for the channel (i.e. shouldVibrate() returns false). the effect is not supported/playable by the device. In this case, if vibration is enabled for the channel, the default channel vibration will be used instead.

See also:

Android reference for android.app.NotificationChannel.getVibrationEffect.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to