Clarify getTrustAgentConfiguration() documentation.
Fixes bug 18983802
Change-Id: I2f6e208cdd4fac95d1d0228bec3de8199baafa57
diff --git a/core/java/android/app/admin/DevicePolicyManager.java b/core/java/android/app/admin/DevicePolicyManager.java
index 7e15ec2..1ed709b 100644
--- a/core/java/android/app/admin/DevicePolicyManager.java
+++ b/core/java/android/app/admin/DevicePolicyManager.java
@@ -2692,7 +2692,7 @@
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param target Component name of the agent to be enabled.
- * @param options TrustAgent-specific feature bundle. If null for any admin, agent
+ * @param configuration TrustAgent-specific feature bundle. If null for any admin, agent
* will be strictly disabled according to the state of the
* {@link #KEYGUARD_DISABLE_TRUST_AGENTS} flag.
* <p>If {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is set and options is not null for all admins,
@@ -2700,10 +2700,11 @@
* <p>Consult documentation for the specific TrustAgent to determine legal options parameters.
*/
public void setTrustAgentConfiguration(ComponentName admin, ComponentName target,
- PersistableBundle options) {
+ PersistableBundle configuration) {
if (mService != null) {
try {
- mService.setTrustAgentConfiguration(admin, target, options, UserHandle.myUserId());
+ mService.setTrustAgentConfiguration(admin, target, configuration,
+ UserHandle.myUserId());
} catch (RemoteException e) {
Log.w(TAG, "Failed talking with device policy service", e);
}
@@ -2715,7 +2716,12 @@
* {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)} for
* all device admins.
*
- * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
+ * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
+ * this function returns a list of configurations for all admins that declare
+ * {@link #KEYGUARD_DISABLE_TRUST_AGENTS}. If any admin declares
+ * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} but doesn't call
+ * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)}
+ * for this {@param agent} or calls it with a null configuration, null is returned.
* @param agent Which component to get enabled features for.
* @return configuration for the given trust agent.
*/