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

Commit aef7473d authored by Lais Andrade's avatar Lais Andrade Committed by Automerger Merge Worker
Browse files

Merge "Update Vibrator documentation for support check methods." am: 669bfab5 

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



Change-Id: Iaa8c45c265848faab5b1e12ad3b951746b06af0b
Signed-off-by: default avatarAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
parents 77567b04 669bfab5

core/java/android/os/Vibrator.java

+7 −4
Original line number Diff line number Diff line
@@ -527,7 +527,8 @@ public abstract class Vibrator { 
    }



    /**

     * Query whether the vibrator supports all the given effects.

     * Query whether the vibrator supports all the given effects. If no argument is provided this

     * method will always return {@link #VIBRATION_EFFECT_SUPPORT_YES}.

     *

     * <p>If an effect is not supported, the system may still automatically fall back to a simpler

     * vibration instead, which is not optimised for the specific device, however vibration isn't
@@ -549,7 +550,8 @@ public abstract class Vibrator { 
     * <p>Use {@link #areEffectsSupported(int...)} to get individual results for each effect.

     *

     * @param effectIds Which effects to query for.

     * @return Whether all the effects are natively supported by the device.

     * @return Whether all specified effects are natively supported by the device. Empty query

     * defaults to {@link #VIBRATION_EFFECT_SUPPORT_YES}.

     */

    @VibrationEffectSupport

    public final int areAllEffectsSupported(
@@ -598,7 +600,8 @@ public abstract class Vibrator { 
    }



    /**

     * Query whether the vibrator supports all of the given primitives.

     * Query whether the vibrator supports all of the given primitives.  If no argument is provided

     * this method will always return {@code true}.

     *

     * <p>If a primitive is not supported by the device, then <em>no vibration</em> will occur if

     * it is played.
@@ -606,7 +609,7 @@ public abstract class Vibrator { 
     * <p>Use {@link #arePrimitivesSupported(int...)} to get individual results for each primitive.

     *

     * @param primitiveIds Which primitives to query for.

     * @return Whether all specified primitives are supported.

     * @return Whether all specified primitives are supported. Empty query defaults to {@code true}.

     */

    public final boolean areAllPrimitivesSupported(

            @NonNull @VibrationEffect.Composition.PrimitiveType int... primitiveIds) {