xref: /aosp_15_r20/developers/build/prebuilts/gradle/BasicManagedProfile/README.md (revision d353a188ca6ec4b5eba25b5fbd7bcb8ce61322fb)
1*d353a188SXin Li
2*d353a188SXin LiAndroid BasicManagedProfile Sample
3*d353a188SXin Li===================================
4*d353a188SXin Li
5*d353a188SXin LiThis sample demonstrates basic functionalities of Managed Profile API
6*d353a188SXin Liintroduced in Android 5.0 Lollipop. You can set up this app as a
7*d353a188SXin Liprofile owner, and use this app to enable/disable apps in the newly
8*d353a188SXin Licreated managed profile. You can also set restrictions to some apps,
9*d353a188SXin Lienable/disable Intent forwarding between profiles, and wipe out all
10*d353a188SXin Lithe data associated with the profile.
11*d353a188SXin Li
12*d353a188SXin LiIntroduction
13*d353a188SXin Li------------
14*d353a188SXin Li
15*d353a188SXin LiAs of Android 5.0, DevicePolicyManager introduces new features to
16*d353a188SXin Lisupport managed profile.
17*d353a188SXin Li
18*d353a188SXin LiTo set up this app as a profile owner, you need to encrypt your device
19*d353a188SXin Li(you are prompted to do if you haven't). This doesn't wipe out the
20*d353a188SXin Lidevice, but be aware that you can set up only one managed profile at a
21*d353a188SXin Litime.
22*d353a188SXin Li
23*d353a188SXin Li[isProfileOwnerApp][1] can be used to determine if a particular
24*d353a188SXin Lipackage is registered as the profile owner for the current user. You
25*d353a188SXin Lican initiate the provisioning flow of a managed profile with Intent of
26*d353a188SXin Li[ACTION_PROVISION_MANAGED_PROFILE][2].
27*d353a188SXin Li
28*d353a188SXin LiYou have to implement a class extending [DeviceAdminReceiver][3] to
29*d353a188SXin Lireceive the result of the provisioning flow. Use
30*d353a188SXin Li[setProfileEnabled][4] to enable the newly created profile, and your
31*d353a188SXin Liapp is now set up as a profile owner.
32*d353a188SXin Li
33*d353a188SXin Li[1]: http://developer.android.com/reference/android/app/admin/DevicePolicyManager.html#isProfileOwnerApp(java.lang.String)
34*d353a188SXin Li[2]: http://developer.android.com/reference/android/app/admin/DevicePolicyManager.html#ACTION_PROVISION_MANAGED_PROFILE
35*d353a188SXin Li[3]: http://developer.android.com/reference/android/app/admin/DeviceAdminReceiver.html
36*d353a188SXin Li[4]: http://developer.android.com/reference/android/app/admin/DevicePolicyManager.html#setProfileEnabled(android.content.ComponentName)
37*d353a188SXin Li
38*d353a188SXin LiPre-requisites
39*d353a188SXin Li--------------
40*d353a188SXin Li
41*d353a188SXin Li- Android SDK 27
42*d353a188SXin Li- Android Build Tools v27.0.2
43*d353a188SXin Li- Android Support Repository
44*d353a188SXin Li
45*d353a188SXin LiScreenshots
46*d353a188SXin Li-------------
47*d353a188SXin Li
48*d353a188SXin Li<img src="screenshots/not_set_up.png" height="400" alt="Screenshot"/> <img src="screenshots/set_up.png" height="400" alt="Screenshot"/> <img src="screenshots/main.png" height="400" alt="Screenshot"/>
49*d353a188SXin Li
50*d353a188SXin LiGetting Started
51*d353a188SXin Li---------------
52*d353a188SXin Li
53*d353a188SXin LiThis sample uses the Gradle build system. To build this project, use the
54*d353a188SXin Li"gradlew build" command or use "Import Project" in Android Studio.
55*d353a188SXin Li
56*d353a188SXin LiSupport
57*d353a188SXin Li-------
58*d353a188SXin Li
59*d353a188SXin Li- Google+ Community: https://plus.google.com/communities/105153134372062985968
60*d353a188SXin Li- Stack Overflow: http://stackoverflow.com/questions/tagged/android
61*d353a188SXin Li
62*d353a188SXin LiIf you've found an error in this sample, please file an issue:
63*d353a188SXin Lihttps://github.com/googlesamples/android-BasicManagedProfile
64*d353a188SXin Li
65*d353a188SXin LiPatches are encouraged, and may be submitted by forking this project and
66*d353a188SXin Lisubmitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
67*d353a188SXin Li
68*d353a188SXin LiLicense
69*d353a188SXin Li-------
70*d353a188SXin Li
71*d353a188SXin LiCopyright 2017 The Android Open Source Project, Inc.
72*d353a188SXin Li
73*d353a188SXin LiLicensed to the Apache Software Foundation (ASF) under one or more contributor
74*d353a188SXin Lilicense agreements.  See the NOTICE file distributed with this work for
75*d353a188SXin Liadditional information regarding copyright ownership.  The ASF licenses this
76*d353a188SXin Lifile to you under the Apache License, Version 2.0 (the "License"); you may not
77*d353a188SXin Liuse this file except in compliance with the License.  You may obtain a copy of
78*d353a188SXin Lithe License at
79*d353a188SXin Li
80*d353a188SXin Lihttp://www.apache.org/licenses/LICENSE-2.0
81*d353a188SXin Li
82*d353a188SXin LiUnless required by applicable law or agreed to in writing, software
83*d353a188SXin Lidistributed under the License is distributed on an "AS IS" BASIS, WITHOUT
84*d353a188SXin LiWARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
85*d353a188SXin LiLicense for the specific language governing permissions and limitations under
86*d353a188SXin Lithe License.
87