Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit a3ff04d1 authored by Treehugger Robot's avatar Treehugger Robot Committed by Automerger Merge Worker
Browse files

Merge "Add documentation to Vibrator on foreground/background app behavior"... 

Merge "Add documentation to Vibrator on foreground/background app behavior" am: 8ceda33e am: 53720c43

Original change: https://android-review.googlesource.com/c/platform/frameworks/base/+/1567201

Change-Id: I5d8500c398b6504a29a3e438461b5bcd41b44a75
parents 89f765a9 53720c43

core/java/android/os/Vibrator.java

+29 −0
Original line number Diff line number Diff line
@@ -327,6 +327,8 @@ public abstract class Vibrator { 
    /**

     * Vibrate constantly for the specified period of time.

     *

     * <p>The app should be in foreground for the vibration to happen.</p>

     *

     * @param milliseconds The number of milliseconds to vibrate.

     * @deprecated Use {@link #vibrate(VibrationEffect)} instead.

     */
@@ -339,6 +341,9 @@ public abstract class Vibrator { 
    /**

     * Vibrate constantly for the specified period of time.

     *

     * <p>The app should be in foreground for the vibration to happen. Background apps should

     * specify a ringtone, notification or alarm usage in order to vibrate.</p>

     *

     * @param milliseconds The number of milliseconds to vibrate.

     * @param attributes   {@link AudioAttributes} corresponding to the vibration. For example,

     *                     specify {@link AudioAttributes#USAGE_ALARM} for alarm vibrations or
@@ -373,6 +378,8 @@ public abstract class Vibrator { 
     * to start the repeat, or -1 to disable repeating.

     * </p>

     *

     * <p>The app should be in foreground for the vibration to happen.</p>

     *

     * @param pattern an array of longs of times for which to turn the vibrator on or off.

     * @param repeat  the index into pattern at which to repeat, or -1 if

     *                you don't want to repeat.
@@ -398,6 +405,9 @@ public abstract class Vibrator { 
     * to start the repeat, or -1 to disable repeating.

     * </p>

     *

     * <p>The app should be in foreground for the vibration to happen. Background apps should

     * specify a ringtone, notification or alarm usage in order to vibrate.</p>

     *

     * @param pattern    an array of longs of times for which to turn the vibrator on or off.

     * @param repeat     the index into pattern at which to repeat, or -1 if

     *                   you don't want to repeat.
@@ -425,11 +435,30 @@ public abstract class Vibrator { 
        }

    }



    /**

     * Vibrate with a given effect.

     *

     * <p>The app should be in foreground for the vibration to happen.</p>

     *

     * @param vibe {@link VibrationEffect} describing the vibration to be performed.

     */

    @RequiresPermission(android.Manifest.permission.VIBRATE)

    public void vibrate(VibrationEffect vibe) {

        vibrate(vibe, null);

    }



    /**

     * Vibrate with a given effect.

     *

     * <p>The app should be in foreground for the vibration to happen. Background apps should

     * specify a ringtone, notification or alarm usage in order to vibrate.</p>

     *

     * @param vibe       {@link VibrationEffect} describing the vibration to be performed.

     * @param attributes {@link AudioAttributes} corresponding to the vibration. For example,

     *                   specify {@link AudioAttributes#USAGE_ALARM} for alarm vibrations or

     *                   {@link AudioAttributes#USAGE_NOTIFICATION_RINGTONE} for

     *                   vibrations associated with incoming calls.

     */

    @RequiresPermission(android.Manifest.permission.VIBRATE)

    public void vibrate(VibrationEffect vibe, AudioAttributes attributes) {

        vibrate(Process.myUid(), mPackageName, vibe, null, attributes);