Specifically, this class provides the ability to: * *
Methods of this class will generally accept an app (identified by a packageName and a user) * and a "setting" (a string representing the "sensitive resource") as arguments. ECM's exact * behavior will generally depend on what restriction state ECM considers each setting and app. For * example: * *
With ECM, this scenario becomes: * *
**This screen then calls {@link #isRestricted}, which checks whether each app listed * on-screen is restricted from the accessibility service setting. It uses this to visually * "gray out" restricted apps.** *
**This screen then calls {@link #createRestrictedSettingDialogIntent} and starts the * intent. This opens the "Restricted setting" dialog.** *
**Upon opening, this dialog marks the app as eligible to have its restriction status * cleared.** *
**This screen calls {@link #isClearRestrictionAllowed} to check whether the app is * eligible to have its restriction status cleared. If this returns {@code true}, this screen * should then show a "Allow restricted setting" button inside the top-right hamburger menu.** *
**In response, this screen should now call {@link #clearRestriction}.** *
This is {@code true} when the setting is a protected setting (i.e., a sensitive resource), * and the app is restricted (i.e., considered dangerous), and the user has not yet cleared the * app's restriction status (i.e., by clicking "Allow restricted settings" for this app). * * @param packageName package name of the application to check for * @param settingIdentifier identifier of the resource to check to check for * @return {@code true} if the setting is restricted from the app * @throws NameNotFoundException if the provided package was not found */ @RequiresPermission(android.Manifest.permission.MANAGE_ENHANCED_CONFIRMATION_STATES) public boolean isRestricted(@NonNull String packageName, @NonNull String settingIdentifier) throws NameNotFoundException { try { return mService.isRestricted(packageName, settingIdentifier, mContext.getUser().getIdentifier()); } catch (IllegalArgumentException e) { throw new NameNotFoundException(packageName); } catch (RemoteException e) { throw e.rethrowFromSystemServer(); } } /** * Clear an app's restriction status (i.e., un-restrict it). * *
After this is called, the app will no longer be restricted from accessing any protected * setting by ECM. This method should be called when the user clicks "Allow restricted settings" * for the app. * * @param packageName package name of the application to remove protection from * @throws NameNotFoundException if the provided package was not found */ @RequiresPermission(android.Manifest.permission.MANAGE_ENHANCED_CONFIRMATION_STATES) public void clearRestriction(@NonNull String packageName) throws NameNotFoundException { try { mService.clearRestriction(packageName, mContext.getUser().getIdentifier()); } catch (IllegalArgumentException e) { throw new NameNotFoundException(packageName); } catch (RemoteException e) { throw e.rethrowFromSystemServer(); } } /** * Check whether the provided app is eligible to have its restriction status cleared (i.e., the * app is restricted, and the "Restricted setting" dialog has been presented to the user). * *
The Settings UI should use method this to check whether to present the user with the * "Allow restricted settings" button. * * @param packageName package name of the application to check for * @return {@code true} if the settings UI should present the user with the ability to clear * restrictions from the provided app * @throws NameNotFoundException if the provided package was not found */ @RequiresPermission(android.Manifest.permission.MANAGE_ENHANCED_CONFIRMATION_STATES) public boolean isClearRestrictionAllowed(@NonNull String packageName) throws NameNotFoundException { try { return mService.isClearRestrictionAllowed(packageName, mContext.getUser().getIdentifier()); } catch (IllegalArgumentException e) { throw new NameNotFoundException(packageName); } catch (RemoteException e) { throw e.rethrowFromSystemServer(); } } /** * Mark the app as eligible to have its restriction status cleared. * *
This should be called from the "Restricted setting" dialog (which {@link * #createRestrictedSettingDialogIntent} directs to) upon being presented to the user. * *
This restriction clearing does not apply to any settings that are restricted based on * global device state * * @param packageName package name of the application which should be considered acknowledged * @throws NameNotFoundException if the provided package was not found */ @RequiresPermission(android.Manifest.permission.MANAGE_ENHANCED_CONFIRMATION_STATES) public void setClearRestrictionAllowed(@NonNull String packageName) throws NameNotFoundException { try { mService.setClearRestrictionAllowed(packageName, mContext.getUser().getIdentifier()); } catch (IllegalArgumentException e) { throw new NameNotFoundException(packageName); } catch (RemoteException e) { throw e.rethrowFromSystemServer(); } } /** * Gets an intent that will open the "Restricted setting" dialog for the specified package * and setting. * *
The "Restricted setting" dialog is a dialog that informs the user that the operation * they've attempted to perform is restricted, and provides them with a link explaining how to * proceed. * * @param packageName package name of the restricted application * @param settingIdentifier identifier of the restricted setting * @throws NameNotFoundException if the provided package was not found */ public @NonNull Intent createRestrictedSettingDialogIntent(@NonNull String packageName, @NonNull String settingIdentifier) throws NameNotFoundException { Intent intent = new Intent(ACTION_SHOW_ECM_RESTRICTED_SETTING_DIALOG); intent.putExtra(Intent.EXTRA_PACKAGE_NAME, packageName); int uid = getPackageUid(packageName); intent.putExtra(Intent.EXTRA_UID, uid); intent.putExtra(Intent.EXTRA_SUBJECT, settingIdentifier); try { String restrictionReason = mService.getRestrictionReason(packageName, settingIdentifier, UserHandle.getUserHandleForUid(uid).getIdentifier()); intent.putExtra(Intent.EXTRA_REASON, restrictionReason); } catch (SecurityException | RemoteException e) { // The caller of this method does not have permission to read the ECM state, so we // won't include it in the return } return intent; } private int getPackageUid(String packageName) throws NameNotFoundException { return mPackageManager.getApplicationInfoAsUser(packageName, /* flags */ 0, mContext.getUser()).uid; } }