Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update Vibrator documentation for support check methods.

Browse Source 
Update documentation for methods areAllEffectsSupported and areAllPrimitivesSupported to explain the default behavior for empty queries. The behavior remains unchanged.

Change-Id: I23dd792af7e3ee2c70fec136fb7db4965a7195be
Fix: 237509304
Test: N/A
This commit is contained in:
Lais Andrade
2022-10-14 14:30:43 +00:00
parent 8314a3e51b
commit ba35aa1ebf
1 changed files with 7 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
core/java/android/os/Vibrator.java
View File

@@ -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) {