Merge "Make the system action API more clear with documentation" into rvc-dev

This commit is contained in:
Sally Yuen
2020-04-06 23:54:03 +00:00
committed by Android (Google) Code Review
2 changed files with 15 additions and 1 deletions

View File

@@ -1819,6 +1819,13 @@ public abstract class AccessibilityService extends Service {
/**
* Returns a list of system actions available in the system right now.
* <p>
* System actions that correspond to the global action constants will have matching action IDs.
* For example, an with id {@link #GLOBAL_ACTION_BACK} will perform the back action.
* </p>
* <p>
* These actions should be called by {@link #performGlobalAction}.
* </p>
*
* @return A list of available system actions.
*/

View File

@@ -1275,7 +1275,14 @@ public final class AccessibilityManager {
/**
* Register the provided {@link RemoteAction} with the given actionId
*
* <p>
* To perform established system actions, an accessibility service uses the GLOBAL_ACTION
* constants in {@link android.accessibilityservice.AccessibilityService}. To provide a
* customized implementation for one of these actions, the id of the registered system action
* must match that of the corresponding GLOBAL_ACTION constant. For example, to register a
* Back action, {@code actionId} must be
* {@link android.accessibilityservice.AccessibilityService#GLOBAL_ACTION_BACK}
* </p>
* @param action The remote action to be registered with the given actionId as system action.
* @param actionId The id uniquely identify the system action.
* @hide