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

Commit 8b8f764d authored by Juan Sebastian Martinez's avatar Juan Sebastian Martinez
Browse files

Updating playToken API docstring. 

This adds a sentence to clarify what happens if no InteractionProperties
are supplied to the function. It now states that haptic feedback plays
as touch feedback.

Test: presubmit
Flag: NONE usage of this API is flagged by separately.
Bug: 344654090
Change-Id: I30ad6de0908ea982884c0bed73a5ca2b4733fd19
parent 9f36e3c0

msdllib/src/com/google/android/msdl/domain/MSDLPlayer.kt

+2 −1
Original line number Diff line number Diff line
@@ -46,7 +46,8 @@ interface MSDLPlayer { 
     *   properties can modify how a token plays (e.g.,

     *   [InteractionProperties.DynamicVibrationScale] for slider haptics in the

     *   [MSDLToken.DRAG_INDICATOR] token) and can be supplied if custom

     *   [android.os.VibrationAttributes] are required for haptic playback.

     *   [android.os.VibrationAttributes] are required for haptic playback. If no properties are

     *   supplied, haptic feedback will play using USAGE_TOUCH [android.os.VibrationAttributes].

     */

    fun playToken(token: MSDLToken, properties: InteractionProperties? = null)