From e134edc4977f3f12621b5c303eb85618334e9727 Mon Sep 17 00:00:00 2001
From: Fabian Kozynski <kozynski@google.com>
Date: Tue, 23 Jun 2020 15:46:35 -0400
Subject: [PATCH] Add information about requestAddControl

Add possible conditions under which SystemUI may not prompt the user to
add a control.

Test: no test
Fixes: 159728016
Change-Id: I143e50cc15397d85b4212d9fb29d64df7c2de80c
---
 .../android/service/controls/ControlsProviderService.java     | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/core/java/android/service/controls/ControlsProviderService.java b/core/java/android/service/controls/ControlsProviderService.java
index 4e5aa0018b618..6bd376a19fc5e 100644
--- a/core/java/android/service/controls/ControlsProviderService.java
+++ b/core/java/android/service/controls/ControlsProviderService.java
@@ -296,6 +296,10 @@ public abstract class ControlsProviderService extends Service {
 
     /**
      * Request SystemUI to prompt the user to add a control to favorites.
+     * <br>
+     * SystemUI may not honor this request in some cases, for example if the requested
+     * {@link Control} is already a favorite, or the requesting package is not currently in the
+     * foreground.
      *
      * @param context A context
      * @param componentName Component name of the {@link ControlsProviderService}