Fix NotificationChannel#setVibrationPattern API Documentation

NotificationManagerService has a logic to fallback to a default vibration pattern if the channel has vibration enabled. Accordingly, this CL fixes the message in the setVibrationPattern API Javadoc.

Change-Id: I909819eb98e5fe3ab8b80f25db7437860ac560ca
This commit is contained in:
Yeabkal Wubshit
2022-07-03 06:26:03 +00:00
committed by Shreerag Jayakrishnan
parent d54dd08f1a
commit 12b1297938

View File

@@ -564,8 +564,10 @@ public final class NotificationChannel implements Parcelable {
/**
* Sets the vibration pattern for notifications posted to this channel. If the provided
* pattern is valid (non-null, non-empty), will {@link #enableVibration(boolean)} enable
* vibration} as well. Otherwise, vibration will be disabled.
* pattern is valid (non-null, non-empty), will enable vibration on this channel
* (equivalent to calling {@link #enableVibration(boolean)} with {@code true}).
* Otherwise, vibration will be disabled unless {@link #enableVibration(boolean)} is
* used with {@code true}, in which case the default vibration will be used.
*
* Only modifiable before the channel is submitted to
* {@link NotificationManager#createNotificationChannel(NotificationChannel)}.