Updating the javadoc of DevicePolicyManager#wipeData

Updating the javadoc of DevicePolicyManager#wipedata to clarify
that the calling user, if not a primary user, will get deleted

Bug: 29253518
Change-Id: I84b316b1a81ebeef5aa3d802058c201f89c257b0
This commit is contained in:
Suprabh Shukla
2016-08-10 15:49:24 -07:00
parent c5e057c736
commit 556b05a9d6

View File

@@ -2348,8 +2348,10 @@ public class DevicePolicyManager {
public static final int WIPE_RESET_PROTECTION_DATA = 0x0002;
/**
* Ask the user data be wiped. Wiping the primary user will cause the device to reboot, erasing
* all user data while next booting up.
* Ask that all user data be wiped. If called as a secondary user, the user will be removed and
* other users will remain unaffected. Calling from the primary user will cause the device to
* reboot, erasing all device data - including all the secondary users and their data - while
* booting up.
* <p>
* The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA} to
* be able to call this method; if it has not, a security exception will be thrown.