PackageManager.java revision 87a7104ae97c4c389611947acedd4e8e30758ae4
1/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.content.pm;
18
19import android.Manifest;
20import android.annotation.CheckResult;
21import android.annotation.DrawableRes;
22import android.annotation.IntDef;
23import android.annotation.IntRange;
24import android.annotation.NonNull;
25import android.annotation.Nullable;
26import android.annotation.RequiresPermission;
27import android.annotation.SdkConstant;
28import android.annotation.SdkConstant.SdkConstantType;
29import android.annotation.StringRes;
30import android.annotation.SystemApi;
31import android.annotation.TestApi;
32import android.annotation.UserIdInt;
33import android.annotation.XmlRes;
34import android.app.PackageDeleteObserver;
35import android.app.PackageInstallObserver;
36import android.app.admin.DevicePolicyManager;
37import android.app.usage.StorageStatsManager;
38import android.content.ComponentName;
39import android.content.Context;
40import android.content.Intent;
41import android.content.IntentFilter;
42import android.content.IntentSender;
43import android.content.pm.PackageParser.PackageParserException;
44import android.content.res.Resources;
45import android.content.res.XmlResourceParser;
46import android.graphics.Rect;
47import android.graphics.drawable.Drawable;
48import android.net.Uri;
49import android.os.Build;
50import android.os.Bundle;
51import android.os.Handler;
52import android.os.RemoteException;
53import android.os.UserHandle;
54import android.os.UserManager;
55import android.os.storage.StorageManager;
56import android.os.storage.VolumeInfo;
57import android.provider.Settings;
58import android.util.AndroidException;
59import android.util.Log;
60
61import com.android.internal.util.ArrayUtils;
62
63import dalvik.system.VMRuntime;
64
65import java.io.File;
66import java.lang.annotation.Retention;
67import java.lang.annotation.RetentionPolicy;
68import java.util.List;
69
70/**
71 * Class for retrieving various kinds of information related to the application
72 * packages that are currently installed on the device.
73 *
74 * You can find this class through {@link Context#getPackageManager}.
75 */
76public abstract class PackageManager {
77    private static final String TAG = "PackageManager";
78
79    /** {@hide} */
80    public static final boolean APPLY_DEFAULT_TO_DEVICE_PROTECTED_STORAGE = true;
81
82    /**
83     * This exception is thrown when a given package, application, or component
84     * name cannot be found.
85     */
86    public static class NameNotFoundException extends AndroidException {
87        public NameNotFoundException() {
88        }
89
90        public NameNotFoundException(String name) {
91            super(name);
92        }
93    }
94
95    /**
96     * Listener for changes in permissions granted to a UID.
97     *
98     * @hide
99     */
100    @SystemApi
101    public interface OnPermissionsChangedListener {
102
103        /**
104         * Called when the permissions for a UID change.
105         * @param uid The UID with a change.
106         */
107        public void onPermissionsChanged(int uid);
108    }
109
110    /**
111     * As a guiding principle:
112     * <p>
113     * {@code GET_} flags are used to request additional data that may have been
114     * elided to save wire space.
115     * <p>
116     * {@code MATCH_} flags are used to include components or packages that
117     * would have otherwise been omitted from a result set by current system
118     * state.
119     */
120
121    /** @hide */
122    @IntDef(flag = true, prefix = { "GET_", "MATCH_" }, value = {
123            GET_ACTIVITIES,
124            GET_CONFIGURATIONS,
125            GET_GIDS,
126            GET_INSTRUMENTATION,
127            GET_INTENT_FILTERS,
128            GET_META_DATA,
129            GET_PERMISSIONS,
130            GET_PROVIDERS,
131            GET_RECEIVERS,
132            GET_SERVICES,
133            GET_SHARED_LIBRARY_FILES,
134            GET_SIGNATURES,
135            GET_URI_PERMISSION_PATTERNS,
136            MATCH_UNINSTALLED_PACKAGES,
137            MATCH_DISABLED_COMPONENTS,
138            MATCH_DISABLED_UNTIL_USED_COMPONENTS,
139            MATCH_SYSTEM_ONLY,
140            MATCH_FACTORY_ONLY,
141            MATCH_DEBUG_TRIAGED_MISSING,
142            MATCH_INSTANT,
143            GET_DISABLED_COMPONENTS,
144            GET_DISABLED_UNTIL_USED_COMPONENTS,
145            GET_UNINSTALLED_PACKAGES,
146    })
147    @Retention(RetentionPolicy.SOURCE)
148    public @interface PackageInfoFlags {}
149
150    /** @hide */
151    @IntDef(flag = true, prefix = { "GET_", "MATCH_" }, value = {
152            GET_META_DATA,
153            GET_SHARED_LIBRARY_FILES,
154            MATCH_UNINSTALLED_PACKAGES,
155            MATCH_SYSTEM_ONLY,
156            MATCH_DEBUG_TRIAGED_MISSING,
157            MATCH_DISABLED_COMPONENTS,
158            MATCH_DISABLED_UNTIL_USED_COMPONENTS,
159            MATCH_INSTANT,
160            MATCH_STATIC_SHARED_LIBRARIES,
161            GET_DISABLED_UNTIL_USED_COMPONENTS,
162            GET_UNINSTALLED_PACKAGES,
163    })
164    @Retention(RetentionPolicy.SOURCE)
165    public @interface ApplicationInfoFlags {}
166
167    /** @hide */
168    @IntDef(flag = true, prefix = { "GET_", "MATCH_" }, value = {
169            GET_META_DATA,
170            GET_SHARED_LIBRARY_FILES,
171            MATCH_ALL,
172            MATCH_DEBUG_TRIAGED_MISSING,
173            MATCH_DEFAULT_ONLY,
174            MATCH_DISABLED_COMPONENTS,
175            MATCH_DISABLED_UNTIL_USED_COMPONENTS,
176            MATCH_DIRECT_BOOT_AWARE,
177            MATCH_DIRECT_BOOT_UNAWARE,
178            MATCH_SYSTEM_ONLY,
179            MATCH_UNINSTALLED_PACKAGES,
180            MATCH_INSTANT,
181            MATCH_STATIC_SHARED_LIBRARIES,
182            GET_DISABLED_COMPONENTS,
183            GET_DISABLED_UNTIL_USED_COMPONENTS,
184            GET_UNINSTALLED_PACKAGES,
185    })
186    @Retention(RetentionPolicy.SOURCE)
187    public @interface ComponentInfoFlags {}
188
189    /** @hide */
190    @IntDef(flag = true, prefix = { "GET_", "MATCH_" }, value = {
191            GET_META_DATA,
192            GET_RESOLVED_FILTER,
193            GET_SHARED_LIBRARY_FILES,
194            MATCH_ALL,
195            MATCH_DEBUG_TRIAGED_MISSING,
196            MATCH_DISABLED_COMPONENTS,
197            MATCH_DISABLED_UNTIL_USED_COMPONENTS,
198            MATCH_DEFAULT_ONLY,
199            MATCH_DIRECT_BOOT_AWARE,
200            MATCH_DIRECT_BOOT_UNAWARE,
201            MATCH_SYSTEM_ONLY,
202            MATCH_UNINSTALLED_PACKAGES,
203            MATCH_INSTANT,
204            GET_DISABLED_COMPONENTS,
205            GET_DISABLED_UNTIL_USED_COMPONENTS,
206            GET_UNINSTALLED_PACKAGES,
207    })
208    @Retention(RetentionPolicy.SOURCE)
209    public @interface ResolveInfoFlags {}
210
211    /** @hide */
212    @IntDef(flag = true, prefix = { "GET_", "MATCH_" }, value = {
213            GET_META_DATA,
214    })
215    @Retention(RetentionPolicy.SOURCE)
216    public @interface PermissionInfoFlags {}
217
218    /** @hide */
219    @IntDef(flag = true, prefix = { "GET_", "MATCH_" }, value = {
220            GET_META_DATA,
221    })
222    @Retention(RetentionPolicy.SOURCE)
223    public @interface PermissionGroupInfoFlags {}
224
225    /** @hide */
226    @IntDef(flag = true, prefix = { "GET_", "MATCH_" }, value = {
227            GET_META_DATA,
228    })
229    @Retention(RetentionPolicy.SOURCE)
230    public @interface InstrumentationInfoFlags {}
231
232    /**
233     * {@link PackageInfo} flag: return information about
234     * activities in the package in {@link PackageInfo#activities}.
235     */
236    public static final int GET_ACTIVITIES              = 0x00000001;
237
238    /**
239     * {@link PackageInfo} flag: return information about
240     * intent receivers in the package in
241     * {@link PackageInfo#receivers}.
242     */
243    public static final int GET_RECEIVERS               = 0x00000002;
244
245    /**
246     * {@link PackageInfo} flag: return information about
247     * services in the package in {@link PackageInfo#services}.
248     */
249    public static final int GET_SERVICES                = 0x00000004;
250
251    /**
252     * {@link PackageInfo} flag: return information about
253     * content providers in the package in
254     * {@link PackageInfo#providers}.
255     */
256    public static final int GET_PROVIDERS               = 0x00000008;
257
258    /**
259     * {@link PackageInfo} flag: return information about
260     * instrumentation in the package in
261     * {@link PackageInfo#instrumentation}.
262     */
263    public static final int GET_INSTRUMENTATION         = 0x00000010;
264
265    /**
266     * {@link PackageInfo} flag: return information about the
267     * intent filters supported by the activity.
268     */
269    public static final int GET_INTENT_FILTERS          = 0x00000020;
270
271    /**
272     * {@link PackageInfo} flag: return information about the
273     * signatures included in the package.
274     */
275    public static final int GET_SIGNATURES          = 0x00000040;
276
277    /**
278     * {@link ResolveInfo} flag: return the IntentFilter that
279     * was matched for a particular ResolveInfo in
280     * {@link ResolveInfo#filter}.
281     */
282    public static final int GET_RESOLVED_FILTER         = 0x00000040;
283
284    /**
285     * {@link ComponentInfo} flag: return the {@link ComponentInfo#metaData}
286     * data {@link android.os.Bundle}s that are associated with a component.
287     * This applies for any API returning a ComponentInfo subclass.
288     */
289    public static final int GET_META_DATA               = 0x00000080;
290
291    /**
292     * {@link PackageInfo} flag: return the
293     * {@link PackageInfo#gids group ids} that are associated with an
294     * application.
295     * This applies for any API returning a PackageInfo class, either
296     * directly or nested inside of another.
297     */
298    public static final int GET_GIDS                    = 0x00000100;
299
300    /**
301     * @deprecated replaced with {@link #MATCH_DISABLED_COMPONENTS}
302     */
303    @Deprecated
304    public static final int GET_DISABLED_COMPONENTS = 0x00000200;
305
306    /**
307     * {@link PackageInfo} flag: include disabled components in the returned info.
308     */
309    public static final int MATCH_DISABLED_COMPONENTS = 0x00000200;
310
311    /**
312     * {@link ApplicationInfo} flag: return the
313     * {@link ApplicationInfo#sharedLibraryFiles paths to the shared libraries}
314     * that are associated with an application.
315     * This applies for any API returning an ApplicationInfo class, either
316     * directly or nested inside of another.
317     */
318    public static final int GET_SHARED_LIBRARY_FILES    = 0x00000400;
319
320    /**
321     * {@link ProviderInfo} flag: return the
322     * {@link ProviderInfo#uriPermissionPatterns URI permission patterns}
323     * that are associated with a content provider.
324     * This applies for any API returning a ProviderInfo class, either
325     * directly or nested inside of another.
326     */
327    public static final int GET_URI_PERMISSION_PATTERNS  = 0x00000800;
328    /**
329     * {@link PackageInfo} flag: return information about
330     * permissions in the package in
331     * {@link PackageInfo#permissions}.
332     */
333    public static final int GET_PERMISSIONS               = 0x00001000;
334
335    /**
336     * @deprecated replaced with {@link #MATCH_UNINSTALLED_PACKAGES}
337     */
338    @Deprecated
339    public static final int GET_UNINSTALLED_PACKAGES = 0x00002000;
340
341    /**
342     * Flag parameter to retrieve some information about all applications (even
343     * uninstalled ones) which have data directories. This state could have
344     * resulted if applications have been deleted with flag
345     * {@code DONT_DELETE_DATA} with a possibility of being replaced or
346     * reinstalled in future.
347     * <p>
348     * Note: this flag may cause less information about currently installed
349     * applications to be returned.
350     */
351    public static final int MATCH_UNINSTALLED_PACKAGES = 0x00002000;
352
353    /**
354     * {@link PackageInfo} flag: return information about
355     * hardware preferences in
356     * {@link PackageInfo#configPreferences PackageInfo.configPreferences},
357     * and requested features in {@link PackageInfo#reqFeatures} and
358     * {@link PackageInfo#featureGroups}.
359     */
360    public static final int GET_CONFIGURATIONS = 0x00004000;
361
362    /**
363     * @deprecated replaced with {@link #MATCH_DISABLED_UNTIL_USED_COMPONENTS}.
364     */
365    @Deprecated
366    public static final int GET_DISABLED_UNTIL_USED_COMPONENTS = 0x00008000;
367
368    /**
369     * {@link PackageInfo} flag: include disabled components which are in
370     * that state only because of {@link #COMPONENT_ENABLED_STATE_DISABLED_UNTIL_USED}
371     * in the returned info.  Note that if you set this flag, applications
372     * that are in this disabled state will be reported as enabled.
373     */
374    public static final int MATCH_DISABLED_UNTIL_USED_COMPONENTS = 0x00008000;
375
376    /**
377     * Resolution and querying flag: if set, only filters that support the
378     * {@link android.content.Intent#CATEGORY_DEFAULT} will be considered for
379     * matching.  This is a synonym for including the CATEGORY_DEFAULT in your
380     * supplied Intent.
381     */
382    public static final int MATCH_DEFAULT_ONLY  = 0x00010000;
383
384    /**
385     * Querying flag: if set and if the platform is doing any filtering of the
386     * results, then the filtering will not happen. This is a synonym for saying
387     * that all results should be returned.
388     * <p>
389     * <em>This flag should be used with extreme care.</em>
390     */
391    public static final int MATCH_ALL = 0x00020000;
392
393    /**
394     * Querying flag: match components which are direct boot <em>unaware</em> in
395     * the returned info, regardless of the current user state.
396     * <p>
397     * When neither {@link #MATCH_DIRECT_BOOT_AWARE} nor
398     * {@link #MATCH_DIRECT_BOOT_UNAWARE} are specified, the default behavior is
399     * to match only runnable components based on the user state. For example,
400     * when a user is started but credentials have not been presented yet, the
401     * user is running "locked" and only {@link #MATCH_DIRECT_BOOT_AWARE}
402     * components are returned. Once the user credentials have been presented,
403     * the user is running "unlocked" and both {@link #MATCH_DIRECT_BOOT_AWARE}
404     * and {@link #MATCH_DIRECT_BOOT_UNAWARE} components are returned.
405     *
406     * @see UserManager#isUserUnlocked()
407     */
408    public static final int MATCH_DIRECT_BOOT_UNAWARE = 0x00040000;
409
410    /**
411     * Querying flag: match components which are direct boot <em>aware</em> in
412     * the returned info, regardless of the current user state.
413     * <p>
414     * When neither {@link #MATCH_DIRECT_BOOT_AWARE} nor
415     * {@link #MATCH_DIRECT_BOOT_UNAWARE} are specified, the default behavior is
416     * to match only runnable components based on the user state. For example,
417     * when a user is started but credentials have not been presented yet, the
418     * user is running "locked" and only {@link #MATCH_DIRECT_BOOT_AWARE}
419     * components are returned. Once the user credentials have been presented,
420     * the user is running "unlocked" and both {@link #MATCH_DIRECT_BOOT_AWARE}
421     * and {@link #MATCH_DIRECT_BOOT_UNAWARE} components are returned.
422     *
423     * @see UserManager#isUserUnlocked()
424     */
425    public static final int MATCH_DIRECT_BOOT_AWARE = 0x00080000;
426
427    /**
428     * Querying flag: include only components from applications that are marked
429     * with {@link ApplicationInfo#FLAG_SYSTEM}.
430     */
431    public static final int MATCH_SYSTEM_ONLY = 0x00100000;
432
433    /**
434     * Internal {@link PackageInfo} flag: include only components on the system image.
435     * This will not return information on any unbundled update to system components.
436     * @hide
437     */
438    @SystemApi
439    public static final int MATCH_FACTORY_ONLY = 0x00200000;
440
441    /**
442     * Allows querying of packages installed for any user, not just the specific one. This flag
443     * is only meant for use by apps that have INTERACT_ACROSS_USERS permission.
444     * @hide
445     */
446    @SystemApi
447    public static final int MATCH_ANY_USER = 0x00400000;
448
449    /**
450     * Combination of MATCH_ANY_USER and MATCH_UNINSTALLED_PACKAGES to mean any known
451     * package.
452     * @hide
453     */
454    public static final int MATCH_KNOWN_PACKAGES = MATCH_UNINSTALLED_PACKAGES | MATCH_ANY_USER;
455
456    /**
457     * Internal {@link PackageInfo} flag: include components that are part of an
458     * instant app. By default, instant app components are not matched.
459     * @hide
460     */
461    @SystemApi
462    public static final int MATCH_INSTANT = 0x00800000;
463
464    /**
465     * Internal {@link PackageInfo} flag: include only components that are exposed to
466     * instant apps. Matched components may have been either explicitly or implicitly
467     * exposed.
468     * @hide
469     */
470    public static final int MATCH_VISIBLE_TO_INSTANT_APP_ONLY = 0x01000000;
471
472    /**
473     * Internal {@link PackageInfo} flag: include only components that have been
474     * explicitly exposed to instant apps.
475     * @hide
476     */
477    public static final int MATCH_EXPLICITLY_VISIBLE_ONLY = 0x02000000;
478
479    /**
480     * Internal {@link PackageInfo} flag: include static shared libraries.
481     * Apps that depend on static shared libs can always access the version
482     * of the lib they depend on. System/shell/root can access all shared
483     * libs regardless of dependency but need to explicitly ask for them
484     * via this flag.
485     * @hide
486     */
487    public static final int MATCH_STATIC_SHARED_LIBRARIES = 0x04000000;
488
489    /**
490     * Internal flag used to indicate that a system component has done their
491     * homework and verified that they correctly handle packages and components
492     * that come and go over time. In particular:
493     * <ul>
494     * <li>Apps installed on external storage, which will appear to be
495     * uninstalled while the the device is ejected.
496     * <li>Apps with encryption unaware components, which will appear to not
497     * exist while the device is locked.
498     * </ul>
499     *
500     * @see #MATCH_UNINSTALLED_PACKAGES
501     * @see #MATCH_DIRECT_BOOT_AWARE
502     * @see #MATCH_DIRECT_BOOT_UNAWARE
503     * @hide
504     */
505    public static final int MATCH_DEBUG_TRIAGED_MISSING = 0x10000000;
506
507    /**
508     * Flag for {@link #addCrossProfileIntentFilter}: if this flag is set: when
509     * resolving an intent that matches the {@code CrossProfileIntentFilter},
510     * the current profile will be skipped. Only activities in the target user
511     * can respond to the intent.
512     *
513     * @hide
514     */
515    public static final int SKIP_CURRENT_PROFILE = 0x00000002;
516
517    /**
518     * Flag for {@link #addCrossProfileIntentFilter}: if this flag is set:
519     * activities in the other profiles can respond to the intent only if no activity with
520     * non-negative priority in current profile can respond to the intent.
521     * @hide
522     */
523    public static final int ONLY_IF_NO_MATCH_FOUND = 0x00000004;
524
525    /** @hide */
526    @IntDef(prefix = { "PERMISSION_" }, value = {
527            PERMISSION_GRANTED,
528            PERMISSION_DENIED
529    })
530    @Retention(RetentionPolicy.SOURCE)
531    public @interface PermissionResult {}
532
533    /**
534     * Permission check result: this is returned by {@link #checkPermission}
535     * if the permission has been granted to the given package.
536     */
537    public static final int PERMISSION_GRANTED = 0;
538
539    /**
540     * Permission check result: this is returned by {@link #checkPermission}
541     * if the permission has not been granted to the given package.
542     */
543    public static final int PERMISSION_DENIED = -1;
544
545    /** @hide */
546    @IntDef(prefix = { "SIGNATURE_" }, value = {
547            SIGNATURE_MATCH,
548            SIGNATURE_NEITHER_SIGNED,
549            SIGNATURE_FIRST_NOT_SIGNED,
550            SIGNATURE_SECOND_NOT_SIGNED,
551            SIGNATURE_NO_MATCH,
552            SIGNATURE_UNKNOWN_PACKAGE,
553    })
554    @Retention(RetentionPolicy.SOURCE)
555    public @interface SignatureResult {}
556
557    /**
558     * Signature check result: this is returned by {@link #checkSignatures}
559     * if all signatures on the two packages match.
560     */
561    public static final int SIGNATURE_MATCH = 0;
562
563    /**
564     * Signature check result: this is returned by {@link #checkSignatures}
565     * if neither of the two packages is signed.
566     */
567    public static final int SIGNATURE_NEITHER_SIGNED = 1;
568
569    /**
570     * Signature check result: this is returned by {@link #checkSignatures}
571     * if the first package is not signed but the second is.
572     */
573    public static final int SIGNATURE_FIRST_NOT_SIGNED = -1;
574
575    /**
576     * Signature check result: this is returned by {@link #checkSignatures}
577     * if the second package is not signed but the first is.
578     */
579    public static final int SIGNATURE_SECOND_NOT_SIGNED = -2;
580
581    /**
582     * Signature check result: this is returned by {@link #checkSignatures}
583     * if not all signatures on both packages match.
584     */
585    public static final int SIGNATURE_NO_MATCH = -3;
586
587    /**
588     * Signature check result: this is returned by {@link #checkSignatures}
589     * if either of the packages are not valid.
590     */
591    public static final int SIGNATURE_UNKNOWN_PACKAGE = -4;
592
593    /** @hide */
594    @IntDef(prefix = { "COMPONENT_ENABLED_STATE_" }, value = {
595            COMPONENT_ENABLED_STATE_DEFAULT,
596            COMPONENT_ENABLED_STATE_ENABLED,
597            COMPONENT_ENABLED_STATE_DISABLED,
598            COMPONENT_ENABLED_STATE_DISABLED_USER,
599            COMPONENT_ENABLED_STATE_DISABLED_UNTIL_USED,
600    })
601    @Retention(RetentionPolicy.SOURCE)
602    public @interface EnabledState {}
603
604    /**
605     * Flag for {@link #setApplicationEnabledSetting(String, int, int)} and
606     * {@link #setComponentEnabledSetting(ComponentName, int, int)}: This
607     * component or application is in its default enabled state (as specified in
608     * its manifest).
609     * <p>
610     * Explicitly setting the component state to this value restores it's
611     * enabled state to whatever is set in the manifest.
612     */
613    public static final int COMPONENT_ENABLED_STATE_DEFAULT = 0;
614
615    /**
616     * Flag for {@link #setApplicationEnabledSetting(String, int, int)}
617     * and {@link #setComponentEnabledSetting(ComponentName, int, int)}: This
618     * component or application has been explictily enabled, regardless of
619     * what it has specified in its manifest.
620     */
621    public static final int COMPONENT_ENABLED_STATE_ENABLED = 1;
622
623    /**
624     * Flag for {@link #setApplicationEnabledSetting(String, int, int)}
625     * and {@link #setComponentEnabledSetting(ComponentName, int, int)}: This
626     * component or application has been explicitly disabled, regardless of
627     * what it has specified in its manifest.
628     */
629    public static final int COMPONENT_ENABLED_STATE_DISABLED = 2;
630
631    /**
632     * Flag for {@link #setApplicationEnabledSetting(String, int, int)} only: The
633     * user has explicitly disabled the application, regardless of what it has
634     * specified in its manifest.  Because this is due to the user's request,
635     * they may re-enable it if desired through the appropriate system UI.  This
636     * option currently <strong>cannot</strong> be used with
637     * {@link #setComponentEnabledSetting(ComponentName, int, int)}.
638     */
639    public static final int COMPONENT_ENABLED_STATE_DISABLED_USER = 3;
640
641    /**
642     * Flag for {@link #setApplicationEnabledSetting(String, int, int)} only: This
643     * application should be considered, until the point where the user actually
644     * wants to use it.  This means that it will not normally show up to the user
645     * (such as in the launcher), but various parts of the user interface can
646     * use {@link #GET_DISABLED_UNTIL_USED_COMPONENTS} to still see it and allow
647     * the user to select it (as for example an IME, device admin, etc).  Such code,
648     * once the user has selected the app, should at that point also make it enabled.
649     * This option currently <strong>can not</strong> be used with
650     * {@link #setComponentEnabledSetting(ComponentName, int, int)}.
651     */
652    public static final int COMPONENT_ENABLED_STATE_DISABLED_UNTIL_USED = 4;
653
654    /** @hide */
655    @IntDef(flag = true, prefix = { "INSTALL_" }, value = {
656            INSTALL_FORWARD_LOCK,
657            INSTALL_REPLACE_EXISTING,
658            INSTALL_ALLOW_TEST,
659            INSTALL_EXTERNAL,
660            INSTALL_INTERNAL,
661            INSTALL_FROM_ADB,
662            INSTALL_ALL_USERS,
663            INSTALL_ALLOW_DOWNGRADE,
664            INSTALL_GRANT_RUNTIME_PERMISSIONS,
665            INSTALL_FORCE_VOLUME_UUID,
666            INSTALL_FORCE_PERMISSION_PROMPT,
667            INSTALL_INSTANT_APP,
668            INSTALL_DONT_KILL_APP,
669            INSTALL_FORCE_SDK,
670            INSTALL_FULL_APP,
671            INSTALL_ALLOCATE_AGGRESSIVE,
672    })
673    @Retention(RetentionPolicy.SOURCE)
674    public @interface InstallFlags {}
675
676    /**
677     * Flag parameter for {@link #installPackage} to indicate that this package
678     * should be installed as forward locked, i.e. only the app itself should
679     * have access to its code and non-resource assets.
680     *
681     * @deprecated new installs into ASEC containers are no longer supported.
682     * @hide
683     */
684    @Deprecated
685    public static final int INSTALL_FORWARD_LOCK = 0x00000001;
686
687    /**
688     * Flag parameter for {@link #installPackage} to indicate that you want to
689     * replace an already installed package, if one exists.
690     *
691     * @hide
692     */
693    public static final int INSTALL_REPLACE_EXISTING = 0x00000002;
694
695    /**
696     * Flag parameter for {@link #installPackage} to indicate that you want to
697     * allow test packages (those that have set android:testOnly in their
698     * manifest) to be installed.
699     * @hide
700     */
701    public static final int INSTALL_ALLOW_TEST = 0x00000004;
702
703    /**
704     * Flag parameter for {@link #installPackage} to indicate that this package
705     * must be installed to an ASEC on a {@link VolumeInfo#TYPE_PUBLIC}.
706     *
707     * @deprecated new installs into ASEC containers are no longer supported;
708     *             use adoptable storage instead.
709     * @hide
710     */
711    @Deprecated
712    public static final int INSTALL_EXTERNAL = 0x00000008;
713
714    /**
715     * Flag parameter for {@link #installPackage} to indicate that this package
716     * must be installed to internal storage.
717     *
718     * @hide
719     */
720    public static final int INSTALL_INTERNAL = 0x00000010;
721
722    /**
723     * Flag parameter for {@link #installPackage} to indicate that this install
724     * was initiated via ADB.
725     *
726     * @hide
727     */
728    public static final int INSTALL_FROM_ADB = 0x00000020;
729
730    /**
731     * Flag parameter for {@link #installPackage} to indicate that this install
732     * should immediately be visible to all users.
733     *
734     * @hide
735     */
736    public static final int INSTALL_ALL_USERS = 0x00000040;
737
738    /**
739     * Flag parameter for {@link #installPackage} to indicate that it is okay
740     * to install an update to an app where the newly installed app has a lower
741     * version code than the currently installed app. This is permitted only if
742     * the currently installed app is marked debuggable.
743     *
744     * @hide
745     */
746    public static final int INSTALL_ALLOW_DOWNGRADE = 0x00000080;
747
748    /**
749     * Flag parameter for {@link #installPackage} to indicate that all runtime
750     * permissions should be granted to the package. If {@link #INSTALL_ALL_USERS}
751     * is set the runtime permissions will be granted to all users, otherwise
752     * only to the owner.
753     *
754     * @hide
755     */
756    public static final int INSTALL_GRANT_RUNTIME_PERMISSIONS = 0x00000100;
757
758    /** {@hide} */
759    public static final int INSTALL_FORCE_VOLUME_UUID = 0x00000200;
760
761    /**
762     * Flag parameter for {@link #installPackage} to indicate that we always want to force
763     * the prompt for permission approval. This overrides any special behaviour for internal
764     * components.
765     *
766     * @hide
767     */
768    public static final int INSTALL_FORCE_PERMISSION_PROMPT = 0x00000400;
769
770    /**
771     * Flag parameter for {@link #installPackage} to indicate that this package is
772     * to be installed as a lightweight "ephemeral" app.
773     *
774     * @hide
775     */
776    public static final int INSTALL_INSTANT_APP = 0x00000800;
777
778    /**
779     * Flag parameter for {@link #installPackage} to indicate that this package contains
780     * a feature split to an existing application and the existing application should not
781     * be killed during the installation process.
782     *
783     * @hide
784     */
785    public static final int INSTALL_DONT_KILL_APP = 0x00001000;
786
787    /**
788     * Flag parameter for {@link #installPackage} to indicate that this package is an
789     * upgrade to a package that refers to the SDK via release letter.
790     *
791     * @hide
792     */
793    public static final int INSTALL_FORCE_SDK = 0x00002000;
794
795    /**
796     * Flag parameter for {@link #installPackage} to indicate that this package is
797     * to be installed as a heavy weight app. This is fundamentally the opposite of
798     * {@link #INSTALL_INSTANT_APP}.
799     *
800     * @hide
801     */
802    public static final int INSTALL_FULL_APP = 0x00004000;
803
804    /**
805     * Flag parameter for {@link #installPackage} to indicate that this package
806     * is critical to system health or security, meaning the system should use
807     * {@link StorageManager#FLAG_ALLOCATE_AGGRESSIVE} internally.
808     *
809     * @hide
810     */
811    public static final int INSTALL_ALLOCATE_AGGRESSIVE = 0x00008000;
812
813    /** @hide */
814    @IntDef(flag = true, prefix = { "DONT_KILL_APP" }, value = {
815            DONT_KILL_APP
816    })
817    @Retention(RetentionPolicy.SOURCE)
818    public @interface EnabledFlags {}
819
820    /**
821     * Flag parameter for
822     * {@link #setComponentEnabledSetting(android.content.ComponentName, int, int)} to indicate
823     * that you don't want to kill the app containing the component.  Be careful when you set this
824     * since changing component states can make the containing application's behavior unpredictable.
825     */
826    public static final int DONT_KILL_APP = 0x00000001;
827
828    /** @hide */
829    @IntDef(prefix = { "INSTALL_REASON_" }, value = {
830            INSTALL_REASON_UNKNOWN,
831            INSTALL_REASON_POLICY,
832            INSTALL_REASON_DEVICE_RESTORE,
833            INSTALL_REASON_DEVICE_SETUP,
834            INSTALL_REASON_USER
835    })
836    @Retention(RetentionPolicy.SOURCE)
837    public @interface InstallReason {}
838
839    /**
840     * Code indicating that the reason for installing this package is unknown.
841     */
842    public static final int INSTALL_REASON_UNKNOWN = 0;
843
844    /**
845     * Code indicating that this package was installed due to enterprise policy.
846     */
847    public static final int INSTALL_REASON_POLICY = 1;
848
849    /**
850     * Code indicating that this package was installed as part of restoring from another device.
851     */
852    public static final int INSTALL_REASON_DEVICE_RESTORE = 2;
853
854    /**
855     * Code indicating that this package was installed as part of device setup.
856     */
857    public static final int INSTALL_REASON_DEVICE_SETUP = 3;
858
859    /**
860     * Code indicating that the package installation was initiated by the user.
861     */
862    public static final int INSTALL_REASON_USER = 4;
863
864    /**
865     * Installation return code: this is passed to the
866     * {@link IPackageInstallObserver} on success.
867     *
868     * @hide
869     */
870    @SystemApi
871    public static final int INSTALL_SUCCEEDED = 1;
872
873    /**
874     * Installation return code: this is passed to the
875     * {@link IPackageInstallObserver} if the package is already installed.
876     *
877     * @hide
878     */
879    @SystemApi
880    public static final int INSTALL_FAILED_ALREADY_EXISTS = -1;
881
882    /**
883     * Installation return code: this is passed to the
884     * {@link IPackageInstallObserver} if the package archive file is invalid.
885     *
886     * @hide
887     */
888    @SystemApi
889    public static final int INSTALL_FAILED_INVALID_APK = -2;
890
891    /**
892     * Installation return code: this is passed to the
893     * {@link IPackageInstallObserver} if the URI passed in is invalid.
894     *
895     * @hide
896     */
897    @SystemApi
898    public static final int INSTALL_FAILED_INVALID_URI = -3;
899
900    /**
901     * Installation return code: this is passed to the
902     * {@link IPackageInstallObserver} if the package manager service found that
903     * the device didn't have enough storage space to install the app.
904     *
905     * @hide
906     */
907    @SystemApi
908    public static final int INSTALL_FAILED_INSUFFICIENT_STORAGE = -4;
909
910    /**
911     * Installation return code: this is passed to the
912     * {@link IPackageInstallObserver} if a package is already installed with
913     * the same name.
914     *
915     * @hide
916     */
917    @SystemApi
918    public static final int INSTALL_FAILED_DUPLICATE_PACKAGE = -5;
919
920    /**
921     * Installation return code: this is passed to the
922     * {@link IPackageInstallObserver} if the requested shared user does not
923     * exist.
924     *
925     * @hide
926     */
927    @SystemApi
928    public static final int INSTALL_FAILED_NO_SHARED_USER = -6;
929
930    /**
931     * Installation return code: this is passed to the
932     * {@link IPackageInstallObserver} if a previously installed package of the
933     * same name has a different signature than the new package (and the old
934     * package's data was not removed).
935     *
936     * @hide
937     */
938    @SystemApi
939    public static final int INSTALL_FAILED_UPDATE_INCOMPATIBLE = -7;
940
941    /**
942     * Installation return code: this is passed to the
943     * {@link IPackageInstallObserver} if the new package is requested a shared
944     * user which is already installed on the device and does not have matching
945     * signature.
946     *
947     * @hide
948     */
949    @SystemApi
950    public static final int INSTALL_FAILED_SHARED_USER_INCOMPATIBLE = -8;
951
952    /**
953     * Installation return code: this is passed to the
954     * {@link IPackageInstallObserver} if the new package uses a shared library
955     * that is not available.
956     *
957     * @hide
958     */
959    @SystemApi
960    public static final int INSTALL_FAILED_MISSING_SHARED_LIBRARY = -9;
961
962    /**
963     * Installation return code: this is passed to the
964     * {@link IPackageInstallObserver} if the new package uses a shared library
965     * that is not available.
966     *
967     * @hide
968     */
969    @SystemApi
970    public static final int INSTALL_FAILED_REPLACE_COULDNT_DELETE = -10;
971
972    /**
973     * Installation return code: this is passed to the
974     * {@link IPackageInstallObserver} if the new package failed while
975     * optimizing and validating its dex files, either because there was not
976     * enough storage or the validation failed.
977     *
978     * @hide
979     */
980    @SystemApi
981    public static final int INSTALL_FAILED_DEXOPT = -11;
982
983    /**
984     * Installation return code: this is passed to the
985     * {@link IPackageInstallObserver} if the new package failed because the
986     * current SDK version is older than that required by the package.
987     *
988     * @hide
989     */
990    @SystemApi
991    public static final int INSTALL_FAILED_OLDER_SDK = -12;
992
993    /**
994     * Installation return code: this is passed to the
995     * {@link IPackageInstallObserver} if the new package failed because it
996     * contains a content provider with the same authority as a provider already
997     * installed in the system.
998     *
999     * @hide
1000     */
1001    @SystemApi
1002    public static final int INSTALL_FAILED_CONFLICTING_PROVIDER = -13;
1003
1004    /**
1005     * Installation return code: this is passed to the
1006     * {@link IPackageInstallObserver} if the new package failed because the
1007     * current SDK version is newer than that required by the package.
1008     *
1009     * @hide
1010     */
1011    @SystemApi
1012    public static final int INSTALL_FAILED_NEWER_SDK = -14;
1013
1014    /**
1015     * Installation return code: this is passed to the
1016     * {@link IPackageInstallObserver} if the new package failed because it has
1017     * specified that it is a test-only package and the caller has not supplied
1018     * the {@link #INSTALL_ALLOW_TEST} flag.
1019     *
1020     * @hide
1021     */
1022    @SystemApi
1023    public static final int INSTALL_FAILED_TEST_ONLY = -15;
1024
1025    /**
1026     * Installation return code: this is passed to the
1027     * {@link IPackageInstallObserver} if the package being installed contains
1028     * native code, but none that is compatible with the device's CPU_ABI.
1029     *
1030     * @hide
1031     */
1032    @SystemApi
1033    public static final int INSTALL_FAILED_CPU_ABI_INCOMPATIBLE = -16;
1034
1035    /**
1036     * Installation return code: this is passed to the
1037     * {@link IPackageInstallObserver} if the new package uses a feature that is
1038     * not available.
1039     *
1040     * @hide
1041     */
1042    @SystemApi
1043    public static final int INSTALL_FAILED_MISSING_FEATURE = -17;
1044
1045    // ------ Errors related to sdcard
1046    /**
1047     * Installation return code: this is passed to the
1048     * {@link IPackageInstallObserver} if a secure container mount point
1049     * couldn't be accessed on external media.
1050     *
1051     * @hide
1052     */
1053    @SystemApi
1054    public static final int INSTALL_FAILED_CONTAINER_ERROR = -18;
1055
1056    /**
1057     * Installation return code: this is passed to the
1058     * {@link IPackageInstallObserver} if the new package couldn't be installed
1059     * in the specified install location.
1060     *
1061     * @hide
1062     */
1063    @SystemApi
1064    public static final int INSTALL_FAILED_INVALID_INSTALL_LOCATION = -19;
1065
1066    /**
1067     * Installation return code: this is passed to the
1068     * {@link IPackageInstallObserver} if the new package couldn't be installed
1069     * in the specified install location because the media is not available.
1070     *
1071     * @hide
1072     */
1073    @SystemApi
1074    public static final int INSTALL_FAILED_MEDIA_UNAVAILABLE = -20;
1075
1076    /**
1077     * Installation return code: this is passed to the
1078     * {@link IPackageInstallObserver} if the new package couldn't be installed
1079     * because the verification timed out.
1080     *
1081     * @hide
1082     */
1083    @SystemApi
1084    public static final int INSTALL_FAILED_VERIFICATION_TIMEOUT = -21;
1085
1086    /**
1087     * Installation return code: this is passed to the
1088     * {@link IPackageInstallObserver} if the new package couldn't be installed
1089     * because the verification did not succeed.
1090     *
1091     * @hide
1092     */
1093    @SystemApi
1094    public static final int INSTALL_FAILED_VERIFICATION_FAILURE = -22;
1095
1096    /**
1097     * Installation return code: this is passed to the
1098     * {@link IPackageInstallObserver} if the package changed from what the
1099     * calling program expected.
1100     *
1101     * @hide
1102     */
1103    @SystemApi
1104    public static final int INSTALL_FAILED_PACKAGE_CHANGED = -23;
1105
1106    /**
1107     * Installation return code: this is passed to the
1108     * {@link IPackageInstallObserver} if the new package is assigned a
1109     * different UID than it previously held.
1110     *
1111     * @hide
1112     */
1113    public static final int INSTALL_FAILED_UID_CHANGED = -24;
1114
1115    /**
1116     * Installation return code: this is passed to the
1117     * {@link IPackageInstallObserver} if the new package has an older version
1118     * code than the currently installed package.
1119     *
1120     * @hide
1121     */
1122    public static final int INSTALL_FAILED_VERSION_DOWNGRADE = -25;
1123
1124    /**
1125     * Installation return code: this is passed to the
1126     * {@link IPackageInstallObserver} if the old package has target SDK high
1127     * enough to support runtime permission and the new package has target SDK
1128     * low enough to not support runtime permissions.
1129     *
1130     * @hide
1131     */
1132    @SystemApi
1133    public static final int INSTALL_FAILED_PERMISSION_MODEL_DOWNGRADE = -26;
1134
1135    /**
1136     * Installation return code: this is passed to the
1137     * {@link IPackageInstallObserver} if the new package attempts to downgrade the
1138     * target sandbox version of the app.
1139     *
1140     * @hide
1141     */
1142    @SystemApi
1143    public static final int INSTALL_FAILED_SANDBOX_VERSION_DOWNGRADE = -27;
1144
1145    /**
1146     * Installation parse return code: this is passed to the
1147     * {@link IPackageInstallObserver} if the parser was given a path that is
1148     * not a file, or does not end with the expected '.apk' extension.
1149     *
1150     * @hide
1151     */
1152    @SystemApi
1153    public static final int INSTALL_PARSE_FAILED_NOT_APK = -100;
1154
1155    /**
1156     * Installation parse return code: this is passed to the
1157     * {@link IPackageInstallObserver} if the parser was unable to retrieve the
1158     * AndroidManifest.xml file.
1159     *
1160     * @hide
1161     */
1162    @SystemApi
1163    public static final int INSTALL_PARSE_FAILED_BAD_MANIFEST = -101;
1164
1165    /**
1166     * Installation parse return code: this is passed to the
1167     * {@link IPackageInstallObserver} if the parser encountered an unexpected
1168     * exception.
1169     *
1170     * @hide
1171     */
1172    @SystemApi
1173    public static final int INSTALL_PARSE_FAILED_UNEXPECTED_EXCEPTION = -102;
1174
1175    /**
1176     * Installation parse return code: this is passed to the
1177     * {@link IPackageInstallObserver} if the parser did not find any
1178     * certificates in the .apk.
1179     *
1180     * @hide
1181     */
1182    @SystemApi
1183    public static final int INSTALL_PARSE_FAILED_NO_CERTIFICATES = -103;
1184
1185    /**
1186     * Installation parse return code: this is passed to the
1187     * {@link IPackageInstallObserver} if the parser found inconsistent
1188     * certificates on the files in the .apk.
1189     *
1190     * @hide
1191     */
1192    @SystemApi
1193    public static final int INSTALL_PARSE_FAILED_INCONSISTENT_CERTIFICATES = -104;
1194
1195    /**
1196     * Installation parse return code: this is passed to the
1197     * {@link IPackageInstallObserver} if the parser encountered a
1198     * CertificateEncodingException in one of the files in the .apk.
1199     *
1200     * @hide
1201     */
1202    @SystemApi
1203    public static final int INSTALL_PARSE_FAILED_CERTIFICATE_ENCODING = -105;
1204
1205    /**
1206     * Installation parse return code: this is passed to the
1207     * {@link IPackageInstallObserver} if the parser encountered a bad or
1208     * missing package name in the manifest.
1209     *
1210     * @hide
1211     */
1212    @SystemApi
1213    public static final int INSTALL_PARSE_FAILED_BAD_PACKAGE_NAME = -106;
1214
1215    /**
1216     * Installation parse return code: this is passed to the
1217     * {@link IPackageInstallObserver} if the parser encountered a bad shared
1218     * user id name in the manifest.
1219     *
1220     * @hide
1221     */
1222    @SystemApi
1223    public static final int INSTALL_PARSE_FAILED_BAD_SHARED_USER_ID = -107;
1224
1225    /**
1226     * Installation parse return code: this is passed to the
1227     * {@link IPackageInstallObserver} if the parser encountered some structural
1228     * problem in the manifest.
1229     *
1230     * @hide
1231     */
1232    @SystemApi
1233    public static final int INSTALL_PARSE_FAILED_MANIFEST_MALFORMED = -108;
1234
1235    /**
1236     * Installation parse return code: this is passed to the
1237     * {@link IPackageInstallObserver} if the parser did not find any actionable
1238     * tags (instrumentation or application) in the manifest.
1239     *
1240     * @hide
1241     */
1242    @SystemApi
1243    public static final int INSTALL_PARSE_FAILED_MANIFEST_EMPTY = -109;
1244
1245    /**
1246     * Installation failed return code: this is passed to the
1247     * {@link IPackageInstallObserver} if the system failed to install the
1248     * package because of system issues.
1249     *
1250     * @hide
1251     */
1252    @SystemApi
1253    public static final int INSTALL_FAILED_INTERNAL_ERROR = -110;
1254
1255    /**
1256     * Installation failed return code: this is passed to the
1257     * {@link IPackageInstallObserver} if the system failed to install the
1258     * package because the user is restricted from installing apps.
1259     *
1260     * @hide
1261     */
1262    public static final int INSTALL_FAILED_USER_RESTRICTED = -111;
1263
1264    /**
1265     * Installation failed return code: this is passed to the
1266     * {@link IPackageInstallObserver} if the system failed to install the
1267     * package because it is attempting to define a permission that is already
1268     * defined by some existing package.
1269     * <p>
1270     * The package name of the app which has already defined the permission is
1271     * passed to a {@link PackageInstallObserver}, if any, as the
1272     * {@link #EXTRA_FAILURE_EXISTING_PACKAGE} string extra; and the name of the
1273     * permission being redefined is passed in the
1274     * {@link #EXTRA_FAILURE_EXISTING_PERMISSION} string extra.
1275     *
1276     * @hide
1277     */
1278    public static final int INSTALL_FAILED_DUPLICATE_PERMISSION = -112;
1279
1280    /**
1281     * Installation failed return code: this is passed to the
1282     * {@link IPackageInstallObserver} if the system failed to install the
1283     * package because its packaged native code did not match any of the ABIs
1284     * supported by the system.
1285     *
1286     * @hide
1287     */
1288    public static final int INSTALL_FAILED_NO_MATCHING_ABIS = -113;
1289
1290    /**
1291     * Internal return code for NativeLibraryHelper methods to indicate that the package
1292     * being processed did not contain any native code. This is placed here only so that
1293     * it can belong to the same value space as the other install failure codes.
1294     *
1295     * @hide
1296     */
1297    public static final int NO_NATIVE_LIBRARIES = -114;
1298
1299    /** {@hide} */
1300    public static final int INSTALL_FAILED_ABORTED = -115;
1301
1302    /**
1303     * Installation failed return code: instant app installs are incompatible with some
1304     * other installation flags supplied for the operation; or other circumstances such
1305     * as trying to upgrade a system app via an instant app install.
1306     * @hide
1307     */
1308    public static final int INSTALL_FAILED_INSTANT_APP_INVALID = -116;
1309
1310    /** @hide */
1311    @IntDef(flag = true, prefix = { "DELETE_" }, value = {
1312            DELETE_KEEP_DATA,
1313            DELETE_ALL_USERS,
1314            DELETE_SYSTEM_APP,
1315            DELETE_DONT_KILL_APP,
1316    })
1317    @Retention(RetentionPolicy.SOURCE)
1318    public @interface DeleteFlags {}
1319
1320    /**
1321     * Flag parameter for {@link #deletePackage} to indicate that you don't want to delete the
1322     * package's data directory.
1323     *
1324     * @hide
1325     */
1326    public static final int DELETE_KEEP_DATA = 0x00000001;
1327
1328    /**
1329     * Flag parameter for {@link #deletePackage} to indicate that you want the
1330     * package deleted for all users.
1331     *
1332     * @hide
1333     */
1334    public static final int DELETE_ALL_USERS = 0x00000002;
1335
1336    /**
1337     * Flag parameter for {@link #deletePackage} to indicate that, if you are calling
1338     * uninstall on a system that has been updated, then don't do the normal process
1339     * of uninstalling the update and rolling back to the older system version (which
1340     * needs to happen for all users); instead, just mark the app as uninstalled for
1341     * the current user.
1342     *
1343     * @hide
1344     */
1345    public static final int DELETE_SYSTEM_APP = 0x00000004;
1346
1347    /**
1348     * Flag parameter for {@link #deletePackage} to indicate that, if you are calling
1349     * uninstall on a package that is replaced to provide new feature splits, the
1350     * existing application should not be killed during the removal process.
1351     *
1352     * @hide
1353     */
1354    public static final int DELETE_DONT_KILL_APP = 0x00000008;
1355
1356    /**
1357     * Return code for when package deletion succeeds. This is passed to the
1358     * {@link IPackageDeleteObserver} if the system succeeded in deleting the
1359     * package.
1360     *
1361     * @hide
1362     */
1363    public static final int DELETE_SUCCEEDED = 1;
1364
1365    /**
1366     * Deletion failed return code: this is passed to the
1367     * {@link IPackageDeleteObserver} if the system failed to delete the package
1368     * for an unspecified reason.
1369     *
1370     * @hide
1371     */
1372    public static final int DELETE_FAILED_INTERNAL_ERROR = -1;
1373
1374    /**
1375     * Deletion failed return code: this is passed to the
1376     * {@link IPackageDeleteObserver} if the system failed to delete the package
1377     * because it is the active DevicePolicy manager.
1378     *
1379     * @hide
1380     */
1381    public static final int DELETE_FAILED_DEVICE_POLICY_MANAGER = -2;
1382
1383    /**
1384     * Deletion failed return code: this is passed to the
1385     * {@link IPackageDeleteObserver} if the system failed to delete the package
1386     * since the user is restricted.
1387     *
1388     * @hide
1389     */
1390    public static final int DELETE_FAILED_USER_RESTRICTED = -3;
1391
1392    /**
1393     * Deletion failed return code: this is passed to the
1394     * {@link IPackageDeleteObserver} if the system failed to delete the package
1395     * because a profile or device owner has marked the package as
1396     * uninstallable.
1397     *
1398     * @hide
1399     */
1400    public static final int DELETE_FAILED_OWNER_BLOCKED = -4;
1401
1402    /** {@hide} */
1403    public static final int DELETE_FAILED_ABORTED = -5;
1404
1405    /**
1406     * Deletion failed return code: this is passed to the
1407     * {@link IPackageDeleteObserver} if the system failed to delete the package
1408     * because the packge is a shared library used by other installed packages.
1409     * {@hide} */
1410    public static final int DELETE_FAILED_USED_SHARED_LIBRARY = -6;
1411
1412    /**
1413     * Return code that is passed to the {@link IPackageMoveObserver} when the
1414     * package has been successfully moved by the system.
1415     *
1416     * @hide
1417     */
1418    public static final int MOVE_SUCCEEDED = -100;
1419
1420    /**
1421     * Error code that is passed to the {@link IPackageMoveObserver} when the
1422     * package hasn't been successfully moved by the system because of
1423     * insufficient memory on specified media.
1424     *
1425     * @hide
1426     */
1427    public static final int MOVE_FAILED_INSUFFICIENT_STORAGE = -1;
1428
1429    /**
1430     * Error code that is passed to the {@link IPackageMoveObserver} if the
1431     * specified package doesn't exist.
1432     *
1433     * @hide
1434     */
1435    public static final int MOVE_FAILED_DOESNT_EXIST = -2;
1436
1437    /**
1438     * Error code that is passed to the {@link IPackageMoveObserver} if the
1439     * specified package cannot be moved since its a system package.
1440     *
1441     * @hide
1442     */
1443    public static final int MOVE_FAILED_SYSTEM_PACKAGE = -3;
1444
1445    /**
1446     * Error code that is passed to the {@link IPackageMoveObserver} if the
1447     * specified package cannot be moved since its forward locked.
1448     *
1449     * @hide
1450     */
1451    public static final int MOVE_FAILED_FORWARD_LOCKED = -4;
1452
1453    /**
1454     * Error code that is passed to the {@link IPackageMoveObserver} if the
1455     * specified package cannot be moved to the specified location.
1456     *
1457     * @hide
1458     */
1459    public static final int MOVE_FAILED_INVALID_LOCATION = -5;
1460
1461    /**
1462     * Error code that is passed to the {@link IPackageMoveObserver} if the
1463     * specified package cannot be moved to the specified location.
1464     *
1465     * @hide
1466     */
1467    public static final int MOVE_FAILED_INTERNAL_ERROR = -6;
1468
1469    /**
1470     * Error code that is passed to the {@link IPackageMoveObserver} if the
1471     * specified package already has an operation pending in the queue.
1472     *
1473     * @hide
1474     */
1475    public static final int MOVE_FAILED_OPERATION_PENDING = -7;
1476
1477    /**
1478     * Error code that is passed to the {@link IPackageMoveObserver} if the
1479     * specified package cannot be moved since it contains a device admin.
1480     *
1481     * @hide
1482     */
1483    public static final int MOVE_FAILED_DEVICE_ADMIN = -8;
1484
1485    /**
1486     * Error code that is passed to the {@link IPackageMoveObserver} if system does not allow
1487     * non-system apps to be moved to internal storage.
1488     *
1489     * @hide
1490     */
1491    public static final int MOVE_FAILED_3RD_PARTY_NOT_ALLOWED_ON_INTERNAL = -9;
1492
1493    /**
1494     * Flag parameter for {@link #movePackage} to indicate that
1495     * the package should be moved to internal storage if its
1496     * been installed on external media.
1497     * @hide
1498     */
1499    @Deprecated
1500    public static final int MOVE_INTERNAL = 0x00000001;
1501
1502    /**
1503     * Flag parameter for {@link #movePackage} to indicate that
1504     * the package should be moved to external media.
1505     * @hide
1506     */
1507    @Deprecated
1508    public static final int MOVE_EXTERNAL_MEDIA = 0x00000002;
1509
1510    /** {@hide} */
1511    public static final String EXTRA_MOVE_ID = "android.content.pm.extra.MOVE_ID";
1512
1513    /**
1514     * Usable by the required verifier as the {@code verificationCode} argument
1515     * for {@link PackageManager#verifyPendingInstall} to indicate that it will
1516     * allow the installation to proceed without any of the optional verifiers
1517     * needing to vote.
1518     *
1519     * @hide
1520     */
1521    public static final int VERIFICATION_ALLOW_WITHOUT_SUFFICIENT = 2;
1522
1523    /**
1524     * Used as the {@code verificationCode} argument for
1525     * {@link PackageManager#verifyPendingInstall} to indicate that the calling
1526     * package verifier allows the installation to proceed.
1527     */
1528    public static final int VERIFICATION_ALLOW = 1;
1529
1530    /**
1531     * Used as the {@code verificationCode} argument for
1532     * {@link PackageManager#verifyPendingInstall} to indicate the calling
1533     * package verifier does not vote to allow the installation to proceed.
1534     */
1535    public static final int VERIFICATION_REJECT = -1;
1536
1537    /**
1538     * Used as the {@code verificationCode} argument for
1539     * {@link PackageManager#verifyIntentFilter} to indicate that the calling
1540     * IntentFilter Verifier confirms that the IntentFilter is verified.
1541     *
1542     * @hide
1543     */
1544    @SystemApi
1545    public static final int INTENT_FILTER_VERIFICATION_SUCCESS = 1;
1546
1547    /**
1548     * Used as the {@code verificationCode} argument for
1549     * {@link PackageManager#verifyIntentFilter} to indicate that the calling
1550     * IntentFilter Verifier confirms that the IntentFilter is NOT verified.
1551     *
1552     * @hide
1553     */
1554    @SystemApi
1555    public static final int INTENT_FILTER_VERIFICATION_FAILURE = -1;
1556
1557    /**
1558     * Internal status code to indicate that an IntentFilter verification result is not specified.
1559     *
1560     * @hide
1561     */
1562    @SystemApi
1563    public static final int INTENT_FILTER_DOMAIN_VERIFICATION_STATUS_UNDEFINED = 0;
1564
1565    /**
1566     * Used as the {@code status} argument for
1567     * {@link #updateIntentVerificationStatusAsUser} to indicate that the User
1568     * will always be prompted the Intent Disambiguation Dialog if there are two
1569     * or more Intent resolved for the IntentFilter's domain(s).
1570     *
1571     * @hide
1572     */
1573    @SystemApi
1574    public static final int INTENT_FILTER_DOMAIN_VERIFICATION_STATUS_ASK = 1;
1575
1576    /**
1577     * Used as the {@code status} argument for
1578     * {@link #updateIntentVerificationStatusAsUser} to indicate that the User
1579     * will never be prompted the Intent Disambiguation Dialog if there are two
1580     * or more resolution of the Intent. The default App for the domain(s)
1581     * specified in the IntentFilter will also ALWAYS be used.
1582     *
1583     * @hide
1584     */
1585    @SystemApi
1586    public static final int INTENT_FILTER_DOMAIN_VERIFICATION_STATUS_ALWAYS = 2;
1587
1588    /**
1589     * Used as the {@code status} argument for
1590     * {@link #updateIntentVerificationStatusAsUser} to indicate that the User
1591     * may be prompted the Intent Disambiguation Dialog if there are two or more
1592     * Intent resolved. The default App for the domain(s) specified in the
1593     * IntentFilter will also NEVER be presented to the User.
1594     *
1595     * @hide
1596     */
1597    @SystemApi
1598    public static final int INTENT_FILTER_DOMAIN_VERIFICATION_STATUS_NEVER = 3;
1599
1600    /**
1601     * Used as the {@code status} argument for
1602     * {@link #updateIntentVerificationStatusAsUser} to indicate that this app
1603     * should always be considered as an ambiguous candidate for handling the
1604     * matching Intent even if there are other candidate apps in the "always"
1605     * state. Put another way: if there are any 'always ask' apps in a set of
1606     * more than one candidate app, then a disambiguation is *always* presented
1607     * even if there is another candidate app with the 'always' state.
1608     *
1609     * @hide
1610     */
1611    @SystemApi
1612    public static final int INTENT_FILTER_DOMAIN_VERIFICATION_STATUS_ALWAYS_ASK = 4;
1613
1614    /**
1615     * Can be used as the {@code millisecondsToDelay} argument for
1616     * {@link PackageManager#extendVerificationTimeout}. This is the
1617     * maximum time {@code PackageManager} waits for the verification
1618     * agent to return (in milliseconds).
1619     */
1620    public static final long MAXIMUM_VERIFICATION_TIMEOUT = 60*60*1000;
1621
1622    /**
1623     * Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: The device's
1624     * audio pipeline is low-latency, more suitable for audio applications sensitive to delays or
1625     * lag in sound input or output.
1626     */
1627    @SdkConstant(SdkConstantType.FEATURE)
1628    public static final String FEATURE_AUDIO_LOW_LATENCY = "android.hardware.audio.low_latency";
1629
1630    /**
1631     * Feature for {@link #getSystemAvailableFeatures} and
1632     * {@link #hasSystemFeature}: The device includes at least one form of audio
1633     * output, such as speakers, audio jack or streaming over bluetooth
1634     */
1635    @SdkConstant(SdkConstantType.FEATURE)
1636    public static final String FEATURE_AUDIO_OUTPUT = "android.hardware.audio.output";
1637
1638    /**
1639     * Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
1640     * The device has professional audio level of functionality and performance.
1641     */
1642    @SdkConstant(SdkConstantType.FEATURE)
1643    public static final String FEATURE_AUDIO_PRO = "android.hardware.audio.pro";
1644
1645    /**
1646     * Feature for {@link #getSystemAvailableFeatures} and
1647     * {@link #hasSystemFeature}: The device is capable of communicating with
1648     * other devices via Bluetooth.
1649     */
1650    @SdkConstant(SdkConstantType.FEATURE)
1651    public static final String FEATURE_BLUETOOTH = "android.hardware.bluetooth";
1652
1653    /**
1654     * Feature for {@link #getSystemAvailableFeatures} and
1655     * {@link #hasSystemFeature}: The device is capable of communicating with
1656     * other devices via Bluetooth Low Energy radio.
1657     */
1658    @SdkConstant(SdkConstantType.FEATURE)
1659    public static final String FEATURE_BLUETOOTH_LE = "android.hardware.bluetooth_le";
1660
1661    /**
1662     * Feature for {@link #getSystemAvailableFeatures} and
1663     * {@link #hasSystemFeature}: The device has a camera facing away
1664     * from the screen.
1665     */
1666    @SdkConstant(SdkConstantType.FEATURE)
1667    public static final String FEATURE_CAMERA = "android.hardware.camera";
1668
1669    /**
1670     * Feature for {@link #getSystemAvailableFeatures} and
1671     * {@link #hasSystemFeature}: The device's camera supports auto-focus.
1672     */
1673    @SdkConstant(SdkConstantType.FEATURE)
1674    public static final String FEATURE_CAMERA_AUTOFOCUS = "android.hardware.camera.autofocus";
1675
1676    /**
1677     * Feature for {@link #getSystemAvailableFeatures} and
1678     * {@link #hasSystemFeature}: The device has at least one camera pointing in
1679     * some direction, or can support an external camera being connected to it.
1680     */
1681    @SdkConstant(SdkConstantType.FEATURE)
1682    public static final String FEATURE_CAMERA_ANY = "android.hardware.camera.any";
1683
1684    /**
1685     * Feature for {@link #getSystemAvailableFeatures} and
1686     * {@link #hasSystemFeature}: The device can support having an external camera connected to it.
1687     * The external camera may not always be connected or available to applications to use.
1688     */
1689    @SdkConstant(SdkConstantType.FEATURE)
1690    public static final String FEATURE_CAMERA_EXTERNAL = "android.hardware.camera.external";
1691
1692    /**
1693     * Feature for {@link #getSystemAvailableFeatures} and
1694     * {@link #hasSystemFeature}: The device's camera supports flash.
1695     */
1696    @SdkConstant(SdkConstantType.FEATURE)
1697    public static final String FEATURE_CAMERA_FLASH = "android.hardware.camera.flash";
1698
1699    /**
1700     * Feature for {@link #getSystemAvailableFeatures} and
1701     * {@link #hasSystemFeature}: The device has a front facing camera.
1702     */
1703    @SdkConstant(SdkConstantType.FEATURE)
1704    public static final String FEATURE_CAMERA_FRONT = "android.hardware.camera.front";
1705
1706    /**
1707     * Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: At least one
1708     * of the cameras on the device supports the
1709     * {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL full hardware}
1710     * capability level.
1711     */
1712    @SdkConstant(SdkConstantType.FEATURE)
1713    public static final String FEATURE_CAMERA_LEVEL_FULL = "android.hardware.camera.level.full";
1714
1715    /**
1716     * Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: At least one
1717     * of the cameras on the device supports the
1718     * {@link android.hardware.camera2.CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_MANUAL_SENSOR manual sensor}
1719     * capability level.
1720     */
1721    @SdkConstant(SdkConstantType.FEATURE)
1722    public static final String FEATURE_CAMERA_CAPABILITY_MANUAL_SENSOR =
1723            "android.hardware.camera.capability.manual_sensor";
1724
1725    /**
1726     * Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: At least one
1727     * of the cameras on the device supports the
1728     * {@link android.hardware.camera2.CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_MANUAL_POST_PROCESSING manual post-processing}
1729     * capability level.
1730     */
1731    @SdkConstant(SdkConstantType.FEATURE)
1732    public static final String FEATURE_CAMERA_CAPABILITY_MANUAL_POST_PROCESSING =
1733            "android.hardware.camera.capability.manual_post_processing";
1734
1735    /**
1736     * Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: At least one
1737     * of the cameras on the device supports the
1738     * {@link android.hardware.camera2.CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_RAW RAW}
1739     * capability level.
1740     */
1741    @SdkConstant(SdkConstantType.FEATURE)
1742    public static final String FEATURE_CAMERA_CAPABILITY_RAW =
1743            "android.hardware.camera.capability.raw";
1744
1745    /**
1746     * Feature for {@link #getSystemAvailableFeatures} and
1747     * {@link #hasSystemFeature}: The device is capable of communicating with
1748     * consumer IR devices.
1749     */
1750    @SdkConstant(SdkConstantType.FEATURE)
1751    public static final String FEATURE_CONSUMER_IR = "android.hardware.consumerir";
1752
1753    /** {@hide} */
1754    @SdkConstant(SdkConstantType.FEATURE)
1755    public static final String FEATURE_CTS = "android.software.cts";
1756
1757    /**
1758     * Feature for {@link #getSystemAvailableFeatures} and
1759     * {@link #hasSystemFeature}: The device supports one or more methods of
1760     * reporting current location.
1761     */
1762    @SdkConstant(SdkConstantType.FEATURE)
1763    public static final String FEATURE_LOCATION = "android.hardware.location";
1764
1765    /**
1766     * Feature for {@link #getSystemAvailableFeatures} and
1767     * {@link #hasSystemFeature}: The device has a Global Positioning System
1768     * receiver and can report precise location.
1769     */
1770    @SdkConstant(SdkConstantType.FEATURE)
1771    public static final String FEATURE_LOCATION_GPS = "android.hardware.location.gps";
1772
1773    /**
1774     * Feature for {@link #getSystemAvailableFeatures} and
1775     * {@link #hasSystemFeature}: The device can report location with coarse
1776     * accuracy using a network-based geolocation system.
1777     */
1778    @SdkConstant(SdkConstantType.FEATURE)
1779    public static final String FEATURE_LOCATION_NETWORK = "android.hardware.location.network";
1780
1781    /**
1782     * Feature for {@link #getSystemAvailableFeatures} and
1783     * {@link #hasSystemFeature}: The device can record audio via a
1784     * microphone.
1785     */
1786    @SdkConstant(SdkConstantType.FEATURE)
1787    public static final String FEATURE_MICROPHONE = "android.hardware.microphone";
1788
1789    /**
1790     * Feature for {@link #getSystemAvailableFeatures} and
1791     * {@link #hasSystemFeature}: The device can communicate using Near-Field
1792     * Communications (NFC).
1793     */
1794    @SdkConstant(SdkConstantType.FEATURE)
1795    public static final String FEATURE_NFC = "android.hardware.nfc";
1796
1797    /**
1798     * Feature for {@link #getSystemAvailableFeatures} and
1799     * {@link #hasSystemFeature}: The device supports host-
1800     * based NFC card emulation.
1801     *
1802     * TODO remove when depending apps have moved to new constant.
1803     * @hide
1804     * @deprecated
1805     */
1806    @Deprecated
1807    @SdkConstant(SdkConstantType.FEATURE)
1808    public static final String FEATURE_NFC_HCE = "android.hardware.nfc.hce";
1809
1810    /**
1811     * Feature for {@link #getSystemAvailableFeatures} and
1812     * {@link #hasSystemFeature}: The device supports host-
1813     * based NFC card emulation.
1814     */
1815    @SdkConstant(SdkConstantType.FEATURE)
1816    public static final String FEATURE_NFC_HOST_CARD_EMULATION = "android.hardware.nfc.hce";
1817
1818    /**
1819     * Feature for {@link #getSystemAvailableFeatures} and
1820     * {@link #hasSystemFeature}: The device supports host-
1821     * based NFC-F card emulation.
1822     */
1823    @SdkConstant(SdkConstantType.FEATURE)
1824    public static final String FEATURE_NFC_HOST_CARD_EMULATION_NFCF = "android.hardware.nfc.hcef";
1825
1826    /**
1827     * Feature for {@link #getSystemAvailableFeatures} and
1828     * {@link #hasSystemFeature}: The device supports any
1829     * one of the {@link #FEATURE_NFC}, {@link #FEATURE_NFC_HOST_CARD_EMULATION},
1830     * or {@link #FEATURE_NFC_HOST_CARD_EMULATION_NFCF} features.
1831     *
1832     * @hide
1833     */
1834    @SdkConstant(SdkConstantType.FEATURE)
1835    public static final String FEATURE_NFC_ANY = "android.hardware.nfc.any";
1836
1837    /**
1838     * Feature for {@link #getSystemAvailableFeatures} and
1839     * {@link #hasSystemFeature}: The device supports the OpenGL ES
1840     * <a href="http://www.khronos.org/registry/gles/extensions/ANDROID/ANDROID_extension_pack_es31a.txt">
1841     * Android Extension Pack</a>.
1842     */
1843    @SdkConstant(SdkConstantType.FEATURE)
1844    public static final String FEATURE_OPENGLES_EXTENSION_PACK = "android.hardware.opengles.aep";
1845
1846    /**
1847     * Feature for {@link #getSystemAvailableFeatures} and
1848     * {@link #hasSystemFeature(String, int)}: If this feature is supported, the Vulkan native API
1849     * will enumerate at least one {@code VkPhysicalDevice}, and the feature version will indicate
1850     * what level of optional hardware features limits it supports.
1851     * <p>
1852     * Level 0 includes the base Vulkan requirements as well as:
1853     * <ul><li>{@code VkPhysicalDeviceFeatures::textureCompressionETC2}</li></ul>
1854     * <p>
1855     * Level 1 additionally includes:
1856     * <ul>
1857     * <li>{@code VkPhysicalDeviceFeatures::fullDrawIndexUint32}</li>
1858     * <li>{@code VkPhysicalDeviceFeatures::imageCubeArray}</li>
1859     * <li>{@code VkPhysicalDeviceFeatures::independentBlend}</li>
1860     * <li>{@code VkPhysicalDeviceFeatures::geometryShader}</li>
1861     * <li>{@code VkPhysicalDeviceFeatures::tessellationShader}</li>
1862     * <li>{@code VkPhysicalDeviceFeatures::sampleRateShading}</li>
1863     * <li>{@code VkPhysicalDeviceFeatures::textureCompressionASTC_LDR}</li>
1864     * <li>{@code VkPhysicalDeviceFeatures::fragmentStoresAndAtomics}</li>
1865     * <li>{@code VkPhysicalDeviceFeatures::shaderImageGatherExtended}</li>
1866     * <li>{@code VkPhysicalDeviceFeatures::shaderUniformBufferArrayDynamicIndexing}</li>
1867     * <li>{@code VkPhysicalDeviceFeatures::shaderSampledImageArrayDynamicIndexing}</li>
1868     * </ul>
1869     */
1870    @SdkConstant(SdkConstantType.FEATURE)
1871    public static final String FEATURE_VULKAN_HARDWARE_LEVEL = "android.hardware.vulkan.level";
1872
1873    /**
1874     * Feature for {@link #getSystemAvailableFeatures} and
1875     * {@link #hasSystemFeature(String, int)}: If this feature is supported, the Vulkan native API
1876     * will enumerate at least one {@code VkPhysicalDevice}, and the feature version will indicate
1877     * what level of optional compute features are supported beyond the Vulkan 1.0 requirements.
1878     * <p>
1879     * Compute level 0 indicates support for the {@code VariablePointers} SPIR-V capability defined
1880     * by the SPV_KHR_variable_pointers extension.
1881     */
1882    @SdkConstant(SdkConstantType.FEATURE)
1883    public static final String FEATURE_VULKAN_HARDWARE_COMPUTE = "android.hardware.vulkan.compute";
1884
1885    /**
1886     * Feature for {@link #getSystemAvailableFeatures} and
1887     * {@link #hasSystemFeature(String, int)}: The version of this feature indicates the highest
1888     * {@code VkPhysicalDeviceProperties::apiVersion} supported by the physical devices that support
1889     * the hardware level indicated by {@link #FEATURE_VULKAN_HARDWARE_LEVEL}. The feature version
1890     * uses the same encoding as Vulkan version numbers:
1891     * <ul>
1892     * <li>Major version number in bits 31-22</li>
1893     * <li>Minor version number in bits 21-12</li>
1894     * <li>Patch version number in bits 11-0</li>
1895     * </ul>
1896     */
1897    @SdkConstant(SdkConstantType.FEATURE)
1898    public static final String FEATURE_VULKAN_HARDWARE_VERSION = "android.hardware.vulkan.version";
1899
1900    /**
1901     * The device includes broadcast radio tuner.
1902     *
1903     * @hide FutureFeature
1904     */
1905    @SdkConstant(SdkConstantType.FEATURE)
1906    public static final String FEATURE_RADIO = "android.hardware.radio";
1907
1908    /**
1909     * Feature for {@link #getSystemAvailableFeatures} and
1910     * {@link #hasSystemFeature}: The device includes an accelerometer.
1911     */
1912    @SdkConstant(SdkConstantType.FEATURE)
1913    public static final String FEATURE_SENSOR_ACCELEROMETER = "android.hardware.sensor.accelerometer";
1914
1915    /**
1916     * Feature for {@link #getSystemAvailableFeatures} and
1917     * {@link #hasSystemFeature}: The device includes a barometer (air
1918     * pressure sensor.)
1919     */
1920    @SdkConstant(SdkConstantType.FEATURE)
1921    public static final String FEATURE_SENSOR_BAROMETER = "android.hardware.sensor.barometer";
1922
1923    /**
1924     * Feature for {@link #getSystemAvailableFeatures} and
1925     * {@link #hasSystemFeature}: The device includes a magnetometer (compass).
1926     */
1927    @SdkConstant(SdkConstantType.FEATURE)
1928    public static final String FEATURE_SENSOR_COMPASS = "android.hardware.sensor.compass";
1929
1930    /**
1931     * Feature for {@link #getSystemAvailableFeatures} and
1932     * {@link #hasSystemFeature}: The device includes a gyroscope.
1933     */
1934    @SdkConstant(SdkConstantType.FEATURE)
1935    public static final String FEATURE_SENSOR_GYROSCOPE = "android.hardware.sensor.gyroscope";
1936
1937    /**
1938     * Feature for {@link #getSystemAvailableFeatures} and
1939     * {@link #hasSystemFeature}: The device includes a light sensor.
1940     */
1941    @SdkConstant(SdkConstantType.FEATURE)
1942    public static final String FEATURE_SENSOR_LIGHT = "android.hardware.sensor.light";
1943
1944    /**
1945     * Feature for {@link #getSystemAvailableFeatures} and
1946     * {@link #hasSystemFeature}: The device includes a proximity sensor.
1947     */
1948    @SdkConstant(SdkConstantType.FEATURE)
1949    public static final String FEATURE_SENSOR_PROXIMITY = "android.hardware.sensor.proximity";
1950
1951    /**
1952     * Feature for {@link #getSystemAvailableFeatures} and
1953     * {@link #hasSystemFeature}: The device includes a hardware step counter.
1954     */
1955    @SdkConstant(SdkConstantType.FEATURE)
1956    public static final String FEATURE_SENSOR_STEP_COUNTER = "android.hardware.sensor.stepcounter";
1957
1958    /**
1959     * Feature for {@link #getSystemAvailableFeatures} and
1960     * {@link #hasSystemFeature}: The device includes a hardware step detector.
1961     */
1962    @SdkConstant(SdkConstantType.FEATURE)
1963    public static final String FEATURE_SENSOR_STEP_DETECTOR = "android.hardware.sensor.stepdetector";
1964
1965    /**
1966     * Feature for {@link #getSystemAvailableFeatures} and
1967     * {@link #hasSystemFeature}: The device includes a heart rate monitor.
1968     */
1969    @SdkConstant(SdkConstantType.FEATURE)
1970    public static final String FEATURE_SENSOR_HEART_RATE = "android.hardware.sensor.heartrate";
1971
1972    /**
1973     * Feature for {@link #getSystemAvailableFeatures} and
1974     * {@link #hasSystemFeature}: The heart rate sensor on this device is an Electrocardiogram.
1975     */
1976    @SdkConstant(SdkConstantType.FEATURE)
1977    public static final String FEATURE_SENSOR_HEART_RATE_ECG =
1978            "android.hardware.sensor.heartrate.ecg";
1979
1980    /**
1981     * Feature for {@link #getSystemAvailableFeatures} and
1982     * {@link #hasSystemFeature}: The device includes a relative humidity sensor.
1983     */
1984    @SdkConstant(SdkConstantType.FEATURE)
1985    public static final String FEATURE_SENSOR_RELATIVE_HUMIDITY =
1986            "android.hardware.sensor.relative_humidity";
1987
1988    /**
1989     * Feature for {@link #getSystemAvailableFeatures} and
1990     * {@link #hasSystemFeature}: The device includes an ambient temperature sensor.
1991     */
1992    @SdkConstant(SdkConstantType.FEATURE)
1993    public static final String FEATURE_SENSOR_AMBIENT_TEMPERATURE =
1994            "android.hardware.sensor.ambient_temperature";
1995
1996    /**
1997     * Feature for {@link #getSystemAvailableFeatures} and
1998     * {@link #hasSystemFeature}: The device supports high fidelity sensor processing
1999     * capabilities.
2000     */
2001    @SdkConstant(SdkConstantType.FEATURE)
2002    public static final String FEATURE_HIFI_SENSORS =
2003            "android.hardware.sensor.hifi_sensors";
2004
2005    /**
2006     * Feature for {@link #getSystemAvailableFeatures} and
2007     * {@link #hasSystemFeature}: The device has a telephony radio with data
2008     * communication support.
2009     */
2010    @SdkConstant(SdkConstantType.FEATURE)
2011    public static final String FEATURE_TELEPHONY = "android.hardware.telephony";
2012
2013    /**
2014     * Feature for {@link #getSystemAvailableFeatures} and
2015     * {@link #hasSystemFeature}: The device has a CDMA telephony stack.
2016     */
2017    @SdkConstant(SdkConstantType.FEATURE)
2018    public static final String FEATURE_TELEPHONY_CDMA = "android.hardware.telephony.cdma";
2019
2020    /**
2021     * Feature for {@link #getSystemAvailableFeatures} and
2022     * {@link #hasSystemFeature}: The device has a GSM telephony stack.
2023     */
2024    @SdkConstant(SdkConstantType.FEATURE)
2025    public static final String FEATURE_TELEPHONY_GSM = "android.hardware.telephony.gsm";
2026
2027    /**
2028     * Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
2029     * The device supports telephony carrier restriction mechanism.
2030     *
2031     * <p>Devices declaring this feature must have an implementation of the
2032     * {@link android.telephony.TelephonyManager#getAllowedCarriers} and
2033     * {@link android.telephony.TelephonyManager#setAllowedCarriers}.
2034     * @hide
2035     */
2036    @SystemApi
2037    @SdkConstant(SdkConstantType.FEATURE)
2038    public static final String FEATURE_TELEPHONY_CARRIERLOCK =
2039            "android.hardware.telephony.carrierlock";
2040
2041    /**
2042     * Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: The device
2043     * supports embedded subscriptions on eUICCs.
2044     * TODO(b/35851809): Make this public.
2045     * @hide
2046     */
2047    @SdkConstant(SdkConstantType.FEATURE)
2048    public static final String FEATURE_TELEPHONY_EUICC = "android.hardware.telephony.euicc";
2049
2050    /**
2051     * Feature for {@link #getSystemAvailableFeatures} and
2052     * {@link #hasSystemFeature}: The device supports connecting to USB devices
2053     * as the USB host.
2054     */
2055    @SdkConstant(SdkConstantType.FEATURE)
2056    public static final String FEATURE_USB_HOST = "android.hardware.usb.host";
2057
2058    /**
2059     * Feature for {@link #getSystemAvailableFeatures} and
2060     * {@link #hasSystemFeature}: The device supports connecting to USB accessories.
2061     */
2062    @SdkConstant(SdkConstantType.FEATURE)
2063    public static final String FEATURE_USB_ACCESSORY = "android.hardware.usb.accessory";
2064
2065    /**
2066     * Feature for {@link #getSystemAvailableFeatures} and
2067     * {@link #hasSystemFeature}: The SIP API is enabled on the device.
2068     */
2069    @SdkConstant(SdkConstantType.FEATURE)
2070    public static final String FEATURE_SIP = "android.software.sip";
2071
2072    /**
2073     * Feature for {@link #getSystemAvailableFeatures} and
2074     * {@link #hasSystemFeature}: The device supports SIP-based VOIP.
2075     */
2076    @SdkConstant(SdkConstantType.FEATURE)
2077    public static final String FEATURE_SIP_VOIP = "android.software.sip.voip";
2078
2079    /**
2080     * Feature for {@link #getSystemAvailableFeatures} and
2081     * {@link #hasSystemFeature}: The Connection Service API is enabled on the device.
2082     */
2083    @SdkConstant(SdkConstantType.FEATURE)
2084    public static final String FEATURE_CONNECTION_SERVICE = "android.software.connectionservice";
2085
2086    /**
2087     * Feature for {@link #getSystemAvailableFeatures} and
2088     * {@link #hasSystemFeature}: The device's display has a touch screen.
2089     */
2090    @SdkConstant(SdkConstantType.FEATURE)
2091    public static final String FEATURE_TOUCHSCREEN = "android.hardware.touchscreen";
2092
2093    /**
2094     * Feature for {@link #getSystemAvailableFeatures} and
2095     * {@link #hasSystemFeature}: The device's touch screen supports
2096     * multitouch sufficient for basic two-finger gesture detection.
2097     */
2098    @SdkConstant(SdkConstantType.FEATURE)
2099    public static final String FEATURE_TOUCHSCREEN_MULTITOUCH = "android.hardware.touchscreen.multitouch";
2100
2101    /**
2102     * Feature for {@link #getSystemAvailableFeatures} and
2103     * {@link #hasSystemFeature}: The device's touch screen is capable of
2104     * tracking two or more fingers fully independently.
2105     */
2106    @SdkConstant(SdkConstantType.FEATURE)
2107    public static final String FEATURE_TOUCHSCREEN_MULTITOUCH_DISTINCT = "android.hardware.touchscreen.multitouch.distinct";
2108
2109    /**
2110     * Feature for {@link #getSystemAvailableFeatures} and
2111     * {@link #hasSystemFeature}: The device's touch screen is capable of
2112     * tracking a full hand of fingers fully independently -- that is, 5 or
2113     * more simultaneous independent pointers.
2114     */
2115    @SdkConstant(SdkConstantType.FEATURE)
2116    public static final String FEATURE_TOUCHSCREEN_MULTITOUCH_JAZZHAND = "android.hardware.touchscreen.multitouch.jazzhand";
2117
2118    /**
2119     * Feature for {@link #getSystemAvailableFeatures} and
2120     * {@link #hasSystemFeature}: The device does not have a touch screen, but
2121     * does support touch emulation for basic events. For instance, the
2122     * device might use a mouse or remote control to drive a cursor, and
2123     * emulate basic touch pointer events like down, up, drag, etc. All
2124     * devices that support android.hardware.touchscreen or a sub-feature are
2125     * presumed to also support faketouch.
2126     */
2127    @SdkConstant(SdkConstantType.FEATURE)
2128    public static final String FEATURE_FAKETOUCH = "android.hardware.faketouch";
2129
2130    /**
2131     * Feature for {@link #getSystemAvailableFeatures} and
2132     * {@link #hasSystemFeature}: The device does not have a touch screen, but
2133     * does support touch emulation for basic events that supports distinct
2134     * tracking of two or more fingers.  This is an extension of
2135     * {@link #FEATURE_FAKETOUCH} for input devices with this capability.  Note
2136     * that unlike a distinct multitouch screen as defined by
2137     * {@link #FEATURE_TOUCHSCREEN_MULTITOUCH_DISTINCT}, these kinds of input
2138     * devices will not actually provide full two-finger gestures since the
2139     * input is being transformed to cursor movement on the screen.  That is,
2140     * single finger gestures will move a cursor; two-finger swipes will
2141     * result in single-finger touch events; other two-finger gestures will
2142     * result in the corresponding two-finger touch event.
2143     */
2144    @SdkConstant(SdkConstantType.FEATURE)
2145    public static final String FEATURE_FAKETOUCH_MULTITOUCH_DISTINCT = "android.hardware.faketouch.multitouch.distinct";
2146
2147    /**
2148     * Feature for {@link #getSystemAvailableFeatures} and
2149     * {@link #hasSystemFeature}: The device does not have a touch screen, but
2150     * does support touch emulation for basic events that supports tracking
2151     * a hand of fingers (5 or more fingers) fully independently.
2152     * This is an extension of
2153     * {@link #FEATURE_FAKETOUCH} for input devices with this capability.  Note
2154     * that unlike a multitouch screen as defined by
2155     * {@link #FEATURE_TOUCHSCREEN_MULTITOUCH_JAZZHAND}, not all two finger
2156     * gestures can be detected due to the limitations described for
2157     * {@link #FEATURE_FAKETOUCH_MULTITOUCH_DISTINCT}.
2158     */
2159    @SdkConstant(SdkConstantType.FEATURE)
2160    public static final String FEATURE_FAKETOUCH_MULTITOUCH_JAZZHAND = "android.hardware.faketouch.multitouch.jazzhand";
2161
2162    /**
2163     * Feature for {@link #getSystemAvailableFeatures} and
2164     * {@link #hasSystemFeature}: The device has biometric hardware to detect a fingerprint.
2165      */
2166    @SdkConstant(SdkConstantType.FEATURE)
2167    public static final String FEATURE_FINGERPRINT = "android.hardware.fingerprint";
2168
2169    /**
2170     * Feature for {@link #getSystemAvailableFeatures} and
2171     * {@link #hasSystemFeature}: The device supports portrait orientation
2172     * screens.  For backwards compatibility, you can assume that if neither
2173     * this nor {@link #FEATURE_SCREEN_LANDSCAPE} is set then the device supports
2174     * both portrait and landscape.
2175     */
2176    @SdkConstant(SdkConstantType.FEATURE)
2177    public static final String FEATURE_SCREEN_PORTRAIT = "android.hardware.screen.portrait";
2178
2179    /**
2180     * Feature for {@link #getSystemAvailableFeatures} and
2181     * {@link #hasSystemFeature}: The device supports landscape orientation
2182     * screens.  For backwards compatibility, you can assume that if neither
2183     * this nor {@link #FEATURE_SCREEN_PORTRAIT} is set then the device supports
2184     * both portrait and landscape.
2185     */
2186    @SdkConstant(SdkConstantType.FEATURE)
2187    public static final String FEATURE_SCREEN_LANDSCAPE = "android.hardware.screen.landscape";
2188
2189    /**
2190     * Feature for {@link #getSystemAvailableFeatures} and
2191     * {@link #hasSystemFeature}: The device supports live wallpapers.
2192     */
2193    @SdkConstant(SdkConstantType.FEATURE)
2194    public static final String FEATURE_LIVE_WALLPAPER = "android.software.live_wallpaper";
2195    /**
2196     * Feature for {@link #getSystemAvailableFeatures} and
2197     * {@link #hasSystemFeature}: The device supports app widgets.
2198     */
2199    @SdkConstant(SdkConstantType.FEATURE)
2200    public static final String FEATURE_APP_WIDGETS = "android.software.app_widgets";
2201
2202    /**
2203     * @hide
2204     * Feature for {@link #getSystemAvailableFeatures} and
2205     * {@link #hasSystemFeature}: The device supports
2206     * {@link android.service.voice.VoiceInteractionService} and
2207     * {@link android.app.VoiceInteractor}.
2208     */
2209    @SdkConstant(SdkConstantType.FEATURE)
2210    public static final String FEATURE_VOICE_RECOGNIZERS = "android.software.voice_recognizers";
2211
2212
2213    /**
2214     * Feature for {@link #getSystemAvailableFeatures} and
2215     * {@link #hasSystemFeature}: The device supports a home screen that is replaceable
2216     * by third party applications.
2217     */
2218    @SdkConstant(SdkConstantType.FEATURE)
2219    public static final String FEATURE_HOME_SCREEN = "android.software.home_screen";
2220
2221    /**
2222     * Feature for {@link #getSystemAvailableFeatures} and
2223     * {@link #hasSystemFeature}: The device supports adding new input methods implemented
2224     * with the {@link android.inputmethodservice.InputMethodService} API.
2225     */
2226    @SdkConstant(SdkConstantType.FEATURE)
2227    public static final String FEATURE_INPUT_METHODS = "android.software.input_methods";
2228
2229    /**
2230     * Feature for {@link #getSystemAvailableFeatures} and
2231     * {@link #hasSystemFeature}: The device supports device policy enforcement via device admins.
2232     */
2233    @SdkConstant(SdkConstantType.FEATURE)
2234    public static final String FEATURE_DEVICE_ADMIN = "android.software.device_admin";
2235
2236    /**
2237     * Feature for {@link #getSystemAvailableFeatures} and
2238     * {@link #hasSystemFeature}: The device supports leanback UI. This is
2239     * typically used in a living room television experience, but is a software
2240     * feature unlike {@link #FEATURE_TELEVISION}. Devices running with this
2241     * feature will use resources associated with the "television" UI mode.
2242     */
2243    @SdkConstant(SdkConstantType.FEATURE)
2244    public static final String FEATURE_LEANBACK = "android.software.leanback";
2245
2246    /**
2247     * Feature for {@link #getSystemAvailableFeatures} and
2248     * {@link #hasSystemFeature}: The device supports only leanback UI. Only
2249     * applications designed for this experience should be run, though this is
2250     * not enforced by the system.
2251     */
2252    @SdkConstant(SdkConstantType.FEATURE)
2253    public static final String FEATURE_LEANBACK_ONLY = "android.software.leanback_only";
2254
2255    /**
2256     * Feature for {@link #getSystemAvailableFeatures} and
2257     * {@link #hasSystemFeature}: The device supports live TV and can display
2258     * contents from TV inputs implemented with the
2259     * {@link android.media.tv.TvInputService} API.
2260     */
2261    @SdkConstant(SdkConstantType.FEATURE)
2262    public static final String FEATURE_LIVE_TV = "android.software.live_tv";
2263
2264    /**
2265     * Feature for {@link #getSystemAvailableFeatures} and
2266     * {@link #hasSystemFeature}: The device supports WiFi (802.11) networking.
2267     */
2268    @SdkConstant(SdkConstantType.FEATURE)
2269    public static final String FEATURE_WIFI = "android.hardware.wifi";
2270
2271    /**
2272     * Feature for {@link #getSystemAvailableFeatures} and
2273     * {@link #hasSystemFeature}: The device supports Wi-Fi Direct networking.
2274     */
2275    @SdkConstant(SdkConstantType.FEATURE)
2276    public static final String FEATURE_WIFI_DIRECT = "android.hardware.wifi.direct";
2277
2278    /**
2279     * Feature for {@link #getSystemAvailableFeatures} and
2280     * {@link #hasSystemFeature}: The device supports Wi-Fi Aware.
2281     */
2282    @SdkConstant(SdkConstantType.FEATURE)
2283    public static final String FEATURE_WIFI_AWARE = "android.hardware.wifi.aware";
2284
2285    /**
2286     * Feature for {@link #getSystemAvailableFeatures} and
2287     * {@link #hasSystemFeature}: The device supports Wi-Fi Passpoint.
2288     */
2289    @SdkConstant(SdkConstantType.FEATURE)
2290    public static final String FEATURE_WIFI_PASSPOINT = "android.hardware.wifi.passpoint";
2291
2292    /**
2293     * Feature for {@link #getSystemAvailableFeatures} and
2294     * {@link #hasSystemFeature}: The device supports LoWPAN networking.
2295     * @hide
2296     */
2297    @SdkConstant(SdkConstantType.FEATURE)
2298    public static final String FEATURE_LOWPAN = "android.hardware.lowpan";
2299
2300    /**
2301     * Feature for {@link #getSystemAvailableFeatures} and
2302     * {@link #hasSystemFeature}: This is a device dedicated to showing UI
2303     * on a vehicle headunit. A headunit here is defined to be inside a
2304     * vehicle that may or may not be moving. A headunit uses either a
2305     * primary display in the center console and/or additional displays in
2306     * the instrument cluster or elsewhere in the vehicle. Headunit display(s)
2307     * have limited size and resolution. The user will likely be focused on
2308     * driving so limiting driver distraction is a primary concern. User input
2309     * can be a variety of hard buttons, touch, rotary controllers and even mouse-
2310     * like interfaces.
2311     */
2312    @SdkConstant(SdkConstantType.FEATURE)
2313    public static final String FEATURE_AUTOMOTIVE = "android.hardware.type.automotive";
2314
2315    /**
2316     * Feature for {@link #getSystemAvailableFeatures} and
2317     * {@link #hasSystemFeature}: This is a device dedicated to showing UI
2318     * on a television.  Television here is defined to be a typical living
2319     * room television experience: displayed on a big screen, where the user
2320     * is sitting far away from it, and the dominant form of input will be
2321     * something like a DPAD, not through touch or mouse.
2322     * @deprecated use {@link #FEATURE_LEANBACK} instead.
2323     */
2324    @Deprecated
2325    @SdkConstant(SdkConstantType.FEATURE)
2326    public static final String FEATURE_TELEVISION = "android.hardware.type.television";
2327
2328    /**
2329     * Feature for {@link #getSystemAvailableFeatures} and
2330     * {@link #hasSystemFeature}: This is a device dedicated to showing UI
2331     * on a watch. A watch here is defined to be a device worn on the body, perhaps on
2332     * the wrist. The user is very close when interacting with the device.
2333     */
2334    @SdkConstant(SdkConstantType.FEATURE)
2335    public static final String FEATURE_WATCH = "android.hardware.type.watch";
2336
2337    /**
2338     * Feature for {@link #getSystemAvailableFeatures} and
2339     * {@link #hasSystemFeature}: This is a device for IoT and may not have an UI. An embedded
2340     * device is defined as a full stack Android device with or without a display and no
2341     * user-installable apps.
2342     */
2343    @SdkConstant(SdkConstantType.FEATURE)
2344    public static final String FEATURE_EMBEDDED = "android.hardware.type.embedded";
2345
2346    /**
2347     * Feature for {@link #getSystemAvailableFeatures} and
2348     * {@link #hasSystemFeature}: This is a device dedicated to be primarily used
2349     * with keyboard, mouse or touchpad. This includes traditional desktop
2350     * computers, laptops and variants such as convertibles or detachables.
2351     * Due to the larger screen, the device will most likely use the
2352     * {@link #FEATURE_FREEFORM_WINDOW_MANAGEMENT} feature as well.
2353     */
2354    @SdkConstant(SdkConstantType.FEATURE)
2355    public static final String FEATURE_PC = "android.hardware.type.pc";
2356
2357    /**
2358     * Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
2359     * The device supports printing.
2360     */
2361    @SdkConstant(SdkConstantType.FEATURE)
2362    public static final String FEATURE_PRINTING = "android.software.print";
2363
2364    /**
2365     * Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
2366     * The device supports {@link android.companion.CompanionDeviceManager#associate associating}
2367     * with devices via {@link android.companion.CompanionDeviceManager}.
2368     */
2369    @SdkConstant(SdkConstantType.FEATURE)
2370    public static final String FEATURE_COMPANION_DEVICE_SETUP
2371            = "android.software.companion_device_setup";
2372
2373    /**
2374     * Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
2375     * The device can perform backup and restore operations on installed applications.
2376     */
2377    @SdkConstant(SdkConstantType.FEATURE)
2378    public static final String FEATURE_BACKUP = "android.software.backup";
2379
2380    /**
2381     * Feature for {@link #getSystemAvailableFeatures} and
2382     * {@link #hasSystemFeature}: The device supports freeform window management.
2383     * Windows have title bars and can be moved and resized.
2384     */
2385    // If this feature is present, you also need to set
2386    // com.android.internal.R.config_freeformWindowManagement to true in your configuration overlay.
2387    @SdkConstant(SdkConstantType.FEATURE)
2388    public static final String FEATURE_FREEFORM_WINDOW_MANAGEMENT
2389            = "android.software.freeform_window_management";
2390
2391    /**
2392     * Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
2393     * The device supports picture-in-picture multi-window mode.
2394     */
2395    @SdkConstant(SdkConstantType.FEATURE)
2396    public static final String FEATURE_PICTURE_IN_PICTURE = "android.software.picture_in_picture";
2397
2398    /**
2399     * Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
2400     * The device supports running activities on secondary displays.
2401     */
2402    @SdkConstant(SdkConstantType.FEATURE)
2403    public static final String FEATURE_ACTIVITIES_ON_SECONDARY_DISPLAYS
2404            = "android.software.activities_on_secondary_displays";
2405
2406    /**
2407     * Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
2408     * The device supports creating secondary users and managed profiles via
2409     * {@link DevicePolicyManager}.
2410     */
2411    @SdkConstant(SdkConstantType.FEATURE)
2412    public static final String FEATURE_MANAGED_USERS = "android.software.managed_users";
2413
2414    /**
2415     * @hide
2416     * TODO: Remove after dependencies updated b/17392243
2417     */
2418    public static final String FEATURE_MANAGED_PROFILES = "android.software.managed_users";
2419
2420    /**
2421     * Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
2422     * The device supports verified boot.
2423     */
2424    @SdkConstant(SdkConstantType.FEATURE)
2425    public static final String FEATURE_VERIFIED_BOOT = "android.software.verified_boot";
2426
2427    /**
2428     * Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
2429     * The device supports secure removal of users. When a user is deleted the data associated
2430     * with that user is securely deleted and no longer available.
2431     */
2432    @SdkConstant(SdkConstantType.FEATURE)
2433    public static final String FEATURE_SECURELY_REMOVES_USERS
2434            = "android.software.securely_removes_users";
2435
2436    /** {@hide} */
2437    @SdkConstant(SdkConstantType.FEATURE)
2438    public static final String FEATURE_FILE_BASED_ENCRYPTION
2439            = "android.software.file_based_encryption";
2440
2441    /**
2442     * Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
2443     * The device has a full implementation of the android.webkit.* APIs. Devices
2444     * lacking this feature will not have a functioning WebView implementation.
2445     */
2446    @SdkConstant(SdkConstantType.FEATURE)
2447    public static final String FEATURE_WEBVIEW = "android.software.webview";
2448
2449    /**
2450     * Feature for {@link #getSystemAvailableFeatures} and
2451     * {@link #hasSystemFeature}: This device supports ethernet.
2452     */
2453    @SdkConstant(SdkConstantType.FEATURE)
2454    public static final String FEATURE_ETHERNET = "android.hardware.ethernet";
2455
2456    /**
2457     * Feature for {@link #getSystemAvailableFeatures} and
2458     * {@link #hasSystemFeature}: This device supports HDMI-CEC.
2459     * @hide
2460     */
2461    @SdkConstant(SdkConstantType.FEATURE)
2462    public static final String FEATURE_HDMI_CEC = "android.hardware.hdmi.cec";
2463
2464    /**
2465     * Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
2466     * The device has all of the inputs necessary to be considered a compatible game controller, or
2467     * includes a compatible game controller in the box.
2468     */
2469    @SdkConstant(SdkConstantType.FEATURE)
2470    public static final String FEATURE_GAMEPAD = "android.hardware.gamepad";
2471
2472    /**
2473     * Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
2474     * The device has a full implementation of the android.media.midi.* APIs.
2475     */
2476    @SdkConstant(SdkConstantType.FEATURE)
2477    public static final String FEATURE_MIDI = "android.software.midi";
2478
2479    /**
2480     * Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
2481     * The device implements an optimized mode for virtual reality (VR) applications that handles
2482     * stereoscopic rendering of notifications, and disables most monocular system UI components
2483     * while a VR application has user focus.
2484     * Devices declaring this feature must include an application implementing a
2485     * {@link android.service.vr.VrListenerService} that can be targeted by VR applications via
2486     * {@link android.app.Activity#setVrModeEnabled}.
2487     */
2488    @SdkConstant(SdkConstantType.FEATURE)
2489    public static final String FEATURE_VR_MODE = "android.software.vr.mode";
2490
2491    /**
2492     * Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
2493     * The device implements {@link #FEATURE_VR_MODE} but additionally meets extra CDD requirements
2494     * to provide a high-quality VR experience.  In general, devices declaring this feature will
2495     * additionally:
2496     * <ul>
2497     *   <li>Deliver consistent performance at a high framerate over an extended period of time
2498     *   for typical VR application CPU/GPU workloads with a minimal number of frame drops for VR
2499     *   applications that have called
2500     *   {@link android.view.Window#setSustainedPerformanceMode}.</li>
2501     *   <li>Implement {@link #FEATURE_HIFI_SENSORS} and have a low sensor latency.</li>
2502     *   <li>Include optimizations to lower display persistence while running VR applications.</li>
2503     *   <li>Implement an optimized render path to minimize latency to draw to the device's main
2504     *   display.</li>
2505     *   <li>Include the following EGL extensions: EGL_ANDROID_create_native_client_buffer,
2506     *   EGL_ANDROID_front_buffer_auto_refresh, EGL_EXT_protected_content,
2507     *   EGL_KHR_mutable_render_buffer, EGL_KHR_reusable_sync, and EGL_KHR_wait_sync.</li>
2508     *   <li>Provide at least one CPU core that is reserved for use solely by the top, foreground
2509     *   VR application process for critical render threads while such an application is
2510     *   running.</li>
2511     * </ul>
2512     */
2513    @SdkConstant(SdkConstantType.FEATURE)
2514    public static final String FEATURE_VR_MODE_HIGH_PERFORMANCE
2515            = "android.hardware.vr.high_performance";
2516
2517    /**
2518     * Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
2519     * The device supports autofill of user credentials, addresses, credit cards, etc
2520     * via integration with {@link android.service.autofill.AutofillService autofill
2521     * providers}.
2522     */
2523    @SdkConstant(SdkConstantType.FEATURE)
2524    public static final String FEATURE_AUTOFILL = "android.software.autofill";
2525
2526    /**
2527     * Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
2528     * The device implements headtracking suitable for a VR device.
2529     */
2530    @SdkConstant(SdkConstantType.FEATURE)
2531    public static final String FEATURE_VR_HEADTRACKING = "android.hardware.vr.headtracking";
2532
2533    /**
2534     * Action to external storage service to clean out removed apps.
2535     * @hide
2536     */
2537    public static final String ACTION_CLEAN_EXTERNAL_STORAGE
2538            = "android.content.pm.CLEAN_EXTERNAL_STORAGE";
2539
2540    /**
2541     * Extra field name for the URI to a verification file. Passed to a package
2542     * verifier.
2543     *
2544     * @hide
2545     */
2546    public static final String EXTRA_VERIFICATION_URI = "android.content.pm.extra.VERIFICATION_URI";
2547
2548    /**
2549     * Extra field name for the ID of a package pending verification. Passed to
2550     * a package verifier and is used to call back to
2551     * {@link PackageManager#verifyPendingInstall(int, int)}
2552     */
2553    public static final String EXTRA_VERIFICATION_ID = "android.content.pm.extra.VERIFICATION_ID";
2554
2555    /**
2556     * Extra field name for the package identifier which is trying to install
2557     * the package.
2558     *
2559     * @hide
2560     */
2561    public static final String EXTRA_VERIFICATION_INSTALLER_PACKAGE
2562            = "android.content.pm.extra.VERIFICATION_INSTALLER_PACKAGE";
2563
2564    /**
2565     * Extra field name for the requested install flags for a package pending
2566     * verification. Passed to a package verifier.
2567     *
2568     * @hide
2569     */
2570    public static final String EXTRA_VERIFICATION_INSTALL_FLAGS
2571            = "android.content.pm.extra.VERIFICATION_INSTALL_FLAGS";
2572
2573    /**
2574     * Extra field name for the uid of who is requesting to install
2575     * the package.
2576     *
2577     * @hide
2578     */
2579    public static final String EXTRA_VERIFICATION_INSTALLER_UID
2580            = "android.content.pm.extra.VERIFICATION_INSTALLER_UID";
2581
2582    /**
2583     * Extra field name for the package name of a package pending verification.
2584     *
2585     * @hide
2586     */
2587    public static final String EXTRA_VERIFICATION_PACKAGE_NAME
2588            = "android.content.pm.extra.VERIFICATION_PACKAGE_NAME";
2589    /**
2590     * Extra field name for the result of a verification, either
2591     * {@link #VERIFICATION_ALLOW}, or {@link #VERIFICATION_REJECT}.
2592     * Passed to package verifiers after a package is verified.
2593     */
2594    public static final String EXTRA_VERIFICATION_RESULT
2595            = "android.content.pm.extra.VERIFICATION_RESULT";
2596
2597    /**
2598     * Extra field name for the version code of a package pending verification.
2599     *
2600     * @hide
2601     */
2602    public static final String EXTRA_VERIFICATION_VERSION_CODE
2603            = "android.content.pm.extra.VERIFICATION_VERSION_CODE";
2604
2605    /**
2606     * Extra field name for the ID of a intent filter pending verification.
2607     * Passed to an intent filter verifier and is used to call back to
2608     * {@link #verifyIntentFilter}
2609     *
2610     * @hide
2611     */
2612    public static final String EXTRA_INTENT_FILTER_VERIFICATION_ID
2613            = "android.content.pm.extra.INTENT_FILTER_VERIFICATION_ID";
2614
2615    /**
2616     * Extra field name for the scheme used for an intent filter pending verification. Passed to
2617     * an intent filter verifier and is used to construct the URI to verify against.
2618     *
2619     * Usually this is "https"
2620     *
2621     * @hide
2622     */
2623    public static final String EXTRA_INTENT_FILTER_VERIFICATION_URI_SCHEME
2624            = "android.content.pm.extra.INTENT_FILTER_VERIFICATION_URI_SCHEME";
2625
2626    /**
2627     * Extra field name for the host names to be used for an intent filter pending verification.
2628     * Passed to an intent filter verifier and is used to construct the URI to verify the
2629     * intent filter.
2630     *
2631     * This is a space delimited list of hosts.
2632     *
2633     * @hide
2634     */
2635    public static final String EXTRA_INTENT_FILTER_VERIFICATION_HOSTS
2636            = "android.content.pm.extra.INTENT_FILTER_VERIFICATION_HOSTS";
2637
2638    /**
2639     * Extra field name for the package name to be used for an intent filter pending verification.
2640     * Passed to an intent filter verifier and is used to check the verification responses coming
2641     * from the hosts. Each host response will need to include the package name of APK containing
2642     * the intent filter.
2643     *
2644     * @hide
2645     */
2646    public static final String EXTRA_INTENT_FILTER_VERIFICATION_PACKAGE_NAME
2647            = "android.content.pm.extra.INTENT_FILTER_VERIFICATION_PACKAGE_NAME";
2648
2649    /**
2650     * The action used to request that the user approve a permission request
2651     * from the application.
2652     *
2653     * @hide
2654     */
2655    @SystemApi
2656    public static final String ACTION_REQUEST_PERMISSIONS =
2657            "android.content.pm.action.REQUEST_PERMISSIONS";
2658
2659    /**
2660     * The names of the requested permissions.
2661     * <p>
2662     * <strong>Type:</strong> String[]
2663     * </p>
2664     *
2665     * @hide
2666     */
2667    @SystemApi
2668    public static final String EXTRA_REQUEST_PERMISSIONS_NAMES =
2669            "android.content.pm.extra.REQUEST_PERMISSIONS_NAMES";
2670
2671    /**
2672     * The results from the permissions request.
2673     * <p>
2674     * <strong>Type:</strong> int[] of #PermissionResult
2675     * </p>
2676     *
2677     * @hide
2678     */
2679    @SystemApi
2680    public static final String EXTRA_REQUEST_PERMISSIONS_RESULTS
2681            = "android.content.pm.extra.REQUEST_PERMISSIONS_RESULTS";
2682
2683    /**
2684     * String extra for {@link PackageInstallObserver} in the 'extras' Bundle in case of
2685     * {@link #INSTALL_FAILED_DUPLICATE_PERMISSION}.  This extra names the package which provides
2686     * the existing definition for the permission.
2687     * @hide
2688     */
2689    public static final String EXTRA_FAILURE_EXISTING_PACKAGE
2690            = "android.content.pm.extra.FAILURE_EXISTING_PACKAGE";
2691
2692    /**
2693     * String extra for {@link PackageInstallObserver} in the 'extras' Bundle in case of
2694     * {@link #INSTALL_FAILED_DUPLICATE_PERMISSION}.  This extra names the permission that is
2695     * being redundantly defined by the package being installed.
2696     * @hide
2697     */
2698    public static final String EXTRA_FAILURE_EXISTING_PERMISSION
2699            = "android.content.pm.extra.FAILURE_EXISTING_PERMISSION";
2700
2701   /**
2702    * Permission flag: The permission is set in its current state
2703    * by the user and apps can still request it at runtime.
2704    *
2705    * @hide
2706    */
2707    @SystemApi
2708    public static final int FLAG_PERMISSION_USER_SET = 1 << 0;
2709
2710    /**
2711     * Permission flag: The permission is set in its current state
2712     * by the user and it is fixed, i.e. apps can no longer request
2713     * this permission.
2714     *
2715     * @hide
2716     */
2717    @SystemApi
2718    public static final int FLAG_PERMISSION_USER_FIXED =  1 << 1;
2719
2720    /**
2721     * Permission flag: The permission is set in its current state
2722     * by device policy and neither apps nor the user can change
2723     * its state.
2724     *
2725     * @hide
2726     */
2727    @SystemApi
2728    public static final int FLAG_PERMISSION_POLICY_FIXED =  1 << 2;
2729
2730    /**
2731     * Permission flag: The permission is set in a granted state but
2732     * access to resources it guards is restricted by other means to
2733     * enable revoking a permission on legacy apps that do not support
2734     * runtime permissions. If this permission is upgraded to runtime
2735     * because the app was updated to support runtime permissions, the
2736     * the permission will be revoked in the upgrade process.
2737     *
2738     * @hide
2739     */
2740    @SystemApi
2741    public static final int FLAG_PERMISSION_REVOKE_ON_UPGRADE =  1 << 3;
2742
2743    /**
2744     * Permission flag: The permission is set in its current state
2745     * because the app is a component that is a part of the system.
2746     *
2747     * @hide
2748     */
2749    @SystemApi
2750    public static final int FLAG_PERMISSION_SYSTEM_FIXED =  1 << 4;
2751
2752    /**
2753     * Permission flag: The permission is granted by default because it
2754     * enables app functionality that is expected to work out-of-the-box
2755     * for providing a smooth user experience. For example, the phone app
2756     * is expected to have the phone permission.
2757     *
2758     * @hide
2759     */
2760    @SystemApi
2761    public static final int FLAG_PERMISSION_GRANTED_BY_DEFAULT =  1 << 5;
2762
2763    /**
2764     * Permission flag: The permission has to be reviewed before any of
2765     * the app components can run.
2766     *
2767     * @hide
2768     */
2769    @SystemApi
2770    public static final int FLAG_PERMISSION_REVIEW_REQUIRED =  1 << 6;
2771
2772    /**
2773     * Mask for all permission flags.
2774     *
2775     * @hide
2776     */
2777    @SystemApi
2778    public static final int MASK_PERMISSION_FLAGS = 0xFF;
2779
2780    /**
2781     * This is a library that contains components apps can invoke. For
2782     * example, a services for apps to bind to, or standard chooser UI,
2783     * etc. This library is versioned and backwards compatible. Clients
2784     * should check its version via {@link android.ext.services.Version
2785     * #getVersionCode()} and avoid calling APIs added in later versions.
2786     *
2787     * @hide
2788     */
2789    public static final String SYSTEM_SHARED_LIBRARY_SERVICES = "android.ext.services";
2790
2791    /**
2792     * This is a library that contains components apps can dynamically
2793     * load. For example, new widgets, helper classes, etc. This library
2794     * is versioned and backwards compatible. Clients should check its
2795     * version via {@link android.ext.shared.Version#getVersionCode()}
2796     * and avoid calling APIs added in later versions.
2797     *
2798     * @hide
2799     */
2800    public static final String SYSTEM_SHARED_LIBRARY_SHARED = "android.ext.shared";
2801
2802    /**
2803     * Used when starting a process for an Activity.
2804     *
2805     * @hide
2806     */
2807    public static final int NOTIFY_PACKAGE_USE_ACTIVITY = 0;
2808
2809    /**
2810     * Used when starting a process for a Service.
2811     *
2812     * @hide
2813     */
2814    public static final int NOTIFY_PACKAGE_USE_SERVICE = 1;
2815
2816    /**
2817     * Used when moving a Service to the foreground.
2818     *
2819     * @hide
2820     */
2821    public static final int NOTIFY_PACKAGE_USE_FOREGROUND_SERVICE = 2;
2822
2823    /**
2824     * Used when starting a process for a BroadcastReceiver.
2825     *
2826     * @hide
2827     */
2828    public static final int NOTIFY_PACKAGE_USE_BROADCAST_RECEIVER = 3;
2829
2830    /**
2831     * Used when starting a process for a ContentProvider.
2832     *
2833     * @hide
2834     */
2835    public static final int NOTIFY_PACKAGE_USE_CONTENT_PROVIDER = 4;
2836
2837    /**
2838     * Used when starting a process for a BroadcastReceiver.
2839     *
2840     * @hide
2841     */
2842    public static final int NOTIFY_PACKAGE_USE_BACKUP = 5;
2843
2844    /**
2845     * Used with Context.getClassLoader() across Android packages.
2846     *
2847     * @hide
2848     */
2849    public static final int NOTIFY_PACKAGE_USE_CROSS_PACKAGE = 6;
2850
2851    /**
2852     * Used when starting a package within a process for Instrumentation.
2853     *
2854     * @hide
2855     */
2856    public static final int NOTIFY_PACKAGE_USE_INSTRUMENTATION = 7;
2857
2858    /**
2859     * Total number of usage reasons.
2860     *
2861     * @hide
2862     */
2863    public static final int NOTIFY_PACKAGE_USE_REASONS_COUNT = 8;
2864
2865    /**
2866     * Constant for specifying the highest installed package version code.
2867     */
2868    public static final int VERSION_CODE_HIGHEST = -1;
2869
2870    /**
2871     * Retrieve overall information about an application package that is
2872     * installed on the system.
2873     *
2874     * @param packageName The full name (i.e. com.google.apps.contacts) of the
2875     *            desired package.
2876     * @param flags Additional option flags to modify the data returned.
2877     * @return A PackageInfo object containing information about the package. If
2878     *         flag {@code MATCH_UNINSTALLED_PACKAGES} is set and if the package
2879     *         is not found in the list of installed applications, the package
2880     *         information is retrieved from the list of uninstalled
2881     *         applications (which includes installed applications as well as
2882     *         applications with data directory i.e. applications which had been
2883     *         deleted with {@code DONT_DELETE_DATA} flag set).
2884     * @throws NameNotFoundException if a package with the given name cannot be
2885     *             found on the system.
2886     */
2887    public abstract PackageInfo getPackageInfo(String packageName, @PackageInfoFlags int flags)
2888            throws NameNotFoundException;
2889
2890    /**
2891     * Retrieve overall information about an application package that is
2892     * installed on the system. This method can be used for retrieving
2893     * information about packages for which multiple versions can be installed
2894     * at the time. Currently only packages hosting static shared libraries can
2895     * have multiple installed versions. The method can also be used to get info
2896     * for a package that has a single version installed by passing
2897     * {@link #VERSION_CODE_HIGHEST} in the {@link VersionedPackage}
2898     * constructor.
2899     *
2900     * @param versionedPackage The versioned package for which to query.
2901     * @param flags Additional option flags to modify the data returned.
2902     * @return A PackageInfo object containing information about the package. If
2903     *         flag {@code MATCH_UNINSTALLED_PACKAGES} is set and if the package
2904     *         is not found in the list of installed applications, the package
2905     *         information is retrieved from the list of uninstalled
2906     *         applications (which includes installed applications as well as
2907     *         applications with data directory i.e. applications which had been
2908     *         deleted with {@code DONT_DELETE_DATA} flag set).
2909     * @throws NameNotFoundException if a package with the given name cannot be
2910     *             found on the system.
2911     */
2912    public abstract PackageInfo getPackageInfo(VersionedPackage versionedPackage,
2913            @PackageInfoFlags int flags) throws NameNotFoundException;
2914
2915    /**
2916     * Retrieve overall information about an application package that is
2917     * installed on the system.
2918     *
2919     * @param packageName The full name (i.e. com.google.apps.contacts) of the
2920     *            desired package.
2921     * @param flags Additional option flags to modify the data returned.
2922     * @param userId The user id.
2923     * @return A PackageInfo object containing information about the package. If
2924     *         flag {@code MATCH_UNINSTALLED_PACKAGES} is set and if the package
2925     *         is not found in the list of installed applications, the package
2926     *         information is retrieved from the list of uninstalled
2927     *         applications (which includes installed applications as well as
2928     *         applications with data directory i.e. applications which had been
2929     *         deleted with {@code DONT_DELETE_DATA} flag set).
2930     * @throws NameNotFoundException if a package with the given name cannot be
2931     *             found on the system.
2932     * @hide
2933     */
2934    @RequiresPermission(Manifest.permission.INTERACT_ACROSS_USERS)
2935    public abstract PackageInfo getPackageInfoAsUser(String packageName,
2936            @PackageInfoFlags int flags, @UserIdInt int userId) throws NameNotFoundException;
2937
2938    /**
2939     * Map from the current package names in use on the device to whatever
2940     * the current canonical name of that package is.
2941     * @param names Array of current names to be mapped.
2942     * @return Returns an array of the same size as the original, containing
2943     * the canonical name for each package.
2944     */
2945    public abstract String[] currentToCanonicalPackageNames(String[] names);
2946
2947    /**
2948     * Map from a packages canonical name to the current name in use on the device.
2949     * @param names Array of new names to be mapped.
2950     * @return Returns an array of the same size as the original, containing
2951     * the current name for each package.
2952     */
2953    public abstract String[] canonicalToCurrentPackageNames(String[] names);
2954
2955    /**
2956     * Returns a "good" intent to launch a front-door activity in a package.
2957     * This is used, for example, to implement an "open" button when browsing
2958     * through packages.  The current implementation looks first for a main
2959     * activity in the category {@link Intent#CATEGORY_INFO}, and next for a
2960     * main activity in the category {@link Intent#CATEGORY_LAUNCHER}. Returns
2961     * <code>null</code> if neither are found.
2962     *
2963     * @param packageName The name of the package to inspect.
2964     *
2965     * @return A fully-qualified {@link Intent} that can be used to launch the
2966     * main activity in the package. Returns <code>null</code> if the package
2967     * does not contain such an activity, or if <em>packageName</em> is not
2968     * recognized.
2969     */
2970    public abstract @Nullable Intent getLaunchIntentForPackage(@NonNull String packageName);
2971
2972    /**
2973     * Return a "good" intent to launch a front-door Leanback activity in a
2974     * package, for use for example to implement an "open" button when browsing
2975     * through packages. The current implementation will look for a main
2976     * activity in the category {@link Intent#CATEGORY_LEANBACK_LAUNCHER}, or
2977     * return null if no main leanback activities are found.
2978     *
2979     * @param packageName The name of the package to inspect.
2980     * @return Returns either a fully-qualified Intent that can be used to launch
2981     *         the main Leanback activity in the package, or null if the package
2982     *         does not contain such an activity.
2983     */
2984    public abstract @Nullable Intent getLeanbackLaunchIntentForPackage(@NonNull String packageName);
2985
2986    /**
2987     * Return an array of all of the POSIX secondary group IDs that have been
2988     * assigned to the given package.
2989     * <p>
2990     * Note that the same package may have different GIDs under different
2991     * {@link UserHandle} on the same device.
2992     *
2993     * @param packageName The full name (i.e. com.google.apps.contacts) of the
2994     *            desired package.
2995     * @return Returns an int array of the assigned GIDs, or null if there are
2996     *         none.
2997     * @throws NameNotFoundException if a package with the given name cannot be
2998     *             found on the system.
2999     */
3000    public abstract int[] getPackageGids(@NonNull String packageName)
3001            throws NameNotFoundException;
3002
3003    /**
3004     * Return an array of all of the POSIX secondary group IDs that have been
3005     * assigned to the given package.
3006     * <p>
3007     * Note that the same package may have different GIDs under different
3008     * {@link UserHandle} on the same device.
3009     *
3010     * @param packageName The full name (i.e. com.google.apps.contacts) of the
3011     *            desired package.
3012     * @return Returns an int array of the assigned gids, or null if there are
3013     *         none.
3014     * @throws NameNotFoundException if a package with the given name cannot be
3015     *             found on the system.
3016     */
3017    public abstract int[] getPackageGids(String packageName, @PackageInfoFlags int flags)
3018            throws NameNotFoundException;
3019
3020    /**
3021     * Return the UID associated with the given package name.
3022     * <p>
3023     * Note that the same package will have different UIDs under different
3024     * {@link UserHandle} on the same device.
3025     *
3026     * @param packageName The full name (i.e. com.google.apps.contacts) of the
3027     *            desired package.
3028     * @return Returns an integer UID who owns the given package name.
3029     * @throws NameNotFoundException if a package with the given name can not be
3030     *             found on the system.
3031     */
3032    public abstract int getPackageUid(String packageName, @PackageInfoFlags int flags)
3033            throws NameNotFoundException;
3034
3035    /**
3036     * Return the UID associated with the given package name.
3037     * <p>
3038     * Note that the same package will have different UIDs under different
3039     * {@link UserHandle} on the same device.
3040     *
3041     * @param packageName The full name (i.e. com.google.apps.contacts) of the
3042     *            desired package.
3043     * @param userId The user handle identifier to look up the package under.
3044     * @return Returns an integer UID who owns the given package name.
3045     * @throws NameNotFoundException if a package with the given name can not be
3046     *             found on the system.
3047     * @hide
3048     */
3049    public abstract int getPackageUidAsUser(String packageName, @UserIdInt int userId)
3050            throws NameNotFoundException;
3051
3052    /**
3053     * Return the UID associated with the given package name.
3054     * <p>
3055     * Note that the same package will have different UIDs under different
3056     * {@link UserHandle} on the same device.
3057     *
3058     * @param packageName The full name (i.e. com.google.apps.contacts) of the
3059     *            desired package.
3060     * @param userId The user handle identifier to look up the package under.
3061     * @return Returns an integer UID who owns the given package name.
3062     * @throws NameNotFoundException if a package with the given name can not be
3063     *             found on the system.
3064     * @hide
3065     */
3066    public abstract int getPackageUidAsUser(String packageName, @PackageInfoFlags int flags,
3067            @UserIdInt int userId) throws NameNotFoundException;
3068
3069    /**
3070     * Retrieve all of the information we know about a particular permission.
3071     *
3072     * @param name The fully qualified name (i.e. com.google.permission.LOGIN)
3073     *            of the permission you are interested in.
3074     * @param flags Additional option flags to modify the data returned.
3075     * @return Returns a {@link PermissionInfo} containing information about the
3076     *         permission.
3077     * @throws NameNotFoundException if a package with the given name cannot be
3078     *             found on the system.
3079     */
3080    public abstract PermissionInfo getPermissionInfo(String name, @PermissionInfoFlags int flags)
3081            throws NameNotFoundException;
3082
3083    /**
3084     * Query for all of the permissions associated with a particular group.
3085     *
3086     * @param group The fully qualified name (i.e. com.google.permission.LOGIN)
3087     *            of the permission group you are interested in. Use null to
3088     *            find all of the permissions not associated with a group.
3089     * @param flags Additional option flags to modify the data returned.
3090     * @return Returns a list of {@link PermissionInfo} containing information
3091     *         about all of the permissions in the given group.
3092     * @throws NameNotFoundException if a package with the given name cannot be
3093     *             found on the system.
3094     */
3095    public abstract List<PermissionInfo> queryPermissionsByGroup(String group,
3096            @PermissionInfoFlags int flags) throws NameNotFoundException;
3097
3098    /**
3099     * Returns true if Permission Review Mode is enabled, false otherwise.
3100     *
3101     * @hide
3102     */
3103    @TestApi
3104    public abstract boolean isPermissionReviewModeEnabled();
3105
3106    /**
3107     * Retrieve all of the information we know about a particular group of
3108     * permissions.
3109     *
3110     * @param name The fully qualified name (i.e.
3111     *            com.google.permission_group.APPS) of the permission you are
3112     *            interested in.
3113     * @param flags Additional option flags to modify the data returned.
3114     * @return Returns a {@link PermissionGroupInfo} containing information
3115     *         about the permission.
3116     * @throws NameNotFoundException if a package with the given name cannot be
3117     *             found on the system.
3118     */
3119    public abstract PermissionGroupInfo getPermissionGroupInfo(String name,
3120            @PermissionGroupInfoFlags int flags) throws NameNotFoundException;
3121
3122    /**
3123     * Retrieve all of the known permission groups in the system.
3124     *
3125     * @param flags Additional option flags to modify the data returned.
3126     * @return Returns a list of {@link PermissionGroupInfo} containing
3127     *         information about all of the known permission groups.
3128     */
3129    public abstract List<PermissionGroupInfo> getAllPermissionGroups(
3130            @PermissionGroupInfoFlags int flags);
3131
3132    /**
3133     * Retrieve all of the information we know about a particular
3134     * package/application.
3135     *
3136     * @param packageName The full name (i.e. com.google.apps.contacts) of an
3137     *            application.
3138     * @param flags Additional option flags to modify the data returned.
3139     * @return An {@link ApplicationInfo} containing information about the
3140     *         package. If flag {@code MATCH_UNINSTALLED_PACKAGES} is set and if
3141     *         the package is not found in the list of installed applications,
3142     *         the application information is retrieved from the list of
3143     *         uninstalled applications (which includes installed applications
3144     *         as well as applications with data directory i.e. applications
3145     *         which had been deleted with {@code DONT_DELETE_DATA} flag set).
3146     * @throws NameNotFoundException if a package with the given name cannot be
3147     *             found on the system.
3148     */
3149    public abstract ApplicationInfo getApplicationInfo(String packageName,
3150            @ApplicationInfoFlags int flags) throws NameNotFoundException;
3151
3152    /** {@hide} */
3153    public abstract ApplicationInfo getApplicationInfoAsUser(String packageName,
3154            @ApplicationInfoFlags int flags, @UserIdInt int userId) throws NameNotFoundException;
3155
3156    /**
3157     * Retrieve all of the information we know about a particular activity
3158     * class.
3159     *
3160     * @param component The full component name (i.e.
3161     *            com.google.apps.contacts/com.google.apps.contacts.
3162     *            ContactsList) of an Activity class.
3163     * @param flags Additional option flags to modify the data returned.
3164     * @return An {@link ActivityInfo} containing information about the
3165     *         activity.
3166     * @throws NameNotFoundException if a package with the given name cannot be
3167     *             found on the system.
3168     */
3169    public abstract ActivityInfo getActivityInfo(ComponentName component,
3170            @ComponentInfoFlags int flags) throws NameNotFoundException;
3171
3172    /**
3173     * Retrieve all of the information we know about a particular receiver
3174     * class.
3175     *
3176     * @param component The full component name (i.e.
3177     *            com.google.apps.calendar/com.google.apps.calendar.
3178     *            CalendarAlarm) of a Receiver class.
3179     * @param flags Additional option flags to modify the data returned.
3180     * @return An {@link ActivityInfo} containing information about the
3181     *         receiver.
3182     * @throws NameNotFoundException if a package with the given name cannot be
3183     *             found on the system.
3184     */
3185    public abstract ActivityInfo getReceiverInfo(ComponentName component,
3186            @ComponentInfoFlags int flags) throws NameNotFoundException;
3187
3188    /**
3189     * Retrieve all of the information we know about a particular service class.
3190     *
3191     * @param component The full component name (i.e.
3192     *            com.google.apps.media/com.google.apps.media.
3193     *            BackgroundPlayback) of a Service class.
3194     * @param flags Additional option flags to modify the data returned.
3195     * @return A {@link ServiceInfo} object containing information about the
3196     *         service.
3197     * @throws NameNotFoundException if a package with the given name cannot be
3198     *             found on the system.
3199     */
3200    public abstract ServiceInfo getServiceInfo(ComponentName component,
3201            @ComponentInfoFlags int flags) throws NameNotFoundException;
3202
3203    /**
3204     * Retrieve all of the information we know about a particular content
3205     * provider class.
3206     *
3207     * @param component The full component name (i.e.
3208     *            com.google.providers.media/com.google.providers.media.
3209     *            MediaProvider) of a ContentProvider class.
3210     * @param flags Additional option flags to modify the data returned.
3211     * @return A {@link ProviderInfo} object containing information about the
3212     *         provider.
3213     * @throws NameNotFoundException if a package with the given name cannot be
3214     *             found on the system.
3215     */
3216    public abstract ProviderInfo getProviderInfo(ComponentName component,
3217            @ComponentInfoFlags int flags) throws NameNotFoundException;
3218
3219    /**
3220     * Return a List of all packages that are installed on the device.
3221     *
3222     * @param flags Additional option flags to modify the data returned.
3223     * @return A List of PackageInfo objects, one for each installed package,
3224     *         containing information about the package. In the unlikely case
3225     *         there are no installed packages, an empty list is returned. If
3226     *         flag {@code MATCH_UNINSTALLED_PACKAGES} is set, the package
3227     *         information is retrieved from the list of uninstalled
3228     *         applications (which includes installed applications as well as
3229     *         applications with data directory i.e. applications which had been
3230     *         deleted with {@code DONT_DELETE_DATA} flag set).
3231     */
3232    public abstract List<PackageInfo> getInstalledPackages(@PackageInfoFlags int flags);
3233
3234    /**
3235     * Return a List of all installed packages that are currently holding any of
3236     * the given permissions.
3237     *
3238     * @param flags Additional option flags to modify the data returned.
3239     * @return A List of PackageInfo objects, one for each installed package
3240     *         that holds any of the permissions that were provided, containing
3241     *         information about the package. If no installed packages hold any
3242     *         of the permissions, an empty list is returned. If flag
3243     *         {@code MATCH_UNINSTALLED_PACKAGES} is set, the package
3244     *         information is retrieved from the list of uninstalled
3245     *         applications (which includes installed applications as well as
3246     *         applications with data directory i.e. applications which had been
3247     *         deleted with {@code DONT_DELETE_DATA} flag set).
3248     */
3249    public abstract List<PackageInfo> getPackagesHoldingPermissions(
3250            String[] permissions, @PackageInfoFlags int flags);
3251
3252    /**
3253     * Return a List of all packages that are installed on the device, for a
3254     * specific user.
3255     *
3256     * @param flags Additional option flags to modify the data returned.
3257     * @param userId The user for whom the installed packages are to be listed
3258     * @return A List of PackageInfo objects, one for each installed package,
3259     *         containing information about the package. In the unlikely case
3260     *         there are no installed packages, an empty list is returned. If
3261     *         flag {@code MATCH_UNINSTALLED_PACKAGES} is set, the package
3262     *         information is retrieved from the list of uninstalled
3263     *         applications (which includes installed applications as well as
3264     *         applications with data directory i.e. applications which had been
3265     *         deleted with {@code DONT_DELETE_DATA} flag set).
3266     * @hide
3267     */
3268    @SystemApi
3269    @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS_FULL)
3270    public abstract List<PackageInfo> getInstalledPackagesAsUser(@PackageInfoFlags int flags,
3271            @UserIdInt int userId);
3272
3273    /**
3274     * Check whether a particular package has been granted a particular
3275     * permission.
3276     *
3277     * @param permName The name of the permission you are checking for.
3278     * @param pkgName The name of the package you are checking against.
3279     *
3280     * @return If the package has the permission, PERMISSION_GRANTED is
3281     * returned.  If it does not have the permission, PERMISSION_DENIED
3282     * is returned.
3283     *
3284     * @see #PERMISSION_GRANTED
3285     * @see #PERMISSION_DENIED
3286     */
3287    @CheckResult
3288    public abstract @PermissionResult int checkPermission(String permName, String pkgName);
3289
3290    /**
3291     * Checks whether a particular permissions has been revoked for a
3292     * package by policy. Typically the device owner or the profile owner
3293     * may apply such a policy. The user cannot grant policy revoked
3294     * permissions, hence the only way for an app to get such a permission
3295     * is by a policy change.
3296     *
3297     * @param permName The name of the permission you are checking for.
3298     * @param pkgName The name of the package you are checking against.
3299     *
3300     * @return Whether the permission is restricted by policy.
3301     */
3302    @CheckResult
3303    public abstract boolean isPermissionRevokedByPolicy(@NonNull String permName,
3304            @NonNull String pkgName);
3305
3306    /**
3307     * Gets the package name of the component controlling runtime permissions.
3308     *
3309     * @return The package name.
3310     *
3311     * @hide
3312     */
3313    public abstract String getPermissionControllerPackageName();
3314
3315    /**
3316     * Add a new dynamic permission to the system.  For this to work, your
3317     * package must have defined a permission tree through the
3318     * {@link android.R.styleable#AndroidManifestPermissionTree
3319     * &lt;permission-tree&gt;} tag in its manifest.  A package can only add
3320     * permissions to trees that were defined by either its own package or
3321     * another with the same user id; a permission is in a tree if it
3322     * matches the name of the permission tree + ".": for example,
3323     * "com.foo.bar" is a member of the permission tree "com.foo".
3324     *
3325     * <p>It is good to make your permission tree name descriptive, because you
3326     * are taking possession of that entire set of permission names.  Thus, it
3327     * must be under a domain you control, with a suffix that will not match
3328     * any normal permissions that may be declared in any applications that
3329     * are part of that domain.
3330     *
3331     * <p>New permissions must be added before
3332     * any .apks are installed that use those permissions.  Permissions you
3333     * add through this method are remembered across reboots of the device.
3334     * If the given permission already exists, the info you supply here
3335     * will be used to update it.
3336     *
3337     * @param info Description of the permission to be added.
3338     *
3339     * @return Returns true if a new permission was created, false if an
3340     * existing one was updated.
3341     *
3342     * @throws SecurityException if you are not allowed to add the
3343     * given permission name.
3344     *
3345     * @see #removePermission(String)
3346     */
3347    public abstract boolean addPermission(PermissionInfo info);
3348
3349    /**
3350     * Like {@link #addPermission(PermissionInfo)} but asynchronously
3351     * persists the package manager state after returning from the call,
3352     * allowing it to return quicker and batch a series of adds at the
3353     * expense of no guarantee the added permission will be retained if
3354     * the device is rebooted before it is written.
3355     */
3356    public abstract boolean addPermissionAsync(PermissionInfo info);
3357
3358    /**
3359     * Removes a permission that was previously added with
3360     * {@link #addPermission(PermissionInfo)}.  The same ownership rules apply
3361     * -- you are only allowed to remove permissions that you are allowed
3362     * to add.
3363     *
3364     * @param name The name of the permission to remove.
3365     *
3366     * @throws SecurityException if you are not allowed to remove the
3367     * given permission name.
3368     *
3369     * @see #addPermission(PermissionInfo)
3370     */
3371    public abstract void removePermission(String name);
3372
3373    /**
3374     * Permission flags set when granting or revoking a permission.
3375     *
3376     * @hide
3377     */
3378    @SystemApi
3379    @IntDef(prefix = { "FLAG_PERMISSION_" }, value = {
3380            FLAG_PERMISSION_USER_SET,
3381            FLAG_PERMISSION_USER_FIXED,
3382            FLAG_PERMISSION_POLICY_FIXED,
3383            FLAG_PERMISSION_REVOKE_ON_UPGRADE,
3384            FLAG_PERMISSION_SYSTEM_FIXED,
3385            FLAG_PERMISSION_GRANTED_BY_DEFAULT
3386    })
3387    @Retention(RetentionPolicy.SOURCE)
3388    public @interface PermissionFlags {}
3389
3390    /**
3391     * Grant a runtime permission to an application which the application does not
3392     * already have. The permission must have been requested by the application.
3393     * If the application is not allowed to hold the permission, a {@link
3394     * java.lang.SecurityException} is thrown. If the package or permission is
3395     * invalid, a {@link java.lang.IllegalArgumentException} is thrown.
3396     * <p>
3397     * <strong>Note: </strong>Using this API requires holding
3398     * android.permission.GRANT_RUNTIME_PERMISSIONS and if the user id is
3399     * not the current user android.permission.INTERACT_ACROSS_USERS_FULL.
3400     * </p>
3401     *
3402     * @param packageName The package to which to grant the permission.
3403     * @param permissionName The permission name to grant.
3404     * @param user The user for which to grant the permission.
3405     *
3406     * @see #revokeRuntimePermission(String, String, android.os.UserHandle)
3407     *
3408     * @hide
3409     */
3410    @SystemApi
3411    @RequiresPermission(android.Manifest.permission.GRANT_RUNTIME_PERMISSIONS)
3412    public abstract void grantRuntimePermission(@NonNull String packageName,
3413            @NonNull String permissionName, @NonNull UserHandle user);
3414
3415    /**
3416     * Revoke a runtime permission that was previously granted by {@link
3417     * #grantRuntimePermission(String, String, android.os.UserHandle)}. The
3418     * permission must have been requested by and granted to the application.
3419     * If the application is not allowed to hold the permission, a {@link
3420     * java.lang.SecurityException} is thrown. If the package or permission is
3421     * invalid, a {@link java.lang.IllegalArgumentException} is thrown.
3422     * <p>
3423     * <strong>Note: </strong>Using this API requires holding
3424     * android.permission.REVOKE_RUNTIME_PERMISSIONS and if the user id is
3425     * not the current user android.permission.INTERACT_ACROSS_USERS_FULL.
3426     * </p>
3427     *
3428     * @param packageName The package from which to revoke the permission.
3429     * @param permissionName The permission name to revoke.
3430     * @param user The user for which to revoke the permission.
3431     *
3432     * @see #grantRuntimePermission(String, String, android.os.UserHandle)
3433     *
3434     * @hide
3435     */
3436    @SystemApi
3437    @RequiresPermission(android.Manifest.permission.REVOKE_RUNTIME_PERMISSIONS)
3438    public abstract void revokeRuntimePermission(@NonNull String packageName,
3439            @NonNull String permissionName, @NonNull UserHandle user);
3440
3441    /**
3442     * Gets the state flags associated with a permission.
3443     *
3444     * @param permissionName The permission for which to get the flags.
3445     * @param packageName The package name for which to get the flags.
3446     * @param user The user for which to get permission flags.
3447     * @return The permission flags.
3448     *
3449     * @hide
3450     */
3451    @SystemApi
3452    @RequiresPermission(anyOf = {
3453            android.Manifest.permission.GRANT_RUNTIME_PERMISSIONS,
3454            android.Manifest.permission.REVOKE_RUNTIME_PERMISSIONS
3455    })
3456    public abstract @PermissionFlags int getPermissionFlags(String permissionName,
3457            String packageName, @NonNull UserHandle user);
3458
3459    /**
3460     * Updates the flags associated with a permission by replacing the flags in
3461     * the specified mask with the provided flag values.
3462     *
3463     * @param permissionName The permission for which to update the flags.
3464     * @param packageName The package name for which to update the flags.
3465     * @param flagMask The flags which to replace.
3466     * @param flagValues The flags with which to replace.
3467     * @param user The user for which to update the permission flags.
3468     *
3469     * @hide
3470     */
3471    @SystemApi
3472    @RequiresPermission(anyOf = {
3473            android.Manifest.permission.GRANT_RUNTIME_PERMISSIONS,
3474            android.Manifest.permission.REVOKE_RUNTIME_PERMISSIONS
3475    })
3476    public abstract void updatePermissionFlags(String permissionName,
3477            String packageName, @PermissionFlags int flagMask, @PermissionFlags int flagValues,
3478            @NonNull UserHandle user);
3479
3480    /**
3481     * Gets whether you should show UI with rationale for requesting a permission.
3482     * You should do this only if you do not have the permission and the context in
3483     * which the permission is requested does not clearly communicate to the user
3484     * what would be the benefit from grating this permission.
3485     *
3486     * @param permission A permission your app wants to request.
3487     * @return Whether you can show permission rationale UI.
3488     *
3489     * @hide
3490     */
3491    public abstract boolean shouldShowRequestPermissionRationale(String permission);
3492
3493    /**
3494     * Returns an {@link android.content.Intent} suitable for passing to
3495     * {@link android.app.Activity#startActivityForResult(android.content.Intent, int)}
3496     * which prompts the user to grant permissions to this application.
3497     *
3498     * @throws NullPointerException if {@code permissions} is {@code null} or empty.
3499     *
3500     * @hide
3501     */
3502    public Intent buildRequestPermissionsIntent(@NonNull String[] permissions) {
3503        if (ArrayUtils.isEmpty(permissions)) {
3504           throw new IllegalArgumentException("permission cannot be null or empty");
3505        }
3506        Intent intent = new Intent(ACTION_REQUEST_PERMISSIONS);
3507        intent.putExtra(EXTRA_REQUEST_PERMISSIONS_NAMES, permissions);
3508        intent.setPackage(getPermissionControllerPackageName());
3509        return intent;
3510    }
3511
3512    /**
3513     * Compare the signatures of two packages to determine if the same
3514     * signature appears in both of them.  If they do contain the same
3515     * signature, then they are allowed special privileges when working
3516     * with each other: they can share the same user-id, run instrumentation
3517     * against each other, etc.
3518     *
3519     * @param pkg1 First package name whose signature will be compared.
3520     * @param pkg2 Second package name whose signature will be compared.
3521     *
3522     * @return Returns an integer indicating whether all signatures on the
3523     * two packages match. The value is >= 0 ({@link #SIGNATURE_MATCH}) if
3524     * all signatures match or < 0 if there is not a match ({@link
3525     * #SIGNATURE_NO_MATCH} or {@link #SIGNATURE_UNKNOWN_PACKAGE}).
3526     *
3527     * @see #checkSignatures(int, int)
3528     */
3529    @CheckResult
3530    public abstract @SignatureResult int checkSignatures(String pkg1, String pkg2);
3531
3532    /**
3533     * Like {@link #checkSignatures(String, String)}, but takes UIDs of
3534     * the two packages to be checked.  This can be useful, for example,
3535     * when doing the check in an IPC, where the UID is the only identity
3536     * available.  It is functionally identical to determining the package
3537     * associated with the UIDs and checking their signatures.
3538     *
3539     * @param uid1 First UID whose signature will be compared.
3540     * @param uid2 Second UID whose signature will be compared.
3541     *
3542     * @return Returns an integer indicating whether all signatures on the
3543     * two packages match. The value is >= 0 ({@link #SIGNATURE_MATCH}) if
3544     * all signatures match or < 0 if there is not a match ({@link
3545     * #SIGNATURE_NO_MATCH} or {@link #SIGNATURE_UNKNOWN_PACKAGE}).
3546     *
3547     * @see #checkSignatures(String, String)
3548     */
3549    @CheckResult
3550    public abstract @SignatureResult int checkSignatures(int uid1, int uid2);
3551
3552    /**
3553     * Retrieve the names of all packages that are associated with a particular
3554     * user id.  In most cases, this will be a single package name, the package
3555     * that has been assigned that user id.  Where there are multiple packages
3556     * sharing the same user id through the "sharedUserId" mechanism, all
3557     * packages with that id will be returned.
3558     *
3559     * @param uid The user id for which you would like to retrieve the
3560     * associated packages.
3561     *
3562     * @return Returns an array of one or more packages assigned to the user
3563     * id, or null if there are no known packages with the given id.
3564     */
3565    public abstract @Nullable String[] getPackagesForUid(int uid);
3566
3567    /**
3568     * Retrieve the official name associated with a uid. This name is
3569     * guaranteed to never change, though it is possible for the underlying
3570     * uid to be changed.  That is, if you are storing information about
3571     * uids in persistent storage, you should use the string returned
3572     * by this function instead of the raw uid.
3573     *
3574     * @param uid The uid for which you would like to retrieve a name.
3575     * @return Returns a unique name for the given uid, or null if the
3576     * uid is not currently assigned.
3577     */
3578    public abstract @Nullable String getNameForUid(int uid);
3579
3580    /**
3581     * Return the user id associated with a shared user name. Multiple
3582     * applications can specify a shared user name in their manifest and thus
3583     * end up using a common uid. This might be used for new applications
3584     * that use an existing shared user name and need to know the uid of the
3585     * shared user.
3586     *
3587     * @param sharedUserName The shared user name whose uid is to be retrieved.
3588     * @return Returns the UID associated with the shared user.
3589     * @throws NameNotFoundException if a package with the given name cannot be
3590     *             found on the system.
3591     * @hide
3592     */
3593    public abstract int getUidForSharedUser(String sharedUserName)
3594            throws NameNotFoundException;
3595
3596    /**
3597     * Return a List of all application packages that are installed on the
3598     * device. If flag GET_UNINSTALLED_PACKAGES has been set, a list of all
3599     * applications including those deleted with {@code DONT_DELETE_DATA}
3600     * (partially installed apps with data directory) will be returned.
3601     *
3602     * @param flags Additional option flags to modify the data returned.
3603     * @return A List of ApplicationInfo objects, one for each installed
3604     *         application. In the unlikely case there are no installed
3605     *         packages, an empty list is returned. If flag
3606     *         {@code MATCH_UNINSTALLED_PACKAGES} is set, the application
3607     *         information is retrieved from the list of uninstalled
3608     *         applications (which includes installed applications as well as
3609     *         applications with data directory i.e. applications which had been
3610     *         deleted with {@code DONT_DELETE_DATA} flag set).
3611     */
3612    public abstract List<ApplicationInfo> getInstalledApplications(@ApplicationInfoFlags int flags);
3613
3614    /**
3615     * Return a List of all application packages that are installed on the
3616     * device, for a specific user. If flag GET_UNINSTALLED_PACKAGES has been
3617     * set, a list of all applications including those deleted with
3618     * {@code DONT_DELETE_DATA} (partially installed apps with data directory)
3619     * will be returned.
3620     *
3621     * @param flags Additional option flags to modify the data returned.
3622     * @param userId The user for whom the installed applications are to be
3623     *            listed
3624     * @return A List of ApplicationInfo objects, one for each installed
3625     *         application. In the unlikely case there are no installed
3626     *         packages, an empty list is returned. If flag
3627     *         {@code MATCH_UNINSTALLED_PACKAGES} is set, the application
3628     *         information is retrieved from the list of uninstalled
3629     *         applications (which includes installed applications as well as
3630     *         applications with data directory i.e. applications which had been
3631     *         deleted with {@code DONT_DELETE_DATA} flag set).
3632     * @hide
3633     */
3634    public abstract List<ApplicationInfo> getInstalledApplicationsAsUser(
3635            @ApplicationInfoFlags int flags, @UserIdInt int userId);
3636
3637    /**
3638     * Gets the instant applications the user recently used.
3639     *
3640     * @return The instant app list.
3641     *
3642     * @hide
3643     */
3644    @SystemApi
3645    @RequiresPermission(Manifest.permission.ACCESS_INSTANT_APPS)
3646    public abstract @NonNull List<InstantAppInfo> getInstantApps();
3647
3648    /**
3649     * Gets the icon for an instant application.
3650     *
3651     * @param packageName The app package name.
3652     *
3653     * @hide
3654     */
3655    @SystemApi
3656    @RequiresPermission(Manifest.permission.ACCESS_INSTANT_APPS)
3657    public abstract @Nullable Drawable getInstantAppIcon(String packageName);
3658
3659    /**
3660     * Gets whether this application is an instant app.
3661     *
3662     * @return Whether caller is an instant app.
3663     *
3664     * @see #isInstantApp(String)
3665     * @see #updateInstantAppCookie(byte[])
3666     * @see #getInstantAppCookie()
3667     * @see #getInstantAppCookieMaxBytes()
3668     */
3669    public abstract boolean isInstantApp();
3670
3671    /**
3672     * Gets whether the given package is an instant app.
3673     *
3674     * @param packageName The package to check
3675     * @return Whether the given package is an instant app.
3676     *
3677     * @see #isInstantApp()
3678     * @see #updateInstantAppCookie(byte[])
3679     * @see #getInstantAppCookie()
3680     * @see #getInstantAppCookieMaxBytes()
3681     * @see #clearInstantAppCookie()
3682     */
3683    public abstract boolean isInstantApp(String packageName);
3684
3685    /**
3686     * Gets the maximum size in bytes of the cookie data an instant app
3687     * can store on the device.
3688     *
3689     * @return The max cookie size in bytes.
3690     *
3691     * @see #isInstantApp()
3692     * @see #isInstantApp(String)
3693     * @see #updateInstantAppCookie(byte[])
3694     * @see #getInstantAppCookie()
3695     * @see #clearInstantAppCookie()
3696     */
3697    public abstract int getInstantAppCookieMaxBytes();
3698
3699    /**
3700     * @deprecated
3701     * @hide
3702     */
3703    public abstract int getInstantAppCookieMaxSize();
3704
3705    /**
3706     * Gets the instant application cookie for this app. Non
3707     * instant apps and apps that were instant but were upgraded
3708     * to normal apps can still access this API. For instant apps
3709     * this cookie is cached for some time after uninstall while for
3710     * normal apps the cookie is deleted after the app is uninstalled.
3711     * The cookie is always present while the app is installed.
3712     *
3713     * @return The cookie.
3714     *
3715     * @see #isInstantApp()
3716     * @see #isInstantApp(String)
3717     * @see #updateInstantAppCookie(byte[])
3718     * @see #getInstantAppCookieMaxBytes()
3719     * @see #clearInstantAppCookie()
3720     */
3721    public abstract @NonNull byte[] getInstantAppCookie();
3722
3723    /**
3724     * Clears the instant application cookie for the calling app.
3725     *
3726     * @see #isInstantApp()
3727     * @see #isInstantApp(String)
3728     * @see #getInstantAppCookieMaxBytes()
3729     * @see #getInstantAppCookie()
3730     * @see #clearInstantAppCookie()
3731     */
3732    public abstract void clearInstantAppCookie();
3733
3734    /**
3735     * Updates the instant application cookie for the calling app. Non
3736     * instant apps and apps that were instant but were upgraded
3737     * to normal apps can still access this API. For instant apps
3738     * this cookie is cached for some time after uninstall while for
3739     * normal apps the cookie is deleted after the app is uninstalled.
3740     * The cookie is always present while the app is installed. The
3741     * cookie size is limited by {@link #getInstantAppCookieMaxBytes()}.
3742     * Passing <code>null</code> or an empty array clears the cookie.
3743     * </p>
3744     *
3745     * @param cookie The cookie data.
3746     *
3747     * @see #isInstantApp()
3748     * @see #isInstantApp(String)
3749     * @see #getInstantAppCookieMaxBytes()
3750     * @see #getInstantAppCookie()
3751     * @see #clearInstantAppCookie()
3752     *
3753     * @throws IllegalArgumentException if the array exceeds max cookie size.
3754     */
3755    public abstract void updateInstantAppCookie(@Nullable byte[] cookie);
3756
3757    /**
3758     * @removed
3759     * @hide
3760     */
3761    public abstract boolean setInstantAppCookie(@Nullable byte[] cookie);
3762
3763    /**
3764     * Get a list of shared libraries that are available on the
3765     * system.
3766     *
3767     * @return An array of shared library names that are
3768     * available on the system, or null if none are installed.
3769     *
3770     */
3771    public abstract String[] getSystemSharedLibraryNames();
3772
3773    /**
3774     * Get a list of shared libraries on the device.
3775     *
3776     * @param flags To filter the libraries to return.
3777     * @return The shared library list.
3778     *
3779     * @see #MATCH_UNINSTALLED_PACKAGES
3780     */
3781    public abstract @NonNull List<SharedLibraryInfo> getSharedLibraries(
3782            @InstallFlags int flags);
3783
3784    /**
3785     * Get a list of shared libraries on the device.
3786     *
3787     * @param flags To filter the libraries to return.
3788     * @param userId The user to query for.
3789     * @return The shared library list.
3790     *
3791     * @see #MATCH_FACTORY_ONLY
3792     * @see #MATCH_KNOWN_PACKAGES
3793     * @see #MATCH_ANY_USER
3794     * @see #MATCH_UNINSTALLED_PACKAGES
3795     *
3796     * @hide
3797     */
3798    public abstract @NonNull List<SharedLibraryInfo> getSharedLibrariesAsUser(
3799            @InstallFlags int flags, @UserIdInt int userId);
3800
3801    /**
3802     * Get the name of the package hosting the services shared library.
3803     *
3804     * @return The library host package.
3805     *
3806     * @hide
3807     */
3808    public abstract @NonNull String getServicesSystemSharedLibraryPackageName();
3809
3810    /**
3811     * Get the name of the package hosting the shared components shared library.
3812     *
3813     * @return The library host package.
3814     *
3815     * @hide
3816     */
3817    public abstract @NonNull String getSharedSystemSharedLibraryPackageName();
3818
3819    /**
3820     * Returns the names of the packages that have been changed
3821     * [eg. added, removed or updated] since the given sequence
3822     * number.
3823     * <p>If no packages have been changed, returns <code>null</code>.
3824     * <p>The sequence number starts at <code>0</code> and is
3825     * reset every boot.
3826     * @param sequenceNumber The first sequence number for which to retrieve package changes.
3827     * @see Settings.Global#BOOT_COUNT
3828     */
3829    public abstract @Nullable ChangedPackages getChangedPackages(
3830            @IntRange(from=0) int sequenceNumber);
3831
3832    /**
3833     * Get a list of features that are available on the
3834     * system.
3835     *
3836     * @return An array of FeatureInfo classes describing the features
3837     * that are available on the system, or null if there are none(!!).
3838     */
3839    public abstract FeatureInfo[] getSystemAvailableFeatures();
3840
3841    /**
3842     * Check whether the given feature name is one of the available features as
3843     * returned by {@link #getSystemAvailableFeatures()}. This tests for the
3844     * presence of <em>any</em> version of the given feature name; use
3845     * {@link #hasSystemFeature(String, int)} to check for a minimum version.
3846     *
3847     * @return Returns true if the devices supports the feature, else false.
3848     */
3849    public abstract boolean hasSystemFeature(String name);
3850
3851    /**
3852     * Check whether the given feature name and version is one of the available
3853     * features as returned by {@link #getSystemAvailableFeatures()}. Since
3854     * features are defined to always be backwards compatible, this returns true
3855     * if the available feature version is greater than or equal to the
3856     * requested version.
3857     *
3858     * @return Returns true if the devices supports the feature, else false.
3859     */
3860    public abstract boolean hasSystemFeature(String name, int version);
3861
3862    /**
3863     * Determine the best action to perform for a given Intent. This is how
3864     * {@link Intent#resolveActivity} finds an activity if a class has not been
3865     * explicitly specified.
3866     * <p>
3867     * <em>Note:</em> if using an implicit Intent (without an explicit
3868     * ComponentName specified), be sure to consider whether to set the
3869     * {@link #MATCH_DEFAULT_ONLY} only flag. You need to do so to resolve the
3870     * activity in the same way that
3871     * {@link android.content.Context#startActivity(Intent)} and
3872     * {@link android.content.Intent#resolveActivity(PackageManager)
3873     * Intent.resolveActivity(PackageManager)} do.
3874     * </p>
3875     *
3876     * @param intent An intent containing all of the desired specification
3877     *            (action, data, type, category, and/or component).
3878     * @param flags Additional option flags to modify the data returned. The
3879     *            most important is {@link #MATCH_DEFAULT_ONLY}, to limit the
3880     *            resolution to only those activities that support the
3881     *            {@link android.content.Intent#CATEGORY_DEFAULT}.
3882     * @return Returns a ResolveInfo object containing the final activity intent
3883     *         that was determined to be the best action. Returns null if no
3884     *         matching activity was found. If multiple matching activities are
3885     *         found and there is no default set, returns a ResolveInfo object
3886     *         containing something else, such as the activity resolver.
3887     */
3888    public abstract ResolveInfo resolveActivity(Intent intent, @ResolveInfoFlags int flags);
3889
3890    /**
3891     * Determine the best action to perform for a given Intent for a given user.
3892     * This is how {@link Intent#resolveActivity} finds an activity if a class
3893     * has not been explicitly specified.
3894     * <p>
3895     * <em>Note:</em> if using an implicit Intent (without an explicit
3896     * ComponentName specified), be sure to consider whether to set the
3897     * {@link #MATCH_DEFAULT_ONLY} only flag. You need to do so to resolve the
3898     * activity in the same way that
3899     * {@link android.content.Context#startActivity(Intent)} and
3900     * {@link android.content.Intent#resolveActivity(PackageManager)
3901     * Intent.resolveActivity(PackageManager)} do.
3902     * </p>
3903     *
3904     * @param intent An intent containing all of the desired specification
3905     *            (action, data, type, category, and/or component).
3906     * @param flags Additional option flags to modify the data returned. The
3907     *            most important is {@link #MATCH_DEFAULT_ONLY}, to limit the
3908     *            resolution to only those activities that support the
3909     *            {@link android.content.Intent#CATEGORY_DEFAULT}.
3910     * @param userId The user id.
3911     * @return Returns a ResolveInfo object containing the final activity intent
3912     *         that was determined to be the best action. Returns null if no
3913     *         matching activity was found. If multiple matching activities are
3914     *         found and there is no default set, returns a ResolveInfo object
3915     *         containing something else, such as the activity resolver.
3916     * @hide
3917     */
3918    public abstract ResolveInfo resolveActivityAsUser(Intent intent, @ResolveInfoFlags int flags,
3919            @UserIdInt int userId);
3920
3921    /**
3922     * Retrieve all activities that can be performed for the given intent.
3923     *
3924     * @param intent The desired intent as per resolveActivity().
3925     * @param flags Additional option flags to modify the data returned. The
3926     *            most important is {@link #MATCH_DEFAULT_ONLY}, to limit the
3927     *            resolution to only those activities that support the
3928     *            {@link android.content.Intent#CATEGORY_DEFAULT}. Or, set
3929     *            {@link #MATCH_ALL} to prevent any filtering of the results.
3930     * @return Returns a List of ResolveInfo objects containing one entry for
3931     *         each matching activity, ordered from best to worst. In other
3932     *         words, the first item is what would be returned by
3933     *         {@link #resolveActivity}. If there are no matching activities, an
3934     *         empty list is returned.
3935     */
3936    public abstract List<ResolveInfo> queryIntentActivities(Intent intent,
3937            @ResolveInfoFlags int flags);
3938
3939    /**
3940     * Retrieve all activities that can be performed for the given intent, for a
3941     * specific user.
3942     *
3943     * @param intent The desired intent as per resolveActivity().
3944     * @param flags Additional option flags to modify the data returned. The
3945     *            most important is {@link #MATCH_DEFAULT_ONLY}, to limit the
3946     *            resolution to only those activities that support the
3947     *            {@link android.content.Intent#CATEGORY_DEFAULT}. Or, set
3948     *            {@link #MATCH_ALL} to prevent any filtering of the results.
3949     * @return Returns a List of ResolveInfo objects containing one entry for
3950     *         each matching activity, ordered from best to worst. In other
3951     *         words, the first item is what would be returned by
3952     *         {@link #resolveActivity}. If there are no matching activities, an
3953     *         empty list is returned.
3954     * @hide
3955     */
3956    public abstract List<ResolveInfo> queryIntentActivitiesAsUser(Intent intent,
3957            @ResolveInfoFlags int flags, @UserIdInt int userId);
3958
3959    /**
3960     * Retrieve a set of activities that should be presented to the user as
3961     * similar options. This is like {@link #queryIntentActivities}, except it
3962     * also allows you to supply a list of more explicit Intents that you would
3963     * like to resolve to particular options, and takes care of returning the
3964     * final ResolveInfo list in a reasonable order, with no duplicates, based
3965     * on those inputs.
3966     *
3967     * @param caller The class name of the activity that is making the request.
3968     *            This activity will never appear in the output list. Can be
3969     *            null.
3970     * @param specifics An array of Intents that should be resolved to the first
3971     *            specific results. Can be null.
3972     * @param intent The desired intent as per resolveActivity().
3973     * @param flags Additional option flags to modify the data returned. The
3974     *            most important is {@link #MATCH_DEFAULT_ONLY}, to limit the
3975     *            resolution to only those activities that support the
3976     *            {@link android.content.Intent#CATEGORY_DEFAULT}.
3977     * @return Returns a List of ResolveInfo objects containing one entry for
3978     *         each matching activity. The list is ordered first by all of the
3979     *         intents resolved in <var>specifics</var> and then any additional
3980     *         activities that can handle <var>intent</var> but did not get
3981     *         included by one of the <var>specifics</var> intents. If there are
3982     *         no matching activities, an empty list is returned.
3983     */
3984    public abstract List<ResolveInfo> queryIntentActivityOptions(@Nullable ComponentName caller,
3985            @Nullable Intent[] specifics, Intent intent, @ResolveInfoFlags int flags);
3986
3987    /**
3988     * Retrieve all receivers that can handle a broadcast of the given intent.
3989     *
3990     * @param intent The desired intent as per resolveActivity().
3991     * @param flags Additional option flags to modify the data returned.
3992     * @return Returns a List of ResolveInfo objects containing one entry for
3993     *         each matching receiver, ordered from best to worst. If there are
3994     *         no matching receivers, an empty list or null is returned.
3995     */
3996    public abstract List<ResolveInfo> queryBroadcastReceivers(Intent intent,
3997            @ResolveInfoFlags int flags);
3998
3999    /**
4000     * Retrieve all receivers that can handle a broadcast of the given intent,
4001     * for a specific user.
4002     *
4003     * @param intent The desired intent as per resolveActivity().
4004     * @param flags Additional option flags to modify the data returned.
4005     * @param userHandle UserHandle of the user being queried.
4006     * @return Returns a List of ResolveInfo objects containing one entry for
4007     *         each matching receiver, ordered from best to worst. If there are
4008     *         no matching receivers, an empty list or null is returned.
4009     * @hide
4010     */
4011    @SystemApi
4012    public List<ResolveInfo> queryBroadcastReceiversAsUser(Intent intent,
4013            @ResolveInfoFlags int flags, UserHandle userHandle) {
4014        return queryBroadcastReceiversAsUser(intent, flags, userHandle.getIdentifier());
4015    }
4016
4017    /**
4018     * @hide
4019     */
4020    public abstract List<ResolveInfo> queryBroadcastReceiversAsUser(Intent intent,
4021            @ResolveInfoFlags int flags, @UserIdInt int userId);
4022
4023
4024    /** {@hide} */
4025    @Deprecated
4026    public List<ResolveInfo> queryBroadcastReceivers(Intent intent,
4027            @ResolveInfoFlags int flags, @UserIdInt int userId) {
4028        final String msg = "Shame on you for calling the hidden API "
4029                + "queryBroadcastReceivers(). Shame!";
4030        if (VMRuntime.getRuntime().getTargetSdkVersion() >= Build.VERSION_CODES.O) {
4031            throw new UnsupportedOperationException(msg);
4032        } else {
4033            Log.d(TAG, msg);
4034            return queryBroadcastReceiversAsUser(intent, flags, userId);
4035        }
4036    }
4037
4038    /**
4039     * Determine the best service to handle for a given Intent.
4040     *
4041     * @param intent An intent containing all of the desired specification
4042     *            (action, data, type, category, and/or component).
4043     * @param flags Additional option flags to modify the data returned.
4044     * @return Returns a ResolveInfo object containing the final service intent
4045     *         that was determined to be the best action. Returns null if no
4046     *         matching service was found.
4047     */
4048    public abstract ResolveInfo resolveService(Intent intent, @ResolveInfoFlags int flags);
4049
4050    /**
4051     * Retrieve all services that can match the given intent.
4052     *
4053     * @param intent The desired intent as per resolveService().
4054     * @param flags Additional option flags to modify the data returned.
4055     * @return Returns a List of ResolveInfo objects containing one entry for
4056     *         each matching service, ordered from best to worst. In other
4057     *         words, the first item is what would be returned by
4058     *         {@link #resolveService}. If there are no matching services, an
4059     *         empty list or null is returned.
4060     */
4061    public abstract List<ResolveInfo> queryIntentServices(Intent intent,
4062            @ResolveInfoFlags int flags);
4063
4064    /**
4065     * Retrieve all services that can match the given intent for a given user.
4066     *
4067     * @param intent The desired intent as per resolveService().
4068     * @param flags Additional option flags to modify the data returned.
4069     * @param userId The user id.
4070     * @return Returns a List of ResolveInfo objects containing one entry for
4071     *         each matching service, ordered from best to worst. In other
4072     *         words, the first item is what would be returned by
4073     *         {@link #resolveService}. If there are no matching services, an
4074     *         empty list or null is returned.
4075     * @hide
4076     */
4077    public abstract List<ResolveInfo> queryIntentServicesAsUser(Intent intent,
4078            @ResolveInfoFlags int flags, @UserIdInt int userId);
4079
4080    /**
4081     * Retrieve all providers that can match the given intent.
4082     *
4083     * @param intent An intent containing all of the desired specification
4084     *            (action, data, type, category, and/or component).
4085     * @param flags Additional option flags to modify the data returned.
4086     * @param userId The user id.
4087     * @return Returns a List of ResolveInfo objects containing one entry for
4088     *         each matching provider, ordered from best to worst. If there are
4089     *         no matching services, an empty list or null is returned.
4090     * @hide
4091     */
4092    public abstract List<ResolveInfo> queryIntentContentProvidersAsUser(
4093            Intent intent, @ResolveInfoFlags int flags, @UserIdInt int userId);
4094
4095    /**
4096     * Retrieve all providers that can match the given intent.
4097     *
4098     * @param intent An intent containing all of the desired specification
4099     *            (action, data, type, category, and/or component).
4100     * @param flags Additional option flags to modify the data returned.
4101     * @return Returns a List of ResolveInfo objects containing one entry for
4102     *         each matching provider, ordered from best to worst. If there are
4103     *         no matching services, an empty list or null is returned.
4104     */
4105    public abstract List<ResolveInfo> queryIntentContentProviders(Intent intent,
4106            @ResolveInfoFlags int flags);
4107
4108    /**
4109     * Find a single content provider by its base path name.
4110     *
4111     * @param name The name of the provider to find.
4112     * @param flags Additional option flags to modify the data returned.
4113     * @return A {@link ProviderInfo} object containing information about the
4114     *         provider. If a provider was not found, returns null.
4115     */
4116    public abstract ProviderInfo resolveContentProvider(String name,
4117            @ComponentInfoFlags int flags);
4118
4119    /**
4120     * Find a single content provider by its base path name.
4121     *
4122     * @param name The name of the provider to find.
4123     * @param flags Additional option flags to modify the data returned.
4124     * @param userId The user id.
4125     * @return A {@link ProviderInfo} object containing information about the
4126     *         provider. If a provider was not found, returns null.
4127     * @hide
4128     */
4129    public abstract ProviderInfo resolveContentProviderAsUser(String name,
4130            @ComponentInfoFlags int flags, @UserIdInt int userId);
4131
4132    /**
4133     * Retrieve content provider information.
4134     * <p>
4135     * <em>Note: unlike most other methods, an empty result set is indicated
4136     * by a null return instead of an empty list.</em>
4137     *
4138     * @param processName If non-null, limits the returned providers to only
4139     *            those that are hosted by the given process. If null, all
4140     *            content providers are returned.
4141     * @param uid If <var>processName</var> is non-null, this is the required
4142     *            uid owning the requested content providers.
4143     * @param flags Additional option flags to modify the data returned.
4144     * @return A list of {@link ProviderInfo} objects containing one entry for
4145     *         each provider either matching <var>processName</var> or, if
4146     *         <var>processName</var> is null, all known content providers.
4147     *         <em>If there are no matching providers, null is returned.</em>
4148     */
4149    public abstract List<ProviderInfo> queryContentProviders(
4150            String processName, int uid, @ComponentInfoFlags int flags);
4151
4152    /**
4153     * Same as {@link #queryContentProviders}, except when {@code metaDataKey} is not null,
4154     * it only returns providers which have metadata with the {@code metaDataKey} key.
4155     *
4156     * <p>DO NOT USE the {@code metaDataKey} parameter, unless you're the contacts provider.
4157     * You really shouldn't need it.  Other apps should use {@link #queryIntentContentProviders}
4158     * instead.
4159     *
4160     * <p>The {@code metaDataKey} parameter was added to allow the contacts provider to quickly
4161     * scan the GAL providers on the device.  Unfortunately the discovery protocol used metadata
4162     * to mark GAL providers, rather than intent filters, so we can't use
4163     * {@link #queryIntentContentProviders} for that.
4164     *
4165     * @hide
4166     */
4167    public List<ProviderInfo> queryContentProviders(
4168            String processName, int uid, @ComponentInfoFlags int flags, String metaDataKey) {
4169        // Provide the default implementation for mocks.
4170        return queryContentProviders(processName, uid, flags);
4171    }
4172
4173    /**
4174     * Retrieve all of the information we know about a particular
4175     * instrumentation class.
4176     *
4177     * @param className The full name (i.e.
4178     *            com.google.apps.contacts.InstrumentList) of an Instrumentation
4179     *            class.
4180     * @param flags Additional option flags to modify the data returned.
4181     * @return An {@link InstrumentationInfo} object containing information
4182     *         about the instrumentation.
4183     * @throws NameNotFoundException if a package with the given name cannot be
4184     *             found on the system.
4185     */
4186    public abstract InstrumentationInfo getInstrumentationInfo(ComponentName className,
4187            @InstrumentationInfoFlags int flags) throws NameNotFoundException;
4188
4189    /**
4190     * Retrieve information about available instrumentation code. May be used to
4191     * retrieve either all instrumentation code, or only the code targeting a
4192     * particular package.
4193     *
4194     * @param targetPackage If null, all instrumentation is returned; only the
4195     *            instrumentation targeting this package name is returned.
4196     * @param flags Additional option flags to modify the data returned.
4197     * @return A list of {@link InstrumentationInfo} objects containing one
4198     *         entry for each matching instrumentation. If there are no
4199     *         instrumentation available, returns an empty list.
4200     */
4201    public abstract List<InstrumentationInfo> queryInstrumentation(String targetPackage,
4202            @InstrumentationInfoFlags int flags);
4203
4204    /**
4205     * Retrieve an image from a package.  This is a low-level API used by
4206     * the various package manager info structures (such as
4207     * {@link ComponentInfo} to implement retrieval of their associated
4208     * icon.
4209     *
4210     * @param packageName The name of the package that this icon is coming from.
4211     * Cannot be null.
4212     * @param resid The resource identifier of the desired image.  Cannot be 0.
4213     * @param appInfo Overall information about <var>packageName</var>.  This
4214     * may be null, in which case the application information will be retrieved
4215     * for you if needed; if you already have this information around, it can
4216     * be much more efficient to supply it here.
4217     *
4218     * @return Returns a Drawable holding the requested image.  Returns null if
4219     * an image could not be found for any reason.
4220     */
4221    public abstract Drawable getDrawable(String packageName, @DrawableRes int resid,
4222            ApplicationInfo appInfo);
4223
4224    /**
4225     * Retrieve the icon associated with an activity.  Given the full name of
4226     * an activity, retrieves the information about it and calls
4227     * {@link ComponentInfo#loadIcon ComponentInfo.loadIcon()} to return its icon.
4228     * If the activity cannot be found, NameNotFoundException is thrown.
4229     *
4230     * @param activityName Name of the activity whose icon is to be retrieved.
4231     *
4232     * @return Returns the image of the icon, or the default activity icon if
4233     * it could not be found.  Does not return null.
4234     * @throws NameNotFoundException Thrown if the resources for the given
4235     * activity could not be loaded.
4236     *
4237     * @see #getActivityIcon(Intent)
4238     */
4239    public abstract Drawable getActivityIcon(ComponentName activityName)
4240            throws NameNotFoundException;
4241
4242    /**
4243     * Retrieve the icon associated with an Intent.  If intent.getClassName() is
4244     * set, this simply returns the result of
4245     * getActivityIcon(intent.getClassName()).  Otherwise it resolves the intent's
4246     * component and returns the icon associated with the resolved component.
4247     * If intent.getClassName() cannot be found or the Intent cannot be resolved
4248     * to a component, NameNotFoundException is thrown.
4249     *
4250     * @param intent The intent for which you would like to retrieve an icon.
4251     *
4252     * @return Returns the image of the icon, or the default activity icon if
4253     * it could not be found.  Does not return null.
4254     * @throws NameNotFoundException Thrown if the resources for application
4255     * matching the given intent could not be loaded.
4256     *
4257     * @see #getActivityIcon(ComponentName)
4258     */
4259    public abstract Drawable getActivityIcon(Intent intent)
4260            throws NameNotFoundException;
4261
4262    /**
4263     * Retrieve the banner associated with an activity. Given the full name of
4264     * an activity, retrieves the information about it and calls
4265     * {@link ComponentInfo#loadIcon ComponentInfo.loadIcon()} to return its
4266     * banner. If the activity cannot be found, NameNotFoundException is thrown.
4267     *
4268     * @param activityName Name of the activity whose banner is to be retrieved.
4269     * @return Returns the image of the banner, or null if the activity has no
4270     *         banner specified.
4271     * @throws NameNotFoundException Thrown if the resources for the given
4272     *             activity could not be loaded.
4273     * @see #getActivityBanner(Intent)
4274     */
4275    public abstract Drawable getActivityBanner(ComponentName activityName)
4276            throws NameNotFoundException;
4277
4278    /**
4279     * Retrieve the banner associated with an Intent. If intent.getClassName()
4280     * is set, this simply returns the result of
4281     * getActivityBanner(intent.getClassName()). Otherwise it resolves the
4282     * intent's component and returns the banner associated with the resolved
4283     * component. If intent.getClassName() cannot be found or the Intent cannot
4284     * be resolved to a component, NameNotFoundException is thrown.
4285     *
4286     * @param intent The intent for which you would like to retrieve a banner.
4287     * @return Returns the image of the banner, or null if the activity has no
4288     *         banner specified.
4289     * @throws NameNotFoundException Thrown if the resources for application
4290     *             matching the given intent could not be loaded.
4291     * @see #getActivityBanner(ComponentName)
4292     */
4293    public abstract Drawable getActivityBanner(Intent intent)
4294            throws NameNotFoundException;
4295
4296    /**
4297     * Return the generic icon for an activity that is used when no specific
4298     * icon is defined.
4299     *
4300     * @return Drawable Image of the icon.
4301     */
4302    public abstract Drawable getDefaultActivityIcon();
4303
4304    /**
4305     * Retrieve the icon associated with an application.  If it has not defined
4306     * an icon, the default app icon is returned.  Does not return null.
4307     *
4308     * @param info Information about application being queried.
4309     *
4310     * @return Returns the image of the icon, or the default application icon
4311     * if it could not be found.
4312     *
4313     * @see #getApplicationIcon(String)
4314     */
4315    public abstract Drawable getApplicationIcon(ApplicationInfo info);
4316
4317    /**
4318     * Retrieve the icon associated with an application.  Given the name of the
4319     * application's package, retrieves the information about it and calls
4320     * getApplicationIcon() to return its icon. If the application cannot be
4321     * found, NameNotFoundException is thrown.
4322     *
4323     * @param packageName Name of the package whose application icon is to be
4324     *                    retrieved.
4325     *
4326     * @return Returns the image of the icon, or the default application icon
4327     * if it could not be found.  Does not return null.
4328     * @throws NameNotFoundException Thrown if the resources for the given
4329     * application could not be loaded.
4330     *
4331     * @see #getApplicationIcon(ApplicationInfo)
4332     */
4333    public abstract Drawable getApplicationIcon(String packageName)
4334            throws NameNotFoundException;
4335
4336    /**
4337     * Retrieve the banner associated with an application.
4338     *
4339     * @param info Information about application being queried.
4340     * @return Returns the image of the banner or null if the application has no
4341     *         banner specified.
4342     * @see #getApplicationBanner(String)
4343     */
4344    public abstract Drawable getApplicationBanner(ApplicationInfo info);
4345
4346    /**
4347     * Retrieve the banner associated with an application. Given the name of the
4348     * application's package, retrieves the information about it and calls
4349     * getApplicationIcon() to return its banner. If the application cannot be
4350     * found, NameNotFoundException is thrown.
4351     *
4352     * @param packageName Name of the package whose application banner is to be
4353     *            retrieved.
4354     * @return Returns the image of the banner or null if the application has no
4355     *         banner specified.
4356     * @throws NameNotFoundException Thrown if the resources for the given
4357     *             application could not be loaded.
4358     * @see #getApplicationBanner(ApplicationInfo)
4359     */
4360    public abstract Drawable getApplicationBanner(String packageName)
4361            throws NameNotFoundException;
4362
4363    /**
4364     * Retrieve the logo associated with an activity. Given the full name of an
4365     * activity, retrieves the information about it and calls
4366     * {@link ComponentInfo#loadLogo ComponentInfo.loadLogo()} to return its
4367     * logo. If the activity cannot be found, NameNotFoundException is thrown.
4368     *
4369     * @param activityName Name of the activity whose logo is to be retrieved.
4370     * @return Returns the image of the logo or null if the activity has no logo
4371     *         specified.
4372     * @throws NameNotFoundException Thrown if the resources for the given
4373     *             activity could not be loaded.
4374     * @see #getActivityLogo(Intent)
4375     */
4376    public abstract Drawable getActivityLogo(ComponentName activityName)
4377            throws NameNotFoundException;
4378
4379    /**
4380     * Retrieve the logo associated with an Intent.  If intent.getClassName() is
4381     * set, this simply returns the result of
4382     * getActivityLogo(intent.getClassName()).  Otherwise it resolves the intent's
4383     * component and returns the logo associated with the resolved component.
4384     * If intent.getClassName() cannot be found or the Intent cannot be resolved
4385     * to a component, NameNotFoundException is thrown.
4386     *
4387     * @param intent The intent for which you would like to retrieve a logo.
4388     *
4389     * @return Returns the image of the logo, or null if the activity has no
4390     * logo specified.
4391     *
4392     * @throws NameNotFoundException Thrown if the resources for application
4393     * matching the given intent could not be loaded.
4394     *
4395     * @see #getActivityLogo(ComponentName)
4396     */
4397    public abstract Drawable getActivityLogo(Intent intent)
4398            throws NameNotFoundException;
4399
4400    /**
4401     * Retrieve the logo associated with an application.  If it has not specified
4402     * a logo, this method returns null.
4403     *
4404     * @param info Information about application being queried.
4405     *
4406     * @return Returns the image of the logo, or null if no logo is specified
4407     * by the application.
4408     *
4409     * @see #getApplicationLogo(String)
4410     */
4411    public abstract Drawable getApplicationLogo(ApplicationInfo info);
4412
4413    /**
4414     * Retrieve the logo associated with an application.  Given the name of the
4415     * application's package, retrieves the information about it and calls
4416     * getApplicationLogo() to return its logo. If the application cannot be
4417     * found, NameNotFoundException is thrown.
4418     *
4419     * @param packageName Name of the package whose application logo is to be
4420     *                    retrieved.
4421     *
4422     * @return Returns the image of the logo, or null if no application logo
4423     * has been specified.
4424     *
4425     * @throws NameNotFoundException Thrown if the resources for the given
4426     * application could not be loaded.
4427     *
4428     * @see #getApplicationLogo(ApplicationInfo)
4429     */
4430    public abstract Drawable getApplicationLogo(String packageName)
4431            throws NameNotFoundException;
4432
4433    /**
4434     * If the target user is a managed profile, then this returns a badged copy of the given icon
4435     * to be able to distinguish it from the original icon. For badging an arbitrary drawable use
4436     * {@link #getUserBadgedDrawableForDensity(
4437     * android.graphics.drawable.Drawable, UserHandle, android.graphics.Rect, int)}.
4438     * <p>
4439     * If the original drawable is a BitmapDrawable and the backing bitmap is
4440     * mutable as per {@link android.graphics.Bitmap#isMutable()}, the badging
4441     * is performed in place and the original drawable is returned.
4442     * </p>
4443     *
4444     * @param icon The icon to badge.
4445     * @param user The target user.
4446     * @return A drawable that combines the original icon and a badge as
4447     *         determined by the system.
4448     */
4449    public abstract Drawable getUserBadgedIcon(Drawable icon, UserHandle user);
4450
4451    /**
4452     * If the target user is a managed profile of the calling user or the caller
4453     * is itself a managed profile, then this returns a badged copy of the given
4454     * drawable allowing the user to distinguish it from the original drawable.
4455     * The caller can specify the location in the bounds of the drawable to be
4456     * badged where the badge should be applied as well as the density of the
4457     * badge to be used.
4458     * <p>
4459     * If the original drawable is a BitmapDrawable and the backing bitmap is
4460     * mutable as per {@link android.graphics.Bitmap#isMutable()}, the badging
4461     * is performed in place and the original drawable is returned.
4462     * </p>
4463     *
4464     * @param drawable The drawable to badge.
4465     * @param user The target user.
4466     * @param badgeLocation Where in the bounds of the badged drawable to place
4467     *         the badge. If it's {@code null}, the badge is applied on top of the entire
4468     *         drawable being badged.
4469     * @param badgeDensity The optional desired density for the badge as per
4470     *         {@link android.util.DisplayMetrics#densityDpi}. If it's not positive,
4471     *         the density of the display is used.
4472     * @return A drawable that combines the original drawable and a badge as
4473     *         determined by the system.
4474     */
4475    public abstract Drawable getUserBadgedDrawableForDensity(Drawable drawable,
4476            UserHandle user, Rect badgeLocation, int badgeDensity);
4477
4478    /**
4479     * If the target user is a managed profile of the calling user or the caller
4480     * is itself a managed profile, then this returns a drawable to use as a small
4481     * icon to include in a view to distinguish it from the original icon.
4482     *
4483     * @param user The target user.
4484     * @param density The optional desired density for the badge as per
4485     *         {@link android.util.DisplayMetrics#densityDpi}. If not provided
4486     *         the density of the current display is used.
4487     * @return the drawable or null if no drawable is required.
4488     * @hide
4489     */
4490    public abstract Drawable getUserBadgeForDensity(UserHandle user, int density);
4491
4492    /**
4493     * If the target user is a managed profile of the calling user or the caller
4494     * is itself a managed profile, then this returns a drawable to use as a small
4495     * icon to include in a view to distinguish it from the original icon. This version
4496     * doesn't have background protection and should be used over a light background instead of
4497     * a badge.
4498     *
4499     * @param user The target user.
4500     * @param density The optional desired density for the badge as per
4501     *         {@link android.util.DisplayMetrics#densityDpi}. If not provided
4502     *         the density of the current display is used.
4503     * @return the drawable or null if no drawable is required.
4504     * @hide
4505     */
4506    public abstract Drawable getUserBadgeForDensityNoBackground(UserHandle user, int density);
4507
4508    /**
4509     * If the target user is a managed profile of the calling user or the caller
4510     * is itself a managed profile, then this returns a copy of the label with
4511     * badging for accessibility services like talkback. E.g. passing in "Email"
4512     * and it might return "Work Email" for Email in the work profile.
4513     *
4514     * @param label The label to change.
4515     * @param user The target user.
4516     * @return A label that combines the original label and a badge as
4517     *         determined by the system.
4518     */
4519    public abstract CharSequence getUserBadgedLabel(CharSequence label, UserHandle user);
4520
4521    /**
4522     * Retrieve text from a package.  This is a low-level API used by
4523     * the various package manager info structures (such as
4524     * {@link ComponentInfo} to implement retrieval of their associated
4525     * labels and other text.
4526     *
4527     * @param packageName The name of the package that this text is coming from.
4528     * Cannot be null.
4529     * @param resid The resource identifier of the desired text.  Cannot be 0.
4530     * @param appInfo Overall information about <var>packageName</var>.  This
4531     * may be null, in which case the application information will be retrieved
4532     * for you if needed; if you already have this information around, it can
4533     * be much more efficient to supply it here.
4534     *
4535     * @return Returns a CharSequence holding the requested text.  Returns null
4536     * if the text could not be found for any reason.
4537     */
4538    public abstract CharSequence getText(String packageName, @StringRes int resid,
4539            ApplicationInfo appInfo);
4540
4541    /**
4542     * Retrieve an XML file from a package.  This is a low-level API used to
4543     * retrieve XML meta data.
4544     *
4545     * @param packageName The name of the package that this xml is coming from.
4546     * Cannot be null.
4547     * @param resid The resource identifier of the desired xml.  Cannot be 0.
4548     * @param appInfo Overall information about <var>packageName</var>.  This
4549     * may be null, in which case the application information will be retrieved
4550     * for you if needed; if you already have this information around, it can
4551     * be much more efficient to supply it here.
4552     *
4553     * @return Returns an XmlPullParser allowing you to parse out the XML
4554     * data.  Returns null if the xml resource could not be found for any
4555     * reason.
4556     */
4557    public abstract XmlResourceParser getXml(String packageName, @XmlRes int resid,
4558            ApplicationInfo appInfo);
4559
4560    /**
4561     * Return the label to use for this application.
4562     *
4563     * @return Returns the label associated with this application, or null if
4564     * it could not be found for any reason.
4565     * @param info The application to get the label of.
4566     */
4567    public abstract CharSequence getApplicationLabel(ApplicationInfo info);
4568
4569    /**
4570     * Retrieve the resources associated with an activity.  Given the full
4571     * name of an activity, retrieves the information about it and calls
4572     * getResources() to return its application's resources.  If the activity
4573     * cannot be found, NameNotFoundException is thrown.
4574     *
4575     * @param activityName Name of the activity whose resources are to be
4576     *                     retrieved.
4577     *
4578     * @return Returns the application's Resources.
4579     * @throws NameNotFoundException Thrown if the resources for the given
4580     * application could not be loaded.
4581     *
4582     * @see #getResourcesForApplication(ApplicationInfo)
4583     */
4584    public abstract Resources getResourcesForActivity(ComponentName activityName)
4585            throws NameNotFoundException;
4586
4587    /**
4588     * Retrieve the resources for an application.  Throws NameNotFoundException
4589     * if the package is no longer installed.
4590     *
4591     * @param app Information about the desired application.
4592     *
4593     * @return Returns the application's Resources.
4594     * @throws NameNotFoundException Thrown if the resources for the given
4595     * application could not be loaded (most likely because it was uninstalled).
4596     */
4597    public abstract Resources getResourcesForApplication(ApplicationInfo app)
4598            throws NameNotFoundException;
4599
4600    /**
4601     * Retrieve the resources associated with an application.  Given the full
4602     * package name of an application, retrieves the information about it and
4603     * calls getResources() to return its application's resources.  If the
4604     * appPackageName cannot be found, NameNotFoundException is thrown.
4605     *
4606     * @param appPackageName Package name of the application whose resources
4607     *                       are to be retrieved.
4608     *
4609     * @return Returns the application's Resources.
4610     * @throws NameNotFoundException Thrown if the resources for the given
4611     * application could not be loaded.
4612     *
4613     * @see #getResourcesForApplication(ApplicationInfo)
4614     */
4615    public abstract Resources getResourcesForApplication(String appPackageName)
4616            throws NameNotFoundException;
4617
4618    /** @hide */
4619    public abstract Resources getResourcesForApplicationAsUser(String appPackageName,
4620            @UserIdInt int userId) throws NameNotFoundException;
4621
4622    /**
4623     * Retrieve overall information about an application package defined in a
4624     * package archive file
4625     *
4626     * @param archiveFilePath The path to the archive file
4627     * @param flags Additional option flags to modify the data returned.
4628     * @return A PackageInfo object containing information about the package
4629     *         archive. If the package could not be parsed, returns null.
4630     */
4631    public PackageInfo getPackageArchiveInfo(String archiveFilePath, @PackageInfoFlags int flags) {
4632        final PackageParser parser = new PackageParser();
4633        parser.setCallback(new PackageParser.CallbackImpl(this));
4634        final File apkFile = new File(archiveFilePath);
4635        try {
4636            if ((flags & (MATCH_DIRECT_BOOT_UNAWARE | MATCH_DIRECT_BOOT_AWARE)) != 0) {
4637                // Caller expressed an explicit opinion about what encryption
4638                // aware/unaware components they want to see, so fall through and
4639                // give them what they want
4640            } else {
4641                // Caller expressed no opinion, so match everything
4642                flags |= MATCH_DIRECT_BOOT_AWARE | MATCH_DIRECT_BOOT_UNAWARE;
4643            }
4644
4645            PackageParser.Package pkg = parser.parseMonolithicPackage(apkFile, 0);
4646            if ((flags & GET_SIGNATURES) != 0) {
4647                PackageParser.collectCertificates(pkg, 0);
4648            }
4649            PackageUserState state = new PackageUserState();
4650            return PackageParser.generatePackageInfo(pkg, null, flags, 0, 0, null, state);
4651        } catch (PackageParserException e) {
4652            return null;
4653        }
4654    }
4655
4656    /**
4657     * @deprecated replaced by {@link PackageInstaller}
4658     * @hide
4659     */
4660    @Deprecated
4661    public abstract void installPackage(
4662            Uri packageURI,
4663            IPackageInstallObserver observer,
4664            @InstallFlags int flags,
4665            String installerPackageName);
4666    /**
4667     * @deprecated replaced by {@link PackageInstaller}
4668     * @hide
4669     */
4670    @Deprecated
4671    public abstract void installPackage(
4672            Uri packageURI,
4673            PackageInstallObserver observer,
4674            @InstallFlags int flags,
4675            String installerPackageName);
4676
4677    /**
4678     * If there is already an application with the given package name installed
4679     * on the system for other users, also install it for the calling user.
4680     * @hide
4681     */
4682    public abstract int installExistingPackage(String packageName) throws NameNotFoundException;
4683
4684    /**
4685     * If there is already an application with the given package name installed
4686     * on the system for other users, also install it for the calling user.
4687     * @hide
4688     */
4689    public abstract int installExistingPackage(String packageName, @InstallReason int installReason)
4690            throws NameNotFoundException;
4691
4692    /**
4693     * If there is already an application with the given package name installed
4694     * on the system for other users, also install it for the specified user.
4695     * @hide
4696     */
4697     @RequiresPermission(anyOf = {
4698            Manifest.permission.INSTALL_PACKAGES,
4699            Manifest.permission.INTERACT_ACROSS_USERS_FULL})
4700    public abstract int installExistingPackageAsUser(String packageName, @UserIdInt int userId)
4701            throws NameNotFoundException;
4702
4703    /**
4704     * Allows a package listening to the
4705     * {@link Intent#ACTION_PACKAGE_NEEDS_VERIFICATION package verification
4706     * broadcast} to respond to the package manager. The response must include
4707     * the {@code verificationCode} which is one of
4708     * {@link PackageManager#VERIFICATION_ALLOW} or
4709     * {@link PackageManager#VERIFICATION_REJECT}.
4710     *
4711     * @param id pending package identifier as passed via the
4712     *            {@link PackageManager#EXTRA_VERIFICATION_ID} Intent extra.
4713     * @param verificationCode either {@link PackageManager#VERIFICATION_ALLOW}
4714     *            or {@link PackageManager#VERIFICATION_REJECT}.
4715     * @throws SecurityException if the caller does not have the
4716     *            PACKAGE_VERIFICATION_AGENT permission.
4717     */
4718    public abstract void verifyPendingInstall(int id, int verificationCode);
4719
4720    /**
4721     * Allows a package listening to the
4722     * {@link Intent#ACTION_PACKAGE_NEEDS_VERIFICATION package verification
4723     * broadcast} to extend the default timeout for a response and declare what
4724     * action to perform after the timeout occurs. The response must include
4725     * the {@code verificationCodeAtTimeout} which is one of
4726     * {@link PackageManager#VERIFICATION_ALLOW} or
4727     * {@link PackageManager#VERIFICATION_REJECT}.
4728     *
4729     * This method may only be called once per package id. Additional calls
4730     * will have no effect.
4731     *
4732     * @param id pending package identifier as passed via the
4733     *            {@link PackageManager#EXTRA_VERIFICATION_ID} Intent extra.
4734     * @param verificationCodeAtTimeout either
4735     *            {@link PackageManager#VERIFICATION_ALLOW} or
4736     *            {@link PackageManager#VERIFICATION_REJECT}. If
4737     *            {@code verificationCodeAtTimeout} is neither
4738     *            {@link PackageManager#VERIFICATION_ALLOW} or
4739     *            {@link PackageManager#VERIFICATION_REJECT}, then
4740     *            {@code verificationCodeAtTimeout} will default to
4741     *            {@link PackageManager#VERIFICATION_REJECT}.
4742     * @param millisecondsToDelay the amount of time requested for the timeout.
4743     *            Must be positive and less than
4744     *            {@link PackageManager#MAXIMUM_VERIFICATION_TIMEOUT}. If
4745     *            {@code millisecondsToDelay} is out of bounds,
4746     *            {@code millisecondsToDelay} will be set to the closest in
4747     *            bounds value; namely, 0 or
4748     *            {@link PackageManager#MAXIMUM_VERIFICATION_TIMEOUT}.
4749     * @throws SecurityException if the caller does not have the
4750     *            PACKAGE_VERIFICATION_AGENT permission.
4751     */
4752    public abstract void extendVerificationTimeout(int id,
4753            int verificationCodeAtTimeout, long millisecondsToDelay);
4754
4755    /**
4756     * Allows a package listening to the
4757     * {@link Intent#ACTION_INTENT_FILTER_NEEDS_VERIFICATION} intent filter verification
4758     * broadcast to respond to the package manager. The response must include
4759     * the {@code verificationCode} which is one of
4760     * {@link PackageManager#INTENT_FILTER_VERIFICATION_SUCCESS} or
4761     * {@link PackageManager#INTENT_FILTER_VERIFICATION_FAILURE}.
4762     *
4763     * @param verificationId pending package identifier as passed via the
4764     *            {@link PackageManager#EXTRA_VERIFICATION_ID} Intent extra.
4765     * @param verificationCode either {@link PackageManager#INTENT_FILTER_VERIFICATION_SUCCESS}
4766     *            or {@link PackageManager#INTENT_FILTER_VERIFICATION_FAILURE}.
4767     * @param failedDomains a list of failed domains if the verificationCode is
4768     *            {@link PackageManager#INTENT_FILTER_VERIFICATION_FAILURE}, otherwise null;
4769     * @throws SecurityException if the caller does not have the
4770     *            INTENT_FILTER_VERIFICATION_AGENT permission.
4771     *
4772     * @hide
4773     */
4774    @SystemApi
4775    @RequiresPermission(android.Manifest.permission.INTENT_FILTER_VERIFICATION_AGENT)
4776    public abstract void verifyIntentFilter(int verificationId, int verificationCode,
4777            List<String> failedDomains);
4778
4779    /**
4780     * Get the status of a Domain Verification Result for an IntentFilter. This is
4781     * related to the {@link android.content.IntentFilter#setAutoVerify(boolean)} and
4782     * {@link android.content.IntentFilter#getAutoVerify()}
4783     *
4784     * This is used by the ResolverActivity to change the status depending on what the User select
4785     * in the Disambiguation Dialog and also used by the Settings App for changing the default App
4786     * for a domain.
4787     *
4788     * @param packageName The package name of the Activity associated with the IntentFilter.
4789     * @param userId The user id.
4790     *
4791     * @return The status to set to. This can be
4792     *              {@link #INTENT_FILTER_DOMAIN_VERIFICATION_STATUS_ASK} or
4793     *              {@link #INTENT_FILTER_DOMAIN_VERIFICATION_STATUS_ALWAYS} or
4794     *              {@link #INTENT_FILTER_DOMAIN_VERIFICATION_STATUS_NEVER} or
4795     *              {@link #INTENT_FILTER_DOMAIN_VERIFICATION_STATUS_UNDEFINED}
4796     *
4797     * @hide
4798     */
4799    @SystemApi
4800    public abstract int getIntentVerificationStatusAsUser(String packageName, @UserIdInt int userId);
4801
4802    /**
4803     * Allow to change the status of a Intent Verification status for all IntentFilter of an App.
4804     * This is related to the {@link android.content.IntentFilter#setAutoVerify(boolean)} and
4805     * {@link android.content.IntentFilter#getAutoVerify()}
4806     *
4807     * This is used by the ResolverActivity to change the status depending on what the User select
4808     * in the Disambiguation Dialog and also used by the Settings App for changing the default App
4809     * for a domain.
4810     *
4811     * @param packageName The package name of the Activity associated with the IntentFilter.
4812     * @param status The status to set to. This can be
4813     *              {@link #INTENT_FILTER_DOMAIN_VERIFICATION_STATUS_ASK} or
4814     *              {@link #INTENT_FILTER_DOMAIN_VERIFICATION_STATUS_ALWAYS} or
4815     *              {@link #INTENT_FILTER_DOMAIN_VERIFICATION_STATUS_NEVER}
4816     * @param userId The user id.
4817     *
4818     * @return true if the status has been set. False otherwise.
4819     *
4820     * @hide
4821     */
4822    @SystemApi
4823    @RequiresPermission(android.Manifest.permission.SET_PREFERRED_APPLICATIONS)
4824    public abstract boolean updateIntentVerificationStatusAsUser(String packageName, int status,
4825            @UserIdInt int userId);
4826
4827    /**
4828     * Get the list of IntentFilterVerificationInfo for a specific package and User.
4829     *
4830     * @param packageName the package name. When this parameter is set to a non null value,
4831     *                    the results will be filtered by the package name provided.
4832     *                    Otherwise, there will be no filtering and it will return a list
4833     *                    corresponding for all packages
4834     *
4835     * @return a list of IntentFilterVerificationInfo for a specific package.
4836     *
4837     * @hide
4838     */
4839    @SystemApi
4840    public abstract List<IntentFilterVerificationInfo> getIntentFilterVerifications(
4841            String packageName);
4842
4843    /**
4844     * Get the list of IntentFilter for a specific package.
4845     *
4846     * @param packageName the package name. This parameter is set to a non null value,
4847     *                    the list will contain all the IntentFilter for that package.
4848     *                    Otherwise, the list will be empty.
4849     *
4850     * @return a list of IntentFilter for a specific package.
4851     *
4852     * @hide
4853     */
4854    @SystemApi
4855    public abstract List<IntentFilter> getAllIntentFilters(String packageName);
4856
4857    /**
4858     * Get the default Browser package name for a specific user.
4859     *
4860     * @param userId The user id.
4861     *
4862     * @return the package name of the default Browser for the specified user. If the user id passed
4863     *         is -1 (all users) it will return a null value.
4864     *
4865     * @hide
4866     */
4867    @TestApi
4868    @SystemApi
4869    public abstract String getDefaultBrowserPackageNameAsUser(@UserIdInt int userId);
4870
4871    /**
4872     * Set the default Browser package name for a specific user.
4873     *
4874     * @param packageName The package name of the default Browser.
4875     * @param userId The user id.
4876     *
4877     * @return true if the default Browser for the specified user has been set,
4878     *         otherwise return false. If the user id passed is -1 (all users) this call will not
4879     *         do anything and just return false.
4880     *
4881     * @hide
4882     */
4883    @SystemApi
4884    @RequiresPermission(android.Manifest.permission.SET_PREFERRED_APPLICATIONS)
4885    public abstract boolean setDefaultBrowserPackageNameAsUser(String packageName,
4886            @UserIdInt int userId);
4887
4888    /**
4889     * Change the installer associated with a given package.  There are limitations
4890     * on how the installer package can be changed; in particular:
4891     * <ul>
4892     * <li> A SecurityException will be thrown if <var>installerPackageName</var>
4893     * is not signed with the same certificate as the calling application.
4894     * <li> A SecurityException will be thrown if <var>targetPackage</var> already
4895     * has an installer package, and that installer package is not signed with
4896     * the same certificate as the calling application.
4897     * </ul>
4898     *
4899     * @param targetPackage The installed package whose installer will be changed.
4900     * @param installerPackageName The package name of the new installer.  May be
4901     * null to clear the association.
4902     */
4903    public abstract void setInstallerPackageName(String targetPackage,
4904            String installerPackageName);
4905
4906    /** @hide */
4907    @SystemApi
4908    @RequiresPermission(Manifest.permission.INSTALL_PACKAGES)
4909    public abstract void setUpdateAvailable(String packageName, boolean updateAvaialble);
4910
4911    /**
4912     * Attempts to delete a package. Since this may take a little while, the
4913     * result will be posted back to the given observer. A deletion will fail if
4914     * the calling context lacks the
4915     * {@link android.Manifest.permission#DELETE_PACKAGES} permission, if the
4916     * named package cannot be found, or if the named package is a system
4917     * package.
4918     *
4919     * @param packageName The name of the package to delete
4920     * @param observer An observer callback to get notified when the package
4921     *            deletion is complete.
4922     *            {@link android.content.pm.IPackageDeleteObserver#packageDeleted}
4923     *            will be called when that happens. observer may be null to
4924     *            indicate that no callback is desired.
4925     * @hide
4926     */
4927    @RequiresPermission(Manifest.permission.DELETE_PACKAGES)
4928    public abstract void deletePackage(String packageName, IPackageDeleteObserver observer,
4929            @DeleteFlags int flags);
4930
4931    /**
4932     * Attempts to delete a package. Since this may take a little while, the
4933     * result will be posted back to the given observer. A deletion will fail if
4934     * the named package cannot be found, or if the named package is a system
4935     * package.
4936     *
4937     * @param packageName The name of the package to delete
4938     * @param observer An observer callback to get notified when the package
4939     *            deletion is complete.
4940     *            {@link android.content.pm.IPackageDeleteObserver#packageDeleted}
4941     *            will be called when that happens. observer may be null to
4942     *            indicate that no callback is desired.
4943     * @param userId The user Id
4944     * @hide
4945     */
4946    @RequiresPermission(anyOf = {
4947            Manifest.permission.DELETE_PACKAGES,
4948            Manifest.permission.INTERACT_ACROSS_USERS_FULL})
4949    public abstract void deletePackageAsUser(@NonNull String packageName,
4950            IPackageDeleteObserver observer, @DeleteFlags int flags, @UserIdInt int userId);
4951
4952    /**
4953     * Retrieve the package name of the application that installed a package. This identifies
4954     * which market the package came from.
4955     *
4956     * @param packageName The name of the package to query
4957     */
4958    public abstract String getInstallerPackageName(String packageName);
4959
4960    /**
4961     * Attempts to clear the user data directory of an application.
4962     * Since this may take a little while, the result will
4963     * be posted back to the given observer.  A deletion will fail if the
4964     * named package cannot be found, or if the named package is a "system package".
4965     *
4966     * @param packageName The name of the package
4967     * @param observer An observer callback to get notified when the operation is finished
4968     * {@link android.content.pm.IPackageDataObserver#onRemoveCompleted(String, boolean)}
4969     * will be called when that happens.  observer may be null to indicate that
4970     * no callback is desired.
4971     *
4972     * @hide
4973     */
4974    public abstract void clearApplicationUserData(String packageName,
4975            IPackageDataObserver observer);
4976    /**
4977     * Attempts to delete the cache files associated with an application.
4978     * Since this may take a little while, the result will
4979     * be posted back to the given observer.  A deletion will fail if the calling context
4980     * lacks the {@link android.Manifest.permission#DELETE_CACHE_FILES} permission, if the
4981     * named package cannot be found, or if the named package is a "system package".
4982     *
4983     * @param packageName The name of the package to delete
4984     * @param observer An observer callback to get notified when the cache file deletion
4985     * is complete.
4986     * {@link android.content.pm.IPackageDataObserver#onRemoveCompleted(String, boolean)}
4987     * will be called when that happens.  observer may be null to indicate that
4988     * no callback is desired.
4989     *
4990     * @hide
4991     */
4992    public abstract void deleteApplicationCacheFiles(String packageName,
4993            IPackageDataObserver observer);
4994
4995    /**
4996     * Attempts to delete the cache files associated with an application for a given user. Since
4997     * this may take a little while, the result will be posted back to the given observer. A
4998     * deletion will fail if the calling context lacks the
4999     * {@link android.Manifest.permission#DELETE_CACHE_FILES} permission, if the named package
5000     * cannot be found, or if the named package is a "system package". If {@code userId} does not
5001     * belong to the calling user, the caller must have
5002     * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} permission.
5003     *
5004     * @param packageName The name of the package to delete
5005     * @param userId the user for which the cache files needs to be deleted
5006     * @param observer An observer callback to get notified when the cache file deletion is
5007     *            complete.
5008     *            {@link android.content.pm.IPackageDataObserver#onRemoveCompleted(String, boolean)}
5009     *            will be called when that happens. observer may be null to indicate that no
5010     *            callback is desired.
5011     * @hide
5012     */
5013    public abstract void deleteApplicationCacheFilesAsUser(String packageName, int userId,
5014            IPackageDataObserver observer);
5015
5016    /**
5017     * Free storage by deleting LRU sorted list of cache files across
5018     * all applications. If the currently available free storage
5019     * on the device is greater than or equal to the requested
5020     * free storage, no cache files are cleared. If the currently
5021     * available storage on the device is less than the requested
5022     * free storage, some or all of the cache files across
5023     * all applications are deleted (based on last accessed time)
5024     * to increase the free storage space on the device to
5025     * the requested value. There is no guarantee that clearing all
5026     * the cache files from all applications will clear up
5027     * enough storage to achieve the desired value.
5028     * @param freeStorageSize The number of bytes of storage to be
5029     * freed by the system. Say if freeStorageSize is XX,
5030     * and the current free storage is YY,
5031     * if XX is less than YY, just return. if not free XX-YY number
5032     * of bytes if possible.
5033     * @param observer call back used to notify when
5034     * the operation is completed
5035     *
5036     * @hide
5037     */
5038    public void freeStorageAndNotify(long freeStorageSize, IPackageDataObserver observer) {
5039        freeStorageAndNotify(null, freeStorageSize, observer);
5040    }
5041
5042    /** {@hide} */
5043    public abstract void freeStorageAndNotify(String volumeUuid, long freeStorageSize,
5044            IPackageDataObserver observer);
5045
5046    /**
5047     * Free storage by deleting LRU sorted list of cache files across
5048     * all applications. If the currently available free storage
5049     * on the device is greater than or equal to the requested
5050     * free storage, no cache files are cleared. If the currently
5051     * available storage on the device is less than the requested
5052     * free storage, some or all of the cache files across
5053     * all applications are deleted (based on last accessed time)
5054     * to increase the free storage space on the device to
5055     * the requested value. There is no guarantee that clearing all
5056     * the cache files from all applications will clear up
5057     * enough storage to achieve the desired value.
5058     * @param freeStorageSize The number of bytes of storage to be
5059     * freed by the system. Say if freeStorageSize is XX,
5060     * and the current free storage is YY,
5061     * if XX is less than YY, just return. if not free XX-YY number
5062     * of bytes if possible.
5063     * @param pi IntentSender call back used to
5064     * notify when the operation is completed.May be null
5065     * to indicate that no call back is desired.
5066     *
5067     * @hide
5068     */
5069    public void freeStorage(long freeStorageSize, IntentSender pi) {
5070        freeStorage(null, freeStorageSize, pi);
5071    }
5072
5073    /** {@hide} */
5074    public abstract void freeStorage(String volumeUuid, long freeStorageSize, IntentSender pi);
5075
5076    /**
5077     * Retrieve the size information for a package.
5078     * Since this may take a little while, the result will
5079     * be posted back to the given observer.  The calling context
5080     * should have the {@link android.Manifest.permission#GET_PACKAGE_SIZE} permission.
5081     *
5082     * @param packageName The name of the package whose size information is to be retrieved
5083     * @param userId The user whose size information should be retrieved.
5084     * @param observer An observer callback to get notified when the operation
5085     * is complete.
5086     * {@link android.content.pm.IPackageStatsObserver#onGetStatsCompleted(PackageStats, boolean)}
5087     * The observer's callback is invoked with a PackageStats object(containing the
5088     * code, data and cache sizes of the package) and a boolean value representing
5089     * the status of the operation. observer may be null to indicate that
5090     * no callback is desired.
5091     *
5092     * @deprecated use {@link StorageStatsManager} instead.
5093     * @hide
5094     */
5095    @Deprecated
5096    public abstract void getPackageSizeInfoAsUser(String packageName, @UserIdInt int userId,
5097            IPackageStatsObserver observer);
5098
5099    /**
5100     * Like {@link #getPackageSizeInfoAsUser(String, int, IPackageStatsObserver)}, but
5101     * returns the size for the calling user.
5102     *
5103     * @deprecated use {@link StorageStatsManager} instead.
5104     * @hide
5105     */
5106    @Deprecated
5107    public void getPackageSizeInfo(String packageName, IPackageStatsObserver observer) {
5108        getPackageSizeInfoAsUser(packageName, UserHandle.myUserId(), observer);
5109    }
5110
5111    /**
5112     * @deprecated This function no longer does anything; it was an old
5113     * approach to managing preferred activities, which has been superseded
5114     * by (and conflicts with) the modern activity-based preferences.
5115     */
5116    @Deprecated
5117    public abstract void addPackageToPreferred(String packageName);
5118
5119    /**
5120     * @deprecated This function no longer does anything; it was an old
5121     * approach to managing preferred activities, which has been superseded
5122     * by (and conflicts with) the modern activity-based preferences.
5123     */
5124    @Deprecated
5125    public abstract void removePackageFromPreferred(String packageName);
5126
5127    /**
5128     * Retrieve the list of all currently configured preferred packages. The
5129     * first package on the list is the most preferred, the last is the least
5130     * preferred.
5131     *
5132     * @param flags Additional option flags to modify the data returned.
5133     * @return A List of PackageInfo objects, one for each preferred
5134     *         application, in order of preference.
5135     */
5136    public abstract List<PackageInfo> getPreferredPackages(@PackageInfoFlags int flags);
5137
5138    /**
5139     * @deprecated This is a protected API that should not have been available
5140     * to third party applications.  It is the platform's responsibility for
5141     * assigning preferred activities and this cannot be directly modified.
5142     *
5143     * Add a new preferred activity mapping to the system.  This will be used
5144     * to automatically select the given activity component when
5145     * {@link Context#startActivity(Intent) Context.startActivity()} finds
5146     * multiple matching activities and also matches the given filter.
5147     *
5148     * @param filter The set of intents under which this activity will be
5149     * made preferred.
5150     * @param match The IntentFilter match category that this preference
5151     * applies to.
5152     * @param set The set of activities that the user was picking from when
5153     * this preference was made.
5154     * @param activity The component name of the activity that is to be
5155     * preferred.
5156     */
5157    @Deprecated
5158    public abstract void addPreferredActivity(IntentFilter filter, int match,
5159            ComponentName[] set, ComponentName activity);
5160
5161    /**
5162     * Same as {@link #addPreferredActivity(IntentFilter, int,
5163            ComponentName[], ComponentName)}, but with a specific userId to apply the preference
5164            to.
5165     * @hide
5166     */
5167    public void addPreferredActivityAsUser(IntentFilter filter, int match,
5168            ComponentName[] set, ComponentName activity, @UserIdInt int userId) {
5169        throw new RuntimeException("Not implemented. Must override in a subclass.");
5170    }
5171
5172    /**
5173     * @deprecated This is a protected API that should not have been available
5174     * to third party applications.  It is the platform's responsibility for
5175     * assigning preferred activities and this cannot be directly modified.
5176     *
5177     * Replaces an existing preferred activity mapping to the system, and if that were not present
5178     * adds a new preferred activity.  This will be used
5179     * to automatically select the given activity component when
5180     * {@link Context#startActivity(Intent) Context.startActivity()} finds
5181     * multiple matching activities and also matches the given filter.
5182     *
5183     * @param filter The set of intents under which this activity will be
5184     * made preferred.
5185     * @param match The IntentFilter match category that this preference
5186     * applies to.
5187     * @param set The set of activities that the user was picking from when
5188     * this preference was made.
5189     * @param activity The component name of the activity that is to be
5190     * preferred.
5191     * @hide
5192     */
5193    @Deprecated
5194    public abstract void replacePreferredActivity(IntentFilter filter, int match,
5195            ComponentName[] set, ComponentName activity);
5196
5197    /**
5198     * @hide
5199     */
5200    @Deprecated
5201    public void replacePreferredActivityAsUser(IntentFilter filter, int match,
5202           ComponentName[] set, ComponentName activity, @UserIdInt int userId) {
5203        throw new RuntimeException("Not implemented. Must override in a subclass.");
5204    }
5205
5206    /**
5207     * Remove all preferred activity mappings, previously added with
5208     * {@link #addPreferredActivity}, from the
5209     * system whose activities are implemented in the given package name.
5210     * An application can only clear its own package(s).
5211     *
5212     * @param packageName The name of the package whose preferred activity
5213     * mappings are to be removed.
5214     */
5215    public abstract void clearPackagePreferredActivities(String packageName);
5216
5217    /**
5218     * Retrieve all preferred activities, previously added with
5219     * {@link #addPreferredActivity}, that are
5220     * currently registered with the system.
5221     *
5222     * @param outFilters A required list in which to place the filters of all of the
5223     * preferred activities.
5224     * @param outActivities A required list in which to place the component names of
5225     * all of the preferred activities.
5226     * @param packageName An optional package in which you would like to limit
5227     * the list.  If null, all activities will be returned; if non-null, only
5228     * those activities in the given package are returned.
5229     *
5230     * @return Returns the total number of registered preferred activities
5231     * (the number of distinct IntentFilter records, not the number of unique
5232     * activity components) that were found.
5233     */
5234    public abstract int getPreferredActivities(@NonNull List<IntentFilter> outFilters,
5235            @NonNull List<ComponentName> outActivities, String packageName);
5236
5237    /**
5238     * Ask for the set of available 'home' activities and the current explicit
5239     * default, if any.
5240     * @hide
5241     */
5242    public abstract ComponentName getHomeActivities(List<ResolveInfo> outActivities);
5243
5244    /**
5245     * Set the enabled setting for a package component (activity, receiver, service, provider).
5246     * This setting will override any enabled state which may have been set by the component in its
5247     * manifest.
5248     *
5249     * @param componentName The component to enable
5250     * @param newState The new enabled state for the component.
5251     * @param flags Optional behavior flags.
5252     */
5253    public abstract void setComponentEnabledSetting(ComponentName componentName,
5254            @EnabledState int newState, @EnabledFlags int flags);
5255
5256    /**
5257     * Return the enabled setting for a package component (activity,
5258     * receiver, service, provider).  This returns the last value set by
5259     * {@link #setComponentEnabledSetting(ComponentName, int, int)}; in most
5260     * cases this value will be {@link #COMPONENT_ENABLED_STATE_DEFAULT} since
5261     * the value originally specified in the manifest has not been modified.
5262     *
5263     * @param componentName The component to retrieve.
5264     * @return Returns the current enabled state for the component.
5265     */
5266    public abstract @EnabledState int getComponentEnabledSetting(
5267            ComponentName componentName);
5268
5269    /**
5270     * Set the enabled setting for an application
5271     * This setting will override any enabled state which may have been set by the application in
5272     * its manifest.  It also overrides the enabled state set in the manifest for any of the
5273     * application's components.  It does not override any enabled state set by
5274     * {@link #setComponentEnabledSetting} for any of the application's components.
5275     *
5276     * @param packageName The package name of the application to enable
5277     * @param newState The new enabled state for the application.
5278     * @param flags Optional behavior flags.
5279     */
5280    public abstract void setApplicationEnabledSetting(String packageName,
5281            @EnabledState int newState, @EnabledFlags int flags);
5282
5283    /**
5284     * Return the enabled setting for an application. This returns
5285     * the last value set by
5286     * {@link #setApplicationEnabledSetting(String, int, int)}; in most
5287     * cases this value will be {@link #COMPONENT_ENABLED_STATE_DEFAULT} since
5288     * the value originally specified in the manifest has not been modified.
5289     *
5290     * @param packageName The package name of the application to retrieve.
5291     * @return Returns the current enabled state for the application.
5292     * @throws IllegalArgumentException if the named package does not exist.
5293     */
5294    public abstract @EnabledState int getApplicationEnabledSetting(String packageName);
5295
5296    /**
5297     * Flush the package restrictions for a given user to disk. This forces the package restrictions
5298     * like component and package enabled settings to be written to disk and avoids the delay that
5299     * is otherwise present when changing those settings.
5300     *
5301     * @param userId Ther userId of the user whose restrictions are to be flushed.
5302     * @hide
5303     */
5304    public abstract void flushPackageRestrictionsAsUser(int userId);
5305
5306    /**
5307     * Puts the package in a hidden state, which is almost like an uninstalled state,
5308     * making the package unavailable, but it doesn't remove the data or the actual
5309     * package file. Application can be unhidden by either resetting the hidden state
5310     * or by installing it, such as with {@link #installExistingPackage(String)}
5311     * @hide
5312     */
5313    public abstract boolean setApplicationHiddenSettingAsUser(String packageName, boolean hidden,
5314            UserHandle userHandle);
5315
5316    /**
5317     * Returns the hidden state of a package.
5318     * @see #setApplicationHiddenSettingAsUser(String, boolean, UserHandle)
5319     * @hide
5320     */
5321    public abstract boolean getApplicationHiddenSettingAsUser(String packageName,
5322            UserHandle userHandle);
5323
5324    /**
5325     * Return whether the device has been booted into safe mode.
5326     */
5327    public abstract boolean isSafeMode();
5328
5329    /**
5330     * Adds a listener for permission changes for installed packages.
5331     *
5332     * @param listener The listener to add.
5333     *
5334     * @hide
5335     */
5336    @SystemApi
5337    @RequiresPermission(Manifest.permission.OBSERVE_GRANT_REVOKE_PERMISSIONS)
5338    public abstract void addOnPermissionsChangeListener(OnPermissionsChangedListener listener);
5339
5340    /**
5341     * Remvoes a listener for permission changes for installed packages.
5342     *
5343     * @param listener The listener to remove.
5344     *
5345     * @hide
5346     */
5347    @SystemApi
5348    @RequiresPermission(Manifest.permission.OBSERVE_GRANT_REVOKE_PERMISSIONS)
5349    public abstract void removeOnPermissionsChangeListener(OnPermissionsChangedListener listener);
5350
5351    /**
5352     * Return the {@link KeySet} associated with the String alias for this
5353     * application.
5354     *
5355     * @param alias The alias for a given {@link KeySet} as defined in the
5356     *        application's AndroidManifest.xml.
5357     * @hide
5358     */
5359    public abstract KeySet getKeySetByAlias(String packageName, String alias);
5360
5361    /** Return the signing {@link KeySet} for this application.
5362     * @hide
5363     */
5364    public abstract KeySet getSigningKeySet(String packageName);
5365
5366    /**
5367     * Return whether the package denoted by packageName has been signed by all
5368     * of the keys specified by the {@link KeySet} ks.  This will return true if
5369     * the package has been signed by additional keys (a superset) as well.
5370     * Compare to {@link #isSignedByExactly(String packageName, KeySet ks)}.
5371     * @hide
5372     */
5373    public abstract boolean isSignedBy(String packageName, KeySet ks);
5374
5375    /**
5376     * Return whether the package denoted by packageName has been signed by all
5377     * of, and only, the keys specified by the {@link KeySet} ks. Compare to
5378     * {@link #isSignedBy(String packageName, KeySet ks)}.
5379     * @hide
5380     */
5381    public abstract boolean isSignedByExactly(String packageName, KeySet ks);
5382
5383    /**
5384     * Puts the package in a suspended state, where attempts at starting activities are denied.
5385     *
5386     * <p>It doesn't remove the data or the actual package file. The application notifications
5387     * will be hidden, the application will not show up in recents, will not be able to show
5388     * toasts or dialogs or ring the device.
5389     *
5390     * <p>The package must already be installed. If the package is uninstalled while suspended
5391     * the package will no longer be suspended.
5392     *
5393     * @param packageNames The names of the packages to set the suspended status.
5394     * @param suspended If set to {@code true} than the packages will be suspended, if set to
5395     * {@code false} the packages will be unsuspended.
5396     * @param userId The user id.
5397     *
5398     * @return an array of package names for which the suspended status is not set as requested in
5399     * this method.
5400     *
5401     * @hide
5402     */
5403    public abstract String[] setPackagesSuspendedAsUser(
5404            String[] packageNames, boolean suspended, @UserIdInt int userId);
5405
5406    /**
5407     * @see #setPackageSuspendedAsUser(String, boolean, int)
5408     * @param packageName The name of the package to get the suspended status of.
5409     * @param userId The user id.
5410     * @return {@code true} if the package is suspended or {@code false} if the package is not
5411     * suspended or could not be found.
5412     * @hide
5413     */
5414    public abstract boolean isPackageSuspendedForUser(String packageName, int userId);
5415
5416    /**
5417     * Provide a hint of what the {@link ApplicationInfo#category} value should
5418     * be for the given package.
5419     * <p>
5420     * This hint can only be set by the app which installed this package, as
5421     * determined by {@link #getInstallerPackageName(String)}.
5422     *
5423     * @param packageName the package to change the category hint for.
5424     * @param categoryHint the category hint to set.
5425     */
5426    public abstract void setApplicationCategoryHint(@NonNull String packageName,
5427            @ApplicationInfo.Category int categoryHint);
5428
5429    /** {@hide} */
5430    public static boolean isMoveStatusFinished(int status) {
5431        return (status < 0 || status > 100);
5432    }
5433
5434    /** {@hide} */
5435    public static abstract class MoveCallback {
5436        public void onCreated(int moveId, Bundle extras) {}
5437        public abstract void onStatusChanged(int moveId, int status, long estMillis);
5438    }
5439
5440    /** {@hide} */
5441    public abstract int getMoveStatus(int moveId);
5442
5443    /** {@hide} */
5444    public abstract void registerMoveCallback(MoveCallback callback, Handler handler);
5445    /** {@hide} */
5446    public abstract void unregisterMoveCallback(MoveCallback callback);
5447
5448    /** {@hide} */
5449    public abstract int movePackage(String packageName, VolumeInfo vol);
5450    /** {@hide} */
5451    public abstract @Nullable VolumeInfo getPackageCurrentVolume(ApplicationInfo app);
5452    /** {@hide} */
5453    public abstract @NonNull List<VolumeInfo> getPackageCandidateVolumes(ApplicationInfo app);
5454
5455    /** {@hide} */
5456    public abstract int movePrimaryStorage(VolumeInfo vol);
5457    /** {@hide} */
5458    public abstract @Nullable VolumeInfo getPrimaryStorageCurrentVolume();
5459    /** {@hide} */
5460    public abstract @NonNull List<VolumeInfo> getPrimaryStorageCandidateVolumes();
5461
5462    /**
5463     * Returns the device identity that verifiers can use to associate their scheme to a particular
5464     * device. This should not be used by anything other than a package verifier.
5465     *
5466     * @return identity that uniquely identifies current device
5467     * @hide
5468     */
5469    public abstract VerifierDeviceIdentity getVerifierDeviceIdentity();
5470
5471    /**
5472     * Returns true if the device is upgrading, such as first boot after OTA.
5473     *
5474     * @hide
5475     */
5476    public abstract boolean isUpgrade();
5477
5478    /**
5479     * Return interface that offers the ability to install, upgrade, and remove
5480     * applications on the device.
5481     */
5482    public abstract @NonNull PackageInstaller getPackageInstaller();
5483
5484    /**
5485     * Adds a {@code CrossProfileIntentFilter}. After calling this method all
5486     * intents sent from the user with id sourceUserId can also be be resolved
5487     * by activities in the user with id targetUserId if they match the
5488     * specified intent filter.
5489     *
5490     * @param filter The {@link IntentFilter} the intent has to match
5491     * @param sourceUserId The source user id.
5492     * @param targetUserId The target user id.
5493     * @param flags The possible values are {@link #SKIP_CURRENT_PROFILE} and
5494     *            {@link #ONLY_IF_NO_MATCH_FOUND}.
5495     * @hide
5496     */
5497    public abstract void addCrossProfileIntentFilter(IntentFilter filter, int sourceUserId,
5498            int targetUserId, int flags);
5499
5500    /**
5501     * Clearing {@code CrossProfileIntentFilter}s which have the specified user
5502     * as their source, and have been set by the app calling this method.
5503     *
5504     * @param sourceUserId The source user id.
5505     * @hide
5506     */
5507    public abstract void clearCrossProfileIntentFilters(int sourceUserId);
5508
5509    /**
5510     * @hide
5511     */
5512    public abstract Drawable loadItemIcon(PackageItemInfo itemInfo, ApplicationInfo appInfo);
5513
5514    /**
5515     * @hide
5516     */
5517    public abstract Drawable loadUnbadgedItemIcon(PackageItemInfo itemInfo, ApplicationInfo appInfo);
5518
5519    /** {@hide} */
5520    public abstract boolean isPackageAvailable(String packageName);
5521
5522    /** {@hide} */
5523    public static String installStatusToString(int status, String msg) {
5524        final String str = installStatusToString(status);
5525        if (msg != null) {
5526            return str + ": " + msg;
5527        } else {
5528            return str;
5529        }
5530    }
5531
5532    /** {@hide} */
5533    public static String installStatusToString(int status) {
5534        switch (status) {
5535            case INSTALL_SUCCEEDED: return "INSTALL_SUCCEEDED";
5536            case INSTALL_FAILED_ALREADY_EXISTS: return "INSTALL_FAILED_ALREADY_EXISTS";
5537            case INSTALL_FAILED_INVALID_APK: return "INSTALL_FAILED_INVALID_APK";
5538            case INSTALL_FAILED_INVALID_URI: return "INSTALL_FAILED_INVALID_URI";
5539            case INSTALL_FAILED_INSUFFICIENT_STORAGE: return "INSTALL_FAILED_INSUFFICIENT_STORAGE";
5540            case INSTALL_FAILED_DUPLICATE_PACKAGE: return "INSTALL_FAILED_DUPLICATE_PACKAGE";
5541            case INSTALL_FAILED_NO_SHARED_USER: return "INSTALL_FAILED_NO_SHARED_USER";
5542            case INSTALL_FAILED_UPDATE_INCOMPATIBLE: return "INSTALL_FAILED_UPDATE_INCOMPATIBLE";
5543            case INSTALL_FAILED_SHARED_USER_INCOMPATIBLE: return "INSTALL_FAILED_SHARED_USER_INCOMPATIBLE";
5544            case INSTALL_FAILED_MISSING_SHARED_LIBRARY: return "INSTALL_FAILED_MISSING_SHARED_LIBRARY";
5545            case INSTALL_FAILED_REPLACE_COULDNT_DELETE: return "INSTALL_FAILED_REPLACE_COULDNT_DELETE";
5546            case INSTALL_FAILED_DEXOPT: return "INSTALL_FAILED_DEXOPT";
5547            case INSTALL_FAILED_OLDER_SDK: return "INSTALL_FAILED_OLDER_SDK";
5548            case INSTALL_FAILED_CONFLICTING_PROVIDER: return "INSTALL_FAILED_CONFLICTING_PROVIDER";
5549            case INSTALL_FAILED_NEWER_SDK: return "INSTALL_FAILED_NEWER_SDK";
5550            case INSTALL_FAILED_TEST_ONLY: return "INSTALL_FAILED_TEST_ONLY";
5551            case INSTALL_FAILED_CPU_ABI_INCOMPATIBLE: return "INSTALL_FAILED_CPU_ABI_INCOMPATIBLE";
5552            case INSTALL_FAILED_MISSING_FEATURE: return "INSTALL_FAILED_MISSING_FEATURE";
5553            case INSTALL_FAILED_CONTAINER_ERROR: return "INSTALL_FAILED_CONTAINER_ERROR";
5554            case INSTALL_FAILED_INVALID_INSTALL_LOCATION: return "INSTALL_FAILED_INVALID_INSTALL_LOCATION";
5555            case INSTALL_FAILED_MEDIA_UNAVAILABLE: return "INSTALL_FAILED_MEDIA_UNAVAILABLE";
5556            case INSTALL_FAILED_VERIFICATION_TIMEOUT: return "INSTALL_FAILED_VERIFICATION_TIMEOUT";
5557            case INSTALL_FAILED_VERIFICATION_FAILURE: return "INSTALL_FAILED_VERIFICATION_FAILURE";
5558            case INSTALL_FAILED_PACKAGE_CHANGED: return "INSTALL_FAILED_PACKAGE_CHANGED";
5559            case INSTALL_FAILED_UID_CHANGED: return "INSTALL_FAILED_UID_CHANGED";
5560            case INSTALL_FAILED_VERSION_DOWNGRADE: return "INSTALL_FAILED_VERSION_DOWNGRADE";
5561            case INSTALL_PARSE_FAILED_NOT_APK: return "INSTALL_PARSE_FAILED_NOT_APK";
5562            case INSTALL_PARSE_FAILED_BAD_MANIFEST: return "INSTALL_PARSE_FAILED_BAD_MANIFEST";
5563            case INSTALL_PARSE_FAILED_UNEXPECTED_EXCEPTION: return "INSTALL_PARSE_FAILED_UNEXPECTED_EXCEPTION";
5564            case INSTALL_PARSE_FAILED_NO_CERTIFICATES: return "INSTALL_PARSE_FAILED_NO_CERTIFICATES";
5565            case INSTALL_PARSE_FAILED_INCONSISTENT_CERTIFICATES: return "INSTALL_PARSE_FAILED_INCONSISTENT_CERTIFICATES";
5566            case INSTALL_PARSE_FAILED_CERTIFICATE_ENCODING: return "INSTALL_PARSE_FAILED_CERTIFICATE_ENCODING";
5567            case INSTALL_PARSE_FAILED_BAD_PACKAGE_NAME: return "INSTALL_PARSE_FAILED_BAD_PACKAGE_NAME";
5568            case INSTALL_PARSE_FAILED_BAD_SHARED_USER_ID: return "INSTALL_PARSE_FAILED_BAD_SHARED_USER_ID";
5569            case INSTALL_PARSE_FAILED_MANIFEST_MALFORMED: return "INSTALL_PARSE_FAILED_MANIFEST_MALFORMED";
5570            case INSTALL_PARSE_FAILED_MANIFEST_EMPTY: return "INSTALL_PARSE_FAILED_MANIFEST_EMPTY";
5571            case INSTALL_FAILED_INTERNAL_ERROR: return "INSTALL_FAILED_INTERNAL_ERROR";
5572            case INSTALL_FAILED_USER_RESTRICTED: return "INSTALL_FAILED_USER_RESTRICTED";
5573            case INSTALL_FAILED_DUPLICATE_PERMISSION: return "INSTALL_FAILED_DUPLICATE_PERMISSION";
5574            case INSTALL_FAILED_NO_MATCHING_ABIS: return "INSTALL_FAILED_NO_MATCHING_ABIS";
5575            case INSTALL_FAILED_ABORTED: return "INSTALL_FAILED_ABORTED";
5576            default: return Integer.toString(status);
5577        }
5578    }
5579
5580    /** {@hide} */
5581    public static int installStatusToPublicStatus(int status) {
5582        switch (status) {
5583            case INSTALL_SUCCEEDED: return PackageInstaller.STATUS_SUCCESS;
5584            case INSTALL_FAILED_ALREADY_EXISTS: return PackageInstaller.STATUS_FAILURE_CONFLICT;
5585            case INSTALL_FAILED_INVALID_APK: return PackageInstaller.STATUS_FAILURE_INVALID;
5586            case INSTALL_FAILED_INVALID_URI: return PackageInstaller.STATUS_FAILURE_INVALID;
5587            case INSTALL_FAILED_INSUFFICIENT_STORAGE: return PackageInstaller.STATUS_FAILURE_STORAGE;
5588            case INSTALL_FAILED_DUPLICATE_PACKAGE: return PackageInstaller.STATUS_FAILURE_CONFLICT;
5589            case INSTALL_FAILED_NO_SHARED_USER: return PackageInstaller.STATUS_FAILURE_CONFLICT;
5590            case INSTALL_FAILED_UPDATE_INCOMPATIBLE: return PackageInstaller.STATUS_FAILURE_CONFLICT;
5591            case INSTALL_FAILED_SHARED_USER_INCOMPATIBLE: return PackageInstaller.STATUS_FAILURE_CONFLICT;
5592            case INSTALL_FAILED_MISSING_SHARED_LIBRARY: return PackageInstaller.STATUS_FAILURE_INCOMPATIBLE;
5593            case INSTALL_FAILED_REPLACE_COULDNT_DELETE: return PackageInstaller.STATUS_FAILURE_CONFLICT;
5594            case INSTALL_FAILED_DEXOPT: return PackageInstaller.STATUS_FAILURE_INVALID;
5595            case INSTALL_FAILED_OLDER_SDK: return PackageInstaller.STATUS_FAILURE_INCOMPATIBLE;
5596            case INSTALL_FAILED_CONFLICTING_PROVIDER: return PackageInstaller.STATUS_FAILURE_CONFLICT;
5597            case INSTALL_FAILED_NEWER_SDK: return PackageInstaller.STATUS_FAILURE_INCOMPATIBLE;
5598            case INSTALL_FAILED_TEST_ONLY: return PackageInstaller.STATUS_FAILURE_INVALID;
5599            case INSTALL_FAILED_CPU_ABI_INCOMPATIBLE: return PackageInstaller.STATUS_FAILURE_INCOMPATIBLE;
5600            case INSTALL_FAILED_MISSING_FEATURE: return PackageInstaller.STATUS_FAILURE_INCOMPATIBLE;
5601            case INSTALL_FAILED_CONTAINER_ERROR: return PackageInstaller.STATUS_FAILURE_STORAGE;
5602            case INSTALL_FAILED_INVALID_INSTALL_LOCATION: return PackageInstaller.STATUS_FAILURE_STORAGE;
5603            case INSTALL_FAILED_MEDIA_UNAVAILABLE: return PackageInstaller.STATUS_FAILURE_STORAGE;
5604            case INSTALL_FAILED_VERIFICATION_TIMEOUT: return PackageInstaller.STATUS_FAILURE_ABORTED;
5605            case INSTALL_FAILED_VERIFICATION_FAILURE: return PackageInstaller.STATUS_FAILURE_ABORTED;
5606            case INSTALL_FAILED_PACKAGE_CHANGED: return PackageInstaller.STATUS_FAILURE_INVALID;
5607            case INSTALL_FAILED_UID_CHANGED: return PackageInstaller.STATUS_FAILURE_INVALID;
5608            case INSTALL_FAILED_VERSION_DOWNGRADE: return PackageInstaller.STATUS_FAILURE_INVALID;
5609            case INSTALL_FAILED_PERMISSION_MODEL_DOWNGRADE: return PackageInstaller.STATUS_FAILURE_INVALID;
5610            case INSTALL_PARSE_FAILED_NOT_APK: return PackageInstaller.STATUS_FAILURE_INVALID;
5611            case INSTALL_PARSE_FAILED_BAD_MANIFEST: return PackageInstaller.STATUS_FAILURE_INVALID;
5612            case INSTALL_PARSE_FAILED_UNEXPECTED_EXCEPTION: return PackageInstaller.STATUS_FAILURE_INVALID;
5613            case INSTALL_PARSE_FAILED_NO_CERTIFICATES: return PackageInstaller.STATUS_FAILURE_INVALID;
5614            case INSTALL_PARSE_FAILED_INCONSISTENT_CERTIFICATES: return PackageInstaller.STATUS_FAILURE_INVALID;
5615            case INSTALL_PARSE_FAILED_CERTIFICATE_ENCODING: return PackageInstaller.STATUS_FAILURE_INVALID;
5616            case INSTALL_PARSE_FAILED_BAD_PACKAGE_NAME: return PackageInstaller.STATUS_FAILURE_INVALID;
5617            case INSTALL_PARSE_FAILED_BAD_SHARED_USER_ID: return PackageInstaller.STATUS_FAILURE_INVALID;
5618            case INSTALL_PARSE_FAILED_MANIFEST_MALFORMED: return PackageInstaller.STATUS_FAILURE_INVALID;
5619            case INSTALL_PARSE_FAILED_MANIFEST_EMPTY: return PackageInstaller.STATUS_FAILURE_INVALID;
5620            case INSTALL_FAILED_INTERNAL_ERROR: return PackageInstaller.STATUS_FAILURE;
5621            case INSTALL_FAILED_USER_RESTRICTED: return PackageInstaller.STATUS_FAILURE_INCOMPATIBLE;
5622            case INSTALL_FAILED_DUPLICATE_PERMISSION: return PackageInstaller.STATUS_FAILURE_CONFLICT;
5623            case INSTALL_FAILED_NO_MATCHING_ABIS: return PackageInstaller.STATUS_FAILURE_INCOMPATIBLE;
5624            case INSTALL_FAILED_ABORTED: return PackageInstaller.STATUS_FAILURE_ABORTED;
5625            default: return PackageInstaller.STATUS_FAILURE;
5626        }
5627    }
5628
5629    /** {@hide} */
5630    public static String deleteStatusToString(int status, String msg) {
5631        final String str = deleteStatusToString(status);
5632        if (msg != null) {
5633            return str + ": " + msg;
5634        } else {
5635            return str;
5636        }
5637    }
5638
5639    /** {@hide} */
5640    public static String deleteStatusToString(int status) {
5641        switch (status) {
5642            case DELETE_SUCCEEDED: return "DELETE_SUCCEEDED";
5643            case DELETE_FAILED_INTERNAL_ERROR: return "DELETE_FAILED_INTERNAL_ERROR";
5644            case DELETE_FAILED_DEVICE_POLICY_MANAGER: return "DELETE_FAILED_DEVICE_POLICY_MANAGER";
5645            case DELETE_FAILED_USER_RESTRICTED: return "DELETE_FAILED_USER_RESTRICTED";
5646            case DELETE_FAILED_OWNER_BLOCKED: return "DELETE_FAILED_OWNER_BLOCKED";
5647            case DELETE_FAILED_ABORTED: return "DELETE_FAILED_ABORTED";
5648            case DELETE_FAILED_USED_SHARED_LIBRARY: return "DELETE_FAILED_USED_SHARED_LIBRARY";
5649            default: return Integer.toString(status);
5650        }
5651    }
5652
5653    /** {@hide} */
5654    public static int deleteStatusToPublicStatus(int status) {
5655        switch (status) {
5656            case DELETE_SUCCEEDED: return PackageInstaller.STATUS_SUCCESS;
5657            case DELETE_FAILED_INTERNAL_ERROR: return PackageInstaller.STATUS_FAILURE;
5658            case DELETE_FAILED_DEVICE_POLICY_MANAGER: return PackageInstaller.STATUS_FAILURE_BLOCKED;
5659            case DELETE_FAILED_USER_RESTRICTED: return PackageInstaller.STATUS_FAILURE_BLOCKED;
5660            case DELETE_FAILED_OWNER_BLOCKED: return PackageInstaller.STATUS_FAILURE_BLOCKED;
5661            case DELETE_FAILED_ABORTED: return PackageInstaller.STATUS_FAILURE_ABORTED;
5662            case DELETE_FAILED_USED_SHARED_LIBRARY: return PackageInstaller.STATUS_FAILURE_CONFLICT;
5663            default: return PackageInstaller.STATUS_FAILURE;
5664        }
5665    }
5666
5667    /** {@hide} */
5668    public static String permissionFlagToString(int flag) {
5669        switch (flag) {
5670            case FLAG_PERMISSION_GRANTED_BY_DEFAULT: return "GRANTED_BY_DEFAULT";
5671            case FLAG_PERMISSION_POLICY_FIXED: return "POLICY_FIXED";
5672            case FLAG_PERMISSION_SYSTEM_FIXED: return "SYSTEM_FIXED";
5673            case FLAG_PERMISSION_USER_SET: return "USER_SET";
5674            case FLAG_PERMISSION_REVOKE_ON_UPGRADE: return "REVOKE_ON_UPGRADE";
5675            case FLAG_PERMISSION_USER_FIXED: return "USER_FIXED";
5676            case FLAG_PERMISSION_REVIEW_REQUIRED: return "REVIEW_REQUIRED";
5677            default: return Integer.toString(flag);
5678        }
5679    }
5680
5681    /** {@hide} */
5682    public static class LegacyPackageInstallObserver extends PackageInstallObserver {
5683        private final IPackageInstallObserver mLegacy;
5684
5685        public LegacyPackageInstallObserver(IPackageInstallObserver legacy) {
5686            mLegacy = legacy;
5687        }
5688
5689        @Override
5690        public void onPackageInstalled(String basePackageName, int returnCode, String msg,
5691                Bundle extras) {
5692            if (mLegacy == null) return;
5693            try {
5694                mLegacy.packageInstalled(basePackageName, returnCode);
5695            } catch (RemoteException ignored) {
5696            }
5697        }
5698    }
5699
5700    /** {@hide} */
5701    public static class LegacyPackageDeleteObserver extends PackageDeleteObserver {
5702        private final IPackageDeleteObserver mLegacy;
5703
5704        public LegacyPackageDeleteObserver(IPackageDeleteObserver legacy) {
5705            mLegacy = legacy;
5706        }
5707
5708        @Override
5709        public void onPackageDeleted(String basePackageName, int returnCode, String msg) {
5710            if (mLegacy == null) return;
5711            try {
5712                mLegacy.packageDeleted(basePackageName, returnCode);
5713            } catch (RemoteException ignored) {
5714            }
5715        }
5716    }
5717
5718    /**
5719     * Return the install reason that was recorded when a package was first
5720     * installed for a specific user. Requesting the install reason for another
5721     * user will require the permission INTERACT_ACROSS_USERS_FULL.
5722     *
5723     * @param packageName The package for which to retrieve the install reason
5724     * @param user The user for whom to retrieve the install reason
5725     * @return The install reason. If the package is not installed for the given
5726     *         user, {@code INSTALL_REASON_UNKNOWN} is returned.
5727     * @hide
5728     */
5729    @TestApi
5730    public abstract @InstallReason int getInstallReason(String packageName,
5731            @NonNull UserHandle user);
5732
5733    /**
5734     * Checks whether the calling package is allowed to request package installs through package
5735     * installer. Apps are encouraged to call this API before launching the package installer via
5736     * intent {@link android.content.Intent#ACTION_INSTALL_PACKAGE}. Starting from Android O, the
5737     * user can explicitly choose what external sources they trust to install apps on the device.
5738     * If this API returns false, the install request will be blocked by the package installer and
5739     * a dialog will be shown to the user with an option to launch settings to change their
5740     * preference. An application must target Android O or higher and declare permission
5741     * {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES} in order to use this API.
5742     *
5743     * @return true if the calling package is trusted by the user to request install packages on
5744     * the device, false otherwise.
5745     * @see android.content.Intent#ACTION_INSTALL_PACKAGE
5746     * @see android.provider.Settings#ACTION_MANAGE_UNKNOWN_APP_SOURCES
5747     */
5748    public abstract boolean canRequestPackageInstalls();
5749
5750    /**
5751     * Return the {@link ComponentName} of the activity providing Settings for the Instant App
5752     * resolver.
5753     *
5754     * @see {@link android.content.Intent#ACTION_INSTANT_APP_RESOLVER_SETTINGS}
5755     * @hide
5756     */
5757    @SystemApi
5758    public abstract ComponentName getInstantAppResolverSettingsComponent();
5759
5760    /**
5761     * Return the {@link ComponentName} of the activity responsible for installing instant
5762     * applications.
5763     *
5764     * @see {@link android.content.Intent#ACTION_INSTALL_INSTANT_APP_PACKAGE}
5765     * @hide
5766     */
5767    @SystemApi
5768    public abstract ComponentName getInstantAppInstallerComponent();
5769
5770    /**
5771     * Return the Android Id for a given Instant App.
5772     *
5773     * @see {@link android.provider.Settings.Secure#ANDROID_ID}
5774     * @hide
5775     */
5776    public abstract String getInstantAppAndroidId(String packageName, @NonNull UserHandle user);
5777
5778    /**
5779     * Callback use to notify the callers of module registration that the operation
5780     * has finished.
5781     *
5782     * @hide
5783     */
5784    @SystemApi
5785    public static abstract class DexModuleRegisterCallback {
5786        public abstract void onDexModuleRegistered(String dexModulePath, boolean success,
5787                String message);
5788    }
5789
5790    /**
5791     * Register an application dex module with the package manager.
5792     * The package manager will keep track of the given module for future optimizations.
5793     *
5794     * Dex module optimizations will disable the classpath checking at runtime. The client bares
5795     * the responsibility to ensure that the static assumptions on classes in the optimized code
5796     * hold at runtime (e.g. there's no duplicate classes in the classpath).
5797     *
5798     * Note that the package manager already keeps track of dex modules loaded with
5799     * {@link dalvik.system.DexClassLoader} and {@link dalvik.system.PathClassLoader}.
5800     * This can be called for an eager registration.
5801     *
5802     * The call might take a while and the results will be posted on the main thread, using
5803     * the given callback.
5804     *
5805     * If the module is intended to be shared with other apps, make sure that the file
5806     * permissions allow for it.
5807     * If at registration time the permissions allow for others to read it, the module would
5808     * be marked as a shared module which might undergo a different optimization strategy.
5809     * (usually shared modules will generated larger optimizations artifacts,
5810     * taking more disk space).
5811     *
5812     * @param dexModulePath the absolute path of the dex module.
5813     * @param callback if not null, {@link DexModuleRegisterCallback#onDexModuleRegistered} will
5814     *                 be called once the registration finishes.
5815     *
5816     * @hide
5817     */
5818    @SystemApi
5819    public abstract void registerDexModule(String dexModulePath,
5820            @Nullable DexModuleRegisterCallback callback);
5821}
5822