UserManager.java revision 385de624aa990266ffbaf70711ac8a330569429e
1/* 2 * Copyright (C) 2012 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16package android.os; 17 18import android.annotation.SystemApi; 19import android.app.ActivityManager; 20import android.app.ActivityManagerNative; 21import android.content.Context; 22import android.content.pm.UserInfo; 23import android.content.res.Resources; 24import android.graphics.Bitmap; 25import android.graphics.BitmapFactory; 26import android.graphics.Rect; 27import android.graphics.drawable.Drawable; 28import android.provider.Settings; 29import android.util.Log; 30import android.view.WindowManager.LayoutParams; 31 32import com.android.internal.R; 33 34import java.io.IOException; 35import java.util.ArrayList; 36import java.util.List; 37 38/** 39 * Manages users and user details on a multi-user system. 40 */ 41public class UserManager { 42 43 private static String TAG = "UserManager"; 44 private final IUserManager mService; 45 private final Context mContext; 46 47 /** 48 * Specifies if a user is disallowed from adding and removing accounts. 49 * The default value is <code>false</code>. 50 * 51 * <p/>Key for user restrictions. 52 * <p/>Type: Boolean 53 * @see #setUserRestrictions(Bundle) 54 * @see #getUserRestrictions() 55 */ 56 public static final String DISALLOW_MODIFY_ACCOUNTS = "no_modify_accounts"; 57 58 /** 59 * Specifies if a user is disallowed from changing Wi-Fi 60 * access points. The default value is <code>false</code>. 61 * <p/>This restriction has no effect in a managed profile. 62 * 63 * <p/>Key for user restrictions. 64 * <p/>Type: Boolean 65 * @see #setUserRestrictions(Bundle) 66 * @see #getUserRestrictions() 67 */ 68 public static final String DISALLOW_CONFIG_WIFI = "no_config_wifi"; 69 70 /** 71 * Specifies if a user is disallowed from installing applications. 72 * The default value is <code>false</code>. 73 * 74 * <p/>Key for user restrictions. 75 * <p/>Type: Boolean 76 * @see #setUserRestrictions(Bundle) 77 * @see #getUserRestrictions() 78 */ 79 public static final String DISALLOW_INSTALL_APPS = "no_install_apps"; 80 81 /** 82 * Specifies if a user is disallowed from uninstalling applications. 83 * The default value is <code>false</code>. 84 * 85 * <p/>Key for user restrictions. 86 * <p/>Type: Boolean 87 * @see #setUserRestrictions(Bundle) 88 * @see #getUserRestrictions() 89 */ 90 public static final String DISALLOW_UNINSTALL_APPS = "no_uninstall_apps"; 91 92 /** 93 * Specifies if a user is disallowed from turning on location sharing. 94 * The default value is <code>false</code>. 95 * <p/>In a managed profile, location sharing always reflects the primary user's setting, but 96 * can be overridden and forced off by setting this restriction to true in the managed profile. 97 * 98 * <p/>Key for user restrictions. 99 * <p/>Type: Boolean 100 * @see #setUserRestrictions(Bundle) 101 * @see #getUserRestrictions() 102 */ 103 public static final String DISALLOW_SHARE_LOCATION = "no_share_location"; 104 105 /** 106 * Specifies if a user is disallowed from enabling the 107 * "Unknown Sources" setting, that allows installation of apps from unknown sources. 108 * The default value is <code>false</code>. 109 * 110 * <p/>Key for user restrictions. 111 * <p/>Type: Boolean 112 * @see #setUserRestrictions(Bundle) 113 * @see #getUserRestrictions() 114 */ 115 public static final String DISALLOW_INSTALL_UNKNOWN_SOURCES = "no_install_unknown_sources"; 116 117 /** 118 * Specifies if a user is disallowed from configuring bluetooth. 119 * This does <em>not</em> restrict the user from turning bluetooth on or off. 120 * The default value is <code>false</code>. 121 * <p/>This restriction has no effect in a managed profile. 122 * 123 * <p/>Key for user restrictions. 124 * <p/>Type: Boolean 125 * @see #setUserRestrictions(Bundle) 126 * @see #getUserRestrictions() 127 */ 128 public static final String DISALLOW_CONFIG_BLUETOOTH = "no_config_bluetooth"; 129 130 /** 131 * Specifies if a user is disallowed from transferring files over 132 * USB. This can only be set by device owners and profile owners on the primary user. 133 * The default value is <code>false</code>. 134 * 135 * <p/>Key for user restrictions. 136 * <p/>Type: Boolean 137 * @see #setUserRestrictions(Bundle) 138 * @see #getUserRestrictions() 139 */ 140 public static final String DISALLOW_USB_FILE_TRANSFER = "no_usb_file_transfer"; 141 142 /** 143 * Specifies if a user is disallowed from configuring user 144 * credentials. The default value is <code>false</code>. 145 * 146 * <p/>Key for user restrictions. 147 * <p/>Type: Boolean 148 * @see #setUserRestrictions(Bundle) 149 * @see #getUserRestrictions() 150 */ 151 public static final String DISALLOW_CONFIG_CREDENTIALS = "no_config_credentials"; 152 153 /** 154 * When set on the primary user this specifies if the user can remove other users. 155 * When set on a secondary user, this specifies if the user can remove itself. 156 * This restriction has no effect on managed profiles. 157 * The default value is <code>false</code>. 158 * 159 * <p/>Key for user restrictions. 160 * <p/>Type: Boolean 161 * @see #setUserRestrictions(Bundle) 162 * @see #getUserRestrictions() 163 */ 164 public static final String DISALLOW_REMOVE_USER = "no_remove_user"; 165 166 /** 167 * Specifies if a user is disallowed from enabling or 168 * accessing debugging features. The default value is <code>false</code>. 169 * 170 * <p/>Key for user restrictions. 171 * <p/>Type: Boolean 172 * @see #setUserRestrictions(Bundle) 173 * @see #getUserRestrictions() 174 */ 175 public static final String DISALLOW_DEBUGGING_FEATURES = "no_debugging_features"; 176 177 /** 178 * Specifies if a user is disallowed from configuring VPN. 179 * The default value is <code>false</code>. 180 * This restriction has no effect in a managed profile. 181 * 182 * <p/>Key for user restrictions. 183 * <p/>Type: Boolean 184 * @see #setUserRestrictions(Bundle) 185 * @see #getUserRestrictions() 186 */ 187 public static final String DISALLOW_CONFIG_VPN = "no_config_vpn"; 188 189 /** 190 * Specifies if a user is disallowed from configuring Tethering 191 * & portable hotspots. This can only be set by device owners and profile owners on the 192 * primary user. The default value is <code>false</code>. 193 * 194 * <p/>Key for user restrictions. 195 * <p/>Type: Boolean 196 * @see #setUserRestrictions(Bundle) 197 * @see #getUserRestrictions() 198 */ 199 public static final String DISALLOW_CONFIG_TETHERING = "no_config_tethering"; 200 201 /** 202 * Specifies if a user is disallowed from factory resetting 203 * from Settings. This can only be set by device owners and profile owners on the primary user. 204 * The default value is <code>false</code>. 205 * <p/>This restriction has no effect on secondary users and managed profiles since only the 206 * primary user can factory reset the device. 207 * 208 * <p/>Key for user restrictions. 209 * <p/>Type: Boolean 210 * @see #setUserRestrictions(Bundle) 211 * @see #getUserRestrictions() 212 */ 213 public static final String DISALLOW_FACTORY_RESET = "no_factory_reset"; 214 215 /** 216 * Specifies if a user is disallowed from adding new users and 217 * profiles. This can only be set by device owners and profile owners on the primary user. 218 * The default value is <code>false</code>. 219 * <p/>This restriction has no effect on secondary users and managed profiles since only the 220 * primary user can add other users. 221 * 222 * <p/>Key for user restrictions. 223 * <p/>Type: Boolean 224 * @see #setUserRestrictions(Bundle) 225 * @see #getUserRestrictions() 226 */ 227 public static final String DISALLOW_ADD_USER = "no_add_user"; 228 229 /** 230 * Specifies if a user is disallowed from disabling application 231 * verification. The default value is <code>false</code>. 232 * 233 * <p/>Key for user restrictions. 234 * <p/>Type: Boolean 235 * @see #setUserRestrictions(Bundle) 236 * @see #getUserRestrictions() 237 */ 238 public static final String ENSURE_VERIFY_APPS = "ensure_verify_apps"; 239 240 /** 241 * Specifies if a user is disallowed from configuring cell 242 * broadcasts. This can only be set by device owners and profile owners on the primary user. 243 * The default value is <code>false</code>. 244 * <p/>This restriction has no effect on secondary users and managed profiles since only the 245 * primary user can configure cell broadcasts. 246 * 247 * <p/>Key for user restrictions. 248 * <p/>Type: Boolean 249 * @see #setUserRestrictions(Bundle) 250 * @see #getUserRestrictions() 251 */ 252 public static final String DISALLOW_CONFIG_CELL_BROADCASTS = "no_config_cell_broadcasts"; 253 254 /** 255 * Specifies if a user is disallowed from configuring mobile 256 * networks. This can only be set by device owners and profile owners on the primary user. 257 * The default value is <code>false</code>. 258 * <p/>This restriction has no effect on secondary users and managed profiles since only the 259 * primary user can configure mobile networks. 260 * 261 * <p/>Key for user restrictions. 262 * <p/>Type: Boolean 263 * @see #setUserRestrictions(Bundle) 264 * @see #getUserRestrictions() 265 */ 266 public static final String DISALLOW_CONFIG_MOBILE_NETWORKS = "no_config_mobile_networks"; 267 268 /** 269 * Specifies if a user is disallowed from modifying 270 * applications in Settings or launchers. The following actions will not be allowed when this 271 * restriction is enabled: 272 * <li>uninstalling apps</li> 273 * <li>disabling apps</li> 274 * <li>clearing app caches</li> 275 * <li>clearing app data</li> 276 * <li>force stopping apps</li> 277 * <li>clearing app defaults</li> 278 * <p> 279 * The default value is <code>false</code>. 280 * 281 * <p/>Key for user restrictions. 282 * <p/>Type: Boolean 283 * @see #setUserRestrictions(Bundle) 284 * @see #getUserRestrictions() 285 */ 286 public static final String DISALLOW_APPS_CONTROL = "no_control_apps"; 287 288 /** 289 * Specifies if a user is disallowed from mounting 290 * physical external media. This can only be set by device owners and profile owners on the 291 * primary user. The default value is <code>false</code>. 292 * 293 * <p/>Key for user restrictions. 294 * <p/>Type: Boolean 295 * @see #setUserRestrictions(Bundle) 296 * @see #getUserRestrictions() 297 */ 298 public static final String DISALLOW_MOUNT_PHYSICAL_MEDIA = "no_physical_media"; 299 300 /** 301 * Specifies if a user is disallowed from adjusting microphone 302 * volume. If set, the microphone will be muted. This can only be set by device owners 303 * and profile owners on the primary user. The default value is <code>false</code>. 304 * 305 * <p/>Key for user restrictions. 306 * <p/>Type: Boolean 307 * @see #setUserRestrictions(Bundle) 308 * @see #getUserRestrictions() 309 */ 310 public static final String DISALLOW_UNMUTE_MICROPHONE = "no_unmute_microphone"; 311 312 /** 313 * Specifies if a user is disallowed from adjusting the master 314 * volume. If set, the master volume will be muted. This can only be set by device owners 315 * and profile owners on the primary user. The default value is <code>false</code>. 316 * 317 * <p/>Key for user restrictions. 318 * <p/>Type: Boolean 319 * @see #setUserRestrictions(Bundle) 320 * @see #getUserRestrictions() 321 */ 322 public static final String DISALLOW_ADJUST_VOLUME = "no_adjust_volume"; 323 324 /** 325 * Specifies that the user is not allowed to make outgoing 326 * phone calls. Emergency calls are still permitted. 327 * The default value is <code>false</code>. 328 * <p/>This restriction has no effect on managed profiles since call intents are normally 329 * forwarded to the primary user. 330 * 331 * <p/>Key for user restrictions. 332 * <p/>Type: Boolean 333 * @see #setUserRestrictions(Bundle) 334 * @see #getUserRestrictions() 335 */ 336 public static final String DISALLOW_OUTGOING_CALLS = "no_outgoing_calls"; 337 338 /** 339 * Specifies that the user is not allowed to send or receive 340 * SMS messages. The default value is <code>false</code>. 341 * 342 * <p/>Key for user restrictions. 343 * <p/>Type: Boolean 344 * @see #setUserRestrictions(Bundle) 345 * @see #getUserRestrictions() 346 */ 347 public static final String DISALLOW_SMS = "no_sms"; 348 349 /** 350 * Specifies that windows besides app windows should not be 351 * created. This will block the creation of the following types of windows. 352 * <li>{@link LayoutParams#TYPE_TOAST}</li> 353 * <li>{@link LayoutParams#TYPE_PHONE}</li> 354 * <li>{@link LayoutParams#TYPE_PRIORITY_PHONE}</li> 355 * <li>{@link LayoutParams#TYPE_SYSTEM_ALERT}</li> 356 * <li>{@link LayoutParams#TYPE_SYSTEM_ERROR}</li> 357 * <li>{@link LayoutParams#TYPE_SYSTEM_OVERLAY}</li> 358 * 359 * <p>This can only be set by device owners and profile owners on the primary user. 360 * The default value is <code>false</code>. 361 * 362 * <p/>Key for user restrictions. 363 * <p/>Type: Boolean 364 * @see #setUserRestrictions(Bundle) 365 * @see #getUserRestrictions() 366 */ 367 public static final String DISALLOW_CREATE_WINDOWS = "no_create_windows"; 368 369 /** 370 * Specifies if what is copied in the clipboard of this profile can 371 * be pasted in related profiles. Does not restrict if the clipboard of related profiles can be 372 * pasted in this profile. 373 * The default value is <code>false</code>. 374 * 375 * <p/>Key for user restrictions. 376 * <p/>Type: Boolean 377 * @see #setUserRestrictions(Bundle) 378 * @see #getUserRestrictions() 379 */ 380 public static final String DISALLOW_CROSS_PROFILE_COPY_PASTE = "no_cross_profile_copy_paste"; 381 382 /** 383 * Specifies if the user is not allowed to use NFC to beam out data from apps. 384 * The default value is <code>false</code>. 385 * 386 * <p/>Key for user restrictions. 387 * <p/>Type: Boolean 388 * @see #setUserRestrictions(Bundle) 389 * @see #getUserRestrictions() 390 */ 391 public static final String DISALLOW_OUTGOING_BEAM = "no_outgoing_beam"; 392 393 /** 394 * Hidden user restriction to disallow access to wallpaper manager APIs. This user restriction 395 * is always set for managed profiles. 396 * @hide 397 * @see #setUserRestrictions(Bundle) 398 * @see #getUserRestrictions() 399 */ 400 public static final String DISALLOW_WALLPAPER = "no_wallpaper"; 401 402 /** 403 * Specifies if the user is not allowed to reboot the device into safe boot mode. 404 * This can only be set by device owners and profile owners on the primary user. 405 * The default value is <code>false</code>. 406 * 407 * <p/>Key for user restrictions. 408 * <p/>Type: Boolean 409 * @see #setUserRestrictions(Bundle) 410 * @see #getUserRestrictions() 411 */ 412 public static final String DISALLOW_SAFE_BOOT = "no_safe_boot"; 413 414 /** 415 * Application restriction key that is used to indicate the pending arrival 416 * of real restrictions for the app. 417 * 418 * <p> 419 * Applications that support restrictions should check for the presence of this key. 420 * A <code>true</code> value indicates that restrictions may be applied in the near 421 * future but are not available yet. It is the responsibility of any 422 * management application that sets this flag to update it when the final 423 * restrictions are enforced. 424 * 425 * <p/>Key for application restrictions. 426 * <p/>Type: Boolean 427 * @see android.app.admin.DevicePolicyManager#setApplicationRestrictions( 428 * android.content.ComponentName, String, Bundle) 429 * @see android.app.admin.DevicePolicyManager#getApplicationRestrictions( 430 * android.content.ComponentName, String) 431 */ 432 public static final String KEY_RESTRICTIONS_PENDING = "restrictions_pending"; 433 434 /** @hide */ 435 public static final int PIN_VERIFICATION_FAILED_INCORRECT = -3; 436 /** @hide */ 437 public static final int PIN_VERIFICATION_FAILED_NOT_SET = -2; 438 /** @hide */ 439 public static final int PIN_VERIFICATION_SUCCESS = -1; 440 441 private static UserManager sInstance = null; 442 443 /** @hide */ 444 public synchronized static UserManager get(Context context) { 445 if (sInstance == null) { 446 sInstance = (UserManager) context.getSystemService(Context.USER_SERVICE); 447 } 448 return sInstance; 449 } 450 451 /** @hide */ 452 public UserManager(Context context, IUserManager service) { 453 mService = service; 454 mContext = context; 455 } 456 457 /** 458 * Returns whether the system supports multiple users. 459 * @return true if multiple users can be created by user, false if it is a single user device. 460 * @hide 461 */ 462 public static boolean supportsMultipleUsers() { 463 return getMaxSupportedUsers() > 1 464 && SystemProperties.getBoolean("fw.show_multiuserui", 465 Resources.getSystem().getBoolean(R.bool.config_enableMultiUserUI)); 466 } 467 468 /** 469 * Returns the user handle for the user that the calling process is running on. 470 * 471 * @return the user handle of the user making this call. 472 * @hide 473 */ 474 public int getUserHandle() { 475 return UserHandle.myUserId(); 476 } 477 478 /** 479 * Returns the user name of the user making this call. This call is only 480 * available to applications on the system image; it requires the 481 * MANAGE_USERS permission. 482 * @return the user name 483 */ 484 public String getUserName() { 485 try { 486 return mService.getUserInfo(getUserHandle()).name; 487 } catch (RemoteException re) { 488 Log.w(TAG, "Could not get user name", re); 489 return ""; 490 } 491 } 492 493 /** 494 * Used to determine whether the user making this call is subject to 495 * teleportations. 496 * 497 * <p>As of {@link android.os.Build.VERSION_CODES#LOLLIPOP}, this method can 498 * now automatically identify goats using advanced goat recognition technology.</p> 499 * 500 * @return Returns true if the user making this call is a goat. 501 */ 502 public boolean isUserAGoat() { 503 return mContext.getPackageManager() 504 .isPackageAvailable("com.coffeestainstudios.goatsimulator"); 505 } 506 507 /** 508 * Used to check if the user making this call is linked to another user. Linked users may have 509 * a reduced number of available apps, app restrictions and account restrictions. 510 * @return whether the user making this call is a linked user 511 * @hide 512 */ 513 public boolean isLinkedUser() { 514 try { 515 return mService.isRestricted(); 516 } catch (RemoteException re) { 517 Log.w(TAG, "Could not check if user is limited ", re); 518 return false; 519 } 520 } 521 522 /** 523 * Checks if the calling app is running as a guest user. 524 * @return whether the caller is a guest user. 525 * @hide 526 */ 527 public boolean isGuestUser() { 528 UserInfo user = getUserInfo(UserHandle.myUserId()); 529 return user != null ? user.isGuest() : false; 530 } 531 532 /** 533 * Checks if the calling app is running in a managed profile. 534 * Requires {@link android.Manifest.permission#MANAGE_USERS} permission. 535 * 536 * @return whether the caller is in a managed profile. 537 * @hide 538 */ 539 @SystemApi 540 public boolean isManagedProfile() { 541 UserInfo user = getUserInfo(UserHandle.myUserId()); 542 return user != null ? user.isManagedProfile() : false; 543 } 544 545 /** 546 * Return whether the given user is actively running. This means that 547 * the user is in the "started" state, not "stopped" -- it is currently 548 * allowed to run code through scheduled alarms, receiving broadcasts, 549 * etc. A started user may be either the current foreground user or a 550 * background user; the result here does not distinguish between the two. 551 * @param user The user to retrieve the running state for. 552 */ 553 public boolean isUserRunning(UserHandle user) { 554 try { 555 return ActivityManagerNative.getDefault().isUserRunning( 556 user.getIdentifier(), false); 557 } catch (RemoteException e) { 558 return false; 559 } 560 } 561 562 /** 563 * Return whether the given user is actively running <em>or</em> stopping. 564 * This is like {@link #isUserRunning(UserHandle)}, but will also return 565 * true if the user had been running but is in the process of being stopped 566 * (but is not yet fully stopped, and still running some code). 567 * @param user The user to retrieve the running state for. 568 */ 569 public boolean isUserRunningOrStopping(UserHandle user) { 570 try { 571 return ActivityManagerNative.getDefault().isUserRunning( 572 user.getIdentifier(), true); 573 } catch (RemoteException e) { 574 return false; 575 } 576 } 577 578 /** 579 * Returns the UserInfo object describing a specific user. 580 * Requires {@link android.Manifest.permission#MANAGE_USERS} permission. 581 * @param userHandle the user handle of the user whose information is being requested. 582 * @return the UserInfo object for a specific user. 583 * @hide 584 */ 585 public UserInfo getUserInfo(int userHandle) { 586 try { 587 return mService.getUserInfo(userHandle); 588 } catch (RemoteException re) { 589 Log.w(TAG, "Could not get user info", re); 590 return null; 591 } 592 } 593 594 /** 595 * Returns the user-wide restrictions imposed on this user. 596 * @return a Bundle containing all the restrictions. 597 */ 598 public Bundle getUserRestrictions() { 599 return getUserRestrictions(Process.myUserHandle()); 600 } 601 602 /** 603 * Returns the user-wide restrictions imposed on the user specified by <code>userHandle</code>. 604 * @param userHandle the UserHandle of the user for whom to retrieve the restrictions. 605 * @return a Bundle containing all the restrictions. 606 */ 607 public Bundle getUserRestrictions(UserHandle userHandle) { 608 try { 609 return mService.getUserRestrictions(userHandle.getIdentifier()); 610 } catch (RemoteException re) { 611 Log.w(TAG, "Could not get user restrictions", re); 612 return Bundle.EMPTY; 613 } 614 } 615 616 /** 617 * Sets all the user-wide restrictions for this user. 618 * Requires the MANAGE_USERS permission. 619 * @param restrictions the Bundle containing all the restrictions. 620 * @deprecated use {@link android.app.admin.DevicePolicyManager#addUserRestriction( 621 * android.content.ComponentName, String)} or 622 * {@link android.app.admin.DevicePolicyManager#clearUserRestriction( 623 * android.content.ComponentName, String)} instead. 624 */ 625 @Deprecated 626 public void setUserRestrictions(Bundle restrictions) { 627 setUserRestrictions(restrictions, Process.myUserHandle()); 628 } 629 630 /** 631 * Sets all the user-wide restrictions for the specified user. 632 * Requires the MANAGE_USERS permission. 633 * @param restrictions the Bundle containing all the restrictions. 634 * @param userHandle the UserHandle of the user for whom to set the restrictions. 635 * @deprecated use {@link android.app.admin.DevicePolicyManager#addUserRestriction( 636 * android.content.ComponentName, String)} or 637 * {@link android.app.admin.DevicePolicyManager#clearUserRestriction( 638 * android.content.ComponentName, String)} instead. 639 */ 640 @Deprecated 641 public void setUserRestrictions(Bundle restrictions, UserHandle userHandle) { 642 try { 643 mService.setUserRestrictions(restrictions, userHandle.getIdentifier()); 644 } catch (RemoteException re) { 645 Log.w(TAG, "Could not set user restrictions", re); 646 } 647 } 648 649 /** 650 * Sets the value of a specific restriction. 651 * Requires the MANAGE_USERS permission. 652 * @param key the key of the restriction 653 * @param value the value for the restriction 654 * @deprecated use {@link android.app.admin.DevicePolicyManager#addUserRestriction( 655 * android.content.ComponentName, String)} or 656 * {@link android.app.admin.DevicePolicyManager#clearUserRestriction( 657 * android.content.ComponentName, String)} instead. 658 */ 659 @Deprecated 660 public void setUserRestriction(String key, boolean value) { 661 Bundle bundle = getUserRestrictions(); 662 bundle.putBoolean(key, value); 663 setUserRestrictions(bundle); 664 } 665 666 /** 667 * @hide 668 * Sets the value of a specific restriction on a specific user. 669 * Requires the MANAGE_USERS permission. 670 * @param key the key of the restriction 671 * @param value the value for the restriction 672 * @param userHandle the user whose restriction is to be changed. 673 * @deprecated use {@link android.app.admin.DevicePolicyManager#addUserRestriction( 674 * android.content.ComponentName, String)} or 675 * {@link android.app.admin.DevicePolicyManager#clearUserRestriction( 676 * android.content.ComponentName, String)} instead. 677 */ 678 @Deprecated 679 public void setUserRestriction(String key, boolean value, UserHandle userHandle) { 680 Bundle bundle = getUserRestrictions(userHandle); 681 bundle.putBoolean(key, value); 682 setUserRestrictions(bundle, userHandle); 683 } 684 685 /** 686 * Returns whether the current user has been disallowed from performing certain actions 687 * or setting certain settings. 688 * 689 * @param restrictionKey The string key representing the restriction. 690 * @return {@code true} if the current user has the given restriction, {@code false} otherwise. 691 */ 692 public boolean hasUserRestriction(String restrictionKey) { 693 return hasUserRestriction(restrictionKey, Process.myUserHandle()); 694 } 695 696 /** 697 * @hide 698 * Returns whether the given user has been disallowed from performing certain actions 699 * or setting certain settings. 700 * @param restrictionKey the string key representing the restriction 701 * @param userHandle the UserHandle of the user for whom to retrieve the restrictions. 702 */ 703 public boolean hasUserRestriction(String restrictionKey, UserHandle userHandle) { 704 try { 705 return mService.hasUserRestriction(restrictionKey, 706 userHandle.getIdentifier()); 707 } catch (RemoteException re) { 708 Log.w(TAG, "Could not check user restrictions", re); 709 return false; 710 } 711 } 712 713 /** 714 * Return the serial number for a user. This is a device-unique 715 * number assigned to that user; if the user is deleted and then a new 716 * user created, the new users will not be given the same serial number. 717 * @param user The user whose serial number is to be retrieved. 718 * @return The serial number of the given user; returns -1 if the 719 * given UserHandle does not exist. 720 * @see #getUserForSerialNumber(long) 721 */ 722 public long getSerialNumberForUser(UserHandle user) { 723 return getUserSerialNumber(user.getIdentifier()); 724 } 725 726 /** 727 * Return the user associated with a serial number previously 728 * returned by {@link #getSerialNumberForUser(UserHandle)}. 729 * @param serialNumber The serial number of the user that is being 730 * retrieved. 731 * @return Return the user associated with the serial number, or null 732 * if there is not one. 733 * @see #getSerialNumberForUser(UserHandle) 734 */ 735 public UserHandle getUserForSerialNumber(long serialNumber) { 736 int ident = getUserHandle((int)serialNumber); 737 return ident >= 0 ? new UserHandle(ident) : null; 738 } 739 740 /** 741 * Creates a user with the specified name and options. 742 * Requires {@link android.Manifest.permission#MANAGE_USERS} permission. 743 * 744 * @param name the user's name 745 * @param flags flags that identify the type of user and other properties. 746 * @see UserInfo 747 * 748 * @return the UserInfo object for the created user, or null if the user could not be created. 749 * @hide 750 */ 751 public UserInfo createUser(String name, int flags) { 752 try { 753 return mService.createUser(name, flags); 754 } catch (RemoteException re) { 755 Log.w(TAG, "Could not create a user", re); 756 return null; 757 } 758 } 759 760 /** 761 * Creates a guest user and configures it. 762 * @param context an application context 763 * @param name the name to set for the user 764 * @hide 765 */ 766 public UserInfo createGuest(Context context, String name) { 767 UserInfo guest = createUser(name, UserInfo.FLAG_GUEST); 768 if (guest != null) { 769 Settings.Secure.putStringForUser(context.getContentResolver(), 770 Settings.Secure.SKIP_FIRST_USE_HINTS, "1", guest.id); 771 try { 772 Bundle guestRestrictions = mService.getDefaultGuestRestrictions(); 773 guestRestrictions.putBoolean(DISALLOW_SMS, true); 774 guestRestrictions.putBoolean(DISALLOW_INSTALL_UNKNOWN_SOURCES, true); 775 mService.setUserRestrictions(guestRestrictions, guest.id); 776 } catch (RemoteException re) { 777 Log.w(TAG, "Could not update guest restrictions"); 778 } 779 } 780 return guest; 781 } 782 783 /** 784 * Creates a secondary user with the specified name and options and configures it with default 785 * restrictions. 786 * Requires {@link android.Manifest.permission#MANAGE_USERS} permission. 787 * 788 * @param name the user's name 789 * @param flags flags that identify the type of user and other properties. 790 * @see UserInfo 791 * 792 * @return the UserInfo object for the created user, or null if the user could not be created. 793 * @hide 794 */ 795 public UserInfo createSecondaryUser(String name, int flags) { 796 try { 797 UserInfo user = mService.createUser(name, flags); 798 if (user == null) { 799 return null; 800 } 801 Bundle userRestrictions = mService.getUserRestrictions(user.id); 802 addDefaultUserRestrictions(userRestrictions); 803 mService.setUserRestrictions(userRestrictions, user.id); 804 return user; 805 } catch (RemoteException re) { 806 Log.w(TAG, "Could not create a user", re); 807 return null; 808 } 809 } 810 811 private static void addDefaultUserRestrictions(Bundle restrictions) { 812 restrictions.putBoolean(DISALLOW_OUTGOING_CALLS, true); 813 restrictions.putBoolean(DISALLOW_SMS, true); 814 } 815 816 /** 817 * Creates a user with the specified name and options as a profile of another user. 818 * Requires {@link android.Manifest.permission#MANAGE_USERS} permission. 819 * 820 * @param name the user's name 821 * @param flags flags that identify the type of user and other properties. 822 * @see UserInfo 823 * @param userHandle new user will be a profile of this use. 824 * 825 * @return the UserInfo object for the created user, or null if the user could not be created. 826 * @hide 827 */ 828 public UserInfo createProfileForUser(String name, int flags, int userHandle) { 829 try { 830 return mService.createProfileForUser(name, flags, userHandle); 831 } catch (RemoteException re) { 832 Log.w(TAG, "Could not create a user", re); 833 return null; 834 } 835 } 836 837 /** 838 * @hide 839 * Marks the guest user for deletion to allow a new guest to be created before deleting 840 * the current user who is a guest. 841 * @param userHandle 842 * @return 843 */ 844 public boolean markGuestForDeletion(int userHandle) { 845 try { 846 return mService.markGuestForDeletion(userHandle); 847 } catch (RemoteException re) { 848 Log.w(TAG, "Could not mark guest for deletion", re); 849 return false; 850 } 851 } 852 853 /** 854 * Sets the user as enabled, if such an user exists. 855 * Requires {@link android.Manifest.permission#MANAGE_USERS} permission. 856 * Note that the default is true, it's only that managed profiles might not be enabled. 857 * 858 * @param userHandle the id of the profile to enable 859 * @hide 860 */ 861 public void setUserEnabled(int userHandle) { 862 try { 863 mService.setUserEnabled(userHandle); 864 } catch (RemoteException e) { 865 Log.w(TAG, "Could not enable the profile", e); 866 } 867 } 868 869 /** 870 * Return the number of users currently created on the device. 871 */ 872 public int getUserCount() { 873 List<UserInfo> users = getUsers(); 874 return users != null ? users.size() : 1; 875 } 876 877 /** 878 * Returns information for all users on this device. 879 * Requires {@link android.Manifest.permission#MANAGE_USERS} permission. 880 * @return the list of users that were created. 881 * @hide 882 */ 883 public List<UserInfo> getUsers() { 884 try { 885 return mService.getUsers(false); 886 } catch (RemoteException re) { 887 Log.w(TAG, "Could not get user list", re); 888 return null; 889 } 890 } 891 892 /** 893 * Checks whether it's possible to add more users. Caller must hold the MANAGE_USERS 894 * permission. 895 * 896 * @return true if more users can be added, false if limit has been reached. 897 * @hide 898 */ 899 public boolean canAddMoreUsers() { 900 final List<UserInfo> users = getUsers(true); 901 final int totalUserCount = users.size(); 902 int aliveUserCount = 0; 903 for (int i = 0; i < totalUserCount; i++) { 904 UserInfo user = users.get(i); 905 if (!user.isGuest()) { 906 aliveUserCount++; 907 } 908 } 909 return aliveUserCount < getMaxSupportedUsers(); 910 } 911 912 /** 913 * Returns list of the profiles of userHandle including 914 * userHandle itself. 915 * Note that this returns both enabled and not enabled profiles. See 916 * {@link #getUserProfiles()} if you need only the enabled ones. 917 * 918 * Requires {@link android.Manifest.permission#MANAGE_USERS} permission. 919 * @param userHandle profiles of this user will be returned. 920 * @return the list of profiles. 921 * @hide 922 */ 923 public List<UserInfo> getProfiles(int userHandle) { 924 try { 925 return mService.getProfiles(userHandle, false /* enabledOnly */); 926 } catch (RemoteException re) { 927 Log.w(TAG, "Could not get user list", re); 928 return null; 929 } 930 } 931 932 /** 933 * Returns a list of UserHandles for profiles associated with the user that the calling process 934 * is running on, including the user itself. 935 * 936 * @return A non-empty list of UserHandles associated with the calling user. 937 */ 938 public List<UserHandle> getUserProfiles() { 939 ArrayList<UserHandle> profiles = new ArrayList<UserHandle>(); 940 List<UserInfo> users = new ArrayList<UserInfo>(); 941 try { 942 users = mService.getProfiles(UserHandle.myUserId(), true /* enabledOnly */); 943 } catch (RemoteException re) { 944 Log.w(TAG, "Could not get user list", re); 945 return null; 946 } 947 for (UserInfo info : users) { 948 UserHandle userHandle = new UserHandle(info.id); 949 profiles.add(userHandle); 950 } 951 return profiles; 952 } 953 954 /** 955 * Returns the parent of the profile which this method is called from 956 * or null if called from a user that is not a profile. 957 * 958 * @hide 959 */ 960 public UserInfo getProfileParent(int userHandle) { 961 try { 962 return mService.getProfileParent(userHandle); 963 } catch (RemoteException re) { 964 Log.w(TAG, "Could not get profile parent", re); 965 return null; 966 } 967 } 968 969 /** 970 * If the target user is a managed profile of the calling user or the caller 971 * is itself a managed profile, then this returns a badged copy of the given 972 * icon to be able to distinguish it from the original icon. For badging an 973 * arbitrary drawable use {@link #getBadgedDrawableForUser( 974 * android.graphics.drawable.Drawable, UserHandle, android.graphics.Rect, int)}. 975 * <p> 976 * If the original drawable is a BitmapDrawable and the backing bitmap is 977 * mutable as per {@link android.graphics.Bitmap#isMutable()}, the bading 978 * is performed in place and the original drawable is returned. 979 * </p> 980 * 981 * @param icon The icon to badge. 982 * @param user The target user. 983 * @return A drawable that combines the original icon and a badge as 984 * determined by the system. 985 * @removed 986 */ 987 public Drawable getBadgedIconForUser(Drawable icon, UserHandle user) { 988 return mContext.getPackageManager().getUserBadgedIcon(icon, user); 989 } 990 991 /** 992 * If the target user is a managed profile of the calling user or the caller 993 * is itself a managed profile, then this returns a badged copy of the given 994 * drawable allowing the user to distinguish it from the original drawable. 995 * The caller can specify the location in the bounds of the drawable to be 996 * badged where the badge should be applied as well as the density of the 997 * badge to be used. 998 * <p> 999 * If the original drawable is a BitmapDrawable and the backing bitmap is 1000 * mutable as per {@link android.graphics.Bitmap#isMutable()}, the bading 1001 * is performed in place and the original drawable is returned. 1002 * </p> 1003 * 1004 * @param badgedDrawable The drawable to badge. 1005 * @param user The target user. 1006 * @param badgeLocation Where in the bounds of the badged drawable to place 1007 * the badge. If not provided, the badge is applied on top of the entire 1008 * drawable being badged. 1009 * @param badgeDensity The optional desired density for the badge as per 1010 * {@link android.util.DisplayMetrics#densityDpi}. If not provided, 1011 * the density of the display is used. 1012 * @return A drawable that combines the original drawable and a badge as 1013 * determined by the system. 1014 * @removed 1015 */ 1016 public Drawable getBadgedDrawableForUser(Drawable badgedDrawable, UserHandle user, 1017 Rect badgeLocation, int badgeDensity) { 1018 return mContext.getPackageManager().getUserBadgedDrawableForDensity(badgedDrawable, user, 1019 badgeLocation, badgeDensity); 1020 } 1021 1022 /** 1023 * If the target user is a managed profile of the calling user or the caller 1024 * is itself a managed profile, then this returns a copy of the label with 1025 * badging for accessibility services like talkback. E.g. passing in "Email" 1026 * and it might return "Work Email" for Email in the work profile. 1027 * 1028 * @param label The label to change. 1029 * @param user The target user. 1030 * @return A label that combines the original label and a badge as 1031 * determined by the system. 1032 * @removed 1033 */ 1034 public CharSequence getBadgedLabelForUser(CharSequence label, UserHandle user) { 1035 return mContext.getPackageManager().getUserBadgedLabel(label, user); 1036 } 1037 1038 /** 1039 * Returns information for all users on this device. Requires 1040 * {@link android.Manifest.permission#MANAGE_USERS} permission. 1041 * 1042 * @param excludeDying specify if the list should exclude users being 1043 * removed. 1044 * @return the list of users that were created. 1045 * @hide 1046 */ 1047 public List<UserInfo> getUsers(boolean excludeDying) { 1048 try { 1049 return mService.getUsers(excludeDying); 1050 } catch (RemoteException re) { 1051 Log.w(TAG, "Could not get user list", re); 1052 return null; 1053 } 1054 } 1055 1056 /** 1057 * Removes a user and all associated data. 1058 * Requires {@link android.Manifest.permission#MANAGE_USERS} permission. 1059 * @param userHandle the integer handle of the user, where 0 is the primary user. 1060 * @hide 1061 */ 1062 public boolean removeUser(int userHandle) { 1063 try { 1064 return mService.removeUser(userHandle); 1065 } catch (RemoteException re) { 1066 Log.w(TAG, "Could not remove user ", re); 1067 return false; 1068 } 1069 } 1070 1071 /** 1072 * Updates the user's name. 1073 * Requires {@link android.Manifest.permission#MANAGE_USERS} permission. 1074 * 1075 * @param userHandle the user's integer handle 1076 * @param name the new name for the user 1077 * @hide 1078 */ 1079 public void setUserName(int userHandle, String name) { 1080 try { 1081 mService.setUserName(userHandle, name); 1082 } catch (RemoteException re) { 1083 Log.w(TAG, "Could not set the user name ", re); 1084 } 1085 } 1086 1087 /** 1088 * Sets the user's photo. 1089 * @param userHandle the user for whom to change the photo. 1090 * @param icon the bitmap to set as the photo. 1091 * @hide 1092 */ 1093 public void setUserIcon(int userHandle, Bitmap icon) { 1094 try { 1095 mService.setUserIcon(userHandle, icon); 1096 } catch (RemoteException re) { 1097 Log.w(TAG, "Could not set the user icon ", re); 1098 } 1099 } 1100 1101 /** 1102 * Returns a file descriptor for the user's photo. PNG data can be read from this file. 1103 * @param userHandle the user whose photo we want to read. 1104 * @return a {@link Bitmap} of the user's photo, or null if there's no photo. 1105 * @see com.android.internal.util.UserIcons#getDefaultUserIcon for a default. 1106 * @hide 1107 */ 1108 public Bitmap getUserIcon(int userHandle) { 1109 try { 1110 ParcelFileDescriptor fd = mService.getUserIcon(userHandle); 1111 if (fd != null) { 1112 try { 1113 return BitmapFactory.decodeFileDescriptor(fd.getFileDescriptor()); 1114 } finally { 1115 try { 1116 fd.close(); 1117 } catch (IOException e) { 1118 } 1119 } 1120 } 1121 } catch (RemoteException re) { 1122 Log.w(TAG, "Could not get the user icon ", re); 1123 } 1124 return null; 1125 } 1126 1127 /** 1128 * Returns the maximum number of users that can be created on this device. A return value 1129 * of 1 means that it is a single user device. 1130 * @hide 1131 * @return a value greater than or equal to 1 1132 */ 1133 public static int getMaxSupportedUsers() { 1134 // Don't allow multiple users on certain builds 1135 if (android.os.Build.ID.startsWith("JVP")) return 1; 1136 // Svelte devices don't get multi-user. 1137 if (ActivityManager.isLowRamDeviceStatic()) return 1; 1138 return SystemProperties.getInt("fw.max_users", 1139 Resources.getSystem().getInteger(R.integer.config_multiuserMaximumUsers)); 1140 } 1141 1142 /** 1143 * Returns true if the user switcher should be shown, this will be if there 1144 * are multiple users that aren't managed profiles. 1145 * @hide 1146 * @return true if user switcher should be shown. 1147 */ 1148 public boolean isUserSwitcherEnabled() { 1149 List<UserInfo> users = getUsers(true); 1150 if (users == null) { 1151 return false; 1152 } 1153 int switchableUserCount = 0; 1154 for (UserInfo user : users) { 1155 if (user.supportsSwitchTo()) { 1156 ++switchableUserCount; 1157 } 1158 } 1159 final boolean guestEnabled = Settings.Global.getInt(mContext.getContentResolver(), 1160 Settings.Global.GUEST_USER_ENABLED, 0) == 1; 1161 return switchableUserCount > 1 || guestEnabled; 1162 } 1163 1164 /** 1165 * Returns a serial number on this device for a given userHandle. User handles can be recycled 1166 * when deleting and creating users, but serial numbers are not reused until the device is wiped. 1167 * @param userHandle 1168 * @return a serial number associated with that user, or -1 if the userHandle is not valid. 1169 * @hide 1170 */ 1171 public int getUserSerialNumber(int userHandle) { 1172 try { 1173 return mService.getUserSerialNumber(userHandle); 1174 } catch (RemoteException re) { 1175 Log.w(TAG, "Could not get serial number for user " + userHandle); 1176 } 1177 return -1; 1178 } 1179 1180 /** 1181 * Returns a userHandle on this device for a given user serial number. User handles can be 1182 * recycled when deleting and creating users, but serial numbers are not reused until the device 1183 * is wiped. 1184 * @param userSerialNumber 1185 * @return the userHandle associated with that user serial number, or -1 if the serial number 1186 * is not valid. 1187 * @hide 1188 */ 1189 public int getUserHandle(int userSerialNumber) { 1190 try { 1191 return mService.getUserHandle(userSerialNumber); 1192 } catch (RemoteException re) { 1193 Log.w(TAG, "Could not get userHandle for user " + userSerialNumber); 1194 } 1195 return -1; 1196 } 1197 1198 /** 1199 * Returns a Bundle containing any saved application restrictions for this user, for the 1200 * given package name. Only an application with this package name can call this method. 1201 * @param packageName the package name of the calling application 1202 * @return a Bundle with the restrictions as key/value pairs, or null if there are no 1203 * saved restrictions. The values can be of type Boolean, String or String[], depending 1204 * on the restriction type, as defined by the application. 1205 */ 1206 public Bundle getApplicationRestrictions(String packageName) { 1207 try { 1208 return mService.getApplicationRestrictions(packageName); 1209 } catch (RemoteException re) { 1210 Log.w(TAG, "Could not get application restrictions for package " + packageName); 1211 } 1212 return null; 1213 } 1214 1215 /** 1216 * @hide 1217 */ 1218 public Bundle getApplicationRestrictions(String packageName, UserHandle user) { 1219 try { 1220 return mService.getApplicationRestrictionsForUser(packageName, user.getIdentifier()); 1221 } catch (RemoteException re) { 1222 Log.w(TAG, "Could not get application restrictions for user " + user.getIdentifier()); 1223 } 1224 return null; 1225 } 1226 1227 /** 1228 * @hide 1229 */ 1230 public void setApplicationRestrictions(String packageName, Bundle restrictions, 1231 UserHandle user) { 1232 try { 1233 mService.setApplicationRestrictions(packageName, restrictions, user.getIdentifier()); 1234 } catch (RemoteException re) { 1235 Log.w(TAG, "Could not set application restrictions for user " + user.getIdentifier()); 1236 } 1237 } 1238 1239 /** 1240 * Sets a new challenge PIN for restrictions. This is only for use by pre-installed 1241 * apps and requires the MANAGE_USERS permission. 1242 * @param newPin the PIN to use for challenge dialogs. 1243 * @return Returns true if the challenge PIN was set successfully. 1244 */ 1245 public boolean setRestrictionsChallenge(String newPin) { 1246 try { 1247 return mService.setRestrictionsChallenge(newPin); 1248 } catch (RemoteException re) { 1249 Log.w(TAG, "Could not change restrictions pin"); 1250 } 1251 return false; 1252 } 1253 1254 /** 1255 * @hide 1256 * @param pin The PIN to verify, or null to get the number of milliseconds to wait for before 1257 * allowing the user to enter the PIN. 1258 * @return Returns a positive number (including zero) for how many milliseconds before 1259 * you can accept another PIN, when the input is null or the input doesn't match the saved PIN. 1260 * Returns {@link #PIN_VERIFICATION_SUCCESS} if the input matches the saved PIN. Returns 1261 * {@link #PIN_VERIFICATION_FAILED_NOT_SET} if there is no PIN set. 1262 */ 1263 public int checkRestrictionsChallenge(String pin) { 1264 try { 1265 return mService.checkRestrictionsChallenge(pin); 1266 } catch (RemoteException re) { 1267 Log.w(TAG, "Could not check restrictions pin"); 1268 } 1269 return PIN_VERIFICATION_FAILED_INCORRECT; 1270 } 1271 1272 /** 1273 * @hide 1274 * Checks whether the user has restrictions that are PIN-protected. An application that 1275 * participates in restrictions can check if the owner has requested a PIN challenge for 1276 * any restricted operations. If there is a PIN in effect, the application should launch 1277 * the PIN challenge activity {@link android.content.Intent#ACTION_RESTRICTIONS_CHALLENGE}. 1278 * @see android.content.Intent#ACTION_RESTRICTIONS_CHALLENGE 1279 * @return whether a restrictions PIN is in effect. 1280 */ 1281 public boolean hasRestrictionsChallenge() { 1282 try { 1283 return mService.hasRestrictionsChallenge(); 1284 } catch (RemoteException re) { 1285 Log.w(TAG, "Could not change restrictions pin"); 1286 } 1287 return false; 1288 } 1289 1290 /** @hide */ 1291 public void removeRestrictions() { 1292 try { 1293 mService.removeRestrictions(); 1294 } catch (RemoteException re) { 1295 Log.w(TAG, "Could not change restrictions pin"); 1296 } 1297 } 1298 1299 /** 1300 * @hide 1301 * Set restrictions that should apply to any future guest user that's created. 1302 */ 1303 public void setDefaultGuestRestrictions(Bundle restrictions) { 1304 try { 1305 mService.setDefaultGuestRestrictions(restrictions); 1306 } catch (RemoteException re) { 1307 Log.w(TAG, "Could not set guest restrictions"); 1308 } 1309 } 1310 1311 /** 1312 * @hide 1313 * Gets the default guest restrictions. 1314 */ 1315 public Bundle getDefaultGuestRestrictions() { 1316 try { 1317 return mService.getDefaultGuestRestrictions(); 1318 } catch (RemoteException re) { 1319 Log.w(TAG, "Could not set guest restrictions"); 1320 } 1321 return new Bundle(); 1322 } 1323 1324 /** 1325 * Returns creation time of the user or of a managed profile associated with the calling user. 1326 * @param userHandle user handle of the user or a managed profile associated with the 1327 * calling user. 1328 * @return creation time in milliseconds since Epoch time. 1329 */ 1330 public long getUserCreationTime(UserHandle userHandle) { 1331 try { 1332 return mService.getUserCreationTime(userHandle.getIdentifier()); 1333 } catch (RemoteException re) { 1334 Log.w(TAG, "Could not get user creation time", re); 1335 return 0; 1336 } 1337 } 1338} 1339