Improve documentation for EXTRA_ROLE_HOLDER_STATE

Fixes: 216832508
Test: compiled
Change-Id: Idc8a0f85f07e011647d34fe3588117d7ed27c808
This commit is contained in:
arangelov
2022-01-31 16:16:05 +00:00
parent 86d5713de2
commit fd2fd2caa4

View File

@@ -587,7 +587,7 @@ public class DevicePolicyManager {
* #ACTION_ROLE_HOLDER_PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE} to signal that an update
* to the role holder is required.
*
* <p>This result code must be accompanied by {@link #EXTRA_ROLE_HOLDER_STATE}.
* <p>This result code can be accompanied by {@link #EXTRA_ROLE_HOLDER_STATE}.
*
* @hide
*/
@@ -595,15 +595,19 @@ public class DevicePolicyManager {
public static final int RESULT_UPDATE_ROLE_HOLDER = 2;
/**
* A {@link Bundle} extra which describes the state of the role holder at the time when it
* returns {@link #RESULT_UPDATE_ROLE_HOLDER}.
* A {@link PersistableBundle} extra which the role holder can use to describe its own state
* when it returns {@link #RESULT_UPDATE_ROLE_HOLDER}.
*
* <p>After the update completes, the role holder's {@link
* #ACTION_ROLE_HOLDER_PROVISION_MANAGED_PROFILE} or {@link
* <p>If {@link #RESULT_UPDATE_ROLE_HOLDER} was accompanied by this extra, after the update
* completes, the role holder's {@link #ACTION_ROLE_HOLDER_PROVISION_MANAGED_PROFILE} or {@link
* #ACTION_ROLE_HOLDER_PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE} intent will be relaunched,
* which will contain this extra. It is the role holder's responsibility to restore its
* state from this extra.
*
* <p>The content of this {@link PersistableBundle} is entirely up to the role holder. It
* should contain anything the role holder needs to restore its original state when it gets
* restarted.
*
* @hide
*/
@SystemApi