1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475
|
/*
* Copyright (C) 2012 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.os;
import static android.app.admin.DevicePolicyResources.Strings.Core.WORK_PROFILE_BADGED_LABEL;
import static android.app.admin.DevicePolicyResources.UNDEFINED;
import android.Manifest;
import android.accounts.AccountManager;
import android.annotation.ColorInt;
import android.annotation.DrawableRes;
import android.annotation.IntDef;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.annotation.RequiresPermission;
import android.annotation.StringDef;
import android.annotation.SuppressAutoDoc;
import android.annotation.SuppressLint;
import android.annotation.SystemApi;
import android.annotation.SystemService;
import android.annotation.TestApi;
import android.annotation.UserHandleAware;
import android.annotation.UserIdInt;
import android.annotation.WorkerThread;
import android.app.Activity;
import android.app.ActivityManager;
import android.app.PropertyInvalidatedCache;
import android.app.admin.DevicePolicyManager;
import android.app.compat.CompatChanges;
import android.compat.annotation.ChangeId;
import android.compat.annotation.EnabledSince;
import android.compat.annotation.UnsupportedAppUsage;
import android.content.ComponentName;
import android.content.Context;
import android.content.Intent;
import android.content.IntentFilter;
import android.content.IntentSender;
import android.content.pm.UserInfo;
import android.content.pm.UserInfo.UserInfoFlag;
import android.content.res.Resources;
import android.graphics.Bitmap;
import android.graphics.BitmapFactory;
import android.graphics.Rect;
import android.graphics.drawable.Drawable;
import android.location.LocationManager;
import android.provider.Settings;
import android.telephony.TelephonyManager;
import android.util.AndroidException;
import android.util.ArraySet;
import android.util.Log;
import android.view.WindowManager.LayoutParams;
import com.android.internal.R;
import com.android.internal.os.RoSystemProperties;
import com.android.internal.util.FrameworkStatsLog;
import java.io.IOException;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.Set;
/**
* Manages users and user details on a multi-user system. There are two major categories of
* users: fully customizable users with their own login, and profiles that share a workspace
* with a related user.
* <p>
* Users are different from accounts, which are managed by
* {@link AccountManager}. Each user can have their own set of accounts.
* <p>
* See {@link DevicePolicyManager#ACTION_PROVISION_MANAGED_PROFILE} for more on managed profiles.
*/
@SystemService(Context.USER_SERVICE)
public class UserManager {
private static final String TAG = "UserManager";
@UnsupportedAppUsage
private final IUserManager mService;
/** Holding the Application context (not constructor param context). */
private final Context mContext;
/** The userId of the constructor param context. To be used instead of mContext.getUserId(). */
private final @UserIdInt int mUserId;
/** The userType of UserHandle.myUserId(); empty string if not a profile; null until cached. */
private String mProfileTypeOfProcessUser = null;
/**
* User type representing a {@link UserHandle#USER_SYSTEM system} user that is a human user.
* This type of user cannot be created; it can only pre-exist on first boot.
* @hide
*/
@SystemApi
public static final String USER_TYPE_FULL_SYSTEM = "android.os.usertype.full.SYSTEM";
/**
* User type representing a regular non-profile non-{@link UserHandle#USER_SYSTEM system} human
* user.
* This is sometimes called an ordinary 'secondary user'.
* @hide
*/
@SystemApi
public static final String USER_TYPE_FULL_SECONDARY = "android.os.usertype.full.SECONDARY";
/**
* User type representing a guest user that may be transient.
* @hide
*/
@SystemApi
public static final String USER_TYPE_FULL_GUEST = "android.os.usertype.full.GUEST";
/**
* User type representing a user for demo purposes only, which can be removed at any time.
* @hide
*/
public static final String USER_TYPE_FULL_DEMO = "android.os.usertype.full.DEMO";
/**
* User type representing a "restricted profile" user, which is a full user that is subject to
* certain restrictions from a parent user. Note, however, that it is NOT technically a profile.
* @hide
*/
public static final String USER_TYPE_FULL_RESTRICTED = "android.os.usertype.full.RESTRICTED";
/**
* User type representing a managed profile, which is a profile that is to be managed by a
* device policy controller (DPC).
* The intended purpose is for work profiles, which are managed by a corporate entity.
* @hide
*/
@SystemApi
public static final String USER_TYPE_PROFILE_MANAGED = "android.os.usertype.profile.MANAGED";
/**
* User type representing a clone profile. Clone profile is a user profile type used to run
* second instance of an otherwise single user App (eg, messengers). Only the primary user
* is allowed to have a clone profile.
*
* @hide
*/
@SystemApi
public static final String USER_TYPE_PROFILE_CLONE = "android.os.usertype.profile.CLONE";
/**
* User type representing a generic profile for testing purposes. Only on debuggable builds.
* @hide
*/
public static final String USER_TYPE_PROFILE_TEST = "android.os.usertype.profile.TEST";
/**
* User type representing a {@link UserHandle#USER_SYSTEM system} user that is <b>not</b> a
* human user.
* This type of user cannot be created; it can only pre-exist on first boot.
* @hide
*/
@SystemApi
public static final String USER_TYPE_SYSTEM_HEADLESS = "android.os.usertype.system.HEADLESS";
/**
* Flag passed to {@link #requestQuietModeEnabled} to request disabling quiet mode only if
* there is no need to confirm the user credentials. If credentials are required to disable
* quiet mode, {@link #requestQuietModeEnabled} will do nothing and return {@code false}.
*/
public static final int QUIET_MODE_DISABLE_ONLY_IF_CREDENTIAL_NOT_REQUIRED = 0x1;
/**
* Flag passed to {@link #requestQuietModeEnabled} to request disabling quiet mode without
* asking for credentials. This is used when managed profile password is forgotten. It starts
* the user in locked state so that a direct boot aware DPC could reset the password.
* Should not be used together with
* {@link #QUIET_MODE_DISABLE_ONLY_IF_CREDENTIAL_NOT_REQUIRED} or an exception will be thrown.
* @hide
*/
public static final int QUIET_MODE_DISABLE_DONT_ASK_CREDENTIAL = 0x2;
/**
* List of flags available for the {@link #requestQuietModeEnabled} method.
* @hide
*/
@Retention(RetentionPolicy.SOURCE)
@IntDef(flag = true, prefix = { "QUIET_MODE_" }, value = {
QUIET_MODE_DISABLE_ONLY_IF_CREDENTIAL_NOT_REQUIRED,
QUIET_MODE_DISABLE_DONT_ASK_CREDENTIAL})
public @interface QuietModeFlag {}
/**
* @hide
* No user restriction.
*/
@SystemApi
public static final int RESTRICTION_NOT_SET = 0x0;
/**
* @hide
* User restriction set by system/user.
*/
@SystemApi
public static final int RESTRICTION_SOURCE_SYSTEM = 0x1;
/**
* @hide
* User restriction set by a device owner.
*/
@SystemApi
public static final int RESTRICTION_SOURCE_DEVICE_OWNER = 0x2;
/**
* @hide
* User restriction set by a profile owner.
*/
@SystemApi
public static final int RESTRICTION_SOURCE_PROFILE_OWNER = 0x4;
/** @hide */
@Retention(RetentionPolicy.SOURCE)
@IntDef(flag = true, prefix = { "RESTRICTION_" }, value = {
RESTRICTION_NOT_SET,
RESTRICTION_SOURCE_SYSTEM,
RESTRICTION_SOURCE_DEVICE_OWNER,
RESTRICTION_SOURCE_PROFILE_OWNER
})
@SystemApi
public @interface UserRestrictionSource {}
/**
* Specifies if a user is disallowed from adding and removing accounts, unless they are
* {@link android.accounts.AccountManager#addAccountExplicitly programmatically} added by
* Authenticator.
* The default value is <code>false</code>.
*
* <p>From {@link android.os.Build.VERSION_CODES#N} a profile or device owner app can still
* use {@link android.accounts.AccountManager} APIs to add or remove accounts when account
* management is disallowed.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_MODIFY_ACCOUNTS = "no_modify_accounts";
/**
* Specifies if a user is disallowed from changing Wi-Fi access points via Settings. This
* restriction does not affect Wi-Fi tethering settings.
*
* <p>A device owner and a profile owner can set this restriction, although the restriction has
* no effect in a managed profile. When it is set by a device owner, a profile owner on the
* primary user or by a profile owner of an organization-owned managed profile on the parent
* profile, it disallows the primary user from changing Wi-Fi access points.
*
* <p>The default value is <code>false</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_CONFIG_WIFI = "no_config_wifi";
/**
* Specifies if a user is disallowed from enabling/disabling Wi-Fi.
*
* <p>This restriction can only be set by a device owner,
* a profile owner of an organization-owned managed profile on the parent profile.
* When it is set by any of these owners, it applies globally - i.e., it disables airplane mode
* from changing Wi-Fi state.
*
* <p>The default value is <code>false</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_CHANGE_WIFI_STATE = "no_change_wifi_state";
/**
* Specifies if a user is disallowed from using Wi-Fi tethering.
*
* <p>This restriction does not limit the user's ability to modify or connect to regular
* Wi-Fi networks, which is separately controlled by {@link #DISALLOW_CONFIG_WIFI}.
*
* <p>This restriction can only be set by a device owner,
* a profile owner of an organization-owned managed profile on the parent profile.
* When it is set by any of these owners, it prevents all users from using
* Wi-Fi tethering. Other forms of tethering are not affected.
*
* This user restriction disables only Wi-Fi tethering.
* Use {@link #DISALLOW_CONFIG_TETHERING} to limit all forms of tethering.
* When {@link #DISALLOW_CONFIG_TETHERING} is set, this user restriction becomes obsolete.
*
* <p>The default value is <code>false</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_WIFI_TETHERING = "no_wifi_tethering";
/**
* Specifies if users are disallowed from sharing Wi-Fi for admin configured networks.
*
* <p>Device owner and profile owner can set this restriction.
* When it is set by any of these owners, it prevents all users from
* sharing Wi-Fi for networks configured by these owners.
* Other networks not configured by these owners are not affected.
*
* <p>The default value is <code>false</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_SHARING_ADMIN_CONFIGURED_WIFI =
"no_sharing_admin_configured_wifi";
/**
* Specifies if a user is disallowed from using Wi-Fi Direct.
*
* <p>This restriction can only be set by a device owner,
* a profile owner of an organization-owned managed profile on the parent profile.
* When it is set by any of these owners, it prevents all users from using
* Wi-Fi Direct.
*
* <p>The default value is <code>false</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_WIFI_DIRECT = "no_wifi_direct";
/**
* Specifies if a user is disallowed from adding a new Wi-Fi configuration.
*
* <p>This restriction can only be set by a device owner,
* a profile owner of an organization-owned managed profile on the parent profile.
* When it is set by any of these owners, it prevents all users from adding
* a new Wi-Fi configuration. This does not limit the owner and carrier's ability
* to add a new configuration.
*
* <p>The default value is <code>false</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_ADD_WIFI_CONFIG = "no_add_wifi_config";
/**
* Specifies if a user is disallowed from changing the device
* language. The default value is <code>false</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_CONFIG_LOCALE = "no_config_locale";
/**
* Specifies if a user is disallowed from installing applications. This user restriction also
* prevents device owners and profile owners installing apps. The default value is
* {@code false}.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_INSTALL_APPS = "no_install_apps";
/**
* Specifies if a user is disallowed from uninstalling applications.
* The default value is <code>false</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_UNINSTALL_APPS = "no_uninstall_apps";
/**
* Specifies if a user is disallowed from turning on location sharing.
*
* <p>In a managed profile, location sharing by default reflects the primary user's setting, but
* can be overridden and forced off by setting this restriction to true in the managed profile.
*
* <p>A device owner and a profile owner can set this restriction. When it is set by a device
* owner, a profile owner on the primary user or by a profile owner of an organization-owned
* managed profile on the parent profile, it prevents the primary user from turning on
* location sharing.
*
* <p>The default value is <code>false</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_SHARE_LOCATION = "no_share_location";
/**
* Specifies if airplane mode is disallowed on the device.
*
* <p>This restriction can only be set by a device owner, a profile owner on the primary
* user or a profile owner of an organization-owned managed profile on the parent profile.
* When it is set by any of these owners, it applies globally - i.e., it disables airplane mode
* on the entire device.
*
* <p>The default value is <code>false</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_AIRPLANE_MODE = "no_airplane_mode";
/**
* Specifies if a user is disallowed from configuring brightness. When device owner sets it,
* it'll only be applied on the target(system) user.
*
* <p>The default value is <code>false</code>.
*
* <p>This user restriction has no effect on managed profiles.
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_CONFIG_BRIGHTNESS = "no_config_brightness";
/**
* Specifies if ambient display is disallowed for the user.
*
* <p>The default value is <code>false</code>.
*
* <p>This user restriction has no effect on managed profiles.
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_AMBIENT_DISPLAY = "no_ambient_display";
/**
* Specifies if a user is disallowed from changing screen off timeout.
*
* <p>The default value is <code>false</code>.
*
* <p>This user restriction has no effect on managed profiles.
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_CONFIG_SCREEN_TIMEOUT = "no_config_screen_timeout";
/**
* Specifies if a user is disallowed from enabling the
* "Unknown Sources" setting, that allows installation of apps from unknown sources.
* Unknown sources exclude adb and special apps such as trusted app stores.
* The default value is <code>false</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_INSTALL_UNKNOWN_SOURCES = "no_install_unknown_sources";
/**
* This restriction is a device-wide version of {@link #DISALLOW_INSTALL_UNKNOWN_SOURCES}.
*
* Specifies if all users on the device are disallowed from enabling the
* "Unknown Sources" setting, that allows installation of apps from unknown sources.
*
* This restriction can be enabled by the profile owner, in which case all accounts and
* profiles will be affected.
*
* The default value is <code>false</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_INSTALL_UNKNOWN_SOURCES_GLOBALLY =
"no_install_unknown_sources_globally";
/**
* Specifies if a user is disallowed from configuring bluetooth via Settings. This does
* <em>not</em> restrict the user from turning bluetooth on or off.
*
* <p>This restriction doesn't prevent the user from using bluetooth. For disallowing usage of
* bluetooth completely on the device, use {@link #DISALLOW_BLUETOOTH}.
*
* <p>A device owner and a profile owner can set this restriction, although the restriction has
* no effect in a managed profile. When it is set by a device owner, a profile owner on the
* primary user or by a profile owner of an organization-owned managed profile on the parent
* profile, it disallows the primary user from configuring bluetooth.
*
* <p>The default value is <code>false</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_CONFIG_BLUETOOTH = "no_config_bluetooth";
/**
* Specifies if bluetooth is disallowed on the device. If bluetooth is disallowed on the device,
* bluetooth cannot be turned on or configured via Settings.
*
* <p>This restriction can only be set by a device owner, a profile owner on the primary
* user or a profile owner of an organization-owned managed profile on the parent profile.
* When it is set by a device owner, it applies globally - i.e., it disables bluetooth on
* the entire device and all users will be affected. When it is set by a profile owner on the
* primary user or by a profile owner of an organization-owned managed profile on the parent
* profile, it disables the primary user from using bluetooth and configuring bluetooth
* in Settings.
*
* <p>The default value is <code>false</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_BLUETOOTH = "no_bluetooth";
/**
* Specifies if outgoing bluetooth sharing is disallowed.
*
* <p>A device owner and a profile owner can set this restriction. When it is set by a device
* owner, it applies globally. When it is set by a profile owner on the primary user or by a
* profile owner of an organization-owned managed profile on the parent profile, it disables
* the primary user from any outgoing bluetooth sharing.
*
* <p>Default is <code>true</code> for managed profiles and false otherwise.
*
* <p>When a device upgrades to {@link android.os.Build.VERSION_CODES#O}, the system sets it
* for all existing managed profiles.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_BLUETOOTH_SHARING = "no_bluetooth_sharing";
/**
* Specifies if a user is disallowed from transferring files over USB.
*
* <p>This restriction can only be set by a device owner, a profile owner on the primary
* user or a profile owner of an organization-owned managed profile on the parent profile.
* When it is set by a device owner, it applies globally. When it is set by a profile owner
* on the primary user or by a profile owner of an organization-owned managed profile on
* the parent profile, it disables the primary user from transferring files over USB. No other
* user on the device is able to use file transfer over USB because the UI for file transfer
* is always associated with the primary user.
*
* <p>The default value is <code>false</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_USB_FILE_TRANSFER = "no_usb_file_transfer";
/**
* Specifies if a user is disallowed from configuring user
* credentials. The default value is <code>false</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_CONFIG_CREDENTIALS = "no_config_credentials";
/**
* When set on the admin user this specifies if the user can remove users.
* When set on a non-admin secondary user, this specifies if the user can remove itself.
* This restriction has no effect on managed profiles.
* The default value is <code>false</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_REMOVE_USER = "no_remove_user";
/**
* Specifies if managed profiles of this user can be removed, other than by its profile owner.
* The default value is <code>false</code>.
* <p>
* This restriction has no effect on managed profiles.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
* @deprecated As the ability to have a managed profile on a fully-managed device has been
* removed from the platform, this restriction will be silently ignored when applied by the
* device owner.
* When the device is provisioned with a managed profile on an organization-owned device,
* the managed profile could not be removed anyway.
*/
@Deprecated
public static final String DISALLOW_REMOVE_MANAGED_PROFILE = "no_remove_managed_profile";
/**
* Specifies if a user is disallowed from enabling or accessing debugging features.
*
* <p>A device owner and a profile owner can set this restriction. When it is set by a device
* owner, a profile owner on the primary user or by a profile owner of an organization-owned
* managed profile on the parent profile, it disables debugging features altogether, including
* USB debugging. When set on a managed profile or a secondary user, it blocks debugging for
* that user only, including starting activities, making service calls, accessing content
* providers, sending broadcasts, installing/uninstalling packages, clearing user data, etc.
*
* <p>The default value is <code>false</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_DEBUGGING_FEATURES = "no_debugging_features";
/**
* Specifies if a user is disallowed from configuring a VPN. The default value is
* <code>false</code>. This restriction has an effect when set by device owners and, in Android
* 6.0 ({@linkplain android.os.Build.VERSION_CODES#M API level 23}) or higher, profile owners.
* <p>This restriction also prevents VPNs from starting. However, in Android 7.0
* ({@linkplain android.os.Build.VERSION_CODES#N API level 24}) or higher, the system does
* start always-on VPNs created by the device or profile owner.
* <p>From Android 12 ({@linkplain android.os.Build.VERSION_CODES#S API level 31}) enforcing
* this restriction clears currently active VPN if it was configured by the user.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_CONFIG_VPN = "no_config_vpn";
/**
* Specifies if a user is disallowed from enabling or disabling location providers. As a
* result, user is disallowed from turning on or off location via Settings.
*
* <p>A device owner and a profile owner can set this restriction. When it is set by a device
* owner, a profile owner on the primary user or by a profile owner of an organization-owned
* managed profile on the parent profile, it disallows the primary user from turning location
* on or off.
*
* <p>The default value is <code>false</code>.
*
* <p>This user restriction is different from {@link #DISALLOW_SHARE_LOCATION},
* as a device owner or a profile owner can still enable or disable location mode via
* {@link DevicePolicyManager#setLocationEnabled} when this restriction is on.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see LocationManager#isLocationEnabled()
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_CONFIG_LOCATION = "no_config_location";
/**
* Specifies configuring date, time and timezone is disallowed via Settings.
*
* <p>A device owner and a profile owner can set this restriction, although the restriction has
* no effect in a managed profile. When it is set by a device owner or by a profile owner of an
* organization-owned managed profile on the parent profile, it applies globally - i.e.,
* it disables date, time and timezone setting on the entire device and all users are affected.
* When it is set by a profile owner on the primary user, it disables the primary user
* from configuring date, time and timezone and disables all configuring of date, time and
* timezone in Settings.
*
* <p>The default value is <code>false</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_CONFIG_DATE_TIME = "no_config_date_time";
/**
* Specifies if a user is disallowed from using and configuring Tethering and portable hotspots
* via Settings.
*
* <p>This restriction can only be set by a device owner, a profile owner on the primary
* user or a profile owner of an organization-owned managed profile on the parent profile.
* When it is set by a device owner, it applies globally. When it is set by a profile owner
* on the primary user or by a profile owner of an organization-owned managed profile on
* the parent profile, it disables the primary user from using Tethering and hotspots and
* disables all configuring of Tethering and hotspots in Settings.
*
* <p>The default value is <code>false</code>.
*
* <p>In Android 9.0 or higher, if tethering is enabled when this restriction is set,
* tethering will be automatically turned off.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_CONFIG_TETHERING = "no_config_tethering";
/**
* Specifies if a user is disallowed from resetting network settings
* from Settings. This can only be set by device owners and profile owners on the primary user.
* The default value is <code>false</code>.
* <p>This restriction has no effect on secondary users and managed profiles since only the
* primary user can reset the network settings of the device.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_NETWORK_RESET = "no_network_reset";
/**
* Specifies if a user is disallowed from factory resetting from Settings.
* This can only be set by device owners and profile owners on an admin user.
* The default value is <code>false</code>.
* <p>This restriction has no effect on non-admin users since they cannot factory reset the
* device.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_FACTORY_RESET = "no_factory_reset";
/**
* Specifies if a user is disallowed from adding new users. This can only be set by device
* owners or profile owners on the primary user. The default value is <code>false</code>.
* <p>This restriction has no effect on secondary users and managed profiles since only the
* primary user can add other users.
* <p> When the device is an organization-owned device provisioned with a managed profile,
* this restriction will be set as a base restriction which cannot be removed by any admin.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_ADD_USER = "no_add_user";
/**
* Specifies if a user is disallowed from adding managed profiles.
* <p>The default value for an unmanaged user is <code>false</code>.
* For users with a device owner set, the default is <code>true</code>.
* <p>This restriction has no effect on managed profiles.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
* @deprecated As the ability to have a managed profile on a fully-managed device has been
* removed from the platform, this restriction will be silently ignored when applied by the
* device owner.
*/
@Deprecated
public static final String DISALLOW_ADD_MANAGED_PROFILE = "no_add_managed_profile";
/**
* Specifies if a user is disallowed from creating clone profile.
* <p>The default value for an unmanaged user is <code>false</code>.
* For users with a device owner set, the default is <code>true</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
* @hide
*/
public static final String DISALLOW_ADD_CLONE_PROFILE = "no_add_clone_profile";
/**
* Specifies if a user is disallowed from disabling application verification. The default
* value is <code>false</code>.
*
* <p>In Android 8.0 ({@linkplain android.os.Build.VERSION_CODES#O API level 26}) and higher,
* this is a global user restriction. If a device owner or profile owner sets this restriction,
* the system enforces app verification across all users on the device. Running in earlier
* Android versions, this restriction affects only the profile that sets it.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String ENSURE_VERIFY_APPS = "ensure_verify_apps";
/**
* Specifies if a user is disallowed from configuring cell broadcasts.
*
* <p>This restriction can only be set by a device owner, a profile owner on the primary
* user or a profile owner of an organization-owned managed profile on the parent profile.
* When it is set by a device owner, it applies globally. When it is set by a profile owner
* on the primary user or by a profile owner of an organization-owned managed profile on
* the parent profile, it disables the primary user from configuring cell broadcasts.
*
* <p>The default value is <code>false</code>.
*
* <p>This restriction has no effect on secondary users and managed profiles since only the
* primary user can configure cell broadcasts.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_CONFIG_CELL_BROADCASTS = "no_config_cell_broadcasts";
/**
* Specifies if a user is disallowed from configuring mobile networks.
*
* <p>This restriction can only be set by a device owner, a profile owner on the primary
* user or a profile owner of an organization-owned managed profile on the parent profile.
* When it is set by a device owner, it applies globally. When it is set by a profile owner
* on the primary user or by a profile owner of an organization-owned managed profile on
* the parent profile, it disables the primary user from configuring mobile networks.
*
* <p>The default value is <code>false</code>.
*
* <p>This restriction has no effect on secondary users and managed profiles since only the
* primary user can configure mobile networks.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_CONFIG_MOBILE_NETWORKS = "no_config_mobile_networks";
/**
* Specifies if a user is disallowed from modifying
* applications in Settings or launchers. The following actions will not be allowed when this
* restriction is enabled:
* <li>uninstalling apps</li>
* <li>disabling apps</li>
* <li>clearing app caches</li>
* <li>clearing app data</li>
* <li>force stopping apps</li>
* <li>clearing app defaults</li>
* <p>
* The default value is <code>false</code>.
*
* <p><strong>Note:</strong> The user will still be able to perform those actions via other
* means (such as adb). Third party apps will also be able to uninstall apps via the
* {@link android.content.pm.PackageInstaller}. {@link #DISALLOW_UNINSTALL_APPS} or
* {@link DevicePolicyManager#setUninstallBlocked(ComponentName, String, boolean)} should be
* used to prevent the user from uninstalling apps completely, and
* {@link DevicePolicyManager#addPersistentPreferredActivity(ComponentName, IntentFilter, ComponentName)}
* to add a default intent handler for a given intent filter.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_APPS_CONTROL = "no_control_apps";
/**
* Specifies if a user is disallowed from mounting physical external media.
*
* <p>This restriction can only be set by a device owner, a profile owner on the primary
* user or a profile owner of an organization-owned managed profile on the parent profile.
* When it is set by a device owner, it applies globally. When it is set by a profile owner
* on the primary user or by a profile owner of an organization-owned managed profile on
* the parent profile, it disables the primary user from mounting physical external media.
*
* <p>The default value is <code>false</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_MOUNT_PHYSICAL_MEDIA = "no_physical_media";
/**
* Specifies if a user is disallowed from adjusting microphone volume. If set, the microphone
* will be muted.
*
* <p>A device owner and a profile owner can set this restriction, although the restriction has
* no effect in a managed profile. When it is set by a device owner, it applies globally. When
* it is set by a profile owner on the primary user or by a profile owner of an
* organization-owned managed profile on the parent profile, it will disallow the primary user
* from adjusting the microphone volume.
*
* <p>The default value is <code>false</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_UNMUTE_MICROPHONE = "no_unmute_microphone";
/**
* Specifies if a user is disallowed from adjusting the global volume. If set, the global volume
* will be muted. This can be set by device owners from API 21 and profile owners from API 24.
* The default value is <code>false</code>.
*
* <p>When the restriction is set by profile owners, then it only applies to relevant
* profiles.
*
* <p>This restriction has no effect on managed profiles.
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_ADJUST_VOLUME = "no_adjust_volume";
/**
* Specifies that the user is not allowed to make outgoing phone calls. Emergency calls are
* still permitted.
*
* <p>A device owner and a profile owner can set this restriction, although the restriction has
* no effect in a managed profile. When it is set by a device owner, a profile owner on the
* primary user or by a profile owner of an organization-owned managed profile on the parent
* profile, it disallows the primary user from making outgoing phone calls.
*
* <p>The default value is <code>false</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_OUTGOING_CALLS = "no_outgoing_calls";
/**
* Specifies that the user is not allowed to send or receive SMS messages.
*
* <p>This restriction can only be set by a device owner, a profile owner on the primary
* user or a profile owner of an organization-owned managed profile on the parent profile.
* When it is set by a device owner, it applies globally. When it is set by a profile owner
* on the primary user or by a profile owner of an organization-owned managed profile on
* the parent profile, it disables the primary user from sending or receiving SMS messages.
*
* <p>The default value is <code>false</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_SMS = "no_sms";
/**
* Specifies if the user is not allowed to have fun. In some cases, the
* device owner may wish to prevent the user from experiencing amusement or
* joy while using the device. The default value is <code>false</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_FUN = "no_fun";
/**
* Specifies that windows besides app windows should not be
* created. This will block the creation of the following types of windows.
* <li>{@link LayoutParams#TYPE_TOAST}</li>
* <li>{@link LayoutParams#TYPE_PHONE}</li>
* <li>{@link LayoutParams#TYPE_PRIORITY_PHONE}</li>
* <li>{@link LayoutParams#TYPE_SYSTEM_ALERT}</li>
* <li>{@link LayoutParams#TYPE_SYSTEM_ERROR}</li>
* <li>{@link LayoutParams#TYPE_SYSTEM_OVERLAY}</li>
* <li>{@link LayoutParams#TYPE_APPLICATION_OVERLAY}</li>
*
* <p>This can only be set by device owners and profile owners on the primary user.
* The default value is <code>false</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_CREATE_WINDOWS = "no_create_windows";
/**
* Specifies that system error dialogs for crashed or unresponsive apps should not be shown.
* In this case, the system will force-stop the app as if the user chooses the "close app"
* option on the UI. A feedback report isn't collected as there is no way for the user to
* provide explicit consent. The default value is <code>false</code>.
*
* <p>When this user restriction is set by device owners, it's applied to all users. When set by
* the profile owner of the primary user or a secondary user, the restriction affects only the
* calling user. This user restriction has no effect on managed profiles.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_SYSTEM_ERROR_DIALOGS = "no_system_error_dialogs";
/**
* Specifies if the clipboard contents can be exported by pasting the data into other users or
* profiles. This restriction doesn't prevent import, such as someone pasting clipboard data
* from other profiles or users. The default value is {@code false}.
*
* <p><strong>Note</strong>: Because it's possible to extract data from screenshots using
* optical character recognition (OCR), we strongly recommend combining this user restriction
* with {@link DevicePolicyManager#setScreenCaptureDisabled(ComponentName, boolean)}.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_CROSS_PROFILE_COPY_PASTE = "no_cross_profile_copy_paste";
/**
* Specifies if the user is not allowed to use NFC to beam out data from apps.
* The default value is <code>false</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_OUTGOING_BEAM = "no_outgoing_beam";
/**
* Hidden user restriction to disallow access to wallpaper manager APIs. This restriction
* generally means that wallpapers are not supported for the particular user. This user
* restriction is always set for managed profiles, because such profiles don't have wallpapers.
* @hide
* @see #DISALLOW_SET_WALLPAPER
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_WALLPAPER = "no_wallpaper";
/**
* User restriction to disallow setting a wallpaper. Profile owner and device owner
* are able to set wallpaper regardless of this restriction.
* The default value is <code>false</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_SET_WALLPAPER = "no_set_wallpaper";
/**
* Specifies if the user is not allowed to reboot the device into safe boot mode.
*
* <p>This restriction can only be set by a device owner, a profile owner on the primary
* user or a profile owner of an organization-owned managed profile on the parent profile.
* When it is set by a device owner, it applies globally. When it is set by a profile owner
* on the primary user or by a profile owner of an organization-owned managed profile on
* the parent profile, it disables the primary user from rebooting the device into safe
* boot mode.
*
* <p>The default value is <code>false</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_SAFE_BOOT = "no_safe_boot";
/**
* Specifies if a user is not allowed to record audio. This restriction is always enabled for
* background users. The default value is <code>false</code>.
*
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
* @hide
*/
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
public static final String DISALLOW_RECORD_AUDIO = "no_record_audio";
/**
* Specifies if a user is not allowed to run in the background and should be stopped during
* user switch. The default value is <code>false</code>.
*
* <p>This restriction can be set by device owners and profile owners.
*
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
* @hide
*/
@SystemApi
public static final String DISALLOW_RUN_IN_BACKGROUND = "no_run_in_background";
/**
* Specifies if a user is not allowed to use the camera.
*
* <p>A device owner and a profile owner can set this restriction. When it is set by a
* device owner, it applies globally - i.e., it disables the use of camera on the entire device
* and all users are affected. When it is set by a profile owner on the primary user or by a
* profile owner of an organization-owned managed profile on the parent profile, it disables
* the primary user from using camera.
*
* <p>The default value is <code>false</code>.
*
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
* @hide
*/
public static final String DISALLOW_CAMERA = "no_camera";
/**
* Specifies if a user is not allowed to unmute the device's global volume.
*
* @see DevicePolicyManager#setMasterVolumeMuted(ComponentName, boolean)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
* @hide
*/
public static final String DISALLOW_UNMUTE_DEVICE = "disallow_unmute_device";
/**
* Specifies if a user is not allowed to use cellular data when roaming.
*
* <p>This restriction can only be set by a device owner, a profile owner on the primary
* user or a profile owner of an organization-owned managed profile on the parent profile.
* When it is set by a device owner, it applies globally. When it is set by a profile owner
* on the primary user or by a profile owner of an organization-owned managed profile on
* the parent profile, it disables the primary user from using cellular data when roaming.
*
* <p>The default value is <code>false</code>.
*
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_DATA_ROAMING = "no_data_roaming";
/**
* Specifies if a user is not allowed to change their icon. Device owner and profile owner
* can set this restriction. When it is set by device owner, only the target user will be
* affected. The default value is <code>false</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_SET_USER_ICON = "no_set_user_icon";
/**
* Specifies if a user is not allowed to enable the oem unlock setting. The default value is
* <code>false</code>. Setting this restriction has no effect if the bootloader is already
* unlocked.
*
* <p>Not for use by third-party applications.
*
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
* @deprecated use {@link OemLockManager#setOemUnlockAllowedByCarrier(boolean, byte[])} instead.
* @hide
*/
@Deprecated
@SystemApi
public static final String DISALLOW_OEM_UNLOCK = "no_oem_unlock";
/**
* Specifies that the managed profile is not allowed to have unified lock screen challenge with
* the primary user.
*
* <p><strong>Note:</strong> Setting this restriction alone doesn't automatically set a
* separate challenge. Profile owner can ask the user to set a new password using
* {@link DevicePolicyManager#ACTION_SET_NEW_PASSWORD} and verify it using
* {@link DevicePolicyManager#isUsingUnifiedPassword(ComponentName)}.
*
* <p>Can be set by profile owners. It only has effect on managed profiles when set by managed
* profile owner. Has no effect on non-managed profiles or users.
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_UNIFIED_PASSWORD = "no_unified_password";
/**
* Allows apps in the parent profile to handle web links from the managed profile.
*
* This user restriction has an effect only in a managed profile.
* If set:
* Intent filters of activities in the parent profile with action
* {@link android.content.Intent#ACTION_VIEW},
* category {@link android.content.Intent#CATEGORY_BROWSABLE}, scheme http or https, and which
* define a host can handle intents from the managed profile.
* The default value is <code>false</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String ALLOW_PARENT_PROFILE_APP_LINKING
= "allow_parent_profile_app_linking";
/**
* Specifies if a user is not allowed to use Autofill Services.
*
* <p>Device owner and profile owner can set this restriction. When it is set by device owner,
* only the target user will be affected.
*
* <p>The default value is <code>false</code>.
*
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_AUTOFILL = "no_autofill";
/**
* Specifies if the contents of a user's screen is not allowed to be captured for artificial
* intelligence purposes.
*
* <p>A device owner and a profile owner can set this restriction. When it is set by a device
* owner, a profile owner on the primary user or by a profile owner of an organization-owned
* managed profile on the parent profile, it disables the primary user's screen from being
* captured for artificial intelligence purposes.
*
* <p>The default value is <code>false</code>.
*
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_CONTENT_CAPTURE = "no_content_capture";
/**
* Specifies if the current user is able to receive content suggestions for selections based on
* the contents of their screen.
*
* <p>A device owner and a profile owner can set this restriction. When it is set by a device
* owner, a profile owner on the primary user or by a profile owner of an organization-owned
* managed profile on the parent profile, it disables the primary user from receiving content
* suggestions for selections based on the contents of their screen.
*
* <p>The default value is <code>false</code>.
*
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_CONTENT_SUGGESTIONS = "no_content_suggestions";
/**
* Specifies if user switching is blocked on the current user.
*
* <p> This restriction can only be set by the device owner, it will be applied to all users.
* Device owner can still switch user via
* {@link DevicePolicyManager#switchUser(ComponentName, UserHandle)} when this restriction is
* set.
*
* <p>The default value is <code>false</code>.
*
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_USER_SWITCH = "no_user_switch";
/**
* Specifies whether the user can share file / picture / data from the primary user into the
* managed profile, either by sending them from the primary side, or by picking up data within
* an app in the managed profile.
* <p>
* When a managed profile is created, the system allows the user to send data from the primary
* side to the profile by setting up certain default cross profile intent filters. If
* this is undesired, this restriction can be set to disallow it. Note that this restriction
* will not block any sharing allowed by explicit
* {@link DevicePolicyManager#addCrossProfileIntentFilter} calls by the profile owner.
* <p>
* This restriction is only meaningful when set by profile owner. When it is set by device
* owner, it does not have any effect.
* <p>
* The default value is <code>false</code>.
*
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_SHARE_INTO_MANAGED_PROFILE = "no_sharing_into_profile";
/**
* Specifies whether the user is allowed to print.
*
* This restriction can be set by device or profile owner.
*
* The default value is {@code false}.
*
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_PRINTING = "no_printing";
/**
* Specifies whether the user is allowed to modify private DNS settings.
*
* <p>This restriction can only be set by a device owner or a profile owner of an
* organization-owned managed profile on the parent profile. When it is set by either of these
* owners, it applies globally.
*
* <p>The default value is <code>false</code>.
*
* <p>Key for user restrictions.
* <p>Type: Boolean
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_CONFIG_PRIVATE_DNS =
"disallow_config_private_dns";
/**
* Specifies whether the microphone toggle is available to the user. If this restriction is set,
* the user will not be able to block microphone access via the system toggle. If microphone
* access is blocked when the restriction is added, it will be automatically re-enabled.
*
* This restriction can only be set by a device owner.
*
* <p>The default value is <code>false</code>.
*
* @see android.hardware.SensorPrivacyManager
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_MICROPHONE_TOGGLE =
"disallow_microphone_toggle";
/**
* Specifies whether the camera toggle is available to the user. If this restriction is set,
* the user will not be able to block camera access via the system toggle. If camera
* access is blocked when the restriction is added, it will be automatically re-enabled.
*
* This restriction can only be set by a device owner.
*
* <p>The default value is <code>false</code>.
*
* @see android.hardware.SensorPrivacyManager
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_CAMERA_TOGGLE =
"disallow_camera_toggle";
/**
* This is really not a user restriction in the normal sense. This can't be set to a user,
* via UserManager nor via DevicePolicyManager. This is not even set in UserSettingsUtils.
* This is defined here purely for convenience within the settings app.
*
* TODO(b/191306258): Refactor the Settings app to remove the need for this field, and delete it
*
* Specifies whether biometrics are available to the user. This is used internally only,
* as a means of communications between biometric settings and
* {@link com.android.settingslib.enterprise.ActionDisabledByAdminControllerFactory}.
*
* @see {@link android.hardware.biometrics.ParentalControlsUtilsInternal}
* @see {@link com.android.settings.biometrics.ParentalControlsUtils}
*
* @hide
*/
public static final String DISALLOW_BIOMETRIC = "disallow_biometric";
/**
* Application restriction key that is used to indicate the pending arrival
* of real restrictions for the app.
*
* <p>
* Applications that support restrictions should check for the presence of this key.
* A <code>true</code> value indicates that restrictions may be applied in the near
* future but are not available yet. It is the responsibility of any
* management application that sets this flag to update it when the final
* restrictions are enforced.
*
* <p>Key for application restrictions.
* <p>Type: Boolean
* @see android.app.admin.DevicePolicyManager#setApplicationRestrictions(
* android.content.ComponentName, String, Bundle)
* @see android.app.admin.DevicePolicyManager#getApplicationRestrictions(
* android.content.ComponentName, String)
*/
public static final String KEY_RESTRICTIONS_PENDING = "restrictions_pending";
/**
* Specifies if a user is not allowed to use 2g networks.
*
* <p>This restriction can only be set by a device owner or a profile owner of an
* organization-owned managed profile on the parent profile.
* In all cases, the setting applies globally on the device and will prevent the device from
* scanning for or connecting to 2g networks, except in the case of an emergency.
*
* <p>The default value is <code>false</code>.
*
* @see DevicePolicyManager#addUserRestriction(ComponentName, String)
* @see DevicePolicyManager#clearUserRestriction(ComponentName, String)
* @see #getUserRestrictions()
*/
public static final String DISALLOW_CELLULAR_2G = "no_cellular_2g";
/**
* List of key values that can be passed into the various user restriction related methods
* in {@link UserManager} & {@link DevicePolicyManager}.
* Note: This is slightly different from the real set of user restrictions listed in {@link
* com.android.server.pm.UserRestrictionsUtils#USER_RESTRICTIONS}. For example
* {@link #KEY_RESTRICTIONS_PENDING} is not a real user restriction, but is a legitimate
* value that can be passed into {@link #hasUserRestriction(String)}.
* @hide
*/
@StringDef(value = {
DISALLOW_MODIFY_ACCOUNTS,
DISALLOW_CONFIG_WIFI,
DISALLOW_CONFIG_LOCALE,
DISALLOW_INSTALL_APPS,
DISALLOW_UNINSTALL_APPS,
DISALLOW_SHARE_LOCATION,
DISALLOW_AIRPLANE_MODE,
DISALLOW_CONFIG_BRIGHTNESS,
DISALLOW_AMBIENT_DISPLAY,
DISALLOW_CONFIG_SCREEN_TIMEOUT,
DISALLOW_INSTALL_UNKNOWN_SOURCES,
DISALLOW_INSTALL_UNKNOWN_SOURCES_GLOBALLY,
DISALLOW_CONFIG_BLUETOOTH,
DISALLOW_BLUETOOTH,
DISALLOW_BLUETOOTH_SHARING,
DISALLOW_USB_FILE_TRANSFER,
DISALLOW_CONFIG_CREDENTIALS,
DISALLOW_REMOVE_USER,
DISALLOW_REMOVE_MANAGED_PROFILE,
DISALLOW_DEBUGGING_FEATURES,
DISALLOW_CONFIG_VPN,
DISALLOW_CONFIG_LOCATION,
DISALLOW_CONFIG_DATE_TIME,
DISALLOW_CONFIG_TETHERING,
DISALLOW_NETWORK_RESET,
DISALLOW_FACTORY_RESET,
DISALLOW_ADD_USER,
DISALLOW_ADD_MANAGED_PROFILE,
DISALLOW_ADD_CLONE_PROFILE,
ENSURE_VERIFY_APPS,
DISALLOW_CONFIG_CELL_BROADCASTS,
DISALLOW_CONFIG_MOBILE_NETWORKS,
DISALLOW_APPS_CONTROL,
DISALLOW_MOUNT_PHYSICAL_MEDIA,
DISALLOW_UNMUTE_MICROPHONE,
DISALLOW_ADJUST_VOLUME,
DISALLOW_OUTGOING_CALLS,
DISALLOW_SMS,
DISALLOW_FUN,
DISALLOW_CREATE_WINDOWS,
DISALLOW_SYSTEM_ERROR_DIALOGS,
DISALLOW_CROSS_PROFILE_COPY_PASTE,
DISALLOW_OUTGOING_BEAM,
DISALLOW_WALLPAPER,
DISALLOW_SET_WALLPAPER,
DISALLOW_SAFE_BOOT,
DISALLOW_RECORD_AUDIO,
DISALLOW_RUN_IN_BACKGROUND,
DISALLOW_CAMERA,
DISALLOW_UNMUTE_DEVICE,
DISALLOW_DATA_ROAMING,
DISALLOW_SET_USER_ICON,
DISALLOW_OEM_UNLOCK,
DISALLOW_UNIFIED_PASSWORD,
ALLOW_PARENT_PROFILE_APP_LINKING,
DISALLOW_AUTOFILL,
DISALLOW_CONTENT_CAPTURE,
DISALLOW_CONTENT_SUGGESTIONS,
DISALLOW_USER_SWITCH,
DISALLOW_SHARE_INTO_MANAGED_PROFILE,
DISALLOW_PRINTING,
DISALLOW_CONFIG_PRIVATE_DNS,
DISALLOW_MICROPHONE_TOGGLE,
DISALLOW_CAMERA_TOGGLE,
KEY_RESTRICTIONS_PENDING,
DISALLOW_BIOMETRIC,
DISALLOW_CHANGE_WIFI_STATE,
DISALLOW_WIFI_TETHERING,
DISALLOW_SHARING_ADMIN_CONFIGURED_WIFI,
DISALLOW_WIFI_DIRECT,
DISALLOW_ADD_WIFI_CONFIG,
DISALLOW_CELLULAR_2G,
})
@Retention(RetentionPolicy.SOURCE)
public @interface UserRestrictionKey {}
private static final String ACTION_CREATE_USER = "android.os.action.CREATE_USER";
/**
* Action to start an activity to create a supervised user.
* Only devices with non-empty config_supervisedUserCreationPackage support this.
*
* @hide
*/
@SystemApi
@RequiresPermission(Manifest.permission.MANAGE_USERS)
public static final String ACTION_CREATE_SUPERVISED_USER =
"android.os.action.CREATE_SUPERVISED_USER";
/**
* Extra containing a name for the user being created. Optional parameter passed to
* ACTION_CREATE_USER activity.
* @hide
*/
public static final String EXTRA_USER_NAME = "android.os.extra.USER_NAME";
/**
* Extra containing account name for the user being created. Optional parameter passed to
* ACTION_CREATE_USER activity.
* @hide
*/
public static final String EXTRA_USER_ACCOUNT_NAME = "android.os.extra.USER_ACCOUNT_NAME";
/**
* Extra containing account type for the user being created. Optional parameter passed to
* ACTION_CREATE_USER activity.
* @hide
*/
public static final String EXTRA_USER_ACCOUNT_TYPE = "android.os.extra.USER_ACCOUNT_TYPE";
/**
* Extra containing account-specific data for the user being created. Optional parameter passed
* to ACTION_CREATE_USER activity.
* @hide
*/
public static final String EXTRA_USER_ACCOUNT_OPTIONS
= "android.os.extra.USER_ACCOUNT_OPTIONS";
/** @hide */
public static final int PIN_VERIFICATION_FAILED_INCORRECT = -3;
/** @hide */
public static final int PIN_VERIFICATION_FAILED_NOT_SET = -2;
/** @hide */
public static final int PIN_VERIFICATION_SUCCESS = -1;
/**
* Sent when user restrictions have changed.
*
* @hide
*/
@SystemApi // To allow seeing it from CTS.
public static final String ACTION_USER_RESTRICTIONS_CHANGED =
"android.os.action.USER_RESTRICTIONS_CHANGED";
/**
* Error result indicating that this user is not allowed to add other users on this device.
* This is a result code returned from the activity created by the intent
* {@link #createUserCreationIntent(String, String, String, PersistableBundle)}.
*/
public static final int USER_CREATION_FAILED_NOT_PERMITTED = Activity.RESULT_FIRST_USER;
/**
* Error result indicating that no more users can be created on this device.
* This is a result code returned from the activity created by the intent
* {@link #createUserCreationIntent(String, String, String, PersistableBundle)}.
*/
public static final int USER_CREATION_FAILED_NO_MORE_USERS = Activity.RESULT_FIRST_USER + 1;
/**
* Indicates that users are switchable.
* @hide
*/
@SystemApi
public static final int SWITCHABILITY_STATUS_OK = 0;
/**
* Indicated that the user is in a phone call.
* @hide
*/
@SystemApi
public static final int SWITCHABILITY_STATUS_USER_IN_CALL = 1 << 0;
/**
* Indicates that user switching is disallowed ({@link #DISALLOW_USER_SWITCH} is set).
* @hide
*/
@SystemApi
public static final int SWITCHABILITY_STATUS_USER_SWITCH_DISALLOWED = 1 << 1;
/**
* Indicates that the system user is locked and user switching is not allowed.
* @hide
*/
@SystemApi
public static final int SWITCHABILITY_STATUS_SYSTEM_USER_LOCKED = 1 << 2;
/**
* Result returned in {@link #getUserSwitchability()} indicating user swichability.
* @hide
*/
@Retention(RetentionPolicy.SOURCE)
@IntDef(flag = true, prefix = { "SWITCHABILITY_STATUS_" }, value = {
SWITCHABILITY_STATUS_OK,
SWITCHABILITY_STATUS_USER_IN_CALL,
SWITCHABILITY_STATUS_USER_SWITCH_DISALLOWED,
SWITCHABILITY_STATUS_SYSTEM_USER_LOCKED
})
public @interface UserSwitchabilityResult {}
/**
* A response code from {@link #removeUserWhenPossible(UserHandle, boolean)} indicating that
* the specified user has been successfully removed.
*
* @hide
*/
@SystemApi
public static final int REMOVE_RESULT_REMOVED = 0;
/**
* A response code from {@link #removeUserWhenPossible(UserHandle, boolean)} indicating that
* the specified user is marked so that it will be removed when the user is stopped or on boot.
*
* @hide
*/
@SystemApi
public static final int REMOVE_RESULT_DEFERRED = 1;
/**
* A response code from {@link #removeUserWhenPossible(UserHandle, boolean)} indicating that
* the specified user is already in the process of being removed.
*
* @hide
*/
@SystemApi
public static final int REMOVE_RESULT_ALREADY_BEING_REMOVED = 2;
/**
* A response code from {@link #removeUserWhenPossible(UserHandle, boolean)} indicating that
* an unknown error occurred that prevented the user from being removed or set as ephemeral.
*
* @hide
*/
@SystemApi
public static final int REMOVE_RESULT_ERROR_UNKNOWN = -1;
/**
* A response code from {@link #removeUserWhenPossible(UserHandle, boolean)} indicating that
* the user could not be removed due to a {@link #DISALLOW_REMOVE_MANAGED_PROFILE} or
* {@link #DISALLOW_REMOVE_USER} user restriction.
*
* @hide
*/
@SystemApi
public static final int REMOVE_RESULT_ERROR_USER_RESTRICTION = -2;
/**
* A response code from {@link #removeUserWhenPossible(UserHandle, boolean)} indicating that
* user being removed does not exist.
*
* @hide
*/
@SystemApi
public static final int REMOVE_RESULT_ERROR_USER_NOT_FOUND = -3;
/**
* A response code from {@link #removeUserWhenPossible(UserHandle, boolean)} indicating that
* user being removed is a {@link UserHandle#SYSTEM} user which can't be removed.
*
* @hide
*/
@SystemApi
public static final int REMOVE_RESULT_ERROR_SYSTEM_USER = -4;
/**
* Possible response codes from {@link #removeUserWhenPossible(UserHandle, boolean)}.
*
* @hide
*/
@IntDef(prefix = { "REMOVE_RESULT_" }, value = {
REMOVE_RESULT_REMOVED,
REMOVE_RESULT_DEFERRED,
REMOVE_RESULT_ALREADY_BEING_REMOVED,
REMOVE_RESULT_ERROR_USER_RESTRICTION,
REMOVE_RESULT_ERROR_USER_NOT_FOUND,
REMOVE_RESULT_ERROR_SYSTEM_USER,
REMOVE_RESULT_ERROR_UNKNOWN,
})
@Retention(RetentionPolicy.SOURCE)
public @interface RemoveResult {}
/**
* Indicates user operation is successful.
*/
public static final int USER_OPERATION_SUCCESS = 0;
/**
* Indicates user operation failed for unknown reason.
*/
public static final int USER_OPERATION_ERROR_UNKNOWN = 1;
/**
* Indicates user operation failed because target user is a managed profile.
*/
public static final int USER_OPERATION_ERROR_MANAGED_PROFILE = 2;
/**
* Indicates user operation failed because maximum running user limit has been reached.
*/
public static final int USER_OPERATION_ERROR_MAX_RUNNING_USERS = 3;
/**
* Indicates user operation failed because the target user is in the foreground.
*/
public static final int USER_OPERATION_ERROR_CURRENT_USER = 4;
/**
* Indicates user operation failed because device has low data storage.
*/
public static final int USER_OPERATION_ERROR_LOW_STORAGE = 5;
/**
* Indicates user operation failed because maximum user limit has been reached.
*/
public static final int USER_OPERATION_ERROR_MAX_USERS = 6;
/**
* Indicates user operation failed because a user with that account already exists.
*
* @hide
*/
@SystemApi
public static final int USER_OPERATION_ERROR_USER_ACCOUNT_ALREADY_EXISTS = 7;
/**
* Result returned from various user operations.
*
* @hide
*/
@Retention(RetentionPolicy.SOURCE)
@IntDef(prefix = { "USER_OPERATION_" }, value = {
USER_OPERATION_SUCCESS,
USER_OPERATION_ERROR_UNKNOWN,
USER_OPERATION_ERROR_MANAGED_PROFILE,
USER_OPERATION_ERROR_MAX_RUNNING_USERS,
USER_OPERATION_ERROR_CURRENT_USER,
USER_OPERATION_ERROR_LOW_STORAGE,
USER_OPERATION_ERROR_MAX_USERS,
USER_OPERATION_ERROR_USER_ACCOUNT_ALREADY_EXISTS
})
public @interface UserOperationResult {}
/**
* Thrown to indicate user operation failed.
*/
public static class UserOperationException extends RuntimeException {
private final @UserOperationResult int mUserOperationResult;
/**
* Constructs a UserOperationException with specific result code.
*
* @param message the detail message
* @param userOperationResult the result code
* @hide
*/
public UserOperationException(String message,
@UserOperationResult int userOperationResult) {
super(message);
mUserOperationResult = userOperationResult;
}
/**
* Returns the operation result code.
*/
public @UserOperationResult int getUserOperationResult() {
return mUserOperationResult;
}
/**
* Returns a UserOperationException containing the same message and error code.
* @hide
*/
public static UserOperationException from(ServiceSpecificException exception) {
return new UserOperationException(exception.getMessage(), exception.errorCode);
}
}
/**
* Converts the ServiceSpecificException into a UserOperationException or throws null;
*
* @param exception exception to convert.
* @param throwInsteadOfNull if an exception should be thrown or null returned.
* @return null if chosen not to throw exception.
* @throws UserOperationException
*/
private <T> T returnNullOrThrowUserOperationException(ServiceSpecificException exception,
boolean throwInsteadOfNull) throws UserOperationException {
if (throwInsteadOfNull) {
throw UserOperationException.from(exception);
} else {
return null;
}
}
/**
* Thrown to indicate user operation failed. (Checked exception)
* @hide
*/
public static class CheckedUserOperationException extends AndroidException {
private final @UserOperationResult int mUserOperationResult;
/**
* Constructs a CheckedUserOperationException with specific result code.
*
* @param message the detail message
* @param userOperationResult the result code
* @hide
*/
public CheckedUserOperationException(String message,
@UserOperationResult int userOperationResult) {
super(message);
mUserOperationResult = userOperationResult;
}
/** Returns the operation result code. */
public @UserOperationResult int getUserOperationResult() {
return mUserOperationResult;
}
/** Return a ServiceSpecificException containing the same message and error code. */
public ServiceSpecificException toServiceSpecificException() {
return new ServiceSpecificException(mUserOperationResult, getMessage());
}
}
/**
* For apps targeting {@link Build.VERSION_CODES#TIRAMISU} and above, any UserManager API marked
* as {@link android.annotation.UserHandleAware @UserHandleAware} will use the context user
* (rather than the calling user).
* For apps targeting an SDK version <em>below</em> this, the behaviour
* depends on the particular method and when it was first introduced:
* <ul>
* <li>
* if the {@literal @}UserHandleAware specifies a
* {@link android.annotation.UserHandleAware#enabledSinceTargetSdkVersion} of
* {@link Build.VERSION_CODES#TIRAMISU} the <em>calling</em> user is used.
* </li>
* <li>
* if the {@literal @}UserHandleAware doesn't specify a
* {@link android.annotation.UserHandleAware#enabledSinceTargetSdkVersion}, the
* <em>context</em> user is used.
* </li>
* <li>there should currently be no other values used by UserManager for
* {@link android.annotation.UserHandleAware#enabledSinceTargetSdkVersion}, since all
* old implicitly user-dependant APIs were updated in that version and anything
* introduced more recently should already be {@literal @}UserHandleAware.
* </li>
* </ul>
*
* Note that when an API marked with
* {@link android.annotation.UserHandleAware#enabledSinceTargetSdkVersion} is run
* on a device whose OS predates that version, the calling user will be used, since on such a
* device, the API is not {@literal @}UserHandleAware yet.
*
* @hide
*/
@ChangeId
@EnabledSince(targetSdkVersion = Build.VERSION_CODES.TIRAMISU)
public static final long ALWAYS_USE_CONTEXT_USER = 183155436L;
/**
* Returns the context user or the calling user, depending on the target SDK.
* New APIs do not require such gating and therefore should always use mUserId instead.
* @see #ALWAYS_USE_CONTEXT_USER
*/
private @UserIdInt int getContextUserIfAppropriate() {
if (CompatChanges.isChangeEnabled(ALWAYS_USE_CONTEXT_USER)) {
return mUserId;
} else {
final int callingUser = UserHandle.myUserId();
if (callingUser != mUserId) {
Log.w(TAG, "Using the calling user " + callingUser
+ ", rather than the specified context user " + mUserId
+ ", because API is only UserHandleAware on higher targetSdkVersions.",
new Throwable());
}
return callingUser;
}
}
/** @hide */
@UnsupportedAppUsage
public static UserManager get(Context context) {
return (UserManager) context.getSystemService(Context.USER_SERVICE);
}
/** @hide */
public UserManager(Context context, IUserManager service) {
mService = service;
Context appContext = context.getApplicationContext();
mContext = (appContext == null ? context : appContext);
mUserId = context.getUserId();
}
/**
* Returns whether this device supports multiple users with their own login and customizable
* space.
* @return whether the device supports multiple users.
*/
public static boolean supportsMultipleUsers() {
return getMaxSupportedUsers() > 1
&& SystemProperties.getBoolean("fw.show_multiuserui",
Resources.getSystem().getBoolean(R.bool.config_enableMultiUserUI));
}
/**
* @hide
* @return Whether the device is running with split system user. It means the system user and
* primary user are two separate users. Previously system user and primary user are combined as
* a single owner user. see @link {android.os.UserHandle#USER_OWNER}
*/
@TestApi
public static boolean isSplitSystemUser() {
return RoSystemProperties.FW_SYSTEM_USER_SPLIT;
}
/**
* @return Whether guest user is always ephemeral
* @hide
*/
public static boolean isGuestUserAlwaysEphemeral() {
return Resources.getSystem()
.getBoolean(com.android.internal.R.bool.config_guestUserEphemeral);
}
/**
* @return true, when we want to enable user manager API and UX to allow
* guest user ephemeral state change based on user input
* @hide
*/
public static boolean isGuestUserAllowEphemeralStateChange() {
return Resources.getSystem()
.getBoolean(com.android.internal.R.bool.config_guestUserAllowEphemeralStateChange);
}
/**
* Checks whether the device is running in a headless system user mode.
*
* <p>Headless system user mode means the {@link #isSystemUser() system user} runs system
* services and some system UI, but it is not associated with any real person and additional
* users must be created to be associated with real persons.
*
* @return whether the device is running in a headless system user mode.
*/
public static boolean isHeadlessSystemUserMode() {
return RoSystemProperties.MULTIUSER_HEADLESS_SYSTEM_USER;
}
/**
* @deprecated use {@link #getUserSwitchability()} instead.
*
* @removed
* @hide
*/
@Deprecated
@RequiresPermission(allOf = {
Manifest.permission.READ_PHONE_STATE,
Manifest.permission.MANAGE_USERS}, // Can be INTERACT_ACROSS_USERS instead.
conditional = true)
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
@UserHandleAware
public boolean canSwitchUsers() {
boolean allowUserSwitchingWhenSystemUserLocked = Settings.Global.getInt(
mContext.getContentResolver(),
Settings.Global.ALLOW_USER_SWITCHING_WHEN_SYSTEM_USER_LOCKED, 0) != 0;
boolean isSystemUserUnlocked = isUserUnlocked(UserHandle.SYSTEM);
boolean inCall = false;
TelephonyManager telephonyManager = mContext.getSystemService(TelephonyManager.class);
if (telephonyManager != null) {
inCall = telephonyManager.getCallState() != TelephonyManager.CALL_STATE_IDLE;
}
boolean isUserSwitchDisallowed = hasUserRestrictionForUser(DISALLOW_USER_SWITCH, mUserId);
return (allowUserSwitchingWhenSystemUserLocked || isSystemUserUnlocked) && !inCall
&& !isUserSwitchDisallowed;
}
/**
* Returns whether switching users is currently allowed for the context user.
* <p>
* Switching users is not allowed in the following cases:
* <li>the user is in a phone call</li>
* <li>{@link #DISALLOW_USER_SWITCH} is set</li>
* <li>system user hasn't been unlocked yet</li>
*
* @return A {@link UserSwitchabilityResult} flag indicating if the user is switchable.
* @hide
*/
@SystemApi
@RequiresPermission(allOf = {Manifest.permission.READ_PHONE_STATE,
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.INTERACT_ACROSS_USERS}, conditional = true)
@UserHandleAware(enabledSinceTargetSdkVersion = Build.VERSION_CODES.TIRAMISU)
public @UserSwitchabilityResult int getUserSwitchability() {
return getUserSwitchability(UserHandle.of(getContextUserIfAppropriate()));
}
/**
* Returns whether switching users is currently allowed for the provided user.
* <p>
* Switching users is not allowed in the following cases:
* <li>the user is in a phone call</li>
* <li>{@link #DISALLOW_USER_SWITCH} is set</li>
* <li>system user hasn't been unlocked yet</li>
*
* @return A {@link UserSwitchabilityResult} flag indicating if the user is switchable.
* @hide
*/
@RequiresPermission(allOf = {Manifest.permission.READ_PHONE_STATE,
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.INTERACT_ACROSS_USERS}, conditional = true)
public @UserSwitchabilityResult int getUserSwitchability(UserHandle userHandle) {
final TelephonyManager tm =
(TelephonyManager) mContext.getSystemService(Context.TELEPHONY_SERVICE);
int flags = SWITCHABILITY_STATUS_OK;
if (tm.getCallState() != TelephonyManager.CALL_STATE_IDLE) {
flags |= SWITCHABILITY_STATUS_USER_IN_CALL;
}
if (hasUserRestrictionForUser(DISALLOW_USER_SWITCH, userHandle)) {
flags |= SWITCHABILITY_STATUS_USER_SWITCH_DISALLOWED;
}
// System User is always unlocked in Headless System User Mode, so ignore this flag
if (!isHeadlessSystemUserMode()) {
final boolean allowUserSwitchingWhenSystemUserLocked = Settings.Global.getInt(
mContext.getContentResolver(),
Settings.Global.ALLOW_USER_SWITCHING_WHEN_SYSTEM_USER_LOCKED, 0) != 0;
final boolean systemUserUnlocked = isUserUnlocked(UserHandle.SYSTEM);
if (!allowUserSwitchingWhenSystemUserLocked && !systemUserUnlocked) {
flags |= SWITCHABILITY_STATUS_SYSTEM_USER_LOCKED;
}
}
return flags;
}
/**
* Returns the userId for the context user.
*
* @return the userId of the context user.
*
* @deprecated To get the <em>calling</em> user, use {@link UserHandle#myUserId()}.
* To get the <em>context</em> user, get it directly from the context.
*
* @hide
*/
@Deprecated
@UnsupportedAppUsage
@UserHandleAware(enabledSinceTargetSdkVersion = Build.VERSION_CODES.TIRAMISU)
// *** Do NOT use this in UserManager. Instead always use mUserId. ***
public @UserIdInt int getUserHandle() {
return getContextUserIfAppropriate();
}
/**
* Returns the userId for the user that this process is running under
* (<em>not</em> the context user).
*
* @return the userId of <em>this process</em>.
*
* @deprecated Use {@link UserHandle#myUserId()}
* @hide
*/
@Deprecated
// NOT @UserHandleAware
public @UserIdInt int getProcessUserId() {
return UserHandle.myUserId();
}
/**
* @return the user type of the context user.
* @hide
*/
@TestApi
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.CREATE_USERS,
android.Manifest.permission.QUERY_USERS})
@UserHandleAware
public @NonNull String getUserType() {
UserInfo userInfo = getUserInfo(mUserId);
return userInfo == null ? "" : userInfo.userType;
}
/**
* Returns the user name of the context user. This call is only available to applications on
* the system image.
*
* @return the user name
*/
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.CREATE_USERS,
android.Manifest.permission.QUERY_USERS,
android.Manifest.permission.GET_ACCOUNTS_PRIVILEGED})
@UserHandleAware(
requiresAnyOfPermissionsIfNotCaller = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.CREATE_USERS,
android.Manifest.permission.QUERY_USERS})
public @NonNull String getUserName() {
if (UserHandle.myUserId() == mUserId) {
try {
return mService.getUserName();
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
} else {
UserInfo userInfo = getUserInfo(mUserId);
if (userInfo != null && userInfo.name != null) {
return userInfo.name;
}
return "";
}
}
/**
* Returns whether user name has been set.
* <p>This method can be used to check that the value returned by {@link #getUserName()} was
* set by the user and is not a placeholder string provided by the system.
* @hide
*/
@SystemApi
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.CREATE_USERS,
android.Manifest.permission.QUERY_USERS,
android.Manifest.permission.GET_ACCOUNTS_PRIVILEGED})
@UserHandleAware(
enabledSinceTargetSdkVersion = Build.VERSION_CODES.TIRAMISU,
requiresAnyOfPermissionsIfNotCaller = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.CREATE_USERS,
android.Manifest.permission.QUERY_USERS})
public boolean isUserNameSet() {
try {
return mService.isUserNameSet(getContextUserIfAppropriate());
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Used to determine whether the user making this call is subject to
* teleportations.
*
* <p>As of {@link android.os.Build.VERSION_CODES#LOLLIPOP}, this method can
* now automatically identify goats using advanced goat recognition technology.</p>
*
* <p>As of {@link android.os.Build.VERSION_CODES#R}, this method always returns
* {@code false} in order to protect goat privacy.</p>
*
* @return Returns whether the user making this call is a goat.
*/
@UserHandleAware(enabledSinceTargetSdkVersion = Build.VERSION_CODES.TIRAMISU)
public boolean isUserAGoat() {
if (mContext.getApplicationInfo().targetSdkVersion >= Build.VERSION_CODES.R) {
return false;
}
// Caution: This is NOT @UserHandleAware (because mContext is getApplicationContext and
// can hold a different userId), but for R+ it returns false, so it doesn't matter anyway.
return mContext.getPackageManager()
.isPackageAvailable("com.coffeestainstudios.goatsimulator");
}
/**
* Used to check if the context user is the primary user. The primary user
* is the first human user on a device. This is not supported in headless system user mode.
*
* @return whether the context user is the primary user.
* @hide
*/
@SystemApi
@RequiresPermission(anyOf = {
Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS,
Manifest.permission.QUERY_USERS})
@UserHandleAware(enabledSinceTargetSdkVersion = Build.VERSION_CODES.TIRAMISU)
public boolean isPrimaryUser() {
final UserInfo user = getUserInfo(getContextUserIfAppropriate());
return user != null && user.isPrimary();
}
/**
* Used to check if the context user is the system user. The system user
* is the initial user that is implicitly created on first boot and hosts most of the
* system services.
*
* @return whether the context user is the system user.
*/
@UserHandleAware(enabledSinceTargetSdkVersion = Build.VERSION_CODES.TIRAMISU)
public boolean isSystemUser() {
return getContextUserIfAppropriate() == UserHandle.USER_SYSTEM;
}
/**
* Used to check if the context user is an admin user. An admin user is allowed to
* modify or configure certain settings that aren't available to non-admin users,
* create and delete additional users, etc. There can be more than one admin users.
*
* @return whether the context user is an admin user.
* @hide
*/
@SystemApi
@RequiresPermission(anyOf = {
Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS,
Manifest.permission.QUERY_USERS})
@UserHandleAware(enabledSinceTargetSdkVersion = Build.VERSION_CODES.TIRAMISU)
public boolean isAdminUser() {
return isUserAdmin(getContextUserIfAppropriate());
}
/**
* @hide
* Returns whether the provided user is an admin user. There can be more than one admin
* user.
*/
@UnsupportedAppUsage
@RequiresPermission(anyOf = {
Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS,
Manifest.permission.QUERY_USERS})
public boolean isUserAdmin(@UserIdInt int userId) {
UserInfo user = getUserInfo(userId);
return user != null && user.isAdmin();
}
/**
* Returns whether the context user is of the given user type.
*
* @param userType the name of the user's user type, e.g.
* {@link UserManager#USER_TYPE_PROFILE_MANAGED}.
* @return true if the user is of the given user type.
* @hide
*/
@SystemApi
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.CREATE_USERS,
android.Manifest.permission.QUERY_USERS})
@UserHandleAware
public boolean isUserOfType(@NonNull String userType) {
try {
return mService.isUserOfType(mUserId, userType);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns whether the user type is a
* {@link UserManager#USER_TYPE_PROFILE_MANAGED managed profile}.
* @hide
*/
public static boolean isUserTypeManagedProfile(@Nullable String userType) {
return USER_TYPE_PROFILE_MANAGED.equals(userType);
}
/**
* Returns whether the user type is a {@link UserManager#USER_TYPE_FULL_GUEST guest user}.
* @hide
*/
public static boolean isUserTypeGuest(@Nullable String userType) {
return USER_TYPE_FULL_GUEST.equals(userType);
}
/**
* Returns whether the user type is a
* {@link UserManager#USER_TYPE_FULL_RESTRICTED restricted user}.
* @hide
*/
public static boolean isUserTypeRestricted(@Nullable String userType) {
return USER_TYPE_FULL_RESTRICTED.equals(userType);
}
/**
* Returns whether the user type is a {@link UserManager#USER_TYPE_FULL_DEMO demo user}.
* @hide
*/
public static boolean isUserTypeDemo(@Nullable String userType) {
return USER_TYPE_FULL_DEMO.equals(userType);
}
/**
* Returns whether the user type is a {@link UserManager#USER_TYPE_PROFILE_CLONE clone user}.
* @hide
*/
public static boolean isUserTypeCloneProfile(@Nullable String userType) {
return USER_TYPE_PROFILE_CLONE.equals(userType);
}
/**
* Returns the enum defined in the statsd UserLifecycleJourneyReported atom corresponding to the
* user type.
* @hide
*/
public static int getUserTypeForStatsd(@NonNull String userType) {
switch (userType) {
case USER_TYPE_FULL_SYSTEM:
return FrameworkStatsLog.USER_LIFECYCLE_JOURNEY_REPORTED__USER_TYPE__FULL_SYSTEM;
case USER_TYPE_FULL_SECONDARY:
return FrameworkStatsLog.USER_LIFECYCLE_JOURNEY_REPORTED__USER_TYPE__FULL_SECONDARY;
case USER_TYPE_FULL_GUEST:
return FrameworkStatsLog.USER_LIFECYCLE_JOURNEY_REPORTED__USER_TYPE__FULL_GUEST;
case USER_TYPE_FULL_DEMO:
return FrameworkStatsLog.USER_LIFECYCLE_JOURNEY_REPORTED__USER_TYPE__FULL_DEMO;
case USER_TYPE_FULL_RESTRICTED:
return FrameworkStatsLog
.USER_LIFECYCLE_JOURNEY_REPORTED__USER_TYPE__FULL_RESTRICTED;
case USER_TYPE_PROFILE_MANAGED:
return FrameworkStatsLog
.USER_LIFECYCLE_JOURNEY_REPORTED__USER_TYPE__PROFILE_MANAGED;
case USER_TYPE_SYSTEM_HEADLESS:
return FrameworkStatsLog
.USER_LIFECYCLE_JOURNEY_REPORTED__USER_TYPE__SYSTEM_HEADLESS;
case USER_TYPE_PROFILE_CLONE:
return FrameworkStatsLog
.USER_LIFECYCLE_JOURNEY_REPORTED__USER_TYPE__PROFILE_CLONE;
default:
return FrameworkStatsLog.USER_LIFECYCLE_JOURNEY_REPORTED__USER_TYPE__TYPE_UNKNOWN;
}
}
/**
* @hide
* @deprecated Use {@link #isRestrictedProfile()}
*/
@UnsupportedAppUsage
@Deprecated
@UserHandleAware(
enabledSinceTargetSdkVersion = Build.VERSION_CODES.TIRAMISU,
requiresAnyOfPermissionsIfNotCaller = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.CREATE_USERS}
)
public boolean isLinkedUser() {
return isRestrictedProfile();
}
/**
* Used to check if the context user is a restricted profile. Restricted profiles
* may have a reduced number of available apps, app restrictions, and account restrictions.
*
* @return whether the context user is a restricted profile.
* @hide
*/
@SystemApi
@UserHandleAware(
enabledSinceTargetSdkVersion = Build.VERSION_CODES.TIRAMISU,
requiresAnyOfPermissionsIfNotCaller = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.CREATE_USERS}
)
public boolean isRestrictedProfile() {
try {
return mService.isRestricted(getContextUserIfAppropriate());
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Check if a user is a restricted profile. Restricted profiles may have a reduced number of
* available apps, app restrictions, and account restrictions.
*
* @param user the user to check
* @return whether the user is a restricted profile.
* @hide
*/
@SystemApi
@RequiresPermission(anyOf = {
Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS},
conditional = true)
public boolean isRestrictedProfile(@NonNull UserHandle user) {
try {
return mService.isRestricted(user.getIdentifier());
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Checks if the calling context user can have a restricted profile.
* @return whether the context user can have a restricted profile.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
@UserHandleAware
public boolean canHaveRestrictedProfile() {
try {
return mService.canHaveRestrictedProfile(mUserId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns whether the context user has at least one restricted profile associated with it.
* @return whether the user has a restricted profile associated with it
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
@UserHandleAware(enabledSinceTargetSdkVersion = Build.VERSION_CODES.TIRAMISU)
public boolean hasRestrictedProfiles() {
try {
return mService.hasRestrictedProfiles(getContextUserIfAppropriate());
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Get the parent of a restricted profile.
*
* @return the parent of the user or {@code null} if the user is not restricted profile
* @hide
*/
@SystemApi
@RequiresPermission(anyOf = {
Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS,
Manifest.permission.QUERY_USERS})
@UserHandleAware
public @Nullable UserHandle getRestrictedProfileParent() {
final UserInfo info = getUserInfo(mUserId);
if (info == null) return null;
if (!info.isRestricted()) return null;
final int parent = info.restrictedProfileParentId;
if (parent == UserHandle.USER_NULL) return null;
return UserHandle.of(parent);
}
/**
* Checks if a user is a guest user.
* @return whether user is a guest user.
* @hide
*/
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
@RequiresPermission(anyOf = {
Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS,
Manifest.permission.QUERY_USERS})
public boolean isGuestUser(@UserIdInt int userId) {
UserInfo user = getUserInfo(userId);
return user != null && user.isGuest();
}
/**
* Used to check if the context user is a guest user. A guest user may be transient.
*
* @return whether the context user is a guest user.
* @hide
*/
@SystemApi
@RequiresPermission(anyOf = {
Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS,
Manifest.permission.QUERY_USERS})
@UserHandleAware(enabledSinceTargetSdkVersion = Build.VERSION_CODES.TIRAMISU)
public boolean isGuestUser() {
UserInfo user = getUserInfo(getContextUserIfAppropriate());
return user != null && user.isGuest();
}
/**
* Checks if the context user is a demo user. When running in a demo user,
* apps can be more helpful to the user, or explain their features in more detail.
*
* @return whether the context user is a demo user.
*/
@UserHandleAware(
enabledSinceTargetSdkVersion = Build.VERSION_CODES.TIRAMISU,
requiresPermissionIfNotCaller = android.Manifest.permission.MANAGE_USERS
)
public boolean isDemoUser() {
try {
return mService.isDemoUser(getContextUserIfAppropriate());
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Checks if the calling context user is running in a profile. A profile is a user that
* typically has its own separate data but shares its UI with some parent user. For example, a
* {@link #isManagedProfile() managed profile} is a type of profile.
*
* @return whether the caller is in a profile.
*/
@UserHandleAware(
requiresAnyOfPermissionsIfNotCallerProfileGroup = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.QUERY_USERS,
android.Manifest.permission.INTERACT_ACROSS_USERS})
public boolean isProfile() {
return isProfile(mUserId);
}
private boolean isProfile(@UserIdInt int userId) {
final String profileType = getProfileType(userId);
return profileType != null && !profileType.equals("");
}
/**
* Returns the user type of the context user if it is a profile.
*
* This is a more specific form of {@link #getUserType()} with relaxed permission requirements.
*
* @return the user type of the context user if it is a {@link #isProfile() profile},
* an empty string if it is not a profile,
* or null if the user doesn't exist.
*/
@UserHandleAware(
requiresAnyOfPermissionsIfNotCallerProfileGroup = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.QUERY_USERS,
android.Manifest.permission.INTERACT_ACROSS_USERS})
private @Nullable String getProfileType() {
return getProfileType(mUserId);
}
/** @see #getProfileType() */
private @Nullable String getProfileType(@UserIdInt int userId) {
// First, the typical case (i.e. the *process* user, not necessarily the context user).
// This cache cannot be become invalidated since it's about the calling process itself.
if (userId == UserHandle.myUserId()) {
// No need for synchronization. Once it becomes non-null, it'll be non-null forever.
// Worst case we might end up calling the AIDL method multiple times but that's fine.
if (mProfileTypeOfProcessUser != null) {
return mProfileTypeOfProcessUser;
}
try {
final String profileType = mService.getProfileType(userId);
if (profileType != null) {
return mProfileTypeOfProcessUser = profileType.intern();
}
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
// The userId is not for the process's user. Use a slower cache that handles invalidation.
return mProfileTypeCache.query(userId);
}
/**
* Checks if the context user is a managed profile.
*
* Note that this applies specifically to <em>managed</em> profiles. For profiles in general,
* use {@link #isProfile()} instead.
*
* @return whether the context user is a managed profile.
*/
@UserHandleAware(
enabledSinceTargetSdkVersion = Build.VERSION_CODES.TIRAMISU,
requiresAnyOfPermissionsIfNotCallerProfileGroup = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.QUERY_USERS,
android.Manifest.permission.INTERACT_ACROSS_USERS})
public boolean isManagedProfile() {
return isManagedProfile(getContextUserIfAppropriate());
}
/**
* Checks if the specified user is a managed profile.
* Requires {@link android.Manifest.permission#MANAGE_USERS} or
* {@link android.Manifest.permission#INTERACT_ACROSS_USERS} or
* {@link android.Manifest.permission#QUERY_USERS} permission, otherwise the caller
* must be in the same profile group of specified user.
*
* Note that this applies specifically to <em>managed</em> profiles. For profiles in general,
* use {@link #isProfile()} instead.
*
* @return whether the specified user is a managed profile.
* @hide
*/
@SystemApi
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.QUERY_USERS,
android.Manifest.permission.INTERACT_ACROSS_USERS}, conditional = true)
public boolean isManagedProfile(@UserIdInt int userId) {
return isUserTypeManagedProfile(getProfileType(userId));
}
/**
* Checks if the context user is a clone profile.
*
* @return whether the context user is a clone profile.
*
* @see android.os.UserManager#USER_TYPE_PROFILE_CLONE
* @hide
*/
@SystemApi
@UserHandleAware(
requiresAnyOfPermissionsIfNotCallerProfileGroup = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.QUERY_USERS,
android.Manifest.permission.INTERACT_ACROSS_USERS})
@SuppressAutoDoc
public boolean isCloneProfile() {
return isUserTypeCloneProfile(getProfileType());
}
/**
* Checks if the context user is an ephemeral user.
*
* @return whether the context user is an ephemeral user.
* @hide
*/
@RequiresPermission(anyOf = {
Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS,
Manifest.permission.QUERY_USERS})
@UserHandleAware
public boolean isEphemeralUser() {
return isUserEphemeral(mUserId);
}
/**
* Returns whether the specified user is ephemeral.
* @hide
*/
@RequiresPermission(anyOf = {
Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS,
Manifest.permission.QUERY_USERS})
public boolean isUserEphemeral(@UserIdInt int userId) {
final UserInfo user = getUserInfo(userId);
return user != null && user.isEphemeral();
}
/**
* Return whether the given user is actively running. This means that
* the user is in the "started" state, not "stopped" -- it is currently
* allowed to run code through scheduled alarms, receiving broadcasts,
* etc. A started user may be either the current foreground user or a
* background user; the result here does not distinguish between the two.
*
* <p>Note prior to Android Nougat MR1 (SDK version <= 24;
* {@link android.os.Build.VERSION_CODES#N}, this API required a system permission
* in order to check other profile's status.
* Since Android Nougat MR1 (SDK version >= 25;
* {@link android.os.Build.VERSION_CODES#N_MR1}), the restriction has been relaxed, and now
* it'll accept any {@link android.os.UserHandle} within the same profile group as the caller.
*
* @param user The user to retrieve the running state for.
*/
@RequiresPermission(anyOf = {Manifest.permission.MANAGE_USERS,
Manifest.permission.INTERACT_ACROSS_USERS}, conditional = true)
public boolean isUserRunning(UserHandle user) {
return isUserRunning(user.getIdentifier());
}
/** {@hide} */
@RequiresPermission(anyOf = {Manifest.permission.MANAGE_USERS,
Manifest.permission.INTERACT_ACROSS_USERS}, conditional = true)
public boolean isUserRunning(@UserIdInt int userId) {
try {
return mService.isUserRunning(userId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Return whether the given user is actively running <em>or</em> stopping.
* This is like {@link #isUserRunning(UserHandle)}, but will also return
* true if the user had been running but is in the process of being stopped
* (but is not yet fully stopped, and still running some code).
*
* <p>Note prior to Android Nougat MR1 (SDK version <= 24;
* {@link android.os.Build.VERSION_CODES#N}, this API required a system permission
* in order to check other profile's status.
* Since Android Nougat MR1 (SDK version >= 25;
* {@link android.os.Build.VERSION_CODES#N_MR1}), the restriction has been relaxed, and now
* it'll accept any {@link android.os.UserHandle} within the same profile group as the caller.
*
* @param user The user to retrieve the running state for.
*/
@RequiresPermission(anyOf = {Manifest.permission.MANAGE_USERS,
Manifest.permission.INTERACT_ACROSS_USERS}, conditional = true)
public boolean isUserRunningOrStopping(UserHandle user) {
try {
// TODO: reconcile stopped vs stopping?
return ActivityManager.getService().isUserRunning(
user.getIdentifier(), ActivityManager.FLAG_OR_STOPPED);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Checks if the context user is running in the foreground.
*
* @return whether the context user is running in the foreground.
*/
@UserHandleAware
public boolean isUserForeground() {
try {
return mService.isUserForeground(mUserId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Return whether the context user is running in an "unlocked" state.
* <p>
* On devices with direct boot, a user is unlocked only after they've
* entered their credentials (such as a lock pattern or PIN). On devices
* without direct boot, a user is unlocked as soon as it starts.
* <p>
* When a user is locked, only device-protected data storage is available.
* When a user is unlocked, both device-protected and credential-protected
* private app data storage is available.
*
* @see Intent#ACTION_USER_UNLOCKED
* @see Context#createDeviceProtectedStorageContext()
*/
@UserHandleAware(
enabledSinceTargetSdkVersion = Build.VERSION_CODES.TIRAMISU,
requiresAnyOfPermissionsIfNotCallerProfileGroup = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.INTERACT_ACROSS_USERS}
)
public boolean isUserUnlocked() {
return isUserUnlocked(getContextUserIfAppropriate());
}
/**
* Return whether the given user is running in an "unlocked" state.
* <p>
* On devices with direct boot, a user is unlocked only after they've
* entered their credentials (such as a lock pattern or PIN). On devices
* without direct boot, a user is unlocked as soon as it starts.
* <p>
* When a user is locked, only device-protected data storage is available.
* When a user is unlocked, both device-protected and credential-protected
* private app data storage is available.
* <p>Requires {@code android.permission.MANAGE_USERS} or
* {@code android.permission.INTERACT_ACROSS_USERS}, otherwise specified {@link UserHandle user}
* must be the calling user or a profile associated with it.
*
* @param user to retrieve the unlocked state for.
* @see Intent#ACTION_USER_UNLOCKED
* @see Context#createDeviceProtectedStorageContext()
*/
@RequiresPermission(anyOf = {Manifest.permission.MANAGE_USERS,
Manifest.permission.INTERACT_ACROSS_USERS}, conditional = true)
public boolean isUserUnlocked(UserHandle user) {
return isUserUnlocked(user.getIdentifier());
}
private static final String CACHE_KEY_IS_USER_UNLOCKED_PROPERTY =
"cache_key.is_user_unlocked";
private final PropertyInvalidatedCache<Integer, Boolean> mIsUserUnlockedCache =
new PropertyInvalidatedCache<Integer, Boolean>(
32, CACHE_KEY_IS_USER_UNLOCKED_PROPERTY) {
@Override
public Boolean recompute(Integer query) {
try {
return mService.isUserUnlocked(query);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
@Override
public boolean bypass(Integer query) {
return query < 0;
}
};
// Uses IS_USER_UNLOCKED_PROPERTY for invalidation as the APIs have the same dependencies.
private final PropertyInvalidatedCache<Integer, Boolean> mIsUserUnlockingOrUnlockedCache =
new PropertyInvalidatedCache<Integer, Boolean>(
32, CACHE_KEY_IS_USER_UNLOCKED_PROPERTY) {
@Override
public Boolean recompute(Integer query) {
try {
return mService.isUserUnlockingOrUnlocked(query);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
@Override
public boolean bypass(Integer query) {
return query < 0;
}
};
/** {@hide} */
@UnsupportedAppUsage
@RequiresPermission(anyOf = {Manifest.permission.MANAGE_USERS,
Manifest.permission.INTERACT_ACROSS_USERS}, conditional = true)
public boolean isUserUnlocked(@UserIdInt int userId) {
return mIsUserUnlockedCache.query(userId);
}
/** {@hide} */
public void disableIsUserUnlockedCache() {
mIsUserUnlockedCache.disableLocal();
mIsUserUnlockingOrUnlockedCache.disableLocal();
}
/** {@hide} */
public static final void invalidateIsUserUnlockedCache() {
PropertyInvalidatedCache.invalidateCache(CACHE_KEY_IS_USER_UNLOCKED_PROPERTY);
}
/**
* Return whether the provided user is already running in an
* "unlocked" state or in the process of unlocking.
* <p>
* On devices with direct boot, a user is unlocked only after they've
* entered their credentials (such as a lock pattern or PIN). On devices
* without direct boot, a user is unlocked as soon as it starts.
* <p>
* When a user is locked, only device-protected data storage is available.
* When a user is unlocked, both device-protected and credential-protected
* private app data storage is available.
*
* <p>Requires {@code android.permission.MANAGE_USERS} or
* {@code android.permission.INTERACT_ACROSS_USERS}, otherwise specified {@link UserHandle user}
* must be the calling user or a profile associated with it.
*
* @hide
*/
@SystemApi
@RequiresPermission(anyOf = {Manifest.permission.MANAGE_USERS,
Manifest.permission.INTERACT_ACROSS_USERS}, conditional = true)
public boolean isUserUnlockingOrUnlocked(@NonNull UserHandle user) {
return isUserUnlockingOrUnlocked(user.getIdentifier());
}
/** {@hide} */
@RequiresPermission(anyOf = {Manifest.permission.MANAGE_USERS,
Manifest.permission.INTERACT_ACROSS_USERS}, conditional = true)
public boolean isUserUnlockingOrUnlocked(@UserIdInt int userId) {
return mIsUserUnlockingOrUnlockedCache.query(userId);
}
/**
* Return the time when the calling user started in elapsed milliseconds since boot,
* or 0 if not started.
*
* @hide
*/
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
// NOT @UserHandleAware
public long getUserStartRealtime() {
if (getContextUserIfAppropriate() != UserHandle.myUserId()) {
// Note: If we want to support this in the future, also annotate with
// @UserHandleAware(enabledSinceTargetSdkVersion = Build.VERSION_CODES.TIRAMISU)
throw new IllegalArgumentException("Calling from a context differing from the calling "
+ "user is not currently supported.");
}
try {
return mService.getUserStartRealtime();
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Return the time when the context user was unlocked elapsed milliseconds since boot,
* or 0 if not unlocked.
*
* @hide
*/
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
// NOT @UserHandleAware
public long getUserUnlockRealtime() {
if (getContextUserIfAppropriate() != UserHandle.myUserId()) {
// Note: If we want to support this in the future, also annotate with
// @UserHandleAware(enabledSinceTargetSdkVersion = Build.VERSION_CODES.TIRAMISU)
throw new IllegalArgumentException("Calling from a context differing from the calling "
+ "user is not currently supported.");
}
try {
return mService.getUserUnlockRealtime();
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns the UserInfo object describing a specific user.
* @param userId the user handle of the user whose information is being requested.
* @return the UserInfo object for a specific user.
* @hide
*/
@UnsupportedAppUsage
@RequiresPermission(anyOf = {
Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS,
Manifest.permission.QUERY_USERS})
public UserInfo getUserInfo(@UserIdInt int userId) {
try {
return mService.getUserInfo(userId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* @hide
*
* Returns who set a user restriction on a user.
* @param restrictionKey the string key representing the restriction
* @param userHandle the UserHandle of the user for whom to retrieve the restrictions.
* @return The source of user restriction. Any combination of {@link #RESTRICTION_NOT_SET},
* {@link #RESTRICTION_SOURCE_SYSTEM}, {@link #RESTRICTION_SOURCE_DEVICE_OWNER}
* and {@link #RESTRICTION_SOURCE_PROFILE_OWNER}
* @deprecated use {@link #getUserRestrictionSources(String, int)} instead.
*/
@Deprecated
@SystemApi
@UserRestrictionSource
@RequiresPermission(anyOf = {
Manifest.permission.MANAGE_USERS,
Manifest.permission.QUERY_USERS})
public int getUserRestrictionSource(@UserRestrictionKey String restrictionKey,
UserHandle userHandle) {
try {
return mService.getUserRestrictionSource(restrictionKey, userHandle.getIdentifier());
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* @hide
*
* Returns a list of users who set a user restriction on a given user.
* @param restrictionKey the string key representing the restriction
* @param userHandle the UserHandle of the user for whom to retrieve the restrictions.
* @return a list of user ids enforcing this restriction.
*/
@SystemApi
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.QUERY_USERS})
public List<EnforcingUser> getUserRestrictionSources(
@UserRestrictionKey String restrictionKey, UserHandle userHandle) {
try {
return mService.getUserRestrictionSources(restrictionKey, userHandle.getIdentifier());
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns the user-wide restrictions imposed on the context user.
* @return a Bundle containing all the restrictions.
*/
@UserHandleAware(
enabledSinceTargetSdkVersion = Build.VERSION_CODES.TIRAMISU,
requiresAnyOfPermissionsIfNotCallerProfileGroup = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.INTERACT_ACROSS_USERS}
)
public Bundle getUserRestrictions() {
try {
return mService.getUserRestrictions(getContextUserIfAppropriate());
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns the user-wide restrictions imposed on the user specified by <code>userHandle</code>.
* @param userHandle the UserHandle of the user for whom to retrieve the restrictions.
* @return a Bundle containing all the restrictions.
*
* <p>Requires {@code android.permission.MANAGE_USERS} or
* {@code android.permission.INTERACT_ACROSS_USERS}, otherwise specified {@link UserHandle user}
* must be the calling user or a profile associated with it.
*/
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.INTERACT_ACROSS_USERS}, conditional = true)
public Bundle getUserRestrictions(UserHandle userHandle) {
try {
return mService.getUserRestrictions(userHandle.getIdentifier());
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* @hide
* Returns whether the given user has been disallowed from performing certain actions
* or setting certain settings through UserManager (e.g. this type of restriction would prevent
* the guest user from doing certain things, such as making calls). This method disregards
* restrictions set by device policy.
* @param restrictionKey the string key representing the restriction
* @param userHandle the UserHandle of the user for whom to retrieve the restrictions.
*/
@TestApi
@UnsupportedAppUsage
@RequiresPermission(anyOf = {Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS})
public boolean hasBaseUserRestriction(@UserRestrictionKey @NonNull String restrictionKey,
@NonNull UserHandle userHandle) {
try {
return mService.hasBaseUserRestriction(restrictionKey, userHandle.getIdentifier());
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* This will no longer work. Device owners and profile owners should use
* {@link DevicePolicyManager#addUserRestriction(ComponentName, String)} instead.
*/
// System apps should use UserManager.setUserRestriction() instead.
@Deprecated
public void setUserRestrictions(Bundle restrictions) {
throw new UnsupportedOperationException("This method is no longer supported");
}
/**
* This will no longer work. Device owners and profile owners should use
* {@link DevicePolicyManager#addUserRestriction(ComponentName, String)} instead.
*/
// System apps should use UserManager.setUserRestriction() instead.
@Deprecated
public void setUserRestrictions(Bundle restrictions, UserHandle userHandle) {
throw new UnsupportedOperationException("This method is no longer supported");
}
/**
* Sets the value of a specific restriction on the context user.
* Requires the MANAGE_USERS permission.
* @param key the key of the restriction
* @param value the value for the restriction
* @deprecated use {@link android.app.admin.DevicePolicyManager#addUserRestriction(
* android.content.ComponentName, String)} or
* {@link android.app.admin.DevicePolicyManager#clearUserRestriction(
* android.content.ComponentName, String)} instead.
*/
@Deprecated
@RequiresPermission(Manifest.permission.MANAGE_USERS)
@UserHandleAware(enabledSinceTargetSdkVersion = Build.VERSION_CODES.TIRAMISU)
public void setUserRestriction(String key, boolean value) {
try {
mService.setUserRestriction(key, value, getContextUserIfAppropriate());
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* @hide
* Sets the value of a specific restriction on a specific user.
* @param key the key of the restriction
* @param value the value for the restriction
* @param userHandle the user whose restriction is to be changed.
* @deprecated use {@link android.app.admin.DevicePolicyManager#addUserRestriction(
* android.content.ComponentName, String)} or
* {@link android.app.admin.DevicePolicyManager#clearUserRestriction(
* android.content.ComponentName, String)} instead.
*/
@Deprecated
@RequiresPermission(Manifest.permission.MANAGE_USERS)
public void setUserRestriction(String key, boolean value, UserHandle userHandle) {
try {
mService.setUserRestriction(key, value, userHandle.getIdentifier());
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns whether the context user has been disallowed from performing certain actions
* or setting certain settings.
*
* @param restrictionKey The string key representing the restriction.
* @return {@code true} if the context user has the given restriction, {@code false} otherwise.
*/
@UserHandleAware(
enabledSinceTargetSdkVersion = Build.VERSION_CODES.TIRAMISU,
requiresAnyOfPermissionsIfNotCallerProfileGroup = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.INTERACT_ACROSS_USERS}
)
public boolean hasUserRestriction(@UserRestrictionKey String restrictionKey) {
return hasUserRestrictionForUser(restrictionKey, getContextUserIfAppropriate());
}
/**
* @hide
* Returns whether the given user has been disallowed from performing certain actions
* or setting certain settings.
* @param restrictionKey the string key representing the restriction
* @param userHandle the UserHandle of the user for whom to retrieve the restrictions.
* @deprecated Use {@link #hasUserRestrictionForUser(String, UserHandle)} instead.
*/
@UnsupportedAppUsage
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.INTERACT_ACROSS_USERS}, conditional = true)
@Deprecated
public boolean hasUserRestriction(@UserRestrictionKey String restrictionKey,
UserHandle userHandle) {
return hasUserRestrictionForUser(restrictionKey, userHandle);
}
/**
* Returns whether the given user has been disallowed from performing certain actions
* or setting certain settings.
* @param restrictionKey the string key representing the restriction
* @param userHandle the UserHandle of the user for whom to retrieve the restrictions.
*
* <p>Requires {@code android.permission.MANAGE_USERS} or
* {@code android.permission.INTERACT_ACROSS_USERS}, otherwise specified {@link UserHandle user}
* must be the calling user or a profile associated with it.
*
* @hide
*/
@SystemApi
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.INTERACT_ACROSS_USERS}, conditional = true)
public boolean hasUserRestrictionForUser(@NonNull @UserRestrictionKey String restrictionKey,
@NonNull UserHandle userHandle) {
return hasUserRestrictionForUser(restrictionKey, userHandle.getIdentifier());
}
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.INTERACT_ACROSS_USERS}, conditional = true)
private boolean hasUserRestrictionForUser(@NonNull @UserRestrictionKey String restrictionKey,
@UserIdInt int userId) {
try {
return mService.hasUserRestriction(restrictionKey, userId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* @hide
* Returns whether any user on the device has the given user restriction set.
*/
public boolean hasUserRestrictionOnAnyUser(@UserRestrictionKey String restrictionKey) {
try {
return mService.hasUserRestrictionOnAnyUser(restrictionKey);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* @hide
*
* Checks whether changing the given setting to the given value is prohibited
* by the corresponding user restriction in the given user.
*
* May only be called by the OS itself.
*
* @return {@code true} if the change is prohibited, {@code false} if the change is allowed.
*/
public boolean isSettingRestrictedForUser(String setting, @UserIdInt int userId,
String value, int callingUid) {
try {
return mService.isSettingRestrictedForUser(setting, userId, value, callingUid);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* @hide
* Register a binder callback for user restrictions changes.
* May only be called by the OS itself.
*/
public void addUserRestrictionsListener(final IUserRestrictionsListener listener) {
try {
mService.addUserRestrictionsListener(listener);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Return the serial number for a user. This is a device-unique
* number assigned to that user; if the user is deleted and then a new
* user created, the new users will not be given the same serial number.
* @param user The user whose serial number is to be retrieved.
* @return The serial number of the given user; returns -1 if the
* given UserHandle does not exist.
* @see #getUserForSerialNumber(long)
*/
public long getSerialNumberForUser(UserHandle user) {
return getUserSerialNumber(user.getIdentifier());
}
/**
* Return the user associated with a serial number previously
* returned by {@link #getSerialNumberForUser(UserHandle)}.
* @param serialNumber The serial number of the user that is being
* retrieved.
* @return Return the user associated with the serial number, or null
* if there is not one.
* @see #getSerialNumberForUser(UserHandle)
*/
public UserHandle getUserForSerialNumber(long serialNumber) {
int ident = getUserHandle((int) serialNumber);
return ident >= 0 ? new UserHandle(ident) : null;
}
/**
* Creates a user with the specified name and options.
* Default user restrictions will be applied.
* Requires {@link android.Manifest.permission#MANAGE_USERS} permission.
*
* @param name the user's name
* @param flags UserInfo flags that identify the type of user and other properties.
* @see UserInfo
*
* @return the UserInfo object for the created user, or null if the user could not be created.
* @throws IllegalArgumentException if flags do not correspond to a valid user type.
* @deprecated Use {@link #createUser(String, String, int)} instead.
* @hide
*/
@UnsupportedAppUsage
@Deprecated
public @Nullable UserInfo createUser(@Nullable String name, @UserInfoFlag int flags) {
return createUser(name, UserInfo.getDefaultUserType(flags), flags);
}
/**
* Creates a user with the specified name and options.
* Default user restrictions will be applied.
*
* <p>Requires {@link android.Manifest.permission#MANAGE_USERS}.
* {@link android.Manifest.permission#CREATE_USERS} suffices if flags are in
* com.android.server.pm.UserManagerService#ALLOWED_FLAGS_FOR_CREATE_USERS_PERMISSION}.
*
* @param name the user's name
* @param userType the type of user, such as {@link UserManager#USER_TYPE_FULL_GUEST}.
* @param flags UserInfo flags that specify user properties.
* @return the {@link UserInfo} object for the created user, or {@code null} if the user
* could not be created.
*
* @see UserInfo
*
* @hide
*/
@RequiresPermission(anyOf = {Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS})
@TestApi
public @Nullable UserInfo createUser(@Nullable String name, @NonNull String userType,
@UserInfoFlag int flags) {
try {
return mService.createUserWithThrow(name, userType, flags);
} catch (ServiceSpecificException e) {
return null;
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Creates a user with the specified {@link NewUserRequest}.
*
* @param newUserRequest specify the user information
*
* @hide
*/
@SystemApi
@RequiresPermission(anyOf = {Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS})
public @NonNull NewUserResponse createUser(@NonNull NewUserRequest newUserRequest) {
try {
final UserHandle userHandle = mService.createUserWithAttributes(
newUserRequest.getName(),
newUserRequest.getUserType(),
newUserRequest.getFlags(),
newUserRequest.getUserIcon(),
newUserRequest.getAccountName(),
newUserRequest.getAccountType(),
newUserRequest.getAccountOptions());
return new NewUserResponse(userHandle, USER_OPERATION_SUCCESS);
} catch (ServiceSpecificException e) {
Log.w(TAG, "Exception while creating user " + newUserRequest, e);
return new NewUserResponse(null, e.errorCode);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Pre-creates a user of the specified type. Default user restrictions will be applied.
*
* <p>This method can be used by OEMs to "warm" up the user creation by pre-creating some users
* at the first boot, so they when the "real" user is created (for example,
* by {@link #createUser(String, String, int)} or {@link #createGuest(Context)}), it
* takes less time.
*
* <p>This method completes the majority of work necessary for user creation: it
* creates user data, CE and DE encryption keys, app data directories, initializes the user and
* grants default permissions. When pre-created users become "real" users, only then are
* components notified of new user creation by firing user creation broadcasts.
*
* <p>All pre-created users are removed during system upgrade.
*
* <p>Requires {@link android.Manifest.permission#MANAGE_USERS}.
* {@link android.Manifest.permission#CREATE_USERS} suffices if flags are in
* com.android.server.pm.UserManagerService#ALLOWED_FLAGS_FOR_CREATE_USERS_PERMISSION}.
*
* @param userType the type of user, such as {@link UserManager#USER_TYPE_FULL_GUEST}.
* @return the {@link UserInfo} object for the created user.
*
* @throws UserOperationException if the user could not be created.
* @hide
*/
@TestApi
@RequiresPermission(anyOf = {Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS})
public @NonNull UserInfo preCreateUser(@NonNull String userType)
throws UserOperationException {
try {
return mService.preCreateUserWithThrow(userType);
} catch (ServiceSpecificException e) {
throw UserOperationException.from(e);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Creates a guest user and configures it.
* @param context an application context
* @return the {@link UserInfo} object for the created user, or {@code null} if the user
* could not be created.
*
* @hide
*/
@RequiresPermission(anyOf = {Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS})
public UserInfo createGuest(Context context) {
try {
final UserInfo guest = mService.createUserWithThrow(null, USER_TYPE_FULL_GUEST, 0);
if (guest != null) {
Settings.Secure.putStringForUser(context.getContentResolver(),
Settings.Secure.SKIP_FIRST_USE_HINTS, "1", guest.id);
if (UserManager.isGuestUserAllowEphemeralStateChange()) {
// Mark guest as (changeably) ephemeral if REMOVE_GUEST_ON_EXIT is 1
// This is done so that a user via a UI controller can choose to
// make a guest as ephemeral or not.
// Settings.Global.REMOVE_GUEST_ON_EXIT holds the choice on what the guest state
// should be, with default being ephemeral.
boolean resetGuestOnExit = Settings.Global.getInt(context.getContentResolver(),
Settings.Global.REMOVE_GUEST_ON_EXIT, 1) == 1;
if (resetGuestOnExit && !guest.isEphemeral()) {
setUserEphemeral(guest.id, true);
}
}
}
return guest;
} catch (ServiceSpecificException e) {
return null;
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Gets the existing guest user if it exists. This does not include guest users that are dying.
* @return The existing guest user if it exists. Null otherwise.
* @hide
*/
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
public UserInfo findCurrentGuestUser() {
try {
return mService.findCurrentGuestUser();
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Creates a user with the specified name and options as a profile of the context's user.
*
* @param name the user's name.
* @param userType the type of user, such as {@link UserManager#USER_TYPE_PROFILE_MANAGED}.
* @param disallowedPackages packages to not install for this profile.
*
* @return the {@link android.os.UserHandle} object for the created user,
* or throws {@link UserOperationException} if the user could not be created
* and calling app is targeting {@link android.os.Build.VERSION_CODES#R} or above
* (otherwise returns {@code null}).
*
* @throws UserOperationException if the user could not be created and the calling app is
* targeting {@link android.os.Build.VERSION_CODES#R} or above.
*
* @hide
*/
@SystemApi
@RequiresPermission(anyOf = {Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS})
@UserHandleAware
public @Nullable UserHandle createProfile(@NonNull String name, @NonNull String userType,
@NonNull Set<String> disallowedPackages) throws UserOperationException {
try {
return mService.createProfileForUserWithThrow(name, userType, 0,
mUserId, disallowedPackages.toArray(
new String[disallowedPackages.size()])).getUserHandle();
} catch (ServiceSpecificException e) {
return returnNullOrThrowUserOperationException(e,
mContext.getApplicationInfo().targetSdkVersion >= Build.VERSION_CODES.R);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Creates a user with the specified name and options as a profile of another user.
* <p>Requires MANAGE_USERS. CREATE_USERS suffices for ALLOWED_FLAGS_FOR_CREATE_USERS_PERMISSION
*
* @param name the user's name
* @param flags flags that identify the type of user and other properties.
* @param userId new user will be a profile of this user.
*
* @return the {@link UserInfo} object for the created user, or null if the user
* could not be created.
* @throws IllegalArgumentException if flags do not correspond to a valid user type.
* @deprecated Use {@link #createProfileForUser(String, String, int, int)} instead.
* @hide
*/
@UnsupportedAppUsage
@RequiresPermission(anyOf = {Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS})
@Deprecated
public UserInfo createProfileForUser(String name, @UserInfoFlag int flags,
@UserIdInt int userId) {
return createProfileForUser(name, UserInfo.getDefaultUserType(flags), flags,
userId, null);
}
/**
* Creates a user with the specified name and options as a profile of another user.
*
* @param name the user's name
* @param userType the type of user, such as {@link UserManager#USER_TYPE_PROFILE_MANAGED}.
* @param flags UserInfo flags that specify user properties.
* @param userId new user will be a profile of this user.
*
* @return the {@link UserInfo} object for the created user, or null if the user
* could not be created.
* @hide
*/
@RequiresPermission(anyOf = {Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS})
public UserInfo createProfileForUser(String name, @NonNull String userType,
@UserInfoFlag int flags, @UserIdInt int userId) {
return createProfileForUser(name, userType, flags, userId, null);
}
/**
* Version of {@link #createProfileForUser(String, String, int, int)} that allows you to specify
* any packages that should not be installed in the new profile by default, these packages can
* still be installed later by the user if needed.
*
* @param name the user's name
* @param userType the type of user, such as {@link UserManager#USER_TYPE_PROFILE_MANAGED}.
* @param flags UserInfo flags that specify user properties.
* @param userId new user will be a profile of this user.
* @param disallowedPackages packages that will not be installed in the profile being created.
*
* @return the {@link UserInfo} object for the created user, or {@code null} if the user could
* not be created.
*
* @hide
*/
@TestApi
@RequiresPermission(anyOf = {Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS})
public @Nullable UserInfo createProfileForUser(@Nullable String name, @NonNull String userType,
@UserInfoFlag int flags, @UserIdInt int userId, @Nullable String[] disallowedPackages) {
try {
return mService.createProfileForUserWithThrow(name, userType, flags, userId,
disallowedPackages);
} catch (ServiceSpecificException e) {
return null;
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Similar to {@link #createProfileForUser(String, String, int, int, String[])}
* except bypassing the checking of {@link UserManager#DISALLOW_ADD_MANAGED_PROFILE}.
*
* @see #createProfileForUser(String, String, int, int, String[])
* @hide
*/
@RequiresPermission(anyOf = {Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS})
public UserInfo createProfileForUserEvenWhenDisallowed(String name,
@NonNull String userType, @UserInfoFlag int flags, @UserIdInt int userId,
String[] disallowedPackages) {
try {
return mService.createProfileForUserEvenWhenDisallowedWithThrow(name, userType, flags,
userId, disallowedPackages);
} catch (ServiceSpecificException e) {
return null;
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Creates a restricted profile with the specified name. This method also sets necessary
* restrictions and adds shared accounts (with the context user).
*
* @param name profile's name
* @return the {@link UserInfo} object for the created user, or {@code null} if the user
* could not be created.
*
* @hide
*/
@TestApi
@RequiresPermission(anyOf = {Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS})
@UserHandleAware
public @Nullable UserInfo createRestrictedProfile(@Nullable String name) {
try {
final int parentUserId = mUserId;
final UserInfo profile = mService.createRestrictedProfileWithThrow(name, parentUserId);
if (profile != null) {
final UserHandle parentUserHandle = UserHandle.of(parentUserId);
AccountManager.get(mContext).addSharedAccountsFromParentUser(parentUserHandle,
UserHandle.of(profile.id));
}
return profile;
} catch (ServiceSpecificException e) {
return null;
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns an intent to create a user for the provided name and account name. The name
* and account name will be used when the setup process for the new user is started.
* <p>
* The intent should be launched using startActivityForResult and the return result will
* indicate if the user consented to adding a new user and if the operation succeeded. Any
* errors in creating the user will be returned in the result code. If the user cancels the
* request, the return result will be {@link Activity#RESULT_CANCELED}. On success, the
* result code will be {@link Activity#RESULT_OK}.
* <p>
* Use {@link #supportsMultipleUsers()} to first check if the device supports this operation
* at all.
* <p>
* The new user is created but not initialized. After switching into the user for the first
* time, the preferred user name and account information are used by the setup process for that
* user.
*
* @param userName Optional name to assign to the user.
* @param accountName Optional account name that will be used by the setup wizard to initialize
* the user.
* @param accountType Optional account type for the account to be created. This is required
* if the account name is specified.
* @param accountOptions Optional bundle of data to be passed in during account creation in the
* new user via {@link AccountManager#addAccount(String, String, String[],
* Bundle, android.app.Activity, android.accounts.AccountManagerCallback,
* Handler)}.
* @return An Intent that can be launched from an Activity.
* @see #USER_CREATION_FAILED_NOT_PERMITTED
* @see #USER_CREATION_FAILED_NO_MORE_USERS
* @see #supportsMultipleUsers
*/
public static Intent createUserCreationIntent(@Nullable String userName,
@Nullable String accountName,
@Nullable String accountType, @Nullable PersistableBundle accountOptions) {
Intent intent = new Intent(ACTION_CREATE_USER);
if (userName != null) {
intent.putExtra(EXTRA_USER_NAME, userName);
}
if (accountName != null && accountType == null) {
throw new IllegalArgumentException("accountType must be specified if accountName is "
+ "specified");
}
if (accountName != null) {
intent.putExtra(EXTRA_USER_ACCOUNT_NAME, accountName);
}
if (accountType != null) {
intent.putExtra(EXTRA_USER_ACCOUNT_TYPE, accountType);
}
if (accountOptions != null) {
intent.putExtra(EXTRA_USER_ACCOUNT_OPTIONS, accountOptions);
}
return intent;
}
/**
* Returns the list of the system packages that would be installed on this type of user upon
* its creation.
*
* Returns {@code null} if all system packages would be installed.
*
* @hide
*/
@TestApi
@SuppressLint("NullableCollection")
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.CREATE_USERS
})
public @Nullable Set<String> getPreInstallableSystemPackages(@NonNull String userType) {
try {
final String[] installableSystemPackages
= mService.getPreInstallableSystemPackages(userType);
if (installableSystemPackages == null) {
return null;
}
return new ArraySet<>(installableSystemPackages);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* @hide
*
* Returns the preferred account name for the context user's creation.
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
@UserHandleAware(enabledSinceTargetSdkVersion = Build.VERSION_CODES.TIRAMISU)
public String getSeedAccountName() {
try {
return mService.getSeedAccountName(getContextUserIfAppropriate());
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* @hide
*
* Returns the preferred account type for the context user's creation.
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
@UserHandleAware(enabledSinceTargetSdkVersion = Build.VERSION_CODES.TIRAMISU)
public String getSeedAccountType() {
try {
return mService.getSeedAccountType(getContextUserIfAppropriate());
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* @hide
*
* Returns the preferred account's options bundle for user creation.
* @return Any options set by the requestor that created the context user.
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
@UserHandleAware(enabledSinceTargetSdkVersion = Build.VERSION_CODES.TIRAMISU)
public PersistableBundle getSeedAccountOptions() {
try {
return mService.getSeedAccountOptions(getContextUserIfAppropriate());
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* @hide
*
* Called by a system activity to set the seed account information of a user created
* through the user creation intent.
* @param userId
* @param accountName
* @param accountType
* @param accountOptions
* @see #createUserCreationIntent(String, String, String, PersistableBundle)
*/
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
public void setSeedAccountData(int userId, String accountName, String accountType,
PersistableBundle accountOptions) {
try {
mService.setSeedAccountData(userId, accountName, accountType, accountOptions,
/* persist= */ true);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* @hide
* Clears the seed information used to create the context user.
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
@UserHandleAware(enabledSinceTargetSdkVersion = Build.VERSION_CODES.TIRAMISU)
public void clearSeedAccountData() {
try {
mService.clearSeedAccountData(getContextUserIfAppropriate());
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* @hide
* Marks the guest user for deletion to allow a new guest to be created before deleting
* the current user who is a guest.
* @param userId
* @return
*/
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
public boolean markGuestForDeletion(@UserIdInt int userId) {
try {
return mService.markGuestForDeletion(userId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Sets the user as enabled, if such an user exists.
*
* <p>Note that the default is true, it's only that managed profiles might not be enabled.
* Also ephemeral users can be disabled to indicate that their removal is in progress and they
* shouldn't be re-entered. Therefore ephemeral users should not be re-enabled once disabled.
*
* @param userId the id of the profile to enable
* @hide
*/
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
public void setUserEnabled(@UserIdInt int userId) {
try {
mService.setUserEnabled(userId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Assigns admin privileges to the user, if such a user exists.
*
* <p>Note that this does not alter the user's pre-existing user restrictions.
*
* @param userId the id of the user to become admin
* @hide
*/
@RequiresPermission(allOf = {
Manifest.permission.INTERACT_ACROSS_USERS_FULL,
Manifest.permission.MANAGE_USERS
})
public void setUserAdmin(@UserIdInt int userId) {
try {
mService.setUserAdmin(userId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Evicts the user's credential encryption key from memory by stopping and restarting the user.
*
* @hide
*/
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
public void evictCredentialEncryptionKey(@UserIdInt int userId) {
try {
mService.evictCredentialEncryptionKey(userId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Return the number of users currently created on the device.
*/
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.CREATE_USERS
})
public int getUserCount() {
List<UserInfo> users = getUsers();
return users != null ? users.size() : 1;
}
/**
* Returns information for all fully-created users on this device, including ones marked for
* deletion.
*
* <p>To retrieve only users that are not marked for deletion, use {@link #getAliveUsers()}.
*
* <p>To retrieve *all* users (including partial and pre-created users), use
* {@link #getUsers(boolean, boolean, boolean)) getUsers(false, false, false)}.
*
* <p>To retrieve a more specific list of users, use
* {@link #getUsers(boolean, boolean, boolean)}.
*
* @return the list of users that were created.
*
* @hide
*/
@UnsupportedAppUsage
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.CREATE_USERS
})
public List<UserInfo> getUsers() {
return getUsers(/*excludePartial= */ true, /* excludeDying= */ false,
/* excludePreCreated= */ true);
}
/**
* Returns information for all "usable" users on this device (i.e, it excludes users that are
* marked for deletion, pre-created users, etc...).
*
* <p>To retrieve all fully-created users, use {@link #getUsers()}.
*
* <p>To retrieve a more specific list of users, use
* {@link #getUsers(boolean, boolean, boolean)}.
*
* @return the list of users that were created.
* @hide
*/
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.CREATE_USERS
})
public @NonNull List<UserInfo> getAliveUsers() {
return getUsers(/*excludePartial= */ true, /* excludeDying= */ true,
/* excludePreCreated= */ true);
}
/**
* @deprecated use {@link #getAliveUsers()} for {@code getUsers(true)}, or
* {@link #getUsers()} for @code getUsers(false)}.
*
* @hide
*/
@Deprecated
@UnsupportedAppUsage
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.CREATE_USERS
})
public @NonNull List<UserInfo> getUsers(boolean excludeDying) {
return getUsers(/*excludePartial= */ true, excludeDying,
/* excludePreCreated= */ true);
}
/**
* Returns information for all users on this device, based on the filtering parameters.
*
* @hide
*/
@TestApi
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.CREATE_USERS
})
public @NonNull List<UserInfo> getUsers(boolean excludePartial, boolean excludeDying,
boolean excludePreCreated) {
try {
return mService.getUsers(excludePartial, excludeDying, excludePreCreated);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns the user handles for all users on this device, based on the filtering parameters.
*
* @param excludeDying specify if the list should exclude users being removed.
* @return the list of user handles.
* @hide
*/
@SystemApi
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.CREATE_USERS
})
public @NonNull List<UserHandle> getUserHandles(boolean excludeDying) {
List<UserInfo> users = getUsers(/* excludePartial= */ true, excludeDying,
/* excludePreCreated= */ true);
List<UserHandle> result = new ArrayList<>(users.size());
for (UserInfo user : users) {
result.add(user.getUserHandle());
}
return result;
}
/**
* Returns serial numbers of all users on this device.
*
* @param excludeDying specify if the list should exclude users being removed.
* @return the list of serial numbers of users that exist on the device.
* @hide
*/
@SystemApi
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.CREATE_USERS
})
public long[] getSerialNumbersOfUsers(boolean excludeDying) {
List<UserInfo> users = getUsers(/* excludePartial= */ true, excludeDying,
/* excludePreCreated= */ true);
long[] result = new long[users.size()];
for (int i = 0; i < result.length; i++) {
result[i] = users.get(i).serialNumber;
}
return result;
}
/**
* @return the user's account name, null if not found.
* @hide
*/
@RequiresPermission( allOf = {
Manifest.permission.INTERACT_ACROSS_USERS_FULL,
Manifest.permission.MANAGE_USERS
})
public @Nullable String getUserAccount(@UserIdInt int userId) {
try {
return mService.getUserAccount(userId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Set account name for the given user.
* @hide
*/
@RequiresPermission( allOf = {
Manifest.permission.INTERACT_ACROSS_USERS_FULL,
Manifest.permission.MANAGE_USERS
})
public void setUserAccount(@UserIdInt int userId, @Nullable String accountName) {
try {
mService.setUserAccount(userId, accountName);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns information for Primary user.
*
* @return the Primary user, null if not found.
* @hide
*/
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
public @Nullable UserInfo getPrimaryUser() {
try {
return mService.getPrimaryUser();
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Checks whether it's possible to add more users.
*
* @return true if more users can be added, false if limit has been reached.
*
* @deprecated use {@link #canAddMoreUsers(String)} instead.
*
* @hide
*/
@Deprecated
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.CREATE_USERS
})
public boolean canAddMoreUsers() {
// TODO(b/142482943): UMS has different logic, excluding Demo and Profile from counting. Why
// not here? The logic is inconsistent. See UMS.canAddMoreManagedProfiles
final List<UserInfo> users = getAliveUsers();
final int totalUserCount = users.size();
int aliveUserCount = 0;
for (int i = 0; i < totalUserCount; i++) {
UserInfo user = users.get(i);
if (!user.isGuest()) {
aliveUserCount++;
}
}
return aliveUserCount < getMaxSupportedUsers();
}
/**
* Checks whether it is possible to add more users of the given user type.
*
* @param userType the type of user, such as {@link UserManager#USER_TYPE_FULL_SECONDARY}.
* @return true if more users of the given type can be added, otherwise false.
* @hide
*/
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.CREATE_USERS
})
public boolean canAddMoreUsers(@NonNull String userType) {
try {
return canAddMoreUsers() && mService.canAddMoreUsersOfType(userType);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns the remaining number of users of the given type that can be created.
*
* @param userType the type of user, such as {@link UserManager#USER_TYPE_FULL_SECONDARY}.
* @return how many additional users can be created.
* @hide
*/
@SystemApi
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.CREATE_USERS,
android.Manifest.permission.QUERY_USERS
})
public int getRemainingCreatableUserCount(@NonNull String userType) {
Objects.requireNonNull(userType, "userType must not be null");
try {
return mService.getRemainingCreatableUserCount(userType);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns the remaining number of profiles that can be added to the context user.
* <p>Note that is applicable to any profile type (currently not including Restricted profiles).
*
* @param userType the type of profile, such as {@link UserManager#USER_TYPE_PROFILE_MANAGED}.
* @return how many additional profiles can be created.
* @hide
*/
@SystemApi
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.CREATE_USERS,
android.Manifest.permission.QUERY_USERS
})
@UserHandleAware
public int getRemainingCreatableProfileCount(@NonNull String userType) {
Objects.requireNonNull(userType, "userType must not be null");
try {
// TODO(b/142482943): Perhaps let the following code apply to restricted users too.
return mService.getRemainingCreatableProfileCount(userType, mUserId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Checks whether it's possible to add more managed profiles.
* if allowedToRemoveOne is true and if the user already has a managed profile, then return if
* we could add a new managed profile to this user after removing the existing one.
*
* @return true if more managed profiles can be added, false if limit has been reached.
* @hide
*/
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.CREATE_USERS,
android.Manifest.permission.QUERY_USERS
})
public boolean canAddMoreManagedProfiles(@UserIdInt int userId, boolean allowedToRemoveOne) {
try {
return mService.canAddMoreManagedProfiles(userId, allowedToRemoveOne);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Checks whether it's possible to add more profiles of the given type to the given user.
*
* @param userType the type of user, such as {@link UserManager#USER_TYPE_PROFILE_MANAGED}.
* @return true if more profiles can be added, false if limit has been reached.
* @hide
*/
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.CREATE_USERS,
android.Manifest.permission.QUERY_USERS
})
public boolean canAddMoreProfilesToUser(@NonNull String userType, @UserIdInt int userId) {
try {
return mService.canAddMoreProfilesToUser(userType, userId, false);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Checks whether this device supports users of the given user type.
*
* @param userType the type of user, such as {@link UserManager#USER_TYPE_FULL_SECONDARY}.
* @return true if the creation of users of the given user type is enabled on this device.
* @hide
*/
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.CREATE_USERS
})
public boolean isUserTypeEnabled(@NonNull String userType) {
try {
return mService.isUserTypeEnabled(userType);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns list of the profiles of userId including userId itself.
* Note that this returns both enabled and not enabled profiles. See
* {@link #getEnabledProfiles(int)} if you need only the enabled ones.
* <p>Note that this includes all profile types (not including Restricted profiles).
*
* <p>Requires {@link android.Manifest.permission#MANAGE_USERS} or
* {@link android.Manifest.permission#CREATE_USERS} or
* {@link android.Manifest.permission#QUERY_USERS} if userId is not the calling user.
* @param userId profiles of this user will be returned.
* @return the list of profiles.
* @hide
*/
@UnsupportedAppUsage
@RequiresPermission(anyOf = {
Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS,
Manifest.permission.QUERY_USERS}, conditional = true)
public List<UserInfo> getProfiles(@UserIdInt int userId) {
try {
return mService.getProfiles(userId, false /* enabledOnly */);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Checks if the 2 provided user handles belong to the same profile group.
*
* @param user one of the two user handles to check.
* @param otherUser one of the two user handles to check.
* @return true if the two users are in the same profile group.
*
* @hide
*/
@SystemApi
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.QUERY_USERS})
public boolean isSameProfileGroup(@NonNull UserHandle user, @NonNull UserHandle otherUser) {
return isSameProfileGroup(user.getIdentifier(), otherUser.getIdentifier());
}
/**
* Checks if the 2 provided user ids belong to the same profile group.
* @param userId one of the two user ids to check.
* @param otherUserId one of the two user ids to check.
* @return true if the two user ids are in the same profile group.
* @hide
*/
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.QUERY_USERS})
public boolean isSameProfileGroup(@UserIdInt int userId, int otherUserId) {
try {
return mService.isSameProfileGroup(userId, otherUserId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns list of the profiles of userId including userId itself.
* Note that this returns only enabled.
* <p>Note that this includes all profile types (not including Restricted profiles).
*
* <p>Requires {@link android.Manifest.permission#MANAGE_USERS} or
* {@link android.Manifest.permission#CREATE_USERS} or
* {@link android.Manifest.permission#QUERY_USERS} if userId is not the calling user.
* @param userId profiles of this user will be returned.
* @return the list of profiles.
* @deprecated use {@link #getUserProfiles()} instead.
*
* @hide
*/
@Deprecated
@UnsupportedAppUsage
@RequiresPermission(anyOf = {
Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS,
Manifest.permission.QUERY_USERS}, conditional = true)
public List<UserInfo> getEnabledProfiles(@UserIdInt int userId) {
try {
return mService.getProfiles(userId, true /* enabledOnly */);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns a list of UserHandles for profiles associated with the context user, including the
* user itself.
* <p>Note that this includes all profile types (not including Restricted profiles).
*
* @return A non-empty list of UserHandles associated with the context user.
*/
@UserHandleAware(
enabledSinceTargetSdkVersion = Build.VERSION_CODES.TIRAMISU,
requiresAnyOfPermissionsIfNotCaller = {
Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS,
Manifest.permission.QUERY_USERS})
public List<UserHandle> getUserProfiles() {
int[] userIds = getProfileIds(getContextUserIfAppropriate(), true /* enabledOnly */);
return convertUserIdsToUserHandles(userIds);
}
/**
* Returns a list of ids for enabled profiles associated with the context user including the
* user itself.
* <p>Note that this includes all profile types (not including Restricted profiles).
*
* @return A non-empty list of UserHandles associated with the context user.
* @hide
*/
@SystemApi
@UserHandleAware(
requiresAnyOfPermissionsIfNotCaller = {
Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS,
Manifest.permission.QUERY_USERS})
public @NonNull List<UserHandle> getEnabledProfiles() {
return getProfiles(true);
}
/**
* Returns a list of ids for all profiles associated with the context user including the user
* itself.
* <p>Note that this includes all profile types (not including Restricted profiles).
*
* @return A non-empty list of UserHandles associated with the context user.
* @hide
*/
@SystemApi
@UserHandleAware(
requiresAnyOfPermissionsIfNotCaller = {
Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS,
Manifest.permission.QUERY_USERS})
public @NonNull List<UserHandle> getAllProfiles() {
return getProfiles(false);
}
/**
* Returns a list of ids for profiles associated with the context user including the user
* itself.
* <p>Note that this includes all profile types (not including Restricted profiles).
*
* @param enabledOnly whether to return only {@link UserInfo#isEnabled() enabled} profiles
* @return A non-empty list of UserHandles associated with the context user.
*/
@UserHandleAware(
requiresAnyOfPermissionsIfNotCaller = {
Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS,
Manifest.permission.QUERY_USERS})
private @NonNull List<UserHandle> getProfiles(boolean enabledOnly) {
final int[] userIds = getProfileIds(mUserId, enabledOnly);
return convertUserIdsToUserHandles(userIds);
}
/** Converts the given array of userIds to a List of UserHandles. */
private @NonNull List<UserHandle> convertUserIdsToUserHandles(@NonNull int[] userIds) {
final List<UserHandle> result = new ArrayList<>(userIds.length);
for (int userId : userIds) {
result.add(UserHandle.of(userId));
}
return result;
}
/**
* Returns a list of ids for profiles associated with the specified user including the user
* itself.
* <p>Note that this includes all profile types (not including Restricted profiles).
*
* @param userId id of the user to return profiles for
* @param enabledOnly whether return only {@link UserInfo#isEnabled() enabled} profiles
* @return A non-empty list of ids of profiles associated with the specified user.
*
* @hide
*/
@RequiresPermission(anyOf = {
Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS,
Manifest.permission.QUERY_USERS}, conditional = true)
public @NonNull int[] getProfileIds(@UserIdInt int userId, boolean enabledOnly) {
try {
return mService.getProfileIds(userId, enabledOnly);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* @see #getProfileIds(int, boolean)
* @hide
*/
@UnsupportedAppUsage
@RequiresPermission(anyOf = {
Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS,
Manifest.permission.QUERY_USERS}, conditional = true)
public int[] getProfileIdsWithDisabled(@UserIdInt int userId) {
return getProfileIds(userId, false /* enabledOnly */);
}
/**
* @see #getProfileIds(int, boolean)
* @hide
*/
@RequiresPermission(anyOf = {
Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS,
Manifest.permission.QUERY_USERS}, conditional = true)
public int[] getEnabledProfileIds(@UserIdInt int userId) {
return getProfileIds(userId, true /* enabledOnly */);
}
/**
* Returns the device credential owner id of the profile from
* which this method is called, or userId if called from a user that
* is not a profile.
*
* @hide
*/
@RequiresPermission(Manifest.permission.MANAGE_USERS)
public int getCredentialOwnerProfile(@UserIdInt int userId) {
try {
return mService.getCredentialOwnerProfile(userId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns the parent of the profile which this method is called from
* or null if called from a user that is not a profile.
*
* @hide
*/
@UnsupportedAppUsage
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.INTERACT_ACROSS_USERS
})
public UserInfo getProfileParent(@UserIdInt int userId) {
try {
return mService.getProfileParent(userId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Get the parent of a user profile.
*
* @param user the handle of the user profile
*
* @return the parent of the user or {@code null} if the user is not profile
*
* @hide
*/
@SystemApi
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.INTERACT_ACROSS_USERS
})
public @Nullable UserHandle getProfileParent(@NonNull UserHandle user) {
UserInfo info = getProfileParent(user.getIdentifier());
if (info == null) {
return null;
}
return UserHandle.of(info.id);
}
/**
* Enables or disables quiet mode for a managed profile. If quiet mode is enabled, apps in a
* managed profile don't run, generate notifications, or consume data or battery.
* <p>
* If a user's credential is needed to turn off quiet mode, a confirm credential screen will be
* shown to the user.
* <p>
* The change may not happen instantly, however apps can listen for
* {@link Intent#ACTION_MANAGED_PROFILE_AVAILABLE} and
* {@link Intent#ACTION_MANAGED_PROFILE_UNAVAILABLE} broadcasts in order to be notified of
* the change of the quiet mode. Apps can also check the current state of quiet mode by
* calling {@link #isQuietModeEnabled(UserHandle)}.
* <p>
* The caller must either be the foreground default launcher or have one of these permissions:
* {@code MANAGE_USERS} or {@code MODIFY_QUIET_MODE}.
*
* @param enableQuietMode whether quiet mode should be enabled or disabled
* @param userHandle user handle of the profile
* @return {@code false} if user's credential is needed in order to turn off quiet mode,
* {@code true} otherwise
* @throws SecurityException if the caller is invalid
* @throws IllegalArgumentException if {@code userHandle} is not a managed profile
*
* @see #isQuietModeEnabled(UserHandle)
*/
@RequiresPermission(anyOf = {android.Manifest.permission.MANAGE_USERS,
Manifest.permission.MODIFY_QUIET_MODE}, conditional = true)
public boolean requestQuietModeEnabled(boolean enableQuietMode, @NonNull UserHandle userHandle) {
return requestQuietModeEnabled(enableQuietMode, userHandle, null);
}
/**
* Perform the same operation as {@link #requestQuietModeEnabled(boolean, UserHandle)}, but
* with a flag to tweak the behavior of the request.
*
* @param enableQuietMode whether quiet mode should be enabled or disabled
* @param userHandle user handle of the profile
* @param flags Can be 0 or {@link #QUIET_MODE_DISABLE_ONLY_IF_CREDENTIAL_NOT_REQUIRED}.
* @return {@code false} if user's credential is needed in order to turn off quiet mode,
* {@code true} otherwise
* @throws SecurityException if the caller is invalid
* @throws IllegalArgumentException if {@code userHandle} is not a managed profile
*
* @see #isQuietModeEnabled(UserHandle)
*/
public boolean requestQuietModeEnabled(boolean enableQuietMode, @NonNull UserHandle userHandle,
@QuietModeFlag int flags) {
return requestQuietModeEnabled(enableQuietMode, userHandle, null, flags);
}
/**
* Similar to {@link #requestQuietModeEnabled(boolean, UserHandle)}, except you can specify
* a target to start when user is unlocked. If {@code target} is specified, caller must have
* the {@link android.Manifest.permission#MANAGE_USERS} permission.
*
* @see {@link #requestQuietModeEnabled(boolean, UserHandle)}
* @hide
*/
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
public boolean requestQuietModeEnabled(
boolean enableQuietMode, @NonNull UserHandle userHandle, IntentSender target) {
return requestQuietModeEnabled(enableQuietMode, userHandle, target, 0);
}
/**
* Similar to {@link #requestQuietModeEnabled(boolean, UserHandle)}, except you can specify
* a target to start when user is unlocked. If {@code target} is specified, caller must have
* the {@link android.Manifest.permission#MANAGE_USERS} permission.
*
* @see #requestQuietModeEnabled(boolean, UserHandle)
* @hide
*/
public boolean requestQuietModeEnabled(
boolean enableQuietMode, @NonNull UserHandle userHandle, IntentSender target,
int flags) {
try {
return mService.requestQuietModeEnabled(
mContext.getPackageName(), enableQuietMode, userHandle.getIdentifier(), target,
flags);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns whether the given profile is in quiet mode or not.
* Notes: Quiet mode is only supported for managed profiles.
*
* @param userHandle The user handle of the profile to be queried.
* @return true if the profile is in quiet mode, false otherwise.
*/
public boolean isQuietModeEnabled(UserHandle userHandle) {
try {
return mService.isQuietModeEnabled(userHandle.getIdentifier());
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns whether the given user has a badge (generally to put on profiles' icons).
*
* @param userId userId of the user in question
* @return true if the user's icons should display a badge; false otherwise.
*
* @see #getBadgedIconForUser more information about badging in general
* @hide
*/
public boolean hasBadge(@UserIdInt int userId) {
if (!isProfile(userId)) {
// Since currently only profiles actually have badges, we can do this optimization.
return false;
}
try {
return mService.hasBadge(userId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns whether the user associated with the context has a badge (generally to put on
* profiles' icons).
*
* @return true if the user's icons should display a badge; false otherwise.
* @see #getBadgedIconForUser more information about badging in general
* @hide
*/
@UserHandleAware
public boolean hasBadge() {
return hasBadge(mUserId);
}
/**
* Returns the light theme badge color for the given user (generally to color a profile's
* icon's badge).
*
* <p>To check whether a badge color is expected for the user, first call {@link #hasBadge}.
*
* @return the color (not the resource ID) to be used for the user's badge
* @throws Resources.NotFoundException if no valid badge color exists for this user
*
* @see #getBadgedIconForUser more information about badging in general
* @hide
*/
public @ColorInt int getUserBadgeColor(@UserIdInt int userId) {
try {
final int resourceId = mService.getUserBadgeColorResId(userId);
return Resources.getSystem().getColor(resourceId, null);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns the dark theme badge color for the given user (generally to color a profile's icon's
* badge).
*
* <p>To check whether a badge color is expected for the user, first call {@link #hasBadge}.
*
* @return the color (not the resource ID) to be used for the user's badge
* @throws Resources.NotFoundException if no valid badge color exists for this user
*
* @see #getBadgedIconForUser more information about badging in general
* @hide
*/
public @ColorInt int getUserBadgeDarkColor(@UserIdInt int userId) {
try {
final int resourceId = mService.getUserBadgeDarkColorResId(userId);
return Resources.getSystem().getColor(resourceId, null);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns the Resource ID of the user's icon badge.
*
* @return the Resource ID of the user's icon badge if it has one; otherwise
* {@link Resources#ID_NULL}.
*
* @see #getBadgedIconForUser more information about badging in general
* @hide
*/
public @DrawableRes int getUserIconBadgeResId(@UserIdInt int userId) {
try {
return mService.getUserIconBadgeResId(userId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns the Resource ID of the user's badge.
*
* @return the Resource ID of the user's badge if it has one; otherwise
* {@link Resources#ID_NULL}.
*
* @see #getBadgedIconForUser more information about badging in general
* @hide
*/
public @DrawableRes int getUserBadgeResId(@UserIdInt int userId) {
try {
return mService.getUserBadgeResId(userId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns the Resource ID of the user's badge without a background.
*
* @return the Resource ID of the user's no-background badge if it has one; otherwise
* {@link Resources#ID_NULL}.
*
* @see #getBadgedIconForUser more information about badging in general
* @hide
*/
public @DrawableRes int getUserBadgeNoBackgroundResId(@UserIdInt int userId) {
try {
return mService.getUserBadgeNoBackgroundResId(userId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* If the target user is a profile of the calling user or the caller
* is itself a profile, then this returns a badged copy of the given
* icon to be able to distinguish it from the original icon. For badging an
* arbitrary drawable use {@link #getBadgedDrawableForUser(
* android.graphics.drawable.Drawable, UserHandle, android.graphics.Rect, int)}.
* <p>
* If the original drawable is a BitmapDrawable and the backing bitmap is
* mutable as per {@link android.graphics.Bitmap#isMutable()}, the badging
* is performed in place and the original drawable is returned.
* </p>
*
* @param icon The icon to badge.
* @param user The target user.
* @return A drawable that combines the original icon and a badge as
* determined by the system.
* @removed
*/
public Drawable getBadgedIconForUser(Drawable icon, UserHandle user) {
return mContext.getPackageManager().getUserBadgedIcon(icon, user);
}
/**
* If the target user is a profile of the calling user or the caller
* is itself a profile, then this returns a badged copy of the given
* drawable allowing the user to distinguish it from the original drawable.
* The caller can specify the location in the bounds of the drawable to be
* badged where the badge should be applied as well as the density of the
* badge to be used.
* <p>
* If the original drawable is a BitmapDrawable and the backing bitmap is
* mutable as per {@link android.graphics.Bitmap#isMutable()}, the badging
* is performed in place and the original drawable is returned.
* </p>
*
* @param badgedDrawable The drawable to badge.
* @param user The target user.
* @param badgeLocation Where in the bounds of the badged drawable to place
* the badge. If it's {@code null}, the badge is applied on top of the entire
* drawable being badged.
* @param badgeDensity The optional desired density for the badge as per
* {@link android.util.DisplayMetrics#densityDpi}. If it's not positive,
* the density of the display is used.
* @return A drawable that combines the original drawable and a badge as
* determined by the system.
* @removed
*/
public Drawable getBadgedDrawableForUser(Drawable badgedDrawable, UserHandle user,
Rect badgeLocation, int badgeDensity) {
return mContext.getPackageManager().getUserBadgedDrawableForDensity(badgedDrawable, user,
badgeLocation, badgeDensity);
}
/**
* If the target user is a profile of the calling user or the caller
* is itself a profile, then this returns a copy of the label with
* badging for accessibility services like talkback. E.g. passing in "Email"
* and it might return "Work Email" for Email in the work profile.
*
* <p>Requires {@link android.Manifest.permission#MANAGE_USERS} or
* {@link android.Manifest.permission#INTERACT_ACROSS_USERS} permission, otherwise the caller
* must be in the same profile group of specified user.
*
* @param label The label to change.
* @param user The target user.
* @return A label that combines the original label and a badge as
* determined by the system.
* @removed
*/
public CharSequence getBadgedLabelForUser(CharSequence label, UserHandle user) {
final int userId = user.getIdentifier();
if (!hasBadge(userId)) {
return label;
}
DevicePolicyManager dpm = mContext.getSystemService(DevicePolicyManager.class);
return dpm.getResources().getString(
getUpdatableUserBadgedLabelId(userId),
() -> getDefaultUserBadgedLabel(label, userId),
/* formatArgs= */ label);
}
private String getUpdatableUserBadgedLabelId(int userId) {
return isManagedProfile(userId) ? WORK_PROFILE_BADGED_LABEL : UNDEFINED;
}
private String getDefaultUserBadgedLabel(CharSequence label, int userId) {
try {
final int resourceId = mService.getUserBadgeLabelResId(userId);
return Resources.getSystem().getString(resourceId, label);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* If the user is a {@link UserManager#isProfile profile}, checks if the user
* shares media with its parent user (the user that created this profile).
* Returns false for any other type of user.
*
* <p>Requires {@link android.Manifest.permission#MANAGE_USERS} or
* {@link android.Manifest.permission#INTERACT_ACROSS_USERS} permission, otherwise the
* caller must be in the same profile group as the user.
*
* @return true if the user shares media with its parent user, false otherwise.
* @hide
*/
@SystemApi
@RequiresPermission(anyOf = {android.Manifest.permission.MANAGE_USERS,
Manifest.permission.INTERACT_ACROSS_USERS}, conditional = true)
@UserHandleAware
@SuppressAutoDoc
public boolean isMediaSharedWithParent() {
try {
return mService.isMediaSharedWithParent(mUserId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns whether the user can have shared lockscreen credential with its parent user.
*
* This API only works for {@link UserManager#isProfile() profiles}
* and will always return false for any other user type.
*
* @hide
*/
@SystemApi
@UserHandleAware(
requiresAnyOfPermissionsIfNotCallerProfileGroup = {
Manifest.permission.MANAGE_USERS,
Manifest.permission.INTERACT_ACROSS_USERS})
@SuppressAutoDoc
public boolean isCredentialSharableWithParent() {
try {
return mService.isCredentialSharableWithParent(mUserId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Removes a user and all associated data.
* @param userId the integer handle of the user.
* @hide
*/
@UnsupportedAppUsage
@RequiresPermission(anyOf = {Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS})
public boolean removeUser(@UserIdInt int userId) {
try {
return mService.removeUser(userId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Removes a user and all associated data.
*
* @param user the user that needs to be removed.
* @return {@code true} if the user was successfully removed, {@code false} otherwise.
* @throws IllegalArgumentException if {@code user} is {@code null}
* @hide
*/
@SystemApi
@RequiresPermission(anyOf = {Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS})
public boolean removeUser(@NonNull UserHandle user) {
if (user == null) {
throw new IllegalArgumentException("user cannot be null");
}
return removeUser(user.getIdentifier());
}
/**
* Similar to {@link #removeUser(int)} except bypassing the checking of
* {@link UserManager#DISALLOW_REMOVE_USER}
* or {@link UserManager#DISALLOW_REMOVE_MANAGED_PROFILE}.
*
* @see {@link #removeUser(int)}
* @hide
*/
@RequiresPermission(anyOf = {Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS})
public boolean removeUserEvenWhenDisallowed(@UserIdInt int userId) {
try {
return mService.removeUserEvenWhenDisallowed(userId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Immediately removes the user or, if the user cannot be removed, such as when the user is
* the current user, then set the user as ephemeral so that it will be removed when it is
* stopped.
*
* @param overrideDevicePolicy when {@code true}, user is removed even if the caller has
* the {@link #DISALLOW_REMOVE_USER} or {@link #DISALLOW_REMOVE_MANAGED_PROFILE} restriction
*
* @return the {@link RemoveResult} code: {@link #REMOVE_RESULT_REMOVED},
* {@link #REMOVE_RESULT_DEFERRED}, {@link #REMOVE_RESULT_ALREADY_BEING_REMOVED},
* {@link #REMOVE_RESULT_ERROR_USER_RESTRICTION}, {@link #REMOVE_RESULT_ERROR_USER_NOT_FOUND},
* {@link #REMOVE_RESULT_ERROR_SYSTEM_USER}, or {@link #REMOVE_RESULT_ERROR_UNKNOWN}. All error
* codes have negative values.
*
* @hide
*/
@SystemApi
@RequiresPermission(anyOf = {Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS})
public @RemoveResult int removeUserWhenPossible(@NonNull UserHandle user,
boolean overrideDevicePolicy) {
try {
return mService.removeUserWhenPossible(user.getIdentifier(), overrideDevicePolicy);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Check if {@link #removeUserWhenPossible} returned a success code which means that the user
* has been removed or is slated for removal.
*
* @param result is {@link #RemoveResult} code return by {@link #removeUserWhenPossible}.
* @return {@code true} if it is a success code.
* @hide
*/
@SystemApi
public static boolean isRemoveResultSuccessful(@RemoveResult int result) {
return result >= 0;
}
/**
* Updates the user's name.
*
* @param userId the user's integer id
* @param name the new name for the user
* @hide
*/
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
public void setUserName(@UserIdInt int userId, String name) {
try {
mService.setUserName(userId, name);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Set the user as ephemeral or non-ephemeral.
*
* If the user was initially created as ephemeral then this
* method has no effect and false is returned.
*
* @param userId the user's integer id
* @param enableEphemeral true: change user state to ephemeral,
* false: change user state to non-ephemeral
* @return true: user now has the desired ephemeral state,
* false: desired user ephemeral state could not be set
*
* @hide
*/
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.CREATE_USERS})
public boolean setUserEphemeral(@UserIdInt int userId, boolean enableEphemeral) {
try {
return mService.setUserEphemeral(userId, enableEphemeral);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Updates the context user's name.
*
* @param name the new name for the user
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
@UserHandleAware
public void setUserName(@Nullable String name) {
setUserName(mUserId, name);
}
/**
* Sets the user's photo.
* @param userId the user for whom to change the photo.
* @param icon the bitmap to set as the photo.
*
* @hide
*/
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
public void setUserIcon(@UserIdInt int userId, @NonNull Bitmap icon) {
try {
mService.setUserIcon(userId, icon);
} catch (ServiceSpecificException e) {
return;
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Sets the context user's photo.
*
* @param icon the bitmap to set as the photo.
*
* @throws UserOperationException according to the function signature, but may not actually
* throw it in practice. Catch RuntimeException instead.
*
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
@UserHandleAware
public void setUserIcon(@NonNull Bitmap icon) throws UserOperationException {
setUserIcon(mUserId, icon);
}
/**
* Returns a bitmap of the user's photo
* @param userId the user whose photo we want to read.
* @return a {@link Bitmap} of the user's photo, or null if there's no photo.
* @see com.android.internal.util.UserIcons#getDefaultUserIcon for a default.
* @hide
*/
@UnsupportedAppUsage
@RequiresPermission(anyOf = {android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.GET_ACCOUNTS_PRIVILEGED})
public Bitmap getUserIcon(@UserIdInt int userId) {
try {
ParcelFileDescriptor fd = mService.getUserIcon(userId);
if (fd != null) {
try {
return BitmapFactory.decodeFileDescriptor(fd.getFileDescriptor());
} finally {
try {
fd.close();
} catch (IOException e) {
}
}
}
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
return null;
}
/**
* Returns a Bitmap for the context user's photo.
*
* @return a {@link Bitmap} of the user's photo, or null if there's no photo.
* @see com.android.internal.util.UserIcons#getDefaultUserIcon for a default.
* @hide
*/
@SystemApi
@RequiresPermission(anyOf = {android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.GET_ACCOUNTS_PRIVILEGED})
@UserHandleAware
public @Nullable Bitmap getUserIcon() {
return getUserIcon(mUserId);
}
/**
* Returns the maximum number of users that can be created on this device. A return value
* of 1 means that it is a single user device.
* @hide
* @return a value greater than or equal to 1
*/
@UnsupportedAppUsage
public static int getMaxSupportedUsers() {
// Don't allow multiple users on certain builds
if (android.os.Build.ID.startsWith("JVP")) return 1;
return Math.max(1, SystemProperties.getInt("fw.max_users",
Resources.getSystem().getInteger(R.integer.config_multiuserMaximumUsers)));
}
/**
* Returns true if the user switcher is enabled (regardless of whether there is anything
* interesting for it to show).
*
* @return true if user switcher is enabled
* @hide
*/
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.CREATE_USERS // And INTERACT_ if diff profile group
})
@UserHandleAware
public boolean isUserSwitcherEnabled() {
return isUserSwitcherEnabled(true);
}
/**
* Returns true if the user switcher should be shown.
*
* @param showEvenIfNotActionable value to return if the feature is enabled but there is nothing
* actionable for the user to do anyway
* @return true if user switcher should be shown.
* @hide
*/
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.CREATE_USERS // And INTERACT_ if diff profile group
})
@UserHandleAware
public boolean isUserSwitcherEnabled(boolean showEvenIfNotActionable) {
try {
if (!mService.isUserSwitcherEnabled(mUserId)) {
return false;
}
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
// The feature is enabled. But is it worth showing?
return showEvenIfNotActionable
|| areThereUsersToWhichToSwitch() // There are switchable users.
|| !hasUserRestrictionForUser(DISALLOW_ADD_USER, mUserId); // New users can be added
}
/** Returns whether there are any users (other than the current user) to which to switch. */
@RequiresPermission(anyOf = {
android.Manifest.permission.MANAGE_USERS,
android.Manifest.permission.CREATE_USERS
})
private boolean areThereUsersToWhichToSwitch() {
final List<UserInfo> users = getAliveUsers();
if (users == null) {
return false;
}
int switchableUserCount = 0;
for (UserInfo user : users) {
if (user.supportsSwitchToByUser()) {
++switchableUserCount;
}
}
return switchableUserCount > 1;
}
/**
* @hide
*/
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
public static boolean isDeviceInDemoMode(Context context) {
return Settings.Global.getInt(context.getContentResolver(),
Settings.Global.DEVICE_DEMO_MODE, 0) > 0;
}
/**
* Returns a serial number on this device for a given userId. User handles can be recycled
* when deleting and creating users, but serial numbers are not reused until the device is wiped.
* @param userId
* @return a serial number associated with that user, or -1 if the userId is not valid.
* @hide
*/
@UnsupportedAppUsage
public int getUserSerialNumber(@UserIdInt int userId) {
try {
return mService.getUserSerialNumber(userId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns a userId on this device for a given user serial number. User handles can be
* recycled when deleting and creating users, but serial numbers are not reused until the device
* is wiped.
* @param userSerialNumber
* @return the userId associated with that user serial number, or -1 if the serial number
* is not valid.
* @hide
*/
@UnsupportedAppUsage
public @UserIdInt int getUserHandle(int userSerialNumber) {
try {
return mService.getUserHandle(userSerialNumber);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns a {@link Bundle} containing any saved application restrictions for the context user,
* for the given package name. Only an application with this package name can call this method.
*
* <p>The returned {@link Bundle} consists of key-value pairs, as defined by the application,
* where the types of values may be:
* <ul>
* <li>{@code boolean}
* <li>{@code int}
* <li>{@code String} or {@code String[]}
* <li>From {@link android.os.Build.VERSION_CODES#M}, {@code Bundle} or {@code Bundle[]}
* </ul>
*
* <p>NOTE: The method performs disk I/O and shouldn't be called on the main thread
*
* @param packageName the package name of the calling application
* @return a {@link Bundle} with the restrictions for that package, or an empty {@link Bundle}
* if there are no saved restrictions.
*
* @see #KEY_RESTRICTIONS_PENDING
*/
@WorkerThread
@UserHandleAware(enabledSinceTargetSdkVersion = Build.VERSION_CODES.TIRAMISU)
public Bundle getApplicationRestrictions(String packageName) {
try {
return mService.getApplicationRestrictionsForUser(packageName,
getContextUserIfAppropriate());
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* @hide
*/
@WorkerThread
public Bundle getApplicationRestrictions(String packageName, UserHandle user) {
try {
return mService.getApplicationRestrictionsForUser(packageName, user.getIdentifier());
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* @hide
*/
@WorkerThread
public void setApplicationRestrictions(String packageName, Bundle restrictions,
UserHandle user) {
try {
mService.setApplicationRestrictions(packageName, restrictions, user.getIdentifier());
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Sets a new challenge PIN for restrictions. This is only for use by pre-installed
* apps and requires the MANAGE_USERS permission.
* @param newPin the PIN to use for challenge dialogs.
* @return Returns true if the challenge PIN was set successfully.
* @deprecated The restrictions PIN functionality is no longer provided by the system.
* This method is preserved for backwards compatibility reasons and always returns false.
*/
@Deprecated
public boolean setRestrictionsChallenge(String newPin) {
return false;
}
/**
* @hide
* Set restrictions that should apply to any future guest user that's created.
*/
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
public void setDefaultGuestRestrictions(Bundle restrictions) {
try {
mService.setDefaultGuestRestrictions(restrictions);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* @hide
* Gets the default guest restrictions.
*/
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
public Bundle getDefaultGuestRestrictions() {
try {
return mService.getDefaultGuestRestrictions();
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns creation time of the given user. The given user must be the calling user or
* a profile associated with it.
* @param userHandle user handle of the calling user or a profile associated with the
* calling user.
* @return creation time in milliseconds since Epoch time.
*/
public long getUserCreationTime(UserHandle userHandle) {
try {
return mService.getUserCreationTime(userHandle.getIdentifier());
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Checks if any uninitialized user has the specific seed account name and type.
*
* @param accountName The account name to check for
* @param accountType The account type of the account to check for
* @return whether the seed account was found
* @hide
*/
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
public boolean someUserHasSeedAccount(String accountName, String accountType) {
try {
return mService.someUserHasSeedAccount(accountName, accountType);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Checks if any initialized or uninitialized user has the specific account name and type.
*
* @param accountName The account name to check for
* @param accountType The account type of the account to check for
* @return whether the account was found
* @hide
*/
@SystemApi
@RequiresPermission(anyOf = {Manifest.permission.MANAGE_USERS,
Manifest.permission.CREATE_USERS})
public boolean someUserHasAccount(
@NonNull String accountName, @NonNull String accountType) {
Objects.requireNonNull(accountName, "accountName must not be null");
Objects.requireNonNull(accountType, "accountType must not be null");
try {
return mService.someUserHasAccount(accountName, accountType);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/* Cache key for anything that assumes that userIds cannot be re-used without rebooting. */
private static final String CACHE_KEY_STATIC_USER_PROPERTIES = "cache_key.static_user_props";
private final PropertyInvalidatedCache<Integer, String> mProfileTypeCache =
new PropertyInvalidatedCache<Integer, String>(32, CACHE_KEY_STATIC_USER_PROPERTIES) {
@Override
public String recompute(Integer query) {
try {
// Will be null (and not cached) if invalid user; otherwise cache the type.
String profileType = mService.getProfileType(query);
if (profileType != null) profileType = profileType.intern();
return profileType;
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
@Override
public boolean bypass(Integer query) {
return query < 0;
}
};
/** {@hide} */
public static final void invalidateStaticUserProperties() {
PropertyInvalidatedCache.invalidateCache(CACHE_KEY_STATIC_USER_PROPERTIES);
}
/**
* @hide
* User that enforces a restriction.
*
* @see #getUserRestrictionSources(String, UserHandle)
*/
@SystemApi
public static final class EnforcingUser implements Parcelable {
private final @UserIdInt int userId;
private final @UserRestrictionSource int userRestrictionSource;
/**
* @hide
*/
public EnforcingUser(
@UserIdInt int userId, @UserRestrictionSource int userRestrictionSource) {
this.userId = userId;
this.userRestrictionSource = userRestrictionSource;
}
private EnforcingUser(Parcel in) {
userId = in.readInt();
userRestrictionSource = in.readInt();
}
public static final @android.annotation.NonNull Creator<EnforcingUser> CREATOR = new Creator<EnforcingUser>() {
@Override
public EnforcingUser createFromParcel(Parcel in) {
return new EnforcingUser(in);
}
@Override
public EnforcingUser[] newArray(int size) {
return new EnforcingUser[size];
}
};
@Override
public int describeContents() {
return 0;
}
@Override
public void writeToParcel(Parcel dest, int flags) {
dest.writeInt(userId);
dest.writeInt(userRestrictionSource);
}
/**
* Returns an id of the enforcing user.
*
* <p> Will be UserHandle.USER_NULL when restriction is set by the system.
*/
public UserHandle getUserHandle() {
return UserHandle.of(userId);
}
/**
* Returns the status of the enforcing user.
*
* <p> One of {@link #RESTRICTION_SOURCE_SYSTEM},
* {@link #RESTRICTION_SOURCE_DEVICE_OWNER} and
* {@link #RESTRICTION_SOURCE_PROFILE_OWNER}
*/
public @UserRestrictionSource int getUserRestrictionSource() {
return userRestrictionSource;
}
}
}
|