Note: If your app targets Android 11 (API level 30) or * higher, the methods in this class each return a filtered list of apps. Learn more about how to * manage package visibility. *
*/ @android.ravenwood.annotation.RavenwoodKeepPartialClass public abstract class PackageManager { private static final String TAG = "PackageManager"; /** {@hide} */ public static final boolean APPLY_DEFAULT_TO_DEVICE_PROTECTED_STORAGE = true; /** {@hide} */ public static final boolean ENABLE_SHARED_UID_MIGRATION = true; /** * This exception is thrown when a given package, application, or component * name cannot be found. */ public static class NameNotFoundException extends AndroidException { public NameNotFoundException() { } public NameNotFoundException(String name) { super(name); } } /** * <application> level {@link android.content.pm.PackageManager.Property} tag specifying * the XML resource ID containing an application's media capabilities XML file * * For example: * <application> * <property android:name="android.media.PROPERTY_MEDIA_CAPABILITIES" * android:resource="@xml/media_capabilities"> * <application> */ public static final String PROPERTY_MEDIA_CAPABILITIES = "android.media.PROPERTY_MEDIA_CAPABILITIES"; /** * <application> level {@link android.content.pm.PackageManager.Property} tag * specifying the XML resource ID containing the declaration of the self-certified network * capabilities used by the application. * *Starting from Android 14, usage of some network capabilities in * {@link android.net.ConnectivityManager#requestNetwork} require the application to * declare its usage of that particular capability in this resource. Only some capabilities * require a declaration. Please look up the specific capability you want to use in * {@link android.net.NetworkCapabilities} to see if it needs declaration in this property. * * For example: * <application> * <property android:name="android.net.PROPERTY_SELF_CERTIFIED_NETWORK_CAPABILITIES" * android:resource="@xml/self_certified_network_capabilities"> * <application> * *
The detail format of self_certified_network_capabilities.xml is described in * {@link android.net.NetworkRequest} */ public static final String PROPERTY_SELF_CERTIFIED_NETWORK_CAPABILITIES = "android.net.PROPERTY_SELF_CERTIFIED_NETWORK_CAPABILITIES"; /** * Application level property that an app can specify to opt-out from having private data * directories both on the internal and external storages. * *
Changing the value of this property during app update is not supported, and such updates * will be rejected. * *
This should only be set by platform apps that know what they are doing. * * @hide */ public static final String PROPERTY_NO_APP_DATA_STORAGE = "android.internal.PROPERTY_NO_APP_DATA_STORAGE"; /** * <service> level {@link android.content.pm.PackageManager.Property} tag specifying * the actual use case of the service if it's foreground service with the type * {@link ServiceInfo#FOREGROUND_SERVICE_TYPE_SPECIAL_USE}. * *
* For example: * <service> * <property android:name="android.app.PROPERTY_SPECIAL_USE_FGS_SUBTYPE" * android:value="foo"/> * </service> */ public static final String PROPERTY_SPECIAL_USE_FGS_SUBTYPE = "android.app.PROPERTY_SPECIAL_USE_FGS_SUBTYPE"; /** * Application level {@link android.content.pm.PackageManager.Property PackageManager * .Property} for an app to inform the system that the app can be opted-in or opted-out * from the compatibility treatment that rotates camera output by 90 degrees on landscape * sensors on devices known to have compatibility issues. * *
The treatment is disabled by default but device manufacturers can enable the treatment * using their discretion to improve camera compatibility. With this property set to * {@code false}, the rotation will not be applied. A value of {@code true} * will ensure that rotation is applied, provided it is enabled for the device. In most cases, * if rotation is the desired behavior this property need not be set. However, if your app * experiences stretching or incorrect rotation on these devices, explicitly setting this to * {@code true} may resolve that behavior. Apps should set this to {@code false} if there * is confidence that the app handles * {@link android.hardware.camera2.CameraCharacteristics#SENSOR_ORIENTATION} correctly. * See the * documentation for best practice. * *
Syntax: *
* <application>
* <property
* android:name="android.camera.PROPERTY_COMPAT_OVERRIDE_LANDSCAPE_TO_PORTRAIT"
* android:value="true|false"/>
* </application>
*
*/
public static final String PROPERTY_COMPAT_OVERRIDE_LANDSCAPE_TO_PORTRAIT =
"android.camera.PROPERTY_COMPAT_OVERRIDE_LANDSCAPE_TO_PORTRAIT";
/**
* Application level {@link android.content.pm.PackageManager.Property PackageManager
* .Property} for a privileged system installer to define a list of up to 500 packages that
* should not have their updates owned by any installer. The list must be provided via a default
* XML resource with the following format:
*
*
* <deny-ownership>PACKAGE_NAME</deny-ownership>
* <deny-ownership>PACKAGE_NAME</deny-ownership>
*
*
* NOTE: Installers that provide this property will not granted update ownership for any
* packages that they request update ownership of.
* @hide
*/
public static final String PROPERTY_LEGACY_UPDATE_OWNERSHIP_DENYLIST =
"android.app.PROPERTY_LEGACY_UPDATE_OWNERSHIP_DENYLIST";
/**
* Application level {@link android.content.pm.PackageManager.Property PackageManager
* .Property} for a app to inform the installer that a file containing the app's android
* safety label data is bundled into the APK as a raw resource.
*
* For example: *
* <application>
* <property
* android:name="android.content.PROPERTY_ANDROID_SAFETY_LABEL"
* android:resource="@raw/app-metadata"/>
* </application>
*
* @hide
*/
public static final String PROPERTY_ANDROID_SAFETY_LABEL =
"android.content.PROPERTY_ANDROID_SAFETY_LABEL";
/**
* A property value set within the manifest.
* * The value of a property will only have a single type, as defined by * the property itself. */ public static final class Property implements Parcelable { private static final int TYPE_BOOLEAN = 1; private static final int TYPE_FLOAT = 2; private static final int TYPE_INTEGER = 3; private static final int TYPE_RESOURCE = 4; private static final int TYPE_STRING = 5; private final String mName; private final int mType; private final String mClassName; private final String mPackageName; private boolean mBooleanValue; private float mFloatValue; private int mIntegerValue; private String mStringValue; /** @hide */ @VisibleForTesting public Property(@NonNull String name, int type, @NonNull String packageName, @Nullable String className) { if (type < TYPE_BOOLEAN || type > TYPE_STRING) { throw new IllegalArgumentException("Invalid type"); } this.mName = Objects.requireNonNull(name); this.mType = type; this.mPackageName = Objects.requireNonNull(packageName); this.mClassName = className; } /** @hide */ public Property(@NonNull String name, boolean value, String packageName, String className) { this(name, TYPE_BOOLEAN, packageName, className); mBooleanValue = value; } /** @hide */ public Property(@NonNull String name, float value, String packageName, String className) { this(name, TYPE_FLOAT, packageName, className); mFloatValue = value; } /** @hide */ public Property(@NonNull String name, int value, boolean isResource, String packageName, String className) { this(name, isResource ? TYPE_RESOURCE : TYPE_INTEGER, packageName, className); mIntegerValue = value; } /** @hide */ public Property(@NonNull String name, String value, String packageName, String className) { this(name, TYPE_STRING, packageName, className); mStringValue = value; } /** @hide */ @VisibleForTesting public int getType() { return mType; } /** * Returns the name of the property. */ @NonNull public String getName() { return mName; } /** * Returns the name of the package where this this property was defined. */ @NonNull public String getPackageName() { return mPackageName; } /** * Returns the classname of the component where this property was defined. *
If the property was defined within and <application> tag, returns * {@code null} */ @Nullable public String getClassName() { return mClassName; } /** * Returns the boolean value set for the property. *
If the property is not of a boolean type, returns {@code false}. */ public boolean getBoolean() { return mBooleanValue; } /** * Returns {@code true} if the property is a boolean type. Otherwise {@code false}. */ public boolean isBoolean() { return mType == TYPE_BOOLEAN; } /** * Returns the float value set for the property. *
If the property is not of a float type, returns {@code 0.0}. */ public float getFloat() { return mFloatValue; } /** * Returns {@code true} if the property is a float type. Otherwise {@code false}. */ public boolean isFloat() { return mType == TYPE_FLOAT; } /** * Returns the integer value set for the property. *
If the property is not of an integer type, returns {@code 0}. */ public int getInteger() { return mType == TYPE_INTEGER ? mIntegerValue : 0; } /** * Returns {@code true} if the property is an integer type. Otherwise {@code false}. */ public boolean isInteger() { return mType == TYPE_INTEGER; } /** * Returns the a resource id set for the property. *
If the property is not of a resource id type, returns {@code 0}. */ public int getResourceId() { return mType == TYPE_RESOURCE ? mIntegerValue : 0; } /** * Returns {@code true} if the property is a resource id type. Otherwise {@code false}. */ public boolean isResourceId() { return mType == TYPE_RESOURCE; } /** * Returns the a String value set for the property. *
If the property is not a String type, returns {@code null}.
*/
@Nullable public String getString() {
return mStringValue;
}
/**
* Returns {@code true} if the property is a String type. Otherwise {@code false}.
*/
public boolean isString() {
return mType == TYPE_STRING;
}
/**
* Adds a mapping from the given key to this property's value in the provided
* {@link android.os.Bundle}. If the provided {@link android.os.Bundle} is
* {@code null}, creates a new {@link android.os.Bundle}.
* @hide
*/
public Bundle toBundle(Bundle outBundle) {
final Bundle b = outBundle == null || outBundle == Bundle.EMPTY
? new Bundle() : outBundle;
if (mType == TYPE_BOOLEAN) {
b.putBoolean(mName, mBooleanValue);
} else if (mType == TYPE_FLOAT) {
b.putFloat(mName, mFloatValue);
} else if (mType == TYPE_INTEGER) {
b.putInt(mName, mIntegerValue);
} else if (mType == TYPE_RESOURCE) {
b.putInt(mName, mIntegerValue);
} else if (mType == TYPE_STRING) {
b.putString(mName, mStringValue);
}
return b;
}
@Override
public int describeContents() {
return 0;
}
@Override
public void writeToParcel(@NonNull Parcel dest, int flags) {
dest.writeString(mName);
dest.writeInt(mType);
dest.writeString(mPackageName);
dest.writeString(mClassName);
if (mType == TYPE_BOOLEAN) {
dest.writeBoolean(mBooleanValue);
} else if (mType == TYPE_FLOAT) {
dest.writeFloat(mFloatValue);
} else if (mType == TYPE_INTEGER) {
dest.writeInt(mIntegerValue);
} else if (mType == TYPE_RESOURCE) {
dest.writeInt(mIntegerValue);
} else if (mType == TYPE_STRING) {
dest.writeString(mStringValue);
}
}
@NonNull
public static final Creator
* This is used by the {@link #setComponentEnabledSettings(List)} to support the batch updates
* of the enabled settings of components.
*
* @see #setComponentEnabledSettings(List)
*/
@DataClass(genConstructor = false)
public static final class ComponentEnabledSetting implements Parcelable {
/**
* The package name of the application to enable the setting.
*/
private final @Nullable String mPackageName;
/**
* The component name of the application to enable the setting.
*/
private final @Nullable ComponentName mComponentName;
/**
* The new enabled state
*/
private final @EnabledState int mEnabledState;
/**
* The optional behavior flag
*/
private final @EnabledFlags int mEnabledFlags;
/**
* Create an instance of the ComponentEnabledSetting for the component level's enabled
* setting update.
*
* @param componentName The component name to update the enabled setting.
* @param newState The new enabled state.
* @param flags The optional behavior flags.
*/
public ComponentEnabledSetting(@NonNull ComponentName componentName,
@EnabledState int newState, @EnabledFlags int flags) {
mPackageName = null;
mComponentName = Objects.requireNonNull(componentName);
mEnabledState = newState;
mEnabledFlags = flags;
}
/**
* Create an instance of the ComponentEnabledSetting for the application level's enabled
* setting update.
*
* @param packageName The package name to update the enabled setting.
* @param newState The new enabled state.
* @param flags The optional behavior flags.
* @hide
*/
public ComponentEnabledSetting(@NonNull String packageName,
@EnabledState int newState, @EnabledFlags int flags) {
mPackageName = Objects.requireNonNull(packageName);
mComponentName = null;
mEnabledState = newState;
mEnabledFlags = flags;
}
/**
* Returns the package name of the setting.
*
* @return the package name.
* @hide
*/
public @NonNull String getPackageName() {
if (isComponent()) {
return mComponentName.getPackageName();
}
return mPackageName;
}
/**
* Returns the component class name of the setting.
*
* @return the class name.
* @hide
*/
public @Nullable String getClassName() {
if (isComponent()) {
return mComponentName.getClassName();
}
return null;
}
/**
* Whether or not this is for the component level's enabled setting update.
*
* @return {@code true} if it's the component level enabled setting update.
* @hide
*/
public boolean isComponent() {
return mComponentName != null;
}
// Code below generated by codegen v1.0.23.
//
// DO NOT MODIFY!
// CHECKSTYLE:OFF Generated code
//
// To regenerate run:
// $ codegen $ANDROID_BUILD_TOP/frameworks/base/core/java/android/content/pm/PackageManager.java
//
// To exclude the generated code from IntelliJ auto-formatting enable (one-time):
// Settings > Editor > Code Style > Formatter Control
//@formatter:off
/**
* The component name of the application to enable the setting.
*/
@DataClass.Generated.Member
public @Nullable ComponentName getComponentName() {
return mComponentName;
}
/**
* The new enabled state
*/
@DataClass.Generated.Member
public @EnabledState int getEnabledState() {
return mEnabledState;
}
/**
* The optional behavior flag
*/
@DataClass.Generated.Member
public @EnabledFlags int getEnabledFlags() {
return mEnabledFlags;
}
@Override
@DataClass.Generated.Member
public void writeToParcel(@NonNull Parcel dest, int flags) {
// You can override field parcelling by defining methods like:
// void parcelFieldName(Parcel dest, int flags) { ... }
byte flg = 0;
if (mPackageName != null) flg |= 0x1;
if (mComponentName != null) flg |= 0x2;
dest.writeByte(flg);
if (mPackageName != null) dest.writeString(mPackageName);
if (mComponentName != null) dest.writeTypedObject(mComponentName, flags);
dest.writeInt(mEnabledState);
dest.writeInt(mEnabledFlags);
}
@Override
@DataClass.Generated.Member
public int describeContents() { return 0; }
/** @hide */
@SuppressWarnings({"unchecked", "RedundantCast"})
@DataClass.Generated.Member
/* package-private */ ComponentEnabledSetting(@NonNull Parcel in) {
// You can override field unparcelling by defining methods like:
// static FieldType unparcelFieldName(Parcel in) { ... }
byte flg = in.readByte();
String packageName = (flg & 0x1) == 0 ? null : in.readString();
ComponentName componentName = (flg & 0x2) == 0 ? null : (ComponentName) in.readTypedObject(ComponentName.CREATOR);
int enabledState = in.readInt();
int enabledFlags = in.readInt();
this.mPackageName = packageName;
this.mComponentName = componentName;
this.mEnabledState = enabledState;
com.android.internal.util.AnnotationValidations.validate(
EnabledState.class, null, mEnabledState);
this.mEnabledFlags = enabledFlags;
com.android.internal.util.AnnotationValidations.validate(
EnabledFlags.class, null, mEnabledFlags);
// onConstructed(); // You can define this method to get a callback
}
@DataClass.Generated.Member
public static final @NonNull Parcelable.Creator
* {@code GET_} flags are used to request additional data that may have been
* elided to save wire space.
*
* {@code MATCH_} flags are used to include components or packages that
* would have otherwise been omitted from a result set by current system
* state.
*/
/** @hide */
@LongDef(flag = true, prefix = { "GET_", "MATCH_" }, value = {
GET_ACTIVITIES,
GET_CONFIGURATIONS,
GET_GIDS,
GET_INSTRUMENTATION,
GET_INTENT_FILTERS,
GET_META_DATA,
GET_PERMISSIONS,
GET_PROVIDERS,
GET_RECEIVERS,
GET_SERVICES,
GET_SHARED_LIBRARY_FILES,
GET_SIGNATURES,
GET_SIGNING_CERTIFICATES,
GET_URI_PERMISSION_PATTERNS,
MATCH_UNINSTALLED_PACKAGES,
MATCH_DISABLED_COMPONENTS,
MATCH_DISABLED_UNTIL_USED_COMPONENTS,
MATCH_SYSTEM_ONLY,
MATCH_FACTORY_ONLY,
MATCH_ANY_USER,
MATCH_DEBUG_TRIAGED_MISSING,
MATCH_INSTANT,
MATCH_APEX,
MATCH_ARCHIVED_PACKAGES,
GET_DISABLED_COMPONENTS,
GET_DISABLED_UNTIL_USED_COMPONENTS,
GET_UNINSTALLED_PACKAGES,
MATCH_HIDDEN_UNTIL_INSTALLED_COMPONENTS,
MATCH_DIRECT_BOOT_AWARE,
MATCH_DIRECT_BOOT_UNAWARE,
GET_ATTRIBUTIONS_LONG,
})
@Retention(RetentionPolicy.SOURCE)
public @interface PackageInfoFlagsBits {}
/** @hide */
@LongDef(flag = true, prefix = { "GET_", "MATCH_" }, value = {
GET_META_DATA,
GET_SHARED_LIBRARY_FILES,
MATCH_UNINSTALLED_PACKAGES,
MATCH_SYSTEM_ONLY,
MATCH_DEBUG_TRIAGED_MISSING,
MATCH_DISABLED_COMPONENTS,
MATCH_DISABLED_UNTIL_USED_COMPONENTS,
MATCH_INSTANT,
MATCH_STATIC_SHARED_AND_SDK_LIBRARIES,
GET_DISABLED_UNTIL_USED_COMPONENTS,
GET_UNINSTALLED_PACKAGES,
MATCH_HIDDEN_UNTIL_INSTALLED_COMPONENTS,
MATCH_APEX,
MATCH_ARCHIVED_PACKAGES,
})
@Retention(RetentionPolicy.SOURCE)
public @interface ApplicationInfoFlagsBits {}
/** @hide */
@LongDef(flag = true, prefix = { "GET_", "MATCH_" }, value = {
GET_META_DATA,
GET_SHARED_LIBRARY_FILES,
MATCH_ALL,
MATCH_DEBUG_TRIAGED_MISSING,
MATCH_DEFAULT_ONLY,
MATCH_DISABLED_COMPONENTS,
MATCH_DISABLED_UNTIL_USED_COMPONENTS,
MATCH_DIRECT_BOOT_AUTO,
MATCH_DIRECT_BOOT_AWARE,
MATCH_DIRECT_BOOT_UNAWARE,
MATCH_SYSTEM_ONLY,
MATCH_UNINSTALLED_PACKAGES,
MATCH_INSTANT,
MATCH_STATIC_SHARED_AND_SDK_LIBRARIES,
GET_DISABLED_COMPONENTS,
GET_DISABLED_UNTIL_USED_COMPONENTS,
GET_UNINSTALLED_PACKAGES,
MATCH_QUARANTINED_COMPONENTS,
})
@Retention(RetentionPolicy.SOURCE)
public @interface ComponentInfoFlagsBits {}
/** @hide */
@LongDef(flag = true, prefix = { "GET_", "MATCH_" }, value = {
GET_META_DATA,
GET_RESOLVED_FILTER,
GET_SHARED_LIBRARY_FILES,
MATCH_ALL,
MATCH_DEBUG_TRIAGED_MISSING,
MATCH_DISABLED_COMPONENTS,
MATCH_DISABLED_UNTIL_USED_COMPONENTS,
MATCH_DEFAULT_ONLY,
MATCH_DIRECT_BOOT_AUTO,
MATCH_DIRECT_BOOT_AWARE,
MATCH_DIRECT_BOOT_UNAWARE,
MATCH_SYSTEM_ONLY,
MATCH_UNINSTALLED_PACKAGES,
MATCH_INSTANT,
GET_DISABLED_COMPONENTS,
GET_DISABLED_UNTIL_USED_COMPONENTS,
GET_UNINSTALLED_PACKAGES,
MATCH_CLONE_PROFILE_LONG,
MATCH_QUARANTINED_COMPONENTS,
})
@Retention(RetentionPolicy.SOURCE)
public @interface ResolveInfoFlagsBits {}
/** @hide */
@IntDef(flag = true, prefix = { "GET_", "MATCH_" }, value = {
MATCH_ALL,
})
@Retention(RetentionPolicy.SOURCE)
public @interface InstalledModulesFlags {}
/** @hide */
@IntDef(flag = true, prefix = { "GET_", "MATCH_" }, value = {
GET_META_DATA,
})
@Retention(RetentionPolicy.SOURCE)
public @interface PermissionInfoFlags {}
/** @hide */
@IntDef(flag = true, prefix = { "GET_", "MATCH_" }, value = {
GET_META_DATA,
})
@Retention(RetentionPolicy.SOURCE)
public @interface PermissionGroupInfoFlags {}
/** @hide */
@IntDef(flag = true, prefix = { "GET_", "MATCH_" }, value = {
GET_META_DATA,
})
@Retention(RetentionPolicy.SOURCE)
public @interface InstrumentationInfoFlags {}
//-------------------------------------------------------------------------
// Beginning of GET_ and MATCH_ flags
//-------------------------------------------------------------------------
/**
* {@link PackageInfo} flag: return information about
* activities in the package in {@link PackageInfo#activities}.
*/
public static final int GET_ACTIVITIES = 0x00000001;
/**
* {@link PackageInfo} flag: return information about
* intent receivers in the package in
* {@link PackageInfo#receivers}.
*/
public static final int GET_RECEIVERS = 0x00000002;
/**
* {@link PackageInfo} flag: return information about
* services in the package in {@link PackageInfo#services}.
*/
public static final int GET_SERVICES = 0x00000004;
/**
* {@link PackageInfo} flag: return information about
* content providers in the package in
* {@link PackageInfo#providers}.
*/
public static final int GET_PROVIDERS = 0x00000008;
/**
* {@link PackageInfo} flag: return information about
* instrumentation in the package in
* {@link PackageInfo#instrumentation}.
*/
public static final int GET_INSTRUMENTATION = 0x00000010;
/**
* {@link PackageInfo} flag: return information about the
* intent filters supported by the activity.
*
* @deprecated The platform does not support getting {@link IntentFilter}s for the package.
*/
@Deprecated
public static final int GET_INTENT_FILTERS = 0x00000020;
/**
* {@link PackageInfo} flag: return information about the
* signatures included in the package.
*
* @deprecated use {@code GET_SIGNING_CERTIFICATES} instead
*/
@Deprecated
public static final int GET_SIGNATURES = 0x00000040;
/**
* {@link ResolveInfo} flag: return the IntentFilter that
* was matched for a particular ResolveInfo in
* {@link ResolveInfo#filter}.
*/
public static final int GET_RESOLVED_FILTER = 0x00000040;
/**
* {@link ComponentInfo} flag: return the {@link ComponentInfo#metaData}
* data {@link android.os.Bundle}s that are associated with a component.
* This applies for any API returning a ComponentInfo subclass.
*/
public static final int GET_META_DATA = 0x00000080;
/**
* {@link PackageInfo} flag: return the
* {@link PackageInfo#gids group ids} that are associated with an
* application.
* This applies for any API returning a PackageInfo class, either
* directly or nested inside of another.
*/
public static final int GET_GIDS = 0x00000100;
/**
* @deprecated replaced with {@link #MATCH_DISABLED_COMPONENTS}
*/
@Deprecated
public static final int GET_DISABLED_COMPONENTS = 0x00000200;
/**
* {@link PackageInfo} flag: include disabled components in the returned info.
*/
public static final int MATCH_DISABLED_COMPONENTS = 0x00000200;
/**
* {@link ApplicationInfo} flag: return the
* {@link ApplicationInfo#sharedLibraryFiles paths to the shared libraries}
* that are associated with an application.
* This applies for any API returning an ApplicationInfo class, either
* directly or nested inside of another.
*/
public static final int GET_SHARED_LIBRARY_FILES = 0x00000400;
/**
* {@link ProviderInfo} flag: return the
* {@link ProviderInfo#uriPermissionPatterns URI permission patterns}
* that are associated with a content provider.
* This applies for any API returning a ProviderInfo class, either
* directly or nested inside of another.
*/
public static final int GET_URI_PERMISSION_PATTERNS = 0x00000800;
/**
* {@link PackageInfo} flag: return information about
* permissions in the package in
* {@link PackageInfo#permissions}.
*/
public static final int GET_PERMISSIONS = 0x00001000;
/**
* @deprecated replaced with {@link #MATCH_UNINSTALLED_PACKAGES}
*/
@Deprecated
public static final int GET_UNINSTALLED_PACKAGES = 0x00002000;
/**
* Flag parameter to retrieve some information about all applications (even
* uninstalled ones) which have data directories. This state could have
* resulted if applications have been deleted with flag
* {@code DELETE_KEEP_DATA} with a possibility of being replaced or
* reinstalled in future.
*
* Note: this flag may cause less information about currently installed
* applications to be returned.
*
* Note: use of this flag requires the android.permission.QUERY_ALL_PACKAGES
* permission to see uninstalled packages.
*/
public static final int MATCH_UNINSTALLED_PACKAGES = 0x00002000;
/**
* {@link PackageInfo} flag: return information about
* hardware preferences in
* {@link PackageInfo#configPreferences PackageInfo.configPreferences},
* and requested features in {@link PackageInfo#reqFeatures} and
* {@link PackageInfo#featureGroups}.
*/
public static final int GET_CONFIGURATIONS = 0x00004000;
/**
* @deprecated replaced with {@link #MATCH_DISABLED_UNTIL_USED_COMPONENTS}.
*/
@Deprecated
public static final int GET_DISABLED_UNTIL_USED_COMPONENTS = 0x00008000;
/**
* {@link PackageInfo} flag: include disabled components which are in
* that state only because of {@link #COMPONENT_ENABLED_STATE_DISABLED_UNTIL_USED}
* in the returned info. Note that if you set this flag, applications
* that are in this disabled state will be reported as enabled.
*/
public static final int MATCH_DISABLED_UNTIL_USED_COMPONENTS = 0x00008000;
/**
* Resolution and querying flag: if set, only filters that support the
* {@link android.content.Intent#CATEGORY_DEFAULT} will be considered for
* matching. This is a synonym for including the CATEGORY_DEFAULT in your
* supplied Intent.
*/
public static final int MATCH_DEFAULT_ONLY = 0x00010000;
/**
* Querying flag: if set and if the platform is doing any filtering of the
* results, then the filtering will not happen. This is a synonym for saying
* that all results should be returned.
*
* This flag should be used with extreme care.
*/
public static final int MATCH_ALL = 0x00020000;
/**
* Querying flag: match components which are direct boot unaware in
* the returned info, regardless of the current user state.
*
* When neither {@link #MATCH_DIRECT_BOOT_AWARE} nor
* {@link #MATCH_DIRECT_BOOT_UNAWARE} are specified, the default behavior is
* to match only runnable components based on the user state. For example,
* when a user is started but credentials have not been presented yet, the
* user is running "locked" and only {@link #MATCH_DIRECT_BOOT_AWARE}
* components are returned. Once the user credentials have been presented,
* the user is running "unlocked" and both {@link #MATCH_DIRECT_BOOT_AWARE}
* and {@link #MATCH_DIRECT_BOOT_UNAWARE} components are returned.
*
* @see UserManager#isUserUnlocked()
*/
public static final int MATCH_DIRECT_BOOT_UNAWARE = 0x00040000;
/**
* Querying flag: match components which are direct boot aware in
* the returned info, regardless of the current user state.
*
* When neither {@link #MATCH_DIRECT_BOOT_AWARE} nor
* {@link #MATCH_DIRECT_BOOT_UNAWARE} are specified, the default behavior is
* to match only runnable components based on the user state. For example,
* when a user is started but credentials have not been presented yet, the
* user is running "locked" and only {@link #MATCH_DIRECT_BOOT_AWARE}
* components are returned. Once the user credentials have been presented,
* the user is running "unlocked" and both {@link #MATCH_DIRECT_BOOT_AWARE}
* and {@link #MATCH_DIRECT_BOOT_UNAWARE} components are returned.
*
* @see UserManager#isUserUnlocked()
*/
public static final int MATCH_DIRECT_BOOT_AWARE = 0x00080000;
/**
* Querying flag: include only components from applications that are marked
* with {@link ApplicationInfo#FLAG_SYSTEM}.
*/
public static final int MATCH_SYSTEM_ONLY = 0x00100000;
/**
* Internal {@link PackageInfo} flag: include only components on the system image.
* This will not return information on any unbundled update to system components.
* @hide
*/
@SystemApi
public static final int MATCH_FACTORY_ONLY = 0x00200000;
/**
* Allows querying of packages installed for any user, not just the specific one. This flag
* is only meant for use by apps that have INTERACT_ACROSS_USERS permission.
* @hide
*/
@SystemApi
public static final int MATCH_ANY_USER = 0x00400000;
/**
* Combination of MATCH_ANY_USER and MATCH_UNINSTALLED_PACKAGES to mean any known
* package.
* @hide
*/
@TestApi
public static final int MATCH_KNOWN_PACKAGES = MATCH_UNINSTALLED_PACKAGES | MATCH_ANY_USER;
/**
* Internal {@link PackageInfo} flag: include components that are part of an
* instant app. By default, instant app components are not matched.
* @hide
*/
@SystemApi
public static final int MATCH_INSTANT = 0x00800000;
/**
* Internal {@link PackageInfo} flag: include only components that are exposed to
* instant apps. Matched components may have been either explicitly or implicitly
* exposed.
* @hide
*/
public static final int MATCH_VISIBLE_TO_INSTANT_APP_ONLY = 0x01000000;
/**
* Internal {@link PackageInfo} flag: include only components that have been
* explicitly exposed to instant apps.
* @hide
*/
public static final int MATCH_EXPLICITLY_VISIBLE_ONLY = 0x02000000;
/**
* Internal {@link PackageInfo} flag: include static shared and SDK libraries.
* Apps that depend on static shared/SDK libs can always access the version
* of the lib they depend on. System/shell/root can access all shared
* libs regardless of dependency but need to explicitly ask for them
* via this flag.
* @hide
*/
@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
public static final int MATCH_STATIC_SHARED_AND_SDK_LIBRARIES = 0x04000000;
/**
* {@link PackageInfo} flag: return the signing certificates associated with
* this package. Each entry is a signing certificate that the package
* has proven it is authorized to use, usually a past signing certificate from
* which it has rotated.
*/
public static final int GET_SIGNING_CERTIFICATES = 0x08000000;
/**
* Querying flag: automatically match components based on their Direct Boot
* awareness and the current user state.
*
* Since the default behavior is to automatically apply the current user
* state, this is effectively a sentinel value that doesn't change the
* output of any queries based on its presence or absence.
*
* Instead, this value can be useful in conjunction with
* {@link android.os.StrictMode.VmPolicy.Builder#detectImplicitDirectBoot()}
* to detect when a caller is relying on implicit automatic matching,
* instead of confirming the explicit behavior they want, using a
* combination of these flags:
* Note: Archived apps are a subset of apps returned by {@link #MATCH_UNINSTALLED_PACKAGES}.
* Note: this flag may cause less information about currently installed
* applications to be returned.
* Note: use of this flag requires the android.permission.QUERY_ALL_PACKAGES
* permission to see uninstalled packages.
*/
@FlaggedApi(android.content.pm.Flags.FLAG_ARCHIVING)
public static final long MATCH_ARCHIVED_PACKAGES = 1L << 32;
/**
* Querying flag: always match components of packages in quarantined state.
* @see #isPackageQuarantined
*/
@FlaggedApi(android.content.pm.Flags.FLAG_QUARANTINED_ENABLED)
public static final long MATCH_QUARANTINED_COMPONENTS = 1L << 33;
/**
* {@link ResolveInfo} flag: allow matching components across clone profile
*
* This flag is used only for query and not resolution, the default behaviour would be to
* restrict querying across clone profile. This flag would be honored only if caller have
* permission {@link Manifest.permission.QUERY_CLONED_APPS}.
*
* @hide
*/
@FlaggedApi(android.content.pm.Flags.FLAG_FIX_DUPLICATED_FLAGS)
@SystemApi
public static final long MATCH_CLONE_PROFILE_LONG = 1L << 34;
//-------------------------------------------------------------------------
// End of GET_ and MATCH_ flags
//-------------------------------------------------------------------------
/**
* Flag for {@link #addCrossProfileIntentFilter}: if this flag is set: when
* resolving an intent that matches the {@code CrossProfileIntentFilter},
* the current profile will be skipped. Only activities in the target user
* can respond to the intent.
*
* @hide
*/
public static final int SKIP_CURRENT_PROFILE = 0x00000002;
/**
* Flag for {@link #addCrossProfileIntentFilter}: if this flag is set:
* activities in the other profiles can respond to the intent only if no activity with
* non-negative priority in current profile can respond to the intent.
* @hide
*/
public static final int ONLY_IF_NO_MATCH_FOUND = 0x00000004;
/** @hide */
@IntDef(flag = true, prefix = { "MODULE_" }, value = {
MODULE_APEX_NAME,
})
@Retention(RetentionPolicy.SOURCE)
public @interface ModuleInfoFlags {}
/**
* Flag for {@link #getModuleInfo}: allow ModuleInfo to be retrieved using the apex module
* name, rather than the package name.
*
* @hide
*/
@SystemApi
public static final int MODULE_APEX_NAME = 0x00000001;
/** @hide */
@IntDef(prefix = { "PERMISSION_" }, value = {
PERMISSION_GRANTED,
PERMISSION_DENIED
})
@Retention(RetentionPolicy.SOURCE)
public @interface PermissionResult {}
/**
* Permission check result: this is returned by {@link #checkPermission}
* if the permission has been granted to the given package.
*/
public static final int PERMISSION_GRANTED = 0;
/**
* Permission check result: this is returned by {@link #checkPermission}
* if the permission has not been granted to the given package.
*/
public static final int PERMISSION_DENIED = -1;
/** @hide */
@IntDef(prefix = { "SIGNATURE_" }, value = {
SIGNATURE_MATCH,
SIGNATURE_NEITHER_SIGNED,
SIGNATURE_FIRST_NOT_SIGNED,
SIGNATURE_SECOND_NOT_SIGNED,
SIGNATURE_NO_MATCH,
SIGNATURE_UNKNOWN_PACKAGE,
})
@Retention(RetentionPolicy.SOURCE)
public @interface SignatureResult {}
/**
* Signature check result: this is returned by {@link #checkSignatures}
* if all signatures on the two packages match.
*/
public static final int SIGNATURE_MATCH = 0;
/**
* Signature check result: this is returned by {@link #checkSignatures}
* if neither of the two packages is signed.
*/
public static final int SIGNATURE_NEITHER_SIGNED = 1;
/**
* Signature check result: this is returned by {@link #checkSignatures}
* if the first package is not signed but the second is.
*/
public static final int SIGNATURE_FIRST_NOT_SIGNED = -1;
/**
* Signature check result: this is returned by {@link #checkSignatures}
* if the second package is not signed but the first is.
*/
public static final int SIGNATURE_SECOND_NOT_SIGNED = -2;
/**
* Signature check result: this is returned by {@link #checkSignatures}
* if not all signatures on both packages match.
*/
public static final int SIGNATURE_NO_MATCH = -3;
/**
* Signature check result: this is returned by {@link #checkSignatures}
* if either of the packages are not valid.
*/
public static final int SIGNATURE_UNKNOWN_PACKAGE = -4;
/** @hide */
@IntDef(prefix = { "COMPONENT_ENABLED_STATE_" }, value = {
COMPONENT_ENABLED_STATE_DEFAULT,
COMPONENT_ENABLED_STATE_ENABLED,
COMPONENT_ENABLED_STATE_DISABLED,
COMPONENT_ENABLED_STATE_DISABLED_USER,
COMPONENT_ENABLED_STATE_DISABLED_UNTIL_USED,
})
@Retention(RetentionPolicy.SOURCE)
public @interface EnabledState {}
/**
* Flag for {@link #setApplicationEnabledSetting(String, int, int)} and
* {@link #setComponentEnabledSetting(ComponentName, int, int)}: This
* component or application is in its default enabled state (as specified in
* its manifest).
*
* Explicitly setting the component state to this value restores it's
* enabled state to whatever is set in the manifest.
*/
public static final int COMPONENT_ENABLED_STATE_DEFAULT = 0;
/**
* Flag for {@link #setApplicationEnabledSetting(String, int, int)}
* and {@link #setComponentEnabledSetting(ComponentName, int, int)}: This
* component or application has been explictily enabled, regardless of
* what it has specified in its manifest.
*/
public static final int COMPONENT_ENABLED_STATE_ENABLED = 1;
/**
* Flag for {@link #setApplicationEnabledSetting(String, int, int)}
* and {@link #setComponentEnabledSetting(ComponentName, int, int)}: This
* component or application has been explicitly disabled, regardless of
* what it has specified in its manifest.
*/
public static final int COMPONENT_ENABLED_STATE_DISABLED = 2;
/**
* Flag for {@link #setApplicationEnabledSetting(String, int, int)} only: The
* user has explicitly disabled the application, regardless of what it has
* specified in its manifest. Because this is due to the user's request,
* they may re-enable it if desired through the appropriate system UI. This
* option currently cannot be used with
* {@link #setComponentEnabledSetting(ComponentName, int, int)}.
*/
public static final int COMPONENT_ENABLED_STATE_DISABLED_USER = 3;
/**
* Flag for {@link #setApplicationEnabledSetting(String, int, int)} only: This
* application should be considered, until the point where the user actually
* wants to use it. This means that it will not normally show up to the user
* (such as in the launcher), but various parts of the user interface can
* use {@link #GET_DISABLED_UNTIL_USED_COMPONENTS} to still see it and allow
* the user to select it (as for example an IME, device admin, etc). Such code,
* once the user has selected the app, should at that point also make it enabled.
* This option currently can not be used with
* {@link #setComponentEnabledSetting(ComponentName, int, int)}.
*/
public static final int COMPONENT_ENABLED_STATE_DISABLED_UNTIL_USED = 4;
/** @hide */
@Retention(RetentionPolicy.SOURCE)
@IntDef(prefix = { "ROLLBACK_DATA_POLICY_" }, value = {
ROLLBACK_DATA_POLICY_RESTORE,
ROLLBACK_DATA_POLICY_WIPE,
ROLLBACK_DATA_POLICY_RETAIN
})
public @interface RollbackDataPolicy {}
/**
* User data will be backed up during install and restored during rollback.
*
* @hide
*/
@SystemApi
public static final int ROLLBACK_DATA_POLICY_RESTORE = 0;
/**
* User data won't be backed up during install but will be wiped out during rollback.
*
* @hide
*/
@SystemApi
public static final int ROLLBACK_DATA_POLICY_WIPE = 1;
/**
* User data won't be backed up during install and will remain unchanged during rollback.
*
* @hide
*/
@SystemApi
public static final int ROLLBACK_DATA_POLICY_RETAIN = 2;
/** @hide */
@IntDef(prefix = {"ROLLBACK_USER_IMPACT_"}, value = {
ROLLBACK_USER_IMPACT_LOW,
ROLLBACK_USER_IMPACT_HIGH,
ROLLBACK_USER_IMPACT_ONLY_MANUAL,
})
@Retention(RetentionPolicy.SOURCE)
public @interface RollbackImpactLevel {}
/**
* Rollback will be performed automatically in response to native crashes on startup or
* persistent service crashes. More suitable for apps that do not store any user data.
*
* @hide
*/
@SystemApi
@FlaggedApi(android.content.pm.Flags.FLAG_RECOVERABILITY_DETECTION)
public static final int ROLLBACK_USER_IMPACT_LOW = 0;
/**
* Rollback will be performed automatically only when the device is found to be unrecoverable.
* More suitable for apps that store user data and have higher impact on user.
*
* @hide
*/
@SystemApi
@FlaggedApi(android.content.pm.Flags.FLAG_RECOVERABILITY_DETECTION)
public static final int ROLLBACK_USER_IMPACT_HIGH = 1;
/**
* Rollback will not be performed automatically. It can be triggered externally.
*
* @hide
*/
@SystemApi
@FlaggedApi(android.content.pm.Flags.FLAG_RECOVERABILITY_DETECTION)
public static final int ROLLBACK_USER_IMPACT_ONLY_MANUAL = 2;
/** @hide */
@IntDef(flag = true, prefix = { "INSTALL_" }, value = {
INSTALL_REPLACE_EXISTING,
INSTALL_ALLOW_TEST,
INSTALL_INTERNAL,
INSTALL_FROM_ADB,
INSTALL_ALL_USERS,
INSTALL_REQUEST_DOWNGRADE,
INSTALL_GRANT_ALL_REQUESTED_PERMISSIONS,
INSTALL_ALL_WHITELIST_RESTRICTED_PERMISSIONS,
INSTALL_FORCE_VOLUME_UUID,
INSTALL_FORCE_PERMISSION_PROMPT,
INSTALL_INSTANT_APP,
INSTALL_DONT_KILL_APP,
INSTALL_FULL_APP,
INSTALL_ALLOCATE_AGGRESSIVE,
INSTALL_VIRTUAL_PRELOAD,
INSTALL_APEX,
INSTALL_ENABLE_ROLLBACK,
INSTALL_ALLOW_DOWNGRADE,
INSTALL_STAGED,
INSTALL_REQUEST_UPDATE_OWNERSHIP,
INSTALL_IGNORE_DEXOPT_PROFILE,
INSTALL_UNARCHIVE_DRAFT,
INSTALL_UNARCHIVE,
})
@Retention(RetentionPolicy.SOURCE)
public @interface InstallFlags {}
/**
* Install flags that can only be used in development workflows (e.g. {@code adb install}).
* @hide
*/
@IntDef(flag = true, prefix = { "INSTALL_DEVELOPMENT_" }, value = {
INSTALL_DEVELOPMENT_FORCE_NON_STAGED_APEX_UPDATE,
})
@Retention(RetentionPolicy.SOURCE)
public @interface DevelopmentInstallFlags {}
/**
* Flag parameter for {@link #installPackage} to indicate that you want to
* replace an already installed package, if one exists.
*
* @hide
*/
@UnsupportedAppUsage
public static final int INSTALL_REPLACE_EXISTING = 0x00000002;
/**
* Flag parameter for {@link #installPackage} to indicate that you want to
* allow test packages (those that have set android:testOnly in their
* manifest) to be installed.
* @hide
*/
public static final int INSTALL_ALLOW_TEST = 0x00000004;
/**
* Flag parameter for {@link #installPackage} to indicate that this package
* must be installed to internal storage.
*
* @hide
*/
public static final int INSTALL_INTERNAL = 0x00000010;
/**
* Flag parameter for {@link #installPackage} to indicate that this install
* was initiated via ADB.
*
* @hide
*/
public static final int INSTALL_FROM_ADB = 0x00000020;
/**
* Flag parameter for {@link #installPackage} to indicate that this install
* should immediately be visible to all users.
*
* @hide
*/
public static final int INSTALL_ALL_USERS = 0x00000040;
/**
* Flag parameter for {@link #installPackage} to indicate that an upgrade to a lower version
* of a package than currently installed has been requested.
*
* Note that this flag doesn't guarantee that downgrade will be performed. That decision
* depends
* on whenever:
*
* Note: In retrospect it would have been preferred to use
* more inclusive terminology when naming this API. Similar APIs added will
* refrain from using the term "whitelist".
*
* The package name of the app which has already defined the permission is passed to a
* {@link PackageInstallObserver}, if any, as the {@link #EXTRA_FAILURE_EXISTING_PACKAGE} string
* extra; and the name of the permission being redefined is passed in the
* {@link #EXTRA_FAILURE_EXISTING_PERMISSION} string extra.
*
* @hide
*/
public static final int INSTALL_FAILED_DUPLICATE_PERMISSION = -112;
/**
* Installation failed return code: this is passed in the
* {@link PackageInstaller#EXTRA_LEGACY_STATUS} if the system failed to install the package
* because its packaged native code did not match any of the ABIs supported by the system.
*
* @hide
*/
public static final int INSTALL_FAILED_NO_MATCHING_ABIS = -113;
/**
* Internal return code for NativeLibraryHelper methods to indicate that the package
* being processed did not contain any native code. This is placed here only so that
* it can belong to the same value space as the other install failure codes.
*
* @hide
*/
@UnsupportedAppUsage
public static final int NO_NATIVE_LIBRARIES = -114;
/** {@hide} */
public static final int INSTALL_FAILED_ABORTED = -115;
/**
* Installation failed return code: install type is incompatible with some other
* installation flags supplied for the operation; or other circumstances such as trying
* to upgrade a system app via an Incremental or instant app install.
* @hide
*/
public static final int INSTALL_FAILED_SESSION_INVALID = -116;
/**
* Installation parse return code: this is passed in the
* {@link PackageInstaller#EXTRA_LEGACY_STATUS} if the dex metadata file is invalid or
* if there was no matching apk file for a dex metadata file.
*
* @hide
*/
public static final int INSTALL_FAILED_BAD_DEX_METADATA = -117;
/**
* Installation parse return code: this is passed in the
* {@link PackageInstaller#EXTRA_LEGACY_STATUS} if there is any signature problem.
*
* @hide
*/
public static final int INSTALL_FAILED_BAD_SIGNATURE = -118;
/**
* Installation failed return code: a new staged session was attempted to be committed while
* there is already one in-progress or new session has package that is already staged.
*
* @hide
*/
public static final int INSTALL_FAILED_OTHER_STAGED_SESSION_IN_PROGRESS = -119;
/**
* Installation failed return code: one of the child sessions does not match the parent session
* in respect to staged or rollback enabled parameters.
*
* @hide
*/
public static final int INSTALL_FAILED_MULTIPACKAGE_INCONSISTENCY = -120;
/**
* Installation failed return code: the required installed version code
* does not match the currently installed package version code.
*
* @hide
*/
public static final int INSTALL_FAILED_WRONG_INSTALLED_VERSION = -121;
/**
* Installation return code: this is passed in the {@link PackageInstaller#EXTRA_LEGACY_STATUS}
* if the new package failed because it contains a request to use a process that was not
* explicitly defined as part of its <processes> tag.
*
* @hide
*/
public static final int INSTALL_FAILED_PROCESS_NOT_DEFINED = -122;
/**
* Installation failed return code: the {@code resources.arsc} of one of the APKs being
* installed is compressed or not aligned on a 4-byte boundary. Resource tables that cannot be
* memory mapped exert excess memory pressure on the system and drastically slow down
* construction of {@link Resources} objects.
*
* @hide
*/
public static final int INSTALL_PARSE_FAILED_RESOURCES_ARSC_COMPRESSED = -124;
/**
* Installation failed return code: the package was skipped and should be ignored.
*
* The reason for the skip is undefined.
* @hide
*/
public static final int INSTALL_PARSE_FAILED_SKIPPED = -125;
/**
* Installation failed return code: this is passed in the
* {@link PackageInstaller#EXTRA_LEGACY_STATUS} if the system failed to install the package
* because it is attempting to define a permission group that is already defined by some
* existing package.
*
* @hide
*/
public static final int INSTALL_FAILED_DUPLICATE_PERMISSION_GROUP = -126;
/**
* Installation failed return code: this is passed in the
* {@link PackageInstaller#EXTRA_LEGACY_STATUS} if the system failed to install the package
* because it is attempting to define a permission in a group that does not exists or that is
* defined by an packages with an incompatible certificate.
*
* @hide
*/
public static final int INSTALL_FAILED_BAD_PERMISSION_GROUP = -127;
/**
* Installation failed return code: an error occurred during the activation phase of this
* session.
*
* @hide
*/
public static final int INSTALL_ACTIVATION_FAILED = -128;
/**
* Installation failed return code: requesting user pre-approval is currently unavailable.
*
* @hide
*/
public static final int INSTALL_FAILED_PRE_APPROVAL_NOT_AVAILABLE = -129;
/**
* Installation return code: this is passed in the {@link PackageInstaller#EXTRA_LEGACY_STATUS}
* if the new package declares bad certificate digest for a shared library in the package
* manifest.
*
* @hide
*/
public static final int INSTALL_FAILED_SHARED_LIBRARY_BAD_CERTIFICATE_DIGEST = -130;
/**
* Installation failed return code: if the system failed to install the package that
* {@link android.R.attr#multiArch} is true in its manifest because its packaged
* native code did not match all of the natively ABIs supported by the system.
*
* @hide
*/
public static final int INSTALL_FAILED_MULTI_ARCH_NOT_MATCH_ALL_NATIVE_ABIS = -131;
/**
* App minimum aspect ratio set by the user which will override app-defined aspect ratio.
*
* @hide
*/
@IntDef(prefix = { "USER_MIN_ASPECT_RATIO_" }, value = {
USER_MIN_ASPECT_RATIO_UNSET,
USER_MIN_ASPECT_RATIO_SPLIT_SCREEN,
USER_MIN_ASPECT_RATIO_DISPLAY_SIZE,
USER_MIN_ASPECT_RATIO_4_3,
USER_MIN_ASPECT_RATIO_16_9,
USER_MIN_ASPECT_RATIO_3_2,
USER_MIN_ASPECT_RATIO_FULLSCREEN,
USER_MIN_ASPECT_RATIO_APP_DEFAULT,
})
@Retention(RetentionPolicy.SOURCE)
public @interface UserMinAspectRatio {}
/**
* No aspect ratio override has been set by user.
*
* @hide
*/
public static final int USER_MIN_ASPECT_RATIO_UNSET = 0;
/**
* Aspect ratio override code: user forces app to split screen aspect ratio. This is adjusted to
* half of the screen without the split screen divider.
*
* @hide
*/
public static final int USER_MIN_ASPECT_RATIO_SPLIT_SCREEN = 1;
/**
* Aspect ratio override code: user forces app to the aspect ratio of the device display size.
* This will be the portrait aspect ratio of the device if the app has fixed portrait
* orientation or the landscape aspect ratio of the device if the app has fixed landscape
* orientation.
*
* @hide
*/
public static final int USER_MIN_ASPECT_RATIO_DISPLAY_SIZE = 2;
/**
* Aspect ratio override code: user forces app to 4:3 min aspect ratio
* @hide
*/
public static final int USER_MIN_ASPECT_RATIO_4_3 = 3;
/**
* Aspect ratio override code: user forces app to 16:9 min aspect ratio
* @hide
*/
public static final int USER_MIN_ASPECT_RATIO_16_9 = 4;
/**
* Aspect ratio override code: user forces app to 3:2 min aspect ratio
* @hide
*/
public static final int USER_MIN_ASPECT_RATIO_3_2 = 5;
/**
* Aspect ratio override code: user forces app to fullscreen
* @hide
*/
public static final int USER_MIN_ASPECT_RATIO_FULLSCREEN = 6;
/**
* Aspect ratio override code: user sets to app's default aspect ratio.
* This resets both the user-forced aspect ratio, and the device manufacturer
* per-app override {@link ActivityInfo#OVERRIDE_ANY_ORIENTATION_TO_USER}.
* It is different from {@link #USER_MIN_ASPECT_RATIO_UNSET} as the latter may
* apply the device manufacturer per-app orientation override if any,
* @hide
*/
public static final int USER_MIN_ASPECT_RATIO_APP_DEFAULT = 7;
/** @hide */
@IntDef(flag = true, prefix = { "DELETE_" }, value = {
DELETE_KEEP_DATA,
DELETE_ALL_USERS,
DELETE_SYSTEM_APP,
DELETE_DONT_KILL_APP,
DELETE_CHATTY,
})
@Retention(RetentionPolicy.SOURCE)
public @interface DeleteFlags {}
/**
* Flag parameter for {@link #deletePackage} to indicate that you don't want to delete the
* package's data directory.
*
* @hide
*/
@SystemApi
public static final int DELETE_KEEP_DATA = 0x00000001;
/**
* Flag parameter for {@link #deletePackage} to indicate that you want the
* package deleted for all users.
*
* @hide
*/
@SystemApi
public static final int DELETE_ALL_USERS = 0x00000002;
/**
* Flag parameter for {@link #deletePackage} to indicate that, if you are calling
* uninstall on a system that has been updated, then don't do the normal process
* of uninstalling the update and rolling back to the older system version (which
* needs to happen for all users); instead, just mark the app as uninstalled for
* the current user.
*
* @hide
*/
public static final int DELETE_SYSTEM_APP = 0x00000004;
/**
* Flag parameter for {@link #deletePackage} to indicate that, if you are calling
* uninstall on a package that is replaced to provide new feature splits, the
* existing application should not be killed during the removal process.
*
* @hide
*/
public static final int DELETE_DONT_KILL_APP = 0x00000008;
/**
* Flag parameter for {@link PackageInstaller#uninstall(VersionedPackage, int, IntentSender)} to
* indicate that the deletion is an archival. This
* flag is only for internal usage as part of
* {@link PackageInstaller#requestArchive}.
*/
@FlaggedApi(android.content.pm.Flags.FLAG_ARCHIVING)
public static final int DELETE_ARCHIVE = 0x00000010;
/**
* Flag parameter for {@link #deletePackage} to indicate that package deletion
* should be chatty.
*
* @hide
*/
public static final int DELETE_CHATTY = 0x80000000;
/**
* Return code for when package deletion succeeds. This is passed to the
* {@link IPackageDeleteObserver} if the system succeeded in deleting the
* package.
*
* @hide
*/
@SystemApi
public static final int DELETE_SUCCEEDED = 1;
/**
* Deletion failed return code: this is passed to the
* {@link IPackageDeleteObserver} if the system failed to delete the package
* for an unspecified reason.
*
* @hide
*/
@SystemApi
public static final int DELETE_FAILED_INTERNAL_ERROR = -1;
/**
* Deletion failed return code: this is passed to the
* {@link IPackageDeleteObserver} if the system failed to delete the package
* because it is the active DevicePolicy manager.
*
* @hide
*/
@SystemApi
public static final int DELETE_FAILED_DEVICE_POLICY_MANAGER = -2;
/**
* Deletion failed return code: this is passed to the
* {@link IPackageDeleteObserver} if the system failed to delete the package
* since the user is restricted.
*
* @hide
*/
public static final int DELETE_FAILED_USER_RESTRICTED = -3;
/**
* Deletion failed return code: this is passed to the
* {@link IPackageDeleteObserver} if the system failed to delete the package
* because a profile or device owner has marked the package as
* uninstallable.
*
* @hide
*/
@SystemApi
public static final int DELETE_FAILED_OWNER_BLOCKED = -4;
/** {@hide} */
@SystemApi
public static final int DELETE_FAILED_ABORTED = -5;
/**
* Deletion failed return code: this is passed to the
* {@link IPackageDeleteObserver} if the system failed to delete the package
* because the packge is a shared library used by other installed packages.
* {@hide} */
public static final int DELETE_FAILED_USED_SHARED_LIBRARY = -6;
/**
* Deletion failed return code: this is passed to the
* {@link IPackageDeleteObserver} if the system failed to delete the package
* because there is an app pinned.
*
* @hide
*/
public static final int DELETE_FAILED_APP_PINNED = -7;
/**
* Deletion failed return code: this is passed to the
* {@link IPackageDeleteObserver} if the system failed to delete the package
* for any child profile with {@link UserProperties#getDeleteAppWithParent()} as true.
* @hide
*/
public static final int DELETE_FAILED_FOR_CHILD_PROFILE = -8;
/**
* Return code that is passed to the {@link IPackageMoveObserver} when the
* package has been successfully moved by the system.
*
* @hide
*/
public static final int MOVE_SUCCEEDED = -100;
/**
* Error code that is passed to the {@link IPackageMoveObserver} when the
* package hasn't been successfully moved by the system because of
* insufficient memory on specified media.
*
* @hide
*/
public static final int MOVE_FAILED_INSUFFICIENT_STORAGE = -1;
/**
* Error code that is passed to the {@link IPackageMoveObserver} if the
* specified package doesn't exist.
*
* @hide
*/
public static final int MOVE_FAILED_DOESNT_EXIST = -2;
/**
* Error code that is passed to the {@link IPackageMoveObserver} if the
* specified package cannot be moved since its a system package.
*
* @hide
*/
public static final int MOVE_FAILED_SYSTEM_PACKAGE = -3;
/**
* Error code that is passed to the {@link IPackageMoveObserver} if the
* specified package cannot be moved to the specified location.
*
* @hide
*/
public static final int MOVE_FAILED_INVALID_LOCATION = -5;
/**
* Error code that is passed to the {@link IPackageMoveObserver} if the
* specified package cannot be moved to the specified location.
*
* @hide
*/
public static final int MOVE_FAILED_INTERNAL_ERROR = -6;
/**
* Error code that is passed to the {@link IPackageMoveObserver} if the
* specified package already has an operation pending in the queue.
*
* @hide
*/
public static final int MOVE_FAILED_OPERATION_PENDING = -7;
/**
* Error code that is passed to the {@link IPackageMoveObserver} if the
* specified package cannot be moved since it contains a device admin.
*
* @hide
*/
public static final int MOVE_FAILED_DEVICE_ADMIN = -8;
/**
* Error code that is passed to the {@link IPackageMoveObserver} if system does not allow
* non-system apps to be moved to internal storage.
*
* @hide
*/
public static final int MOVE_FAILED_3RD_PARTY_NOT_ALLOWED_ON_INTERNAL = -9;
/** @hide */
public static final int MOVE_FAILED_LOCKED_USER = -10;
/**
* Flag parameter for {@link #movePackage} to indicate that
* the package should be moved to internal storage if its
* been installed on external media.
* @hide
*/
@Deprecated
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
public static final int MOVE_INTERNAL = 0x00000001;
/**
* Flag parameter for {@link #movePackage} to indicate that
* the package should be moved to external media.
* @hide
*/
@Deprecated
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
public static final int MOVE_EXTERNAL_MEDIA = 0x00000002;
/** {@hide} */
public static final String EXTRA_MOVE_ID = "android.content.pm.extra.MOVE_ID";
/**
* Extra field name for notifying package change event. Currently, it is used by PackageMonitor.
* @hide
*/
public static final String EXTRA_PACKAGE_MONITOR_CALLBACK_RESULT =
"android.content.pm.extra.EXTRA_PACKAGE_MONITOR_CALLBACK_RESULT";
/**
* Usable by the required verifier as the {@code verificationCode} argument
* for {@link PackageManager#verifyPendingInstall} to indicate that it will
* allow the installation to proceed without any of the optional verifiers
* needing to vote.
*
* @hide
*/
public static final int VERIFICATION_ALLOW_WITHOUT_SUFFICIENT = 2;
/**
* Used as the {@code verificationCode} argument for
* {@link PackageManager#verifyPendingInstall} to indicate that the calling
* package verifier allows the installation to proceed.
*/
public static final int VERIFICATION_ALLOW = 1;
/**
* Used as the {@code verificationCode} argument for
* {@link PackageManager#verifyPendingInstall} to indicate the calling
* package verifier does not vote to allow the installation to proceed.
*/
public static final int VERIFICATION_REJECT = -1;
/**
* Used as the {@code verificationCode} argument for
* {@link PackageManager#verifyIntentFilter} to indicate that the calling
* IntentFilter Verifier confirms that the IntentFilter is verified.
*
* @deprecated Use {@link DomainVerificationManager} APIs.
* @hide
*/
@Deprecated
@SystemApi
public static final int INTENT_FILTER_VERIFICATION_SUCCESS = 1;
/**
* Used as the {@code verificationCode} argument for
* {@link PackageManager#verifyIntentFilter} to indicate that the calling
* IntentFilter Verifier confirms that the IntentFilter is NOT verified.
*
* @deprecated Use {@link DomainVerificationManager} APIs.
* @hide
*/
@Deprecated
@SystemApi
public static final int INTENT_FILTER_VERIFICATION_FAILURE = -1;
/**
* Internal status code to indicate that an IntentFilter verification result is not specified.
*
* @deprecated Use {@link DomainVerificationManager} APIs.
* @hide
*/
@Deprecated
@SystemApi
public static final int INTENT_FILTER_DOMAIN_VERIFICATION_STATUS_UNDEFINED = 0;
/**
* Used as the {@code status} argument for
* {@link #updateIntentVerificationStatusAsUser} to indicate that the User
* will always be prompted the Intent Disambiguation Dialog if there are two
* or more Intent resolved for the IntentFilter's domain(s).
*
* @deprecated Use {@link DomainVerificationManager} APIs.
* @hide
*/
@Deprecated
@SystemApi
public static final int INTENT_FILTER_DOMAIN_VERIFICATION_STATUS_ASK = 1;
/**
* Used as the {@code status} argument for
* {@link #updateIntentVerificationStatusAsUser} to indicate that the User
* will never be prompted the Intent Disambiguation Dialog if there are two
* or more resolution of the Intent. The default App for the domain(s)
* specified in the IntentFilter will also ALWAYS be used.
*
* @deprecated Use {@link DomainVerificationManager} APIs.
* @hide
*/
@Deprecated
@SystemApi
public static final int INTENT_FILTER_DOMAIN_VERIFICATION_STATUS_ALWAYS = 2;
/**
* Used as the {@code status} argument for
* {@link #updateIntentVerificationStatusAsUser} to indicate that the User
* may be prompted the Intent Disambiguation Dialog if there are two or more
* Intent resolved. The default App for the domain(s) specified in the
* IntentFilter will also NEVER be presented to the User.
*
* @deprecated Use {@link DomainVerificationManager} APIs.
* @hide
*/
@Deprecated
@SystemApi
public static final int INTENT_FILTER_DOMAIN_VERIFICATION_STATUS_NEVER = 3;
/**
* Used as the {@code status} argument for
* {@link #updateIntentVerificationStatusAsUser} to indicate that this app
* should always be considered as an ambiguous candidate for handling the
* matching Intent even if there are other candidate apps in the "always"
* state. Put another way: if there are any 'always ask' apps in a set of
* more than one candidate app, then a disambiguation is *always* presented
* even if there is another candidate app with the 'always' state.
*
* @deprecated Use {@link DomainVerificationManager} APIs.
* @hide
*/
@Deprecated
@SystemApi
public static final int INTENT_FILTER_DOMAIN_VERIFICATION_STATUS_ALWAYS_ASK = 4;
/**
* Indicates that the app metadata does not exist or its source is unknown.
* @hide
*/
@FlaggedApi(android.content.pm.Flags.FLAG_ASL_IN_APK_APP_METADATA_SOURCE)
@SystemApi
public static final int APP_METADATA_SOURCE_UNKNOWN = 0;
/**
* Indicates that the app metadata is provided by the APK itself.
* @hide
*/
@FlaggedApi(android.content.pm.Flags.FLAG_ASL_IN_APK_APP_METADATA_SOURCE)
@SystemApi
public static final int APP_METADATA_SOURCE_APK = 1;
/**
* Indicates that the app metadata is provided by the installer that installed the app.
* @hide
*/
@FlaggedApi(android.content.pm.Flags.FLAG_ASL_IN_APK_APP_METADATA_SOURCE)
@SystemApi
public static final int APP_METADATA_SOURCE_INSTALLER = 2;
/**
* Indicates that the app metadata is provided as part of the system image.
* @hide
*/
@FlaggedApi(android.content.pm.Flags.FLAG_ASL_IN_APK_APP_METADATA_SOURCE)
@SystemApi
public static final int APP_METADATA_SOURCE_SYSTEM_IMAGE = 3;
/** @hide */
@IntDef(flag = true, prefix = { "APP_METADATA_SOURCE_" }, value = {
APP_METADATA_SOURCE_UNKNOWN,
APP_METADATA_SOURCE_APK,
APP_METADATA_SOURCE_INSTALLER,
APP_METADATA_SOURCE_SYSTEM_IMAGE,
})
@Retention(RetentionPolicy.SOURCE)
public @interface AppMetadataSource {}
/**
* Can be used as the {@code millisecondsToDelay} argument for
* {@link PackageManager#extendVerificationTimeout}. This is the
* maximum time {@code PackageManager} waits for the verification
* agent to return (in milliseconds).
*/
public static final long MAXIMUM_VERIFICATION_TIMEOUT = 60*60*1000;
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: The device's
* audio pipeline is low-latency, more suitable for audio applications sensitive to delays or
* lag in sound input or output.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_AUDIO_LOW_LATENCY = "android.hardware.audio.low_latency";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device includes at least one form of audio
* output, as defined in the Android Compatibility Definition Document (CDD)
* section 7.8 Audio.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_AUDIO_OUTPUT = "android.hardware.audio.output";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
* The device has professional audio level of functionality and performance.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_AUDIO_PRO = "android.hardware.audio.pro";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}
* which indicates whether head tracking for spatial audio operates with low-latency,
* as defined by the CDD criteria for the feature.
*
*/
@SdkConstant(SdkConstantType.FEATURE)
@FlaggedApi(FLAG_FEATURE_SPATIAL_AUDIO_HEADTRACKING_LOW_LATENCY)
public static final String FEATURE_AUDIO_SPATIAL_HEADTRACKING_LOW_LATENCY =
"android.hardware.audio.spatial.headtracking.low_latency";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device is capable of communicating with
* other devices via Bluetooth.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_BLUETOOTH = "android.hardware.bluetooth";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device is capable of communicating with
* other devices via Bluetooth Low Energy radio.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_BLUETOOTH_LE = "android.hardware.bluetooth_le";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device has a camera facing away
* from the screen.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_CAMERA = "android.hardware.camera";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device's camera supports auto-focus.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_CAMERA_AUTOFOCUS = "android.hardware.camera.autofocus";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device has at least one camera pointing in
* some direction, or can support an external camera being connected to it.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_CAMERA_ANY = "android.hardware.camera.any";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device can support having an external camera connected to it.
* The external camera may not always be connected or available to applications to use.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_CAMERA_EXTERNAL = "android.hardware.camera.external";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device's camera supports flash.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_CAMERA_FLASH = "android.hardware.camera.flash";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device has a front facing camera.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_CAMERA_FRONT = "android.hardware.camera.front";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: At least one
* of the cameras on the device supports the
* {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL full hardware}
* capability level.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_CAMERA_LEVEL_FULL = "android.hardware.camera.level.full";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: At least one
* of the cameras on the device supports the
* {@link android.hardware.camera2.CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_MANUAL_SENSOR manual sensor}
* capability level.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_CAMERA_CAPABILITY_MANUAL_SENSOR =
"android.hardware.camera.capability.manual_sensor";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: At least one
* of the cameras on the device supports the
* {@link android.hardware.camera2.CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_MANUAL_POST_PROCESSING manual post-processing}
* capability level.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_CAMERA_CAPABILITY_MANUAL_POST_PROCESSING =
"android.hardware.camera.capability.manual_post_processing";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: At least one
* of the cameras on the device supports the
* {@link android.hardware.camera2.CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_RAW RAW}
* capability level.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_CAMERA_CAPABILITY_RAW =
"android.hardware.camera.capability.raw";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: At least one
* of the cameras on the device supports the
* {@link android.hardware.camera2.CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_MOTION_TRACKING
* MOTION_TRACKING} capability level.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_CAMERA_AR =
"android.hardware.camera.ar";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device's main front and back cameras can stream
* concurrently as described in {@link
* android.hardware.camera2.CameraManager#getConcurrentCameraIds()}.
* While {@link android.hardware.camera2.CameraManager#getConcurrentCameraIds()} and
* associated APIs are only available on API level 30 or newer, this feature flag may be
* advertised by devices on API levels below 30. If present on such a device, the same
* guarantees hold: The main front and main back camera can be used at the same time, with
* guaranteed stream configurations as defined in the table for concurrent streaming at
* {@link android.hardware.camera2.CameraDevice#createCaptureSession(android.hardware.camera2.params.SessionConfiguration)}.
* Known feature versions include:
* See sections 2 and 9 in the
* Android CDD for more
* details.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_SECURITY_MODEL_COMPATIBLE =
"android.hardware.security.model.compatible";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports the OpenGL ES
*
* Android Extension Pack.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_OPENGLES_EXTENSION_PACK = "android.hardware.opengles.aep";
/**
* Feature for {@link #getSystemAvailableFeatures()} and {@link #hasSystemFeature(String)}.
* This feature indicates whether device supports
* Android Virtualization Framework.
*
* @hide
*/
@SystemApi
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_VIRTUALIZATION_FRAMEWORK =
"android.software.virtualization_framework";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature(String, int)}: If this feature is supported, the Vulkan
* implementation on this device is hardware accelerated, and the Vulkan native API will
* enumerate at least one {@code VkPhysicalDevice}, and the feature version will indicate what
* level of optional hardware features limits it supports.
*
* Level 0 includes the base Vulkan requirements as well as:
*
* Level 1 additionally includes:
*
* Compute level 0 indicates:
*
* Example: 2019-03-01 is encoded as 0x07E30301, and would indicate that the device passes the
* Vulkan dEQP test suite version that was current on 2019-03-01.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_VULKAN_DEQP_LEVEL = "android.software.vulkan.deqp.level";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature(String, int)}: If this feature is supported, the feature version
* specifies a date such that the device is known to pass the OpenGLES dEQP test suite
* associated with that date. The date is encoded as follows:
*
* Example: 2021-03-01 is encoded as 0x07E50301, and would indicate that the device passes the
* OpenGL ES dEQP test suite version that was current on 2021-03-01.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_OPENGLES_DEQP_LEVEL = "android.software.opengles.deqp.level";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device includes broadcast radio tuner.
* @hide
*/
@SystemApi
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_BROADCAST_RADIO = "android.hardware.broadcastradio";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device has a secure implementation of keyguard, meaning the
* device supports PIN, pattern and password as defined in Android CDD
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_SECURE_LOCK_SCREEN = "android.software.secure_lock_screen";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device includes an accelerometer.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_SENSOR_ACCELEROMETER = "android.hardware.sensor.accelerometer";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device includes a barometer (air
* pressure sensor.)
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_SENSOR_BAROMETER = "android.hardware.sensor.barometer";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device includes a magnetometer (compass).
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_SENSOR_COMPASS = "android.hardware.sensor.compass";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device includes a gyroscope.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_SENSOR_GYROSCOPE = "android.hardware.sensor.gyroscope";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device includes a limited axes accelerometer.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_SENSOR_ACCELEROMETER_LIMITED_AXES =
"android.hardware.sensor.accelerometer_limited_axes";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device includes a limited axes gyroscope.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_SENSOR_GYROSCOPE_LIMITED_AXES =
"android.hardware.sensor.gyroscope_limited_axes";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device includes an uncalibrated limited axes accelerometer.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_SENSOR_ACCELEROMETER_LIMITED_AXES_UNCALIBRATED =
"android.hardware.sensor.accelerometer_limited_axes_uncalibrated";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device includes an uncalibrated limited axes gyroscope.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_SENSOR_GYROSCOPE_LIMITED_AXES_UNCALIBRATED =
"android.hardware.sensor.gyroscope_limited_axes_uncalibrated";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device includes a light sensor.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_SENSOR_LIGHT = "android.hardware.sensor.light";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device includes a proximity sensor.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_SENSOR_PROXIMITY = "android.hardware.sensor.proximity";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device includes a hardware step counter.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_SENSOR_STEP_COUNTER = "android.hardware.sensor.stepcounter";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device includes a hardware step detector.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_SENSOR_STEP_DETECTOR = "android.hardware.sensor.stepdetector";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device includes a heart rate monitor.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_SENSOR_HEART_RATE = "android.hardware.sensor.heartrate";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The heart rate sensor on this device is an Electrocardiogram.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_SENSOR_HEART_RATE_ECG =
"android.hardware.sensor.heartrate.ecg";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device includes a relative humidity sensor.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_SENSOR_RELATIVE_HUMIDITY =
"android.hardware.sensor.relative_humidity";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device includes an ambient temperature sensor.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_SENSOR_AMBIENT_TEMPERATURE =
"android.hardware.sensor.ambient_temperature";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device includes a hinge angle sensor.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_SENSOR_HINGE_ANGLE = "android.hardware.sensor.hinge_angle";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device includes a heading sensor.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_SENSOR_HEADING = "android.hardware.sensor.heading";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports exposing head tracker sensors from peripheral
* devices via the dynamic sensors API.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_SENSOR_DYNAMIC_HEAD_TRACKER = "android.hardware.sensor.dynamic.head_tracker";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports high fidelity sensor processing
* capabilities.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_HIFI_SENSORS =
"android.hardware.sensor.hifi_sensors";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
* The device supports a hardware mechanism for invoking an assist gesture.
* @see android.provider.Settings.Secure#ASSIST_GESTURE_ENABLED
* @hide
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_ASSIST_GESTURE = "android.hardware.sensor.assist";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device has a telephony radio with data
* communication support.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_TELEPHONY = "android.hardware.telephony";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device has a CDMA telephony stack.
*
* This feature should only be defined if {@link #FEATURE_TELEPHONY} has been defined.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_TELEPHONY_CDMA = "android.hardware.telephony.cdma";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device has a GSM telephony stack.
*
* This feature should only be defined if {@link #FEATURE_TELEPHONY} has been defined.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_TELEPHONY_GSM = "android.hardware.telephony.gsm";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
* The device supports telephony carrier restriction mechanism.
*
* Devices declaring this feature must have an implementation of the
* {@link android.telephony.TelephonyManager#getAllowedCarriers} and
* {@link android.telephony.TelephonyManager#setAllowedCarriers}.
*
* This feature should only be defined if {@link #FEATURE_TELEPHONY_SUBSCRIPTION}
* has been defined.
* @hide
*/
@SystemApi
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_TELEPHONY_CARRIERLOCK =
"android.hardware.telephony.carrierlock";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: The device
* supports embedded subscriptions on eUICCs.
*
* This feature should only be defined if {@link #FEATURE_TELEPHONY_SUBSCRIPTION}
* has been defined.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_TELEPHONY_EUICC = "android.hardware.telephony.euicc";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: The device
* supports multiple enabled profiles on eUICCs.
*
* Devices declaring this feature must have an implementation of the
* {@link UiccCardInfo#getPorts},
* {@link UiccCardInfo#isMultipleEnabledProfilesSupported} and
* {@link android.telephony.euicc.EuiccManager#switchToSubscription (with portIndex)}.
*
* This feature should only be defined if {@link #FEATURE_TELEPHONY_EUICC} have been defined.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_TELEPHONY_EUICC_MEP = "android.hardware.telephony.euicc.mep";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: The device
* supports cell-broadcast reception using the MBMS APIs.
*
* This feature should only be defined if both {@link #FEATURE_TELEPHONY_SUBSCRIPTION}
* and {@link #FEATURE_TELEPHONY_RADIO_ACCESS} have been defined.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_TELEPHONY_MBMS = "android.hardware.telephony.mbms";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: The device
* supports attaching to IMS implementations using the ImsService API in telephony.
*
* This feature should only be defined if {@link #FEATURE_TELEPHONY_DATA} has been defined.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_TELEPHONY_IMS = "android.hardware.telephony.ims";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: The device
* supports a single IMS registration as defined by carrier networks in the IMS service
* implementation using the {@link ImsService} API, {@link GbaService} API, and IRadio 1.6 HAL.
*
* When set, the device must fully support the following APIs for an application to implement
* IMS single registration:
*
* This feature should only be defined if {@link #FEATURE_TELEPHONY_IMS} is also defined.
* @hide
*/
@SystemApi
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_TELEPHONY_IMS_SINGLE_REGISTRATION =
"android.hardware.telephony.ims.singlereg";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
* The device supports Telecom Service APIs.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_TELECOM = "android.software.telecom";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
* The device supports Telephony APIs for calling service.
*
* This feature should only be defined if {@link #FEATURE_TELEPHONY_RADIO_ACCESS},
* {@link #FEATURE_TELEPHONY_SUBSCRIPTION}, and {@link #FEATURE_TELECOM} have been defined.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_TELEPHONY_CALLING = "android.hardware.telephony.calling";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
* The device supports Telephony APIs for data service.
*
* This feature should only be defined if both {@link #FEATURE_TELEPHONY_SUBSCRIPTION}
* and {@link #FEATURE_TELEPHONY_RADIO_ACCESS} have been defined.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_TELEPHONY_DATA = "android.hardware.telephony.data";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
* The device supports Telephony APIs for SMS and MMS.
*
* This feature should only be defined if both {@link #FEATURE_TELEPHONY_SUBSCRIPTION}
* and {@link #FEATURE_TELEPHONY_RADIO_ACCESS} have been defined.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_TELEPHONY_MESSAGING = "android.hardware.telephony.messaging";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
* The device supports Telephony APIs for the radio access.
*
* This feature should only be defined if {@link #FEATURE_TELEPHONY} has been defined.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_TELEPHONY_RADIO_ACCESS =
"android.hardware.telephony.radio.access";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
* The device supports Telephony APIs for Satellite communication.
*
* This feature should only be defined if {@link #FEATURE_TELEPHONY_MESSAGING}
* has been defined.
*
* @hide
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_TELEPHONY_SATELLITE = "android.hardware.telephony.satellite";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
* The device supports Telephony APIs for the subscription.
*
* This feature should only be defined if {@link #FEATURE_TELEPHONY} has been defined.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_TELEPHONY_SUBSCRIPTION =
"android.hardware.telephony.subscription";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
* The device is capable of communicating with other devices via
* Thread networking protocol.
*/
@FlaggedApi(com.android.net.thread.platform.flags.Flags.FLAG_THREAD_ENABLED_PLATFORM)
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_THREAD_NETWORK = "android.hardware.thread_network";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device is capable of communicating with
* other devices via ultra wideband.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_UWB = "android.hardware.uwb";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports connecting to USB devices
* as the USB host.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_USB_HOST = "android.hardware.usb.host";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports connecting to USB accessories.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_USB_ACCESSORY = "android.hardware.usb.accessory";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The SIP API is enabled on the device.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_SIP = "android.software.sip";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports SIP-based VOIP.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_SIP_VOIP = "android.software.sip.voip";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The Connection Service API is enabled on the device.
* @deprecated use {@link #FEATURE_TELECOM} instead.
*/
@Deprecated
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_CONNECTION_SERVICE = "android.software.connectionservice";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device's display has a touch screen.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_TOUCHSCREEN = "android.hardware.touchscreen";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device's touch screen supports
* multitouch sufficient for basic two-finger gesture detection.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_TOUCHSCREEN_MULTITOUCH = "android.hardware.touchscreen.multitouch";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device's touch screen is capable of
* tracking two or more fingers fully independently.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_TOUCHSCREEN_MULTITOUCH_DISTINCT = "android.hardware.touchscreen.multitouch.distinct";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device's touch screen is capable of
* tracking a full hand of fingers fully independently -- that is, 5 or
* more simultaneous independent pointers.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_TOUCHSCREEN_MULTITOUCH_JAZZHAND = "android.hardware.touchscreen.multitouch.jazzhand";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device does not have a touch screen, but
* does support touch emulation for basic events. For instance, the
* device might use a mouse or remote control to drive a cursor, and
* emulate basic touch pointer events like down, up, drag, etc. All
* devices that support android.hardware.touchscreen or a sub-feature are
* presumed to also support faketouch.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_FAKETOUCH = "android.hardware.faketouch";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device does not have a touch screen, but
* does support touch emulation for basic events that supports distinct
* tracking of two or more fingers. This is an extension of
* {@link #FEATURE_FAKETOUCH} for input devices with this capability. Note
* that unlike a distinct multitouch screen as defined by
* {@link #FEATURE_TOUCHSCREEN_MULTITOUCH_DISTINCT}, these kinds of input
* devices will not actually provide full two-finger gestures since the
* input is being transformed to cursor movement on the screen. That is,
* single finger gestures will move a cursor; two-finger swipes will
* result in single-finger touch events; other two-finger gestures will
* result in the corresponding two-finger touch event.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_FAKETOUCH_MULTITOUCH_DISTINCT = "android.hardware.faketouch.multitouch.distinct";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device does not have a touch screen, but
* does support touch emulation for basic events that supports tracking
* a hand of fingers (5 or more fingers) fully independently.
* This is an extension of
* {@link #FEATURE_FAKETOUCH} for input devices with this capability. Note
* that unlike a multitouch screen as defined by
* {@link #FEATURE_TOUCHSCREEN_MULTITOUCH_JAZZHAND}, not all two finger
* gestures can be detected due to the limitations described for
* {@link #FEATURE_FAKETOUCH_MULTITOUCH_DISTINCT}.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_FAKETOUCH_MULTITOUCH_JAZZHAND = "android.hardware.faketouch.multitouch.jazzhand";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device has biometric hardware to detect a fingerprint.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_FINGERPRINT = "android.hardware.fingerprint";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device has biometric hardware to perform face authentication.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_FACE = "android.hardware.biometrics.face";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device has biometric hardware to perform iris authentication.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_IRIS = "android.hardware.biometrics.iris";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports portrait orientation
* screens. For backwards compatibility, you can assume that if neither
* this nor {@link #FEATURE_SCREEN_LANDSCAPE} is set then the device supports
* both portrait and landscape.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_SCREEN_PORTRAIT = "android.hardware.screen.portrait";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports landscape orientation
* screens. For backwards compatibility, you can assume that if neither
* this nor {@link #FEATURE_SCREEN_PORTRAIT} is set then the device supports
* both portrait and landscape.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_SCREEN_LANDSCAPE = "android.hardware.screen.landscape";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports live wallpapers.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_LIVE_WALLPAPER = "android.software.live_wallpaper";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports app widgets.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_APP_WIDGETS = "android.software.app_widgets";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports the
* {@link android.R.attr#cantSaveState} API.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_CANT_SAVE_STATE = "android.software.cant_save_state";
/**
* @hide
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports
* {@link android.service.games.GameService}.
*
* @hide
*/
@SdkConstant(SdkConstantType.FEATURE)
@SystemApi
public static final String FEATURE_GAME_SERVICE = "android.software.game_service";
/**
* @hide
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports
* {@link android.service.voice.VoiceInteractionService} and
* {@link android.app.VoiceInteractor}.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_VOICE_RECOGNIZERS = "android.software.voice_recognizers";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports a home screen that is replaceable
* by third party applications.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_HOME_SCREEN = "android.software.home_screen";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports adding new input methods implemented
* with the {@link android.inputmethodservice.InputMethodService} API.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_INPUT_METHODS = "android.software.input_methods";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports device policy enforcement via device admins.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_DEVICE_ADMIN = "android.software.device_admin";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports leanback UI. This is
* typically used in a living room television experience, but is a software
* feature unlike {@link #FEATURE_TELEVISION}. Devices running with this
* feature will use resources associated with the "television" UI mode.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_LEANBACK = "android.software.leanback";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports only leanback UI. Only
* applications designed for this experience should be run, though this is
* not enforced by the system.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_LEANBACK_ONLY = "android.software.leanback_only";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports live TV and can display
* contents from TV inputs implemented with the
* {@link android.media.tv.TvInputService} API.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_LIVE_TV = "android.software.live_tv";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports WiFi (802.11) networking.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_WIFI = "android.hardware.wifi";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports Wi-Fi Direct networking.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_WIFI_DIRECT = "android.hardware.wifi.direct";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports Wi-Fi Aware.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_WIFI_AWARE = "android.hardware.wifi.aware";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports Wi-Fi Passpoint and all
* Passpoint related APIs in {@link WifiManager} are supported. Refer to
* {@link WifiManager#addOrUpdatePasspointConfiguration} for more info.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_WIFI_PASSPOINT = "android.hardware.wifi.passpoint";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports Wi-Fi RTT (IEEE 802.11mc).
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_WIFI_RTT = "android.hardware.wifi.rtt";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports LoWPAN networking.
* @hide
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_LOWPAN = "android.hardware.lowpan";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: This is a device dedicated to showing UI
* on a vehicle headunit. A headunit here is defined to be inside a
* vehicle that may or may not be moving. A headunit uses either a
* primary display in the center console and/or additional displays in
* the instrument cluster or elsewhere in the vehicle. Headunit display(s)
* have limited size and resolution. The user will likely be focused on
* driving so limiting driver distraction is a primary concern. User input
* can be a variety of hard buttons, touch, rotary controllers and even mouse-
* like interfaces.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_AUTOMOTIVE = "android.hardware.type.automotive";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: This is a device dedicated to showing UI
* on a television. Television here is defined to be a typical living
* room television experience: displayed on a big screen, where the user
* is sitting far away from it, and the dominant form of input will be
* something like a DPAD, not through touch or mouse.
* @deprecated use {@link #FEATURE_LEANBACK} instead.
*/
@Deprecated
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_TELEVISION = "android.hardware.type.television";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: This is a device dedicated to showing UI
* on a watch. A watch here is defined to be a device worn on the body, perhaps on
* the wrist. The user is very close when interacting with the device.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_WATCH = "android.hardware.type.watch";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: This is a device for IoT and may not have an UI. An embedded
* device is defined as a full stack Android device with or without a display and no
* user-installable apps.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_EMBEDDED = "android.hardware.type.embedded";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: This is a device dedicated to be primarily used
* with keyboard, mouse or touchpad. This includes traditional desktop
* computers, laptops and variants such as convertibles or detachables.
* Due to the larger screen, the device will most likely use the
* {@link #FEATURE_FREEFORM_WINDOW_MANAGEMENT} feature as well.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_PC = "android.hardware.type.pc";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
* The device supports printing.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_PRINTING = "android.software.print";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
* The device supports {@link android.companion.CompanionDeviceManager#associate associating}
* with devices via {@link android.companion.CompanionDeviceManager}.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_COMPANION_DEVICE_SETUP
= "android.software.companion_device_setup";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
* The device can perform backup and restore operations on installed applications.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_BACKUP = "android.software.backup";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports freeform window management.
* Windows have title bars and can be moved and resized.
*/
// If this feature is present, you also need to set
// com.android.internal.R.config_freeformWindowManagement to true in your configuration overlay.
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_FREEFORM_WINDOW_MANAGEMENT
= "android.software.freeform_window_management";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
* The device supports picture-in-picture multi-window mode.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_PICTURE_IN_PICTURE = "android.software.picture_in_picture";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
* The device supports expanded picture-in-picture multi-window mode.
*
* @see android.app.PictureInPictureParams.Builder#setExpandedAspectRatio
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_EXPANDED_PICTURE_IN_PICTURE
= "android.software.expanded_picture_in_picture";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
* The device supports running activities on secondary displays. Displays here
* refers to both physical and virtual displays. Disabling this feature can impact
* support for application projection use-cases and support for virtual devices
* on the device.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_ACTIVITIES_ON_SECONDARY_DISPLAYS
= "android.software.activities_on_secondary_displays";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
* The device supports creating secondary users and managed profiles via
* {@link DevicePolicyManager}.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_MANAGED_USERS = "android.software.managed_users";
/**
* @hide
* TODO: Remove after dependencies updated b/17392243
*/
public static final String FEATURE_MANAGED_PROFILES = "android.software.managed_users";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
* The device supports verified boot.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_VERIFIED_BOOT = "android.software.verified_boot";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
* The device supports secure removal of users. When a user is deleted the data associated
* with that user is securely deleted and no longer available.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_SECURELY_REMOVES_USERS
= "android.software.securely_removes_users";
/** {@hide} */
@TestApi
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_FILE_BASED_ENCRYPTION
= "android.software.file_based_encryption";
/** {@hide} */
@TestApi
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_ADOPTABLE_STORAGE
= "android.software.adoptable_storage";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
* The device has a full implementation of the android.webkit.* APIs. Devices
* lacking this feature will not have a functioning WebView implementation.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_WEBVIEW = "android.software.webview";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: This device supports ethernet.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_ETHERNET = "android.hardware.ethernet";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: This device supports HDMI-CEC.
* @hide
*/
@TestApi
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_HDMI_CEC = "android.hardware.hdmi.cec";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
* The device has all of the inputs necessary to be considered a compatible game controller, or
* includes a compatible game controller in the box.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_GAMEPAD = "android.hardware.gamepad";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
* The device has a full implementation of the android.media.midi.* APIs.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_MIDI = "android.software.midi";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
* The device implements an optimized mode for virtual reality (VR) applications that handles
* stereoscopic rendering of notifications, and disables most monocular system UI components
* while a VR application has user focus.
* Devices declaring this feature must include an application implementing a
* {@link android.service.vr.VrListenerService} that can be targeted by VR applications via
* {@link android.app.Activity#setVrModeEnabled}.
* @deprecated use {@link #FEATURE_VR_MODE_HIGH_PERFORMANCE} instead.
*/
@Deprecated
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_VR_MODE = "android.software.vr.mode";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
* The device implements an optimized mode for virtual reality (VR) applications that handles
* stereoscopic rendering of notifications, disables most monocular system UI components
* while a VR application has user focus and meets extra CDD requirements to provide a
* high-quality VR experience.
* Devices declaring this feature must include an application implementing a
* {@link android.service.vr.VrListenerService} that can be targeted by VR applications via
* {@link android.app.Activity#setVrModeEnabled}.
* and must meet CDD requirements to provide a high-quality VR experience.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_VR_MODE_HIGH_PERFORMANCE
= "android.hardware.vr.high_performance";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
* The device supports autofill of user credentials, addresses, credit cards, etc
* via integration with {@link android.service.autofill.AutofillService autofill
* providers}.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_AUTOFILL = "android.software.autofill";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
* The device implements headtracking suitable for a VR device.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_VR_HEADTRACKING = "android.hardware.vr.headtracking";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature(String, int)}: If this feature is supported, the device implements
* the Android Keystore backed by an isolated execution environment. The version indicates
* which features are implemented in the isolated execution environment:
* This feature implies that the device supports XFRM Interfaces (CONFIG_XFRM_INTERFACE), or
* VTIs with kernel patches allowing updates of output/set mark via UPDSA.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_IPSEC_TUNNELS = "android.software.ipsec_tunnels";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: The device has
* the requisite kernel support for migrating IPsec tunnels to new source/destination addresses.
*
* This feature implies that the device supports XFRM Migration (CONFIG_XFRM_MIGRATE) and has
* the kernel fixes to support cross-address-family IPsec tunnel migration
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_IPSEC_TUNNEL_MIGRATION =
"android.software.ipsec_tunnel_migration";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports a system interface for the user to select
* and bind device control services provided by applications.
*
* @see android.service.controls.ControlsProviderService
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_CONTROLS = "android.software.controls";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: The device has
* the requisite hardware support to support reboot escrow of synthetic password for updates.
*
* This feature implies that the device has the RebootEscrow HAL implementation.
*
* @hide
*/
@SystemApi
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_REBOOT_ESCROW = "android.hardware.reboot_escrow";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: The device has
* the requisite kernel support to support incremental delivery aka Incremental FileSystem.
*
* feature not present - IncFs is not present on the device.
* 1 - IncFs v1, core features, no PerUid support. Optional in R.
* 2 - IncFs v2, PerUid support, fs-verity support. Required in S.
*
* @see IncrementalManager#isFeatureEnabled
* @see IncrementalManager#getVersion()
* @hide
*/
@SystemApi
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_INCREMENTAL_DELIVERY =
"android.software.incremental_delivery";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: The device
* has the requisite kernel support for the EROFS filesystem present in 4.19 kernels as a
* staging driver, which lacks 0padding and big pcluster support.
*
* @hide
*/
@SystemApi
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_EROFS_LEGACY = "android.software.erofs_legacy";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: The device
* has the requisite kernel support for the EROFS filesystem present in 5.10 kernels, which
* has 0padding, big pcluster, and chunked index support.
*
* @hide
*/
@SystemApi
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_EROFS = "android.software.erofs";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
* The device has tuner hardware to support tuner operations.
*
* This feature implies that the device has the tuner HAL implementation.
*
* @hide
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_TUNER = "android.hardware.tv.tuner";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: The device has
* the necessary changes to support app enumeration.
*
* @hide
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_APP_ENUMERATION = "android.software.app_enumeration";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: The device has
* a Keystore implementation that can only enforce limited use key in hardware with max usage
* count equals to 1.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_KEYSTORE_SINGLE_USE_KEY =
"android.hardware.keystore.single_use_key";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: The device has
* a Keystore implementation that can enforce limited use key in hardware with any max usage
* count (including count equals to 1).
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_KEYSTORE_LIMITED_USE_KEY =
"android.hardware.keystore.limited_use_key";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: The device has
* a Keystore implementation that can create application-specific attestation keys.
* See {@link android.security.keystore.KeyGenParameterSpec.Builder#setAttestKeyAlias}.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_KEYSTORE_APP_ATTEST_KEY =
"android.hardware.keystore.app_attest_key";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: The device
* is opted-in to receive per-app compatibility overrides that are applied in
* {@link com.android.server.compat.overrides.AppCompatOverridesService}.
*
* @hide
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_APP_COMPAT_OVERRIDES =
"android.software.app_compat_overrides";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: The device
* supports communal mode,
*
* @hide
*/
@SdkConstant(SdkConstantType.FEATURE)
@TestApi
public static final String FEATURE_COMMUNAL_MODE = "android.software.communal_mode";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: The device
* supports dream overlay feature, which is an informational layer shown on top of dreams.
*
* @hide
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_DREAM_OVERLAY = "android.software.dream_overlay";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: The device
* supports window magnification.
*
* @see android.accessibilityservice.MagnificationConfig#MAGNIFICATION_MODE_WINDOW
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_WINDOW_MAGNIFICATION =
"android.software.window_magnification";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: The device
* supports retrieval of user credentials, via integration with credential providers.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_CREDENTIALS = "android.software.credentials";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: The device
* supports locking (for example, by a financing provider in case of a missed payment).
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_DEVICE_LOCK = "android.software.device_lock";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: The device
* supports showing location-based suggestions for wallet cards provided by the default payment
* app.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_WALLET_LOCATION_BASED_SUGGESTIONS =
"android.software.wallet_location_based_suggestions";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: The device has
* the rotary encoder hardware to support rotating bezel on watch.
*
* @hide
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_ROTARY_ENCODER_LOW_RES =
"android.hardware.rotaryencoder.lowres";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: The device has
* support for contextual search helper.
*
* @hide
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_CONTEXTUAL_SEARCH_HELPER =
"android.software.contextualsearch";
/** @hide */
public static final boolean APP_ENUMERATION_ENABLED_BY_DEFAULT = true;
/**
* Extra field name for the URI to a verification file. Passed to a package verifier.
*
* @hide
*/
public static final String EXTRA_VERIFICATION_URI = "android.content.pm.extra.VERIFICATION_URI";
/**
* Extra field name for the ID of a package pending verification. Passed to
* a package verifier and is used to call back to
* {@link PackageManager#verifyPendingInstall(int, int)}
*/
public static final String EXTRA_VERIFICATION_ID = "android.content.pm.extra.VERIFICATION_ID";
/**
* Extra field name for the package identifier which is trying to install
* the package.
*
* @hide
*/
public static final String EXTRA_VERIFICATION_INSTALLER_PACKAGE
= "android.content.pm.extra.VERIFICATION_INSTALLER_PACKAGE";
/**
* Extra field name for the requested install flags for a package pending
* verification. Passed to a package verifier.
*
* @hide
*/
public static final String EXTRA_VERIFICATION_INSTALL_FLAGS
= "android.content.pm.extra.VERIFICATION_INSTALL_FLAGS";
/**
* Extra field name for the uid of who is requesting to install
* the package.
*
* @hide
*/
public static final String EXTRA_VERIFICATION_INSTALLER_UID
= "android.content.pm.extra.VERIFICATION_INSTALLER_UID";
/**
* Extra field name for the package name of a package pending verification.
*
* @hide
*/
public static final String EXTRA_VERIFICATION_PACKAGE_NAME
= "android.content.pm.extra.VERIFICATION_PACKAGE_NAME";
/**
* Extra field name for the result of a verification, either
* {@link #VERIFICATION_ALLOW}, or {@link #VERIFICATION_REJECT}.
* Passed to package verifiers after a package is verified.
*/
public static final String EXTRA_VERIFICATION_RESULT
= "android.content.pm.extra.VERIFICATION_RESULT";
/**
* Extra field name for tracking whether user action
* was requested for a particular install, either {@code true} or {@code false}.
* @hide
*/
public static final String EXTRA_USER_ACTION_REQUIRED
= "android.content.pm.extra.USER_ACTION_REQUIRED";
/**
* Extra field name for the version code of a package pending verification.
* @deprecated Use {@link #EXTRA_VERIFICATION_LONG_VERSION_CODE} instead.
* @hide
*/
@Deprecated
public static final String EXTRA_VERIFICATION_VERSION_CODE
= "android.content.pm.extra.VERIFICATION_VERSION_CODE";
/**
* Extra field name for the long version code of a package pending verification
* @hide
*/
public static final String EXTRA_VERIFICATION_LONG_VERSION_CODE =
"android.content.pm.extra.VERIFICATION_LONG_VERSION_CODE";
/**
* Extra field name for the Merkle tree root hash of a package.
* Passed to a package verifier both prior to verification and as a result
* of verification.
* The value of the extra is a specially formatted list:
* {@code filename1:HASH_1;filename2:HASH_2;...;filenameN:HASH_N}
* The extra must include an entry for every APK within an installation. If
* a hash is not physically present, a hash value of {@code 0} will be used.
* The root hash is generated using SHA-256, no salt with a 4096 byte block
* size. See the description of the
* fs-verity merkle-tree
* for more details.
* @hide
*/
@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
public static final String EXTRA_VERIFICATION_ROOT_HASH =
"android.content.pm.extra.VERIFICATION_ROOT_HASH";
/**
* Extra field name for the ID of a intent filter pending verification.
* Passed to an intent filter verifier and is used to call back to
* {@link #verifyIntentFilter}
*
* @deprecated Use DomainVerificationManager APIs.
* @hide
*/
@Deprecated
public static final String EXTRA_INTENT_FILTER_VERIFICATION_ID
= "android.content.pm.extra.INTENT_FILTER_VERIFICATION_ID";
/**
* Extra field name for the scheme used for an intent filter pending verification. Passed to
* an intent filter verifier and is used to construct the URI to verify against.
*
* Usually this is "https"
*
* @deprecated Use DomainVerificationManager APIs.
* @hide
*/
@Deprecated
public static final String EXTRA_INTENT_FILTER_VERIFICATION_URI_SCHEME
= "android.content.pm.extra.INTENT_FILTER_VERIFICATION_URI_SCHEME";
/**
* Extra field name for the host names to be used for an intent filter pending verification.
* Passed to an intent filter verifier and is used to construct the URI to verify the
* intent filter.
*
* This is a space delimited list of hosts.
*
* @deprecated Use DomainVerificationManager APIs.
* @hide
*/
@Deprecated
public static final String EXTRA_INTENT_FILTER_VERIFICATION_HOSTS
= "android.content.pm.extra.INTENT_FILTER_VERIFICATION_HOSTS";
/**
* Extra field name for the package name to be used for an intent filter pending verification.
* Passed to an intent filter verifier and is used to check the verification responses coming
* from the hosts. Each host response will need to include the package name of APK containing
* the intent filter.
*
* @deprecated Use DomainVerificationManager APIs.
* @hide
*/
@Deprecated
public static final String EXTRA_INTENT_FILTER_VERIFICATION_PACKAGE_NAME
= "android.content.pm.extra.INTENT_FILTER_VERIFICATION_PACKAGE_NAME";
/**
* The action used to request that the user approve a permission request
* from the application.
*
* @hide
*/
@SystemApi
public static final String ACTION_REQUEST_PERMISSIONS =
"android.content.pm.action.REQUEST_PERMISSIONS";
/**
* The action used to request that the user approve a permission request
* from the application. Sent from an application other than the one whose permissions
* will be granted. Can only be used by the system server.
*
* @hide
*/
@SystemApi
public static final String ACTION_REQUEST_PERMISSIONS_FOR_OTHER =
"android.content.pm.action.REQUEST_PERMISSIONS_FOR_OTHER";
/**
* The names of the requested permissions.
*
* Type: String[]
*
* Type: int
*
* Type: int[] of #PermissionResult
*
* Type: String[]
*
* Note: In retrospect it would have been preferred to use
* more inclusive terminology when naming this API. Similar APIs added will
* refrain from using the term "whitelist".
*
* Note: In retrospect it would have been preferred to use
* more inclusive terminology when naming this API. Similar APIs added will
* refrain from using the term "whitelist".
*
* Note: In retrospect it would have been preferred to use
* more inclusive terminology when naming this API. Similar APIs added will
* refrain from using the term "whitelist".
*
* This shared library no longer exists since Android R.
*
* @see #getServicesSystemSharedLibraryPackageName()
*
* @hide
*/
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
@TestApi
public static final String SYSTEM_SHARED_LIBRARY_SERVICES = "android.ext.services";
/**
* This is a library that contains components apps can dynamically
* load. For example, new widgets, helper classes, etc. This library
* is versioned and backwards compatible. Clients should check its
* version via {@link android.ext.shared.Version#getVersionCode()}
* and avoid calling APIs added in later versions.
*
* @hide
*/
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
@TestApi
public static final String SYSTEM_SHARED_LIBRARY_SHARED = "android.ext.shared";
/** @hide */
@IntDef({
NOTIFY_PACKAGE_USE_ACTIVITY,
NOTIFY_PACKAGE_USE_SERVICE,
NOTIFY_PACKAGE_USE_FOREGROUND_SERVICE,
NOTIFY_PACKAGE_USE_BROADCAST_RECEIVER,
NOTIFY_PACKAGE_USE_CONTENT_PROVIDER,
NOTIFY_PACKAGE_USE_BACKUP,
NOTIFY_PACKAGE_USE_CROSS_PACKAGE,
NOTIFY_PACKAGE_USE_INSTRUMENTATION,
})
public @interface NotifyReason {
}
/**
* Used when starting a process for an Activity.
*
* @hide
*/
public static final int NOTIFY_PACKAGE_USE_ACTIVITY = 0;
/**
* Used when starting a process for a Service.
*
* @hide
*/
public static final int NOTIFY_PACKAGE_USE_SERVICE = 1;
/**
* Used when moving a Service to the foreground.
*
* @hide
*/
public static final int NOTIFY_PACKAGE_USE_FOREGROUND_SERVICE = 2;
/**
* Used when starting a process for a BroadcastReceiver.
*
* @hide
*/
public static final int NOTIFY_PACKAGE_USE_BROADCAST_RECEIVER = 3;
/**
* Used when starting a process for a ContentProvider.
*
* @hide
*/
public static final int NOTIFY_PACKAGE_USE_CONTENT_PROVIDER = 4;
/**
* Used when starting a process for a BroadcastReceiver.
*
* @hide
*/
public static final int NOTIFY_PACKAGE_USE_BACKUP = 5;
/**
* Used with Context.getClassLoader() across Android packages.
*
* @hide
*/
public static final int NOTIFY_PACKAGE_USE_CROSS_PACKAGE = 6;
/**
* Used when starting a package within a process for Instrumentation.
*
* @hide
*/
public static final int NOTIFY_PACKAGE_USE_INSTRUMENTATION = 7;
/**
* Total number of usage reasons.
*
* @hide
*/
public static final int NOTIFY_PACKAGE_USE_REASONS_COUNT = 8;
/**
* Constant for specifying the highest installed package version code.
*/
public static final int VERSION_CODE_HIGHEST = -1;
/**
* Apps targeting Android R and above will need to declare the packages and intents they intend
* to use to get details about other apps on a device. Such declarations must be made via the
* {@code Consider using {@link #getLaunchIntentSenderForPackage(String)} if
* the caller is not allowed to query for the The caller can invoke
* {@link IntentSender#sendIntent(Context, int, Intent, IntentSender.OnFinished, Handler)}
* to launch the activity. An {@link IntentSender.SendIntentException} is thrown if the
* package does not contain such an activity, or if packageName is not recognized.
*
* @param packageName The name of the package to inspect.
* @return Returns a {@link IntentSender} to launch the activity.
*
* @see #getLaunchIntentForPackage(String)
*/
public @NonNull IntentSender getLaunchIntentSenderForPackage(@NonNull String packageName) {
throw new UnsupportedOperationException("getLaunchIntentSenderForPackage not implemented"
+ "in subclass");
}
/**
* Return an array of all of the POSIX secondary group IDs that have been
* assigned to the given package.
*
* Note that the same package may have different GIDs under different
* {@link UserHandle} on the same device.
*
* @param packageName The full name (i.e. com.google.apps.contacts) of the
* desired package.
* @return Returns an int array of the assigned GIDs, or null if there are
* none.
* @throws NameNotFoundException if no such package is available to the
* caller.
*/
public abstract int[] getPackageGids(@NonNull String packageName)
throws NameNotFoundException;
/**
* Return an array of all of the POSIX secondary group IDs that have been
* assigned to the given package.
*
* Note that the same package may have different GIDs under different
* {@link UserHandle} on the same device.
*
* Use {@link #getPackageGids(String, PackageInfoFlags)} when long flags are needed.
*
* @param packageName The full name (i.e. com.google.apps.contacts) of the
* desired package.
* @return Returns an int array of the assigned gids, or null if there are
* none.
* @throws NameNotFoundException if no such package is available to the
* caller.
*/
public abstract int[] getPackageGids(@NonNull String packageName, int flags)
throws NameNotFoundException;
/**
* See {@link #getPackageGids(String, int)}.
*/
@Nullable
public int[] getPackageGids(@NonNull String packageName, @NonNull PackageInfoFlags flags)
throws NameNotFoundException {
throw new UnsupportedOperationException(
"getPackageGids not implemented in subclass");
}
/**
* Return the UID associated with the given package name.
*
* Note that the same package will have different UIDs under different
* {@link UserHandle} on the same device.
*
* Use {@link #getPackageUid(String, PackageInfoFlags)} when long flags are needed.
*
* @param packageName The full name (i.e. com.google.apps.contacts) of the
* desired package.
* @return Returns an integer UID who owns the given package name.
* @throws NameNotFoundException if no such package is available to the
* caller.
*/
public abstract int getPackageUid(@NonNull String packageName, int flags)
throws NameNotFoundException;
/**
* See {@link #getPackageUid(String, int)}.
*/
public int getPackageUid(@NonNull String packageName, @NonNull PackageInfoFlags flags)
throws NameNotFoundException {
throw new UnsupportedOperationException(
"getPackageUid not implemented in subclass");
}
/**
* Return the UID associated with the given package name.
*
* Note that the same package will have different UIDs under different
* {@link UserHandle} on the same device.
*
* @param packageName The full name (i.e. com.google.apps.contacts) of the
* desired package.
* @param userId The user handle identifier to look up the package under.
* @return Returns an integer UID who owns the given package name.
* @throws NameNotFoundException if no such package is available to the
* caller.
* @hide
*/
@SuppressWarnings("HiddenAbstractMethod")
@UnsupportedAppUsage
public abstract int getPackageUidAsUser(@NonNull String packageName, @UserIdInt int userId)
throws NameNotFoundException;
/**
* See {@link #getPackageUidAsUser(String, PackageInfoFlags, int)}.
* Use {@link #getPackageUidAsUser(String, PackageInfoFlags, int)} when long flags are needed.
* @hide
*/
@SuppressWarnings("HiddenAbstractMethod")
@UnsupportedAppUsage
public abstract int getPackageUidAsUser(@NonNull String packageName,
int flags, @UserIdInt int userId) throws NameNotFoundException;
/**
* Return the UID associated with the given package name.
*
* Note that the same package will have different UIDs under different
* {@link UserHandle} on the same device.
*
* @param packageName The full name (i.e. com.google.apps.contacts) of the
* desired package.
* @param flags Additional option flags to modify the data returned.
* @param userId The user handle identifier to look up the package under.
* @return Returns an integer UID who owns the given package name.
* @throws NameNotFoundException if no such package is available to the
* caller.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS_FULL)
public int getPackageUidAsUser(@NonNull String packageName, @NonNull PackageInfoFlags flags,
@UserIdInt int userId) throws NameNotFoundException {
throw new UnsupportedOperationException(
"getPackageUidAsUser not implemented in subclass");
}
/**
* Retrieve all of the information we know about a particular permission.
*
* @param permName The fully qualified name (i.e. com.google.permission.LOGIN)
* of the permission you are interested in.
* @param flags Additional option flags to modify the data returned.
* @return Returns a {@link PermissionInfo} containing information about the
* permission.
* @throws NameNotFoundException if a package with the given name cannot be
* found on the system.
*/
//@Deprecated
public abstract PermissionInfo getPermissionInfo(@NonNull String permName,
@PermissionInfoFlags int flags) throws NameNotFoundException;
/**
* Query for all of the permissions associated with a particular group.
*
* @param permissionGroup The fully qualified name (i.e. com.google.permission.LOGIN)
* of the permission group you are interested in. Use {@code null} to
* find all of the permissions not associated with a group.
* @param flags Additional option flags to modify the data returned.
* @return Returns a list of {@link PermissionInfo} containing information
* about all of the permissions in the given group.
* @throws NameNotFoundException if a group with the given name cannot be
* found on the system.
*/
//@Deprecated
@NonNull
public abstract List The user usually grants and revokes permission-groups. If this option is set some
* dangerous system permissions can be revoked/granted by the user separately from their group.
*
* @hide
*/
@SuppressWarnings("HiddenAbstractMethod")
@SystemApi
public abstract boolean arePermissionsIndividuallyControlled();
/**
* Returns true if wireless consent mode is enabled
*
* @hide
*/
@SuppressWarnings("HiddenAbstractMethod")
public abstract boolean isWirelessConsentModeEnabled();
/**
* Retrieve all of the information we know about a particular group of
* permissions.
*
* @param groupName The fully qualified name (i.e.
* com.google.permission_group.APPS) of the permission you are
* interested in.
* @param flags Additional option flags to modify the data returned.
* @return Returns a {@link PermissionGroupInfo} containing information
* about the permission.
* @throws NameNotFoundException if a package with the given name cannot be
* found on the system.
*/
//@Deprecated
@NonNull
public abstract PermissionGroupInfo getPermissionGroupInfo(@NonNull String groupName,
@PermissionGroupInfoFlags int flags) throws NameNotFoundException;
/**
* Retrieve all of the known permission groups in the system.
*
* @param flags Additional option flags to modify the data returned.
* @return Returns a list of {@link PermissionGroupInfo} containing
* information about all of the known permission groups.
*/
//@Deprecated
@NonNull
public abstract List
* Note: This API returns the underlying permission state
* as-is and is mostly intended for permission managing system apps. To
* perform an access check for a certain app, please use the
* {@link Context#checkPermission} APIs instead.
*
* @param permName The name of the permission you are checking for.
* @param packageName The name of the package you are checking against.
*
* @return If the package has the permission, PERMISSION_GRANTED is
* returned. If it does not have the permission, PERMISSION_DENIED
* is returned.
*
* @see #PERMISSION_GRANTED
* @see #PERMISSION_DENIED
*/
@CheckResult
@PermissionResult
public abstract int checkPermission(@NonNull String permName,
@NonNull String packageName);
/**
* Checks whether a particular permissions has been revoked for a
* package by policy. Typically the device owner or the profile owner
* may apply such a policy. The user cannot grant policy revoked
* permissions, hence the only way for an app to get such a permission
* is by a policy change.
*
* @param permName The name of the permission you are checking for.
* @param packageName The name of the package you are checking against.
*
* @return Whether the permission is restricted by policy.
*/
@CheckResult
//@Deprecated
public abstract boolean isPermissionRevokedByPolicy(@NonNull String permName,
@NonNull String packageName);
/**
* Gets the package name of the component controlling runtime permissions.
*
* @return the package name of the component controlling runtime permissions
*
* @hide
*/
@NonNull
@SystemApi
@TestApi
@SuppressLint("UnflaggedApi") // Promoting from @SystemApi(MODULE_LIBRARIES)
public String getPermissionControllerPackageName() {
throw new RuntimeException("Not implemented. Must override in a subclass.");
}
/**
* Returns the package name of the component implementing sdk sandbox service.
*
* @return the package name of the component implementing sdk sandbox service
*
* @hide
*/
@NonNull
@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
@TestApi
public String getSdkSandboxPackageName() {
throw new RuntimeException("Not implemented. Must override in a subclass.");
}
/**
* Add a new dynamic permission to the system. For this to work, your
* package must have defined a permission tree through the
* {@link android.R.styleable#AndroidManifestPermissionTree
* <permission-tree>} tag in its manifest. A package can only add
* permissions to trees that were defined by either its own package or
* another with the same user id; a permission is in a tree if it
* matches the name of the permission tree + ".": for example,
* "com.foo.bar" is a member of the permission tree "com.foo".
*
* It is good to make your permission tree name descriptive, because you
* are taking possession of that entire set of permission names. Thus, it
* must be under a domain you control, with a suffix that will not match
* any normal permissions that may be declared in any applications that
* are part of that domain.
*
* New permissions must be added before
* any .apks are installed that use those permissions. Permissions you
* add through this method are remembered across reboots of the device.
* If the given permission already exists, the info you supply here
* will be used to update it.
*
* @param info Description of the permission to be added.
*
* @return Returns true if a new permission was created, false if an
* existing one was updated.
*
* @throws SecurityException if you are not allowed to add the
* given permission name.
*
* @see #removePermission(String)
*/
//@Deprecated
public abstract boolean addPermission(@NonNull PermissionInfo info);
/**
* Like {@link #addPermission(PermissionInfo)} but asynchronously
* persists the package manager state after returning from the call,
* allowing it to return quicker and batch a series of adds at the
* expense of no guarantee the added permission will be retained if
* the device is rebooted before it is written.
*/
//@Deprecated
public abstract boolean addPermissionAsync(@NonNull PermissionInfo info);
/**
* Removes a permission that was previously added with
* {@link #addPermission(PermissionInfo)}. The same ownership rules apply
* -- you are only allowed to remove permissions that you are allowed
* to add.
*
* @param permName The name of the permission to remove.
*
* @throws SecurityException if you are not allowed to remove the
* given permission name.
*
* @see #addPermission(PermissionInfo)
*/
//@Deprecated
public abstract void removePermission(@NonNull String permName);
/**
* Permission flags set when granting or revoking a permission.
*
* @removed mistakenly exposed as system-api previously
*/
@IntDef(prefix = { "FLAG_PERMISSION_" }, value = {
FLAG_PERMISSION_USER_SET,
FLAG_PERMISSION_USER_FIXED,
FLAG_PERMISSION_POLICY_FIXED,
FLAG_PERMISSION_REVOKE_ON_UPGRADE,
FLAG_PERMISSION_SYSTEM_FIXED,
FLAG_PERMISSION_GRANTED_BY_DEFAULT,
FLAG_PERMISSION_USER_SENSITIVE_WHEN_GRANTED,
FLAG_PERMISSION_USER_SENSITIVE_WHEN_DENIED,
/*
FLAG_PERMISSION_REVOKE_WHEN_REQUESED
*/
FLAG_PERMISSION_RESTRICTION_UPGRADE_EXEMPT,
FLAG_PERMISSION_RESTRICTION_SYSTEM_EXEMPT,
FLAG_PERMISSION_RESTRICTION_INSTALLER_EXEMPT,
FLAG_PERMISSION_APPLY_RESTRICTION,
FLAG_PERMISSION_GRANTED_BY_ROLE,
FLAG_PERMISSION_REVOKED_COMPAT,
FLAG_PERMISSION_ONE_TIME,
FLAG_PERMISSION_AUTO_REVOKED
})
@Retention(RetentionPolicy.SOURCE)
public @interface PermissionFlags {}
/**
* Grant a runtime permission to an application which the application does not
* already have. The permission must have been requested by the application.
* If the application is not allowed to hold the permission, a {@link
* java.lang.SecurityException} is thrown. If the package or permission is
* invalid, a {@link java.lang.IllegalArgumentException} is thrown.
*
* Note: Using this API requires holding
* android.permission.GRANT_RUNTIME_PERMISSIONS and if the user id is
* not the current user android.permission.INTERACT_ACROSS_USERS_FULL.
*
* Note: Using this API requires holding
* android.permission.REVOKE_RUNTIME_PERMISSIONS and if the user id is
* not the current user android.permission.INTERACT_ACROSS_USERS_FULL.
*
* Note: Using this API requires holding
* android.permission.REVOKE_RUNTIME_PERMISSIONS and if the user id is
* not the current user android.permission.INTERACT_ACROSS_USERS_FULL.
* Permissions can be hard restricted which means that the app cannot hold
* them or soft restricted where the app can hold the permission but in a weaker
* form. Whether a permission is {@link PermissionInfo#FLAG_HARD_RESTRICTED hard
* restricted} or {@link PermissionInfo#FLAG_SOFT_RESTRICTED soft restricted}
* depends on the permission declaration. Whitelisting a hard restricted permission
* allows for the to hold that permission and whitelisting a soft restricted
* permission allows the app to hold the permission in its full, unrestricted form.
*
*
* Note: In retrospect it would have been preferred to use
* more inclusive terminology when naming this API. Similar APIs added will
* refrain from using the term "whitelist".
* Permissions can be hard restricted which means that the app cannot hold
* them or soft restricted where the app can hold the permission but in a weaker
* form. Whether a permission is {@link PermissionInfo#FLAG_HARD_RESTRICTED hard
* restricted} or {@link PermissionInfo#FLAG_SOFT_RESTRICTED soft restricted}
* depends on the permission declaration. Whitelisting a hard restricted permission
* allows for the to hold that permission and whitelisting a soft restricted
* permission allows the app to hold the permission in its full, unrestricted form.
*
* You need to specify the whitelists for which to set the whitelisted permissions
* which will clear the previous whitelisted permissions and replace them with the
* provided ones.
*
*
* Note: In retrospect it would have been preferred to use
* more inclusive terminology when naming this API. Similar APIs added will
* refrain from using the term "whitelist".
* Permissions can be hard restricted which means that the app cannot hold
* them or soft restricted where the app can hold the permission but in a weaker
* form. Whether a permission is {@link PermissionInfo#FLAG_HARD_RESTRICTED hard
* restricted} or {@link PermissionInfo#FLAG_SOFT_RESTRICTED soft restricted}
* depends on the permission declaration. Whitelisting a hard restricted permission
* allows for the to hold that permission and whitelisting a soft restricted
* permission allows the app to hold the permission in its full, unrestricted form.
*
* You need to specify the whitelists for which to set the whitelisted permissions
* which will clear the previous whitelisted permissions and replace them with the
* provided ones.
*
*
* Note: In retrospect it would have been preferred to use
* more inclusive terminology when naming this API. Similar APIs added will
* refrain from using the term "whitelist".
*
* Note: In retrospect it would have been preferred to use
* more inclusive terminology when naming this API. Similar APIs added will
* refrain from using the term "whitelist".
*
* Note: In retrospect it would have been preferred to use
* more inclusive terminology when naming this API. Similar APIs added will
* refrain from using the term "whitelist".
* The intended use is for apps to reference this label in its instruction for users to grant
* a background permission.
*
* @return the localized label that corresponds to the settings option for granting
* background access
*/
@NonNull
public CharSequence getBackgroundPermissionOptionLabel() {
return "";
}
/**
* Returns an {@link android.content.Intent} suitable for passing to
* {@link android.app.Activity#startActivityForResult(android.content.Intent, int)}
* which prompts the user to grant permissions to this application.
*
* @throws NullPointerException if {@code permissions} is {@code null} or empty.
*
* @hide
*/
@NonNull
@UnsupportedAppUsage
public Intent buildRequestPermissionsIntent(@NonNull String[] permissions) {
if (ArrayUtils.isEmpty(permissions)) {
throw new IllegalArgumentException("permission cannot be null or empty");
}
Intent intent = new Intent(ACTION_REQUEST_PERMISSIONS);
intent.putExtra(EXTRA_REQUEST_PERMISSIONS_NAMES, permissions);
intent.setPackage(getPermissionControllerPackageName());
return intent;
}
/**
* Compare the signatures of two packages to determine if the same
* signature appears in both of them. If they do contain the same
* signature, then they are allowed special privileges when working
* with each other: they can share the same user-id, run instrumentation
* against each other, etc.
*
* @param packageName1 First package name whose signature will be compared.
* @param packageName2 Second package name whose signature will be compared.
*
* @return Returns an integer indicating whether all signatures on the
* two packages match. The value is >= 0 ({@link #SIGNATURE_MATCH}) if
* all signatures match or < 0 if there is not a match ({@link
* #SIGNATURE_NO_MATCH} or {@link #SIGNATURE_UNKNOWN_PACKAGE}).
*
* @see #checkSignatures(int, int)
*/
@CheckResult
@SignatureResult
public abstract int checkSignatures(@NonNull String packageName1,
@NonNull String packageName2);
/**
* Like {@link #checkSignatures(String, String)}, but takes UIDs of
* the two packages to be checked. This can be useful, for example,
* when doing the check in an IPC, where the UID is the only identity
* available. It is functionally identical to determining the package
* associated with the UIDs and checking their signatures.
*
* @param uid1 First UID whose signature will be compared.
* @param uid2 Second UID whose signature will be compared.
*
* @return Returns an integer indicating whether all signatures on the
* two packages match. The value is >= 0 ({@link #SIGNATURE_MATCH}) if
* all signatures match or < 0 if there is not a match ({@link
* #SIGNATURE_NO_MATCH} or {@link #SIGNATURE_UNKNOWN_PACKAGE}).
*
* @see #checkSignatures(String, String)
*/
@CheckResult
public abstract @SignatureResult int checkSignatures(int uid1, int uid2);
/**
* Retrieve the names of all packages that are associated with a particular
* user id. In most cases, this will be a single package name, the package
* that has been assigned that user id. Where there are multiple packages
* sharing the same user id through the "sharedUserId" mechanism, all
* packages with that id will be returned.
*
* @param uid The user id for which you would like to retrieve the
* associated packages.
*
* @return Returns an array of one or more packages assigned to the user
* id, or null if there are no known packages with the given id.
*/
public abstract @Nullable String[] getPackagesForUid(int uid);
/**
* Retrieve the official name associated with a uid. This name is
* guaranteed to never change, though it is possible for the underlying
* uid to be changed. That is, if you are storing information about
* uids in persistent storage, you should use the string returned
* by this function instead of the raw uid.
*
* @param uid The uid for which you would like to retrieve a name.
* @return Returns a unique name for the given uid, or null if the
* uid is not currently assigned.
*/
public abstract @Nullable String getNameForUid(int uid);
/**
* Retrieves the official names associated with each given uid.
* @see #getNameForUid(int)
*
* @hide
*/
@SuppressWarnings({"HiddenAbstractMethod", "NullableCollection"})
@TestApi
public abstract @Nullable String[] getNamesForUids(int[] uids);
/**
* Return the user id associated with a shared user name. Multiple
* applications can specify a shared user name in their manifest and thus
* end up using a common uid. This might be used for new applications
* that use an existing shared user name and need to know the uid of the
* shared user.
*
* @param sharedUserName The shared user name whose uid is to be retrieved.
* @return Returns the UID associated with the shared user.
* @throws NameNotFoundException if a package with the given name cannot be
* found on the system.
* @hide
*/
@SuppressWarnings("HiddenAbstractMethod")
@UnsupportedAppUsage
public abstract int getUidForSharedUser(@NonNull String sharedUserName)
throws NameNotFoundException;
/**
* Return a List of all application packages that are installed for the
* current user. If flag GET_UNINSTALLED_PACKAGES has been set, a list of all
* applications including those deleted with {@code DELETE_KEEP_DATA}
* (partially installed apps with data directory) will be returned.
*
* Use {@link #getInstalledApplications(ApplicationInfoFlags)} when long flags are needed.
*
* @param flags Additional option flags to modify the data returned.
* @return A List of ApplicationInfo objects, one for each installed
* application. In the unlikely case there are no installed
* packages, an empty list is returned. If flag
* {@code MATCH_UNINSTALLED_PACKAGES} is set, the application
* information is retrieved from the list of uninstalled
* applications (which includes installed applications as well as
* applications with data directory i.e. applications which had been
* deleted with {@code DELETE_KEEP_DATA} flag set).
*/
@NonNull
public abstract List
* Note that this package is no longer a shared library since Android R. It is now a package
* that hosts for a bunch of updatable services that the system binds to.
*
* @return The library host package.
*
* @hide
*/
@SuppressWarnings("HiddenAbstractMethod")
@UnsupportedAppUsage
@TestApi
public abstract @NonNull String getServicesSystemSharedLibraryPackageName();
/**
* Get the name of the package hosting the shared components shared library.
*
* @return The library host package.
*
* @hide
*/
@SuppressWarnings("HiddenAbstractMethod")
@UnsupportedAppUsage
@TestApi
public abstract @NonNull String getSharedSystemSharedLibraryPackageName();
/**
* Returns the names of the packages that have been changed
* [eg. added, removed or updated] since the given sequence
* number.
* If no packages have been changed, returns The sequence number starts at
* Note: if using an implicit Intent (without an explicit
* ComponentName specified), be sure to consider whether to set the
* {@link #MATCH_DEFAULT_ONLY} only flag. You need to do so to resolve the
* activity in the same way that
* {@link android.content.Context#startActivity(Intent)} and
* {@link android.content.Intent#resolveActivity(PackageManager)
* Intent.resolveActivity(PackageManager)} do.
*
* Note: if using an implicit Intent (without an explicit
* ComponentName specified), be sure to consider whether to set the
* {@link #MATCH_DEFAULT_ONLY} only flag. You need to do so to resolve the
* activity in the same way that
* {@link android.content.Context#startActivity(Intent)} and
* {@link android.content.Intent#resolveActivity(PackageManager)
* Intent.resolveActivity(PackageManager)} do.
*
* Example:
*
* Note: unlike most other methods, an empty result set is indicated
* by a null return instead of an empty list.
*
* Use {@link #queryContentProviders(String, int, ComponentInfoFlags)} when long flags are
* needed.
*
* @param processName If non-null, limits the returned providers to only
* those that are hosted by the given process. If null, all
* content providers are returned.
* @param uid If processName is non-null, this is the required
* uid owning the requested content providers.
* @param flags Additional option flags to modify the data returned.
* @return A list of {@link ProviderInfo} objects containing one entry for
* each provider either matching processName or, if
* processName is null, all known content providers.
* If there are no matching providers, null is returned.
*/
@NonNull
public abstract List DO NOT USE the {@code metaDataKey} parameter, unless you're the contacts provider.
* You really shouldn't need it. Other apps should use {@link #queryIntentContentProviders}
* instead.
*
* The {@code metaDataKey} parameter was added to allow the contacts provider to quickly
* scan the GAL providers on the device. Unfortunately the discovery protocol used metadata
* to mark GAL providers, rather than intent filters, so we can't use
* {@link #queryIntentContentProviders} for that.
*
* Use {@link #queryContentProviders(String, int, ComponentInfoFlags, String)} when long flags
* are needed.
*
* @hide
*/
@NonNull
public List
* If the original drawable is a BitmapDrawable and the backing bitmap is
* mutable as per {@link android.graphics.Bitmap#isMutable()}, the badging
* is performed in place and the original drawable is returned.
*
* If the original drawable is a BitmapDrawable and the backing bitmap is
* mutable as per {@link android.graphics.Bitmap#isMutable()}, the badging
* is performed in place and the original drawable is returned.
*
* If the calling application does not hold the INSTALL_PACKAGES permission then
* the result will always return {@code null} from
* {@link InstallSourceInfo#getOriginatingPackageName()}.
*
* If the package that requested the install has been uninstalled, then information about it
* will only be returned from {@link InstallSourceInfo#getInitiatingPackageName()} and
* {@link InstallSourceInfo#getInitiatingPackageSigningInfo()} if the calling package is
* requesting its own install information and is not an instant app.
*
* @param packageName The name of the package to query
* @throws NameNotFoundException if the given package name is not available to the caller.
*/
@NonNull
public InstallSourceInfo getInstallSourceInfo(@NonNull String packageName)
throws NameNotFoundException {
throw new UnsupportedOperationException("getInstallSourceInfo not implemented");
}
/**
* Returns true if an app is archivable.
*
* @throws NameNotFoundException if the given package name is not available to the caller.
* @see PackageInstaller#requestArchive
*/
@FlaggedApi(android.content.pm.Flags.FLAG_ARCHIVING)
public boolean isAppArchivable(@NonNull String packageName) throws NameNotFoundException {
throw new UnsupportedOperationException("isAppArchivable not implemented");
}
/**
* Attempts to clear the user data directory of an application.
* Since this may take a little while, the result will
* be posted back to the given observer. A deletion will fail if the
* named package cannot be found, or if the named package is a "system package".
*
* @param packageName The name of the package
* @param observer An observer callback to get notified when the operation is finished
* {@link android.content.pm.IPackageDataObserver#onRemoveCompleted(String, boolean)}
* will be called when that happens. observer may be null to indicate that
* no callback is desired.
*
* @hide
*/
@SuppressWarnings("HiddenAbstractMethod")
@UnsupportedAppUsage
public abstract void clearApplicationUserData(@NonNull String packageName,
@Nullable IPackageDataObserver observer);
/**
* Attempts to delete the cache files associated with an application.
* Since this may take a little while, the result will
* be posted back to the given observer. A deletion will fail if the calling context
* lacks the {@link android.Manifest.permission#DELETE_CACHE_FILES} permission, if the
* named package cannot be found, or if the named package is a "system package".
*
* @param packageName The name of the package to delete
* @param observer An observer callback to get notified when the cache file deletion
* is complete.
* {@link android.content.pm.IPackageDataObserver#onRemoveCompleted(String, boolean)}
* will be called when that happens. observer may be null to indicate that
* no callback is desired.
*
* @hide
*/
@SuppressWarnings("HiddenAbstractMethod")
@UnsupportedAppUsage
public abstract void deleteApplicationCacheFiles(@NonNull String packageName,
@Nullable IPackageDataObserver observer);
/**
* Attempts to delete the cache files associated with an application for a given user. Since
* this may take a little while, the result will be posted back to the given observer. A
* deletion will fail if the calling context lacks the
* {@link android.Manifest.permission#DELETE_CACHE_FILES} permission, if the named package
* cannot be found, or if the named package is a "system package". If {@code userId} does not
* belong to the calling user, the caller must have
* {@link android.Manifest.permission#INTERACT_ACROSS_USERS} permission.
*
* @param packageName The name of the package to delete
* @param userId the user for which the cache files needs to be deleted
* @param observer An observer callback to get notified when the cache file deletion is
* complete.
* {@link android.content.pm.IPackageDataObserver#onRemoveCompleted(String, boolean)}
* will be called when that happens. observer may be null to indicate that no
* callback is desired.
* @hide
*/
@SuppressWarnings("HiddenAbstractMethod")
@UnsupportedAppUsage
public abstract void deleteApplicationCacheFilesAsUser(@NonNull String packageName,
@UserIdInt int userId, @Nullable IPackageDataObserver observer);
/**
* Free storage by deleting LRU sorted list of cache files across
* all applications. If the currently available free storage
* on the device is greater than or equal to the requested
* free storage, no cache files are cleared. If the currently
* available storage on the device is less than the requested
* free storage, some or all of the cache files across
* all applications are deleted (based on last accessed time)
* to increase the free storage space on the device to
* the requested value. There is no guarantee that clearing all
* the cache files from all applications will clear up
* enough storage to achieve the desired value.
* @param freeStorageSize The number of bytes of storage to be
* freed by the system. Say if freeStorageSize is XX,
* and the current free storage is YY,
* if XX is less than YY, just return. if not free XX-YY number
* of bytes if possible.
* @param observer call back used to notify when
* the operation is completed
*
* @hide
*/
@UnsupportedAppUsage
public void freeStorageAndNotify(long freeStorageSize,
@Nullable IPackageDataObserver observer) {
freeStorageAndNotify(null, freeStorageSize, observer);
}
/** {@hide} */
@SuppressWarnings("HiddenAbstractMethod")
@UnsupportedAppUsage
public abstract void freeStorageAndNotify(@Nullable String volumeUuid, long freeStorageSize,
@Nullable IPackageDataObserver observer);
/**
* Free storage by deleting LRU sorted list of cache files across
* all applications. If the currently available free storage
* on the device is greater than or equal to the requested
* free storage, no cache files are cleared. If the currently
* available storage on the device is less than the requested
* free storage, some or all of the cache files across
* all applications are deleted (based on last accessed time)
* to increase the free storage space on the device to
* the requested value. There is no guarantee that clearing all
* the cache files from all applications will clear up
* enough storage to achieve the desired value.
* @param freeStorageSize The number of bytes of storage to be
* freed by the system. Say if freeStorageSize is XX,
* and the current free storage is YY,
* if XX is less than YY, just return. if not free XX-YY number
* of bytes if possible.
* @param pi IntentSender call back used to
* notify when the operation is completed.May be null
* to indicate that no call back is desired.
*
* @hide
*/
@UnsupportedAppUsage
public void freeStorage(long freeStorageSize, @Nullable IntentSender pi) {
freeStorage(null, freeStorageSize, pi);
}
/** {@hide} */
@SuppressWarnings("HiddenAbstractMethod")
@UnsupportedAppUsage
public abstract void freeStorage(@Nullable String volumeUuid, long freeStorageSize,
@Nullable IntentSender pi);
/**
* Retrieve the size information for a package.
* Since this may take a little while, the result will
* be posted back to the given observer. The calling context
* should have the {@link android.Manifest.permission#GET_PACKAGE_SIZE} permission.
*
* @param packageName The name of the package whose size information is to be retrieved
* @param userId The user whose size information should be retrieved.
* @param observer An observer callback to get notified when the operation
* is complete.
* {@link android.content.pm.IPackageStatsObserver#onGetStatsCompleted(PackageStats, boolean)}
* The observer's callback is invoked with a PackageStats object(containing the
* code, data and cache sizes of the package) and a boolean value representing
* the status of the operation. observer may be null to indicate that
* no callback is desired.
*
* @deprecated use {@link StorageStatsManager} instead.
* @hide
*/
@SuppressWarnings("HiddenAbstractMethod")
@Deprecated
@UnsupportedAppUsage
public abstract void getPackageSizeInfoAsUser(@NonNull String packageName,
@UserIdInt int userId, @Nullable IPackageStatsObserver observer);
/**
* Like {@link #getPackageSizeInfoAsUser(String, int, IPackageStatsObserver)}, but
* returns the size for the calling user.
*
* @deprecated use {@link StorageStatsManager} instead.
* @hide
*/
@Deprecated
@UnsupportedAppUsage
public void getPackageSizeInfo(@NonNull String packageName, IPackageStatsObserver observer) {
getPackageSizeInfoAsUser(packageName, getUserId(), observer);
}
/**
* @deprecated This function no longer does anything. It is the platform's
* responsibility to assign preferred activities and this cannot be modified
* directly. To determine the activities resolved by the platform, use
* {@link #resolveActivity} or {@link #queryIntentActivities}. To configure
* an app to be responsible for a particular role and to check current role
* holders, see {@link android.app.role.RoleManager}.
*/
@Deprecated
public abstract void addPackageToPreferred(@NonNull String packageName);
/**
* @deprecated This function no longer does anything. It is the platform's
* responsibility to assign preferred activities and this cannot be modified
* directly. To determine the activities resolved by the platform, use
* {@link #resolveActivity} or {@link #queryIntentActivities}. To configure
* an app to be responsible for a particular role and to check current role
* holders, see {@link android.app.role.RoleManager}.
*/
@Deprecated
public abstract void removePackageFromPreferred(@NonNull String packageName);
/**
* Retrieve the list of all currently configured preferred packages. The
* first package on the list is the most preferred, the last is the least
* preferred.
*
* @param flags Additional option flags to modify the data returned.
* @return A List of PackageInfo objects, one for each preferred
* application, in order of preference.
*
* @deprecated This function no longer does anything. It is the platform's
* responsibility to assign preferred activities and this cannot be modified
* directly. To determine the activities resolved by the platform, use
* {@link #resolveActivity} or {@link #queryIntentActivities}. To configure
* an app to be responsible for a particular role and to check current role
* holders, see {@link android.app.role.RoleManager}.
*/
@NonNull
@Deprecated
public abstract List Consider using {@link #setComponentEnabledSettings(List)} if multiple components need to
* be updated atomically.
*
* @param componentName The component to enable
* @param newState The new enabled state for the component.
* @param flags Optional behavior flags.
*/
@RequiresPermission(value = android.Manifest.permission.CHANGE_COMPONENT_ENABLED_STATE,
conditional = true)
public abstract void setComponentEnabledSetting(@NonNull ComponentName componentName,
@EnabledState int newState, @EnabledFlags int flags);
/**
* Set the enabled settings for package components such as activities, receivers, services and
* providers. This setting will override any enabled state which may have been set by the
* component in its manifest.
*
* This api accepts a list of component changes, and applies them all atomically. The
* application can use this api if components have dependencies and need to be updated
* atomically.
*
* The permission is not required if target components are running under the same uid with
* the caller.
*
* @param settings The list of component enabled settings to update. Note that an
* {@link IllegalArgumentException} is thrown if the duplicated component name
* is in the list or there's a conflict {@link #DONT_KILL_APP} flag between
* different components in the same package.
*
* @see #setComponentEnabledSetting(ComponentName, int, int)
*/
@RequiresPermission(value = android.Manifest.permission.CHANGE_COMPONENT_ENABLED_STATE,
conditional = true)
public void setComponentEnabledSettings(@NonNull List The caller must hold {@link android.Manifest.permission#SUSPEND_APPS} to use this API.
*
* @param packages Packages to mark as distracting.
* @param restrictionFlags Any combination of restrictions to impose on the given packages.
* {@link #RESTRICTION_NONE} can be used to clear any existing
* restrictions.
* @return A list of packages that could not have the {@code restrictionFlags} set. The system
* may prevent restricting critical packages to preserve normal device function.
*
* @hide
* @see #RESTRICTION_NONE
* @see #RESTRICTION_HIDE_FROM_SUGGESTIONS
* @see #RESTRICTION_HIDE_NOTIFICATIONS
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.SUSPEND_APPS)
@NonNull
public String[] setDistractingPackageRestrictions(@NonNull String[] packages,
@DistractionRestriction int restrictionFlags) {
throw new UnsupportedOperationException(
"setDistractingPackageRestrictions not implemented");
}
/**
* Puts the package in a suspended state, where attempts at starting activities are denied.
*
* It doesn't remove the data or the actual package file. The application's notifications
* will be hidden, any of its started activities will be stopped and it will not be able to
* show toasts or system alert windows or ring the device.
*
* When the user tries to launch a suspended app, a system dialog with the given
* {@code dialogMessage} will be shown instead. Since the message is supplied to the system as
* a {@link String}, the caller needs to take care of localization as needed.
* The dialog message can optionally contain a placeholder for the name of the suspended app.
* The system uses {@link String#format(Locale, String, Object...) String.format} to insert the
* app name into the message, so an example format string could be {@code "The app %1$s is
* currently suspended"}. This makes it easier for callers to provide a single message which
* works for all the packages being suspended in a single call.
*
* The package must already be installed. If the package is uninstalled while suspended
* the package will no longer be suspended. Optionally, the suspending app can provide extra information in the form of
* {@link PersistableBundle} objects to be shared with the apps being suspended and the
* launcher to support customization that they might need to handle the suspended state.
*
* The caller must hold {@link Manifest.permission#SUSPEND_APPS} to use this API.
*
* @param packageNames The names of the packages to set the suspended status.
* @param suspended If set to {@code true}, the packages will be suspended, if set to
* {@code false}, the packages will be unsuspended.
* @param appExtras An optional {@link PersistableBundle} that the suspending app can provide
* which will be shared with the apps being suspended. Ignored if
* {@code suspended} is false.
* @param launcherExtras An optional {@link PersistableBundle} that the suspending app can
* provide which will be shared with the launcher. Ignored if
* {@code suspended} is false.
* @param dialogMessage The message to be displayed to the user, when they try to launch a
* suspended app.
*
* @return an array of package names for which the suspended status could not be set as
* requested in this method. Returns {@code null} if {@code packageNames} was {@code null}.
*
* @deprecated use {@link #setPackagesSuspended(String[], boolean, PersistableBundle,
* PersistableBundle, android.content.pm.SuspendDialogInfo)} instead.
*
* @hide
*/
@SystemApi
@Deprecated
@RequiresPermission(Manifest.permission.SUSPEND_APPS)
@Nullable
public String[] setPackagesSuspended(@Nullable String[] packageNames, boolean suspended,
@Nullable PersistableBundle appExtras, @Nullable PersistableBundle launcherExtras,
@Nullable String dialogMessage) {
throw new UnsupportedOperationException("setPackagesSuspended not implemented");
}
/**
* Puts the given packages in a suspended state, where attempts at starting activities are
* denied.
*
* The suspended application's notifications and all of its windows will be hidden, any
* of its started activities will be stopped and it won't be able to ring the device.
* It doesn't remove the data or the actual package file.
*
* When the user tries to launch a suspended app, a system dialog alerting them that the app
* is suspended will be shown instead.
* The caller can optionally customize the dialog by passing a {@link SuspendDialogInfo} object
* to this API. This dialog will have a button that starts the
* {@link Intent#ACTION_SHOW_SUSPENDED_APP_DETAILS} intent if the suspending app declares an
* activity which handles this action.
*
* The packages being suspended must already be installed. If a package is uninstalled, it
* will no longer be suspended.
*
* Optionally, the suspending app can provide extra information in the form of
* {@link PersistableBundle} objects to be shared with the apps being suspended and the
* launcher to support customization that they might need to handle the suspended state.
*
* The caller must hold {@link Manifest.permission#SUSPEND_APPS} to use this API except for
* device owner and profile owner.
*
* @param packageNames The names of the packages to set the suspended status.
* @param suspended If set to {@code true}, the packages will be suspended, if set to
* {@code false}, the packages will be unsuspended.
* @param appExtras An optional {@link PersistableBundle} that the suspending app can provide
* which will be shared with the apps being suspended. Ignored if
* {@code suspended} is false.
* @param launcherExtras An optional {@link PersistableBundle} that the suspending app can
* provide which will be shared with the launcher. Ignored if
* {@code suspended} is false.
* @param dialogInfo An optional {@link SuspendDialogInfo} object describing the dialog that
* should be shown to the user when they try to launch a suspended app.
* Ignored if {@code suspended} is false.
*
* @return an array of package names for which the suspended status could not be set as
* requested in this method. Returns {@code null} if {@code packageNames} was {@code null}.
*
* @see #isPackageSuspended
* @see SuspendDialogInfo
* @see SuspendDialogInfo.Builder
* @see Intent#ACTION_SHOW_SUSPENDED_APP_DETAILS
*
* @hide
*/
@SystemApi
@RequiresPermission(value=Manifest.permission.SUSPEND_APPS, conditional=true)
@Nullable
public String[] setPackagesSuspended(@Nullable String[] packageNames, boolean suspended,
@Nullable PersistableBundle appExtras, @Nullable PersistableBundle launcherExtras,
@Nullable SuspendDialogInfo dialogInfo) {
throw new UnsupportedOperationException("setPackagesSuspended not implemented");
}
/**
* Puts the given packages in a suspended state, where attempts at starting activities are
* denied.
*
* The suspended application's notifications and all of its windows will be hidden, any
* of its started activities will be stopped and it won't be able to ring the device.
* It doesn't remove the data or the actual package file.
*
* When the user tries to launch a suspended app, a system dialog alerting them that the app
* is suspended will be shown instead.
* The caller can optionally customize the dialog by passing a {@link SuspendDialogInfo} object
* to this API. This dialog will have a button that starts the
* {@link Intent#ACTION_SHOW_SUSPENDED_APP_DETAILS} intent if the suspending app declares an
* activity which handles this action.
*
* The packages being suspended must already be installed. If a package is uninstalled, it
* will no longer be suspended.
*
* Optionally, the suspending app can provide extra information in the form of
* {@link PersistableBundle} objects to be shared with the apps being suspended and the
* launcher to support customization that they might need to handle the suspended state.
*
* The caller must hold {@link Manifest.permission#SUSPEND_APPS} to use this API except for
* device owner and profile owner or the {@link Manifest.permission#QUARANTINE_APPS} if the
* caller is using {@link #FLAG_SUSPEND_QUARANTINED}.
*
* @param packageNames The names of the packages to set the suspended status.
* @param suspended If set to {@code true}, the packages will be suspended, if set to
* {@code false}, the packages will be unsuspended.
* @param appExtras An optional {@link PersistableBundle} that the suspending app can provide
* which will be shared with the apps being suspended. Ignored if
* {@code suspended} is false.
* @param launcherExtras An optional {@link PersistableBundle} that the suspending app can
* provide which will be shared with the launcher. Ignored if
* {@code suspended} is false.
* @param dialogInfo An optional {@link SuspendDialogInfo} object describing the dialog that
* should be shown to the user when they try to launch a suspended app.
* Ignored if {@code suspended} is false.
* @param flags Optional behavior flags.
*
* @return an array of package names for which the suspended status could not be set as
* requested in this method. Returns {@code null} if {@code packageNames} was {@code null}.
*
* @see #isPackageSuspended
* @see SuspendDialogInfo
* @see SuspendDialogInfo.Builder
* @see Intent#ACTION_SHOW_SUSPENDED_APP_DETAILS
*
* @hide
*/
@SystemApi
@FlaggedApi(android.content.pm.Flags.FLAG_QUARANTINED_ENABLED)
@RequiresPermission(anyOf = {
Manifest.permission.SUSPEND_APPS,
Manifest.permission.QUARANTINE_APPS
}, conditional = true)
@SuppressLint("NullableCollection")
@Nullable
public String[] setPackagesSuspended(@Nullable String[] packageNames, boolean suspended,
@Nullable PersistableBundle appExtras, @Nullable PersistableBundle launcherExtras,
@Nullable SuspendDialogInfo dialogInfo, @SuspendedFlags int flags) {
throw new UnsupportedOperationException("setPackagesSuspended not implemented");
}
/**
* Returns any packages in a given set of packages that cannot be suspended via a call to {@link
* #setPackagesSuspended(String[], boolean, PersistableBundle, PersistableBundle,
* SuspendDialogInfo) setPackagesSuspended}. The platform prevents suspending certain critical
* packages to keep the device in a functioning state, e.g. the default dialer and launcher.
* Apps need to hold {@link Manifest.permission#SUSPEND_APPS SUSPEND_APPS} to call this API.
*
*
* Note that this set of critical packages can change with time, so even though a package name
* was not returned by this call, it does not guarantee that a subsequent call to
* {@link #setPackagesSuspended(String[], boolean, PersistableBundle, PersistableBundle,
* SuspendDialogInfo) setPackagesSuspended} for that package will succeed, especially if
* significant time elapsed between the two calls.
*
* @param packageNames The packages to check.
* @return A list of packages that can not be currently suspended by the system.
* @hide
*/
@SystemApi
@RequiresPermission(Manifest.permission.SUSPEND_APPS)
@NonNull
public String[] getUnsuspendablePackages(@NonNull String[] packageNames) {
throw new UnsupportedOperationException("getUnsuspendablePackages not implemented");
}
/**
* @see #setPackagesSuspended(String[], boolean, PersistableBundle, PersistableBundle, String)
* @param packageName The name of the package to get the suspended status of.
* @param userId The user id.
* @return {@code true} if the package is suspended or {@code false} if the package is not
* suspended.
* @throws IllegalArgumentException if the package was not found.
* @hide
*/
@SuppressWarnings("HiddenAbstractMethod")
@UnsupportedAppUsage
public abstract boolean isPackageSuspendedForUser(@NonNull String packageName, int userId);
/**
* Query if an app is currently suspended.
*
* @return {@code true} if the given package is suspended, {@code false} otherwise
* @throws NameNotFoundException if the package could not be found.
*
* @see #isPackageSuspended()
*/
public boolean isPackageSuspended(@NonNull String packageName) throws NameNotFoundException {
throw new UnsupportedOperationException("isPackageSuspended not implemented");
}
/**
* Apps can query this to know if they have been suspended. A system app with the permission
* {@code android.permission.SUSPEND_APPS} can put any app on the device into a suspended state.
*
* While in this state, the application's notifications will be hidden, any of its started
* activities will be stopped and it will not be able to show toasts or dialogs or play audio.
* When the user tries to launch a suspended app, the system will, instead, show a
* dialog to the user informing them that they cannot use this app while it is suspended.
*
* When an app is put into this state, the broadcast action
* {@link Intent#ACTION_MY_PACKAGE_SUSPENDED} will be delivered to any of its broadcast
* receivers that included this action in their intent-filters, including manifest
* receivers. Similarly, a broadcast action {@link Intent#ACTION_MY_PACKAGE_UNSUSPENDED}
* is delivered when a previously suspended app is taken out of this state. Apps are expected to
* use these to gracefully deal with transitions to and from this state.
*
* @return {@code true} if the calling package has been suspended, {@code false} otherwise.
*
* @see #getSuspendedPackageAppExtras()
* @see Intent#ACTION_MY_PACKAGE_SUSPENDED
* @see Intent#ACTION_MY_PACKAGE_UNSUSPENDED
*/
public boolean isPackageSuspended() {
throw new UnsupportedOperationException("isPackageSuspended not implemented");
}
/**
* Returns a {@link Bundle} of extras that was meant to be sent to the calling app when it was
* suspended. An app with the permission {@code android.permission.SUSPEND_APPS} can supply this
* to the system at the time of suspending an app.
*
* This is the same {@link Bundle} that is sent along with the broadcast
* {@link Intent#ACTION_MY_PACKAGE_SUSPENDED}, whenever the app is suspended. The contents of
* this {@link Bundle} are a contract between the suspended app and the suspending app.
*
* Note: These extras are optional, so if no extras were supplied to the system, this method
* will return {@code null}, even when the calling app has been suspended.
*
* @return A {@link Bundle} containing the extras for the app, or {@code null} if the
* package is not currently suspended.
*
* @see #isPackageSuspended()
* @see Intent#ACTION_MY_PACKAGE_UNSUSPENDED
* @see Intent#ACTION_MY_PACKAGE_SUSPENDED
* @see Intent#EXTRA_SUSPENDED_PACKAGE_EXTRAS
*/
public @Nullable Bundle getSuspendedPackageAppExtras() {
throw new UnsupportedOperationException("getSuspendedPackageAppExtras not implemented");
}
/**
* Get the name of the package that suspended the given package. Packages can be suspended by
* device administrators or apps holding {@link android.Manifest.permission#MANAGE_USERS} or
* {@link android.Manifest.permission#SUSPEND_APPS}.
*
*
* Note:This API doesn't support cross user suspension and should only be used
* for testing.
* @param suspendedPackage The package that has been suspended.
* @return Name of the package that suspended the given package. Returns {@code null} if the
* given package is not currently suspended and the platform package name - i.e.
* {@code "android"} - if the package was suspended by a device admin.
* @hide
*/
public @Nullable String getSuspendingPackage(@NonNull String suspendedPackage) {
throw new UnsupportedOperationException("getSuspendingPackage not implemented");
}
/**
* Query if an app is currently stopped.
*
* @return {@code true} if the given package is stopped, {@code false} otherwise
* @throws NameNotFoundException if the package could not be found.
* @see ApplicationInfo#FLAG_STOPPED
*/
@FlaggedApi(android.content.pm.Flags.FLAG_STAY_STOPPED)
public boolean isPackageStopped(@NonNull String packageName) throws NameNotFoundException {
throw new UnsupportedOperationException("isPackageStopped not implemented");
}
/**
* Query if an app is currently quarantined.
* A misbehaving app can be quarantined by e.g. a system of another privileged entity.
* Quarantined apps are similar to disabled, but still visible in e.g. Launcher.
* Only activities of such apps can still be queried, but not services etc.
* Quarantined apps can't be bound to, and won't receive broadcasts.
* They can't be resolved, unless {@link #MATCH_QUARANTINED_COMPONENTS} specified.
*
* @return {@code true} if the given package is quarantined, {@code false} otherwise
* @throws NameNotFoundException if the package could not be found.
*/
@FlaggedApi(android.content.pm.Flags.FLAG_QUARANTINED_ENABLED)
public boolean isPackageQuarantined(@NonNull String packageName) throws NameNotFoundException {
throw new UnsupportedOperationException("isPackageQuarantined not implemented");
}
/**
* Provide a hint of what the {@link ApplicationInfo#category} value should
* be for the given package.
*
* This hint can only be set by the app which installed this package, as
* determined by {@link #getInstallerPackageName(String)}.
*
* @param packageName the package to change the category hint for.
* @param categoryHint the category hint to set.
*/
@SuppressWarnings("HiddenAbstractMethod")
public abstract void setApplicationCategoryHint(@NonNull String packageName,
@ApplicationInfo.Category int categoryHint);
/** {@hide} */
public static boolean isMoveStatusFinished(int status) {
return (status < 0 || status > 100);
}
/** {@hide} */
public static abstract class MoveCallback {
public void onCreated(int moveId, Bundle extras) {}
public abstract void onStatusChanged(int moveId, int status, long estMillis);
}
/** {@hide} */
@SuppressWarnings("HiddenAbstractMethod")
@UnsupportedAppUsage
public abstract int getMoveStatus(int moveId);
/** {@hide} */
@SuppressWarnings("HiddenAbstractMethod")
@UnsupportedAppUsage
public abstract void registerMoveCallback(@NonNull MoveCallback callback,
@NonNull Handler handler);
/** {@hide} */
@SuppressWarnings("HiddenAbstractMethod")
@UnsupportedAppUsage
public abstract void unregisterMoveCallback(@NonNull MoveCallback callback);
/** {@hide} */
@SuppressWarnings("HiddenAbstractMethod")
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
public abstract int movePackage(@NonNull String packageName, @NonNull VolumeInfo vol);
/** {@hide} */
@SuppressWarnings("HiddenAbstractMethod")
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
public abstract @Nullable VolumeInfo getPackageCurrentVolume(@NonNull ApplicationInfo app);
/** {@hide} */
@SuppressWarnings("HiddenAbstractMethod")
@NonNull
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
public abstract List
* Note: In retrospect it would have been preferred to use
* more inclusive terminology when naming this API. Similar APIs added will
* refrain from using the term "whitelist".
* If the property is not defined with any <application> tag,
* returns and empty list.
*/
@NonNull
public List If the property is not defined with any <activity> and <activity-alias> tag,
* returns and empty list.
*/
@NonNull
public List If the property is not defined with any <provider> tag,
* returns and empty list.
*/
@NonNull
public List If the property is not defined with any <receiver> tag,
* returns and empty list.
*/
@NonNull
public List If the property is not defined with any <service> tag,
* returns and empty list.
*/
@NonNull
public List
* Note: The caller must be able to query for details about the source and target
* package. A {@link NameNotFoundException} is thrown if it isn't.
*
* @param sourcePackageName The source package that would receive details about the
* target package.
* @param targetPackageName The target package whose details would be shared with the
* source package.
* @return {@code true} if the source package is able to query for details about the
* target package.
* @throws NameNotFoundException if either a given package can not be found on the
* system, or if the caller is not able to query for details about the source or
* target package.
*/
public boolean canPackageQuery(@NonNull String sourcePackageName,
@NonNull String targetPackageName) throws NameNotFoundException {
throw new UnsupportedOperationException(
"canPackageQuery not implemented in subclass");
}
/**
* Same as {@link #canPackageQuery(String, String)} but accepts an array of target packages to
* be queried.
*
* @param sourcePackageName The source package that would receive details about the
* target package.
* @param targetPackageNames An array of target packages whose details would be shared with the
* source package.
* @return An array of booleans where each member specifies whether the source package is able
* to query for details about the target package given by the corresponding value at the same
* index in the array of target packages.
* @throws NameNotFoundException if either a given package can not be found on the
* system, or if the caller is not able to query for details about the source or
* target packages.
*/
@NonNull
public boolean[] canPackageQuery(@NonNull String sourcePackageName,
@NonNull String[] targetPackageNames) throws NameNotFoundException {
throw new UnsupportedOperationException(
"canPackageQuery not implemented in subclass");
}
/**
* Makes a package that provides an authority {@code visibleAuthority} become visible to the
* application {@code recipientUid}.
*
* @throws SecurityException when called by a package other than the contacts provider
* @hide
*/
public void makeProviderVisible(int recipientUid, String visibleAuthority) {
try {
ActivityThread.getPackageManager().makeProviderVisible(recipientUid, visibleAuthority);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* Makes the package associated with the uid {@code visibleUid} become visible to the
* recipient application. The recipient application can receive the details about the
* visible package if successful.
*
* Read package visibility for more
* information.
*
* @param recipientUid The uid of the application that is being given access to {@code
* visibleUid}
* @param visibleUid The uid of the application that is becoming accessible to {@code
* recipientAppId}
* @hide
*/
@RequiresPermission(android.Manifest.permission.MAKE_UID_VISIBLE)
@TestApi
@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
public void makeUidVisible(int recipientUid, int visibleUid) {
throw new UnsupportedOperationException(
"makeUidVisible not implemented in subclass");
}
/**
* Return archived package info for the package or null if the package is not installed.
* @see PackageInstaller#installPackageArchived
*/
@FlaggedApi(android.content.pm.Flags.FLAG_ARCHIVING)
public @Nullable ArchivedPackageInfo getArchivedPackage(@NonNull String packageName) {
throw new UnsupportedOperationException(
"getArchivedPackage not implemented in subclass");
}
// Some of the flags don't affect the query result, but let's be conservative and cache
// each combination of flags separately.
private static final class ApplicationInfoQuery {
final String packageName;
final long flags;
final int userId;
ApplicationInfoQuery(@Nullable String packageName, @ApplicationInfoFlagsBits long flags,
int userId) {
this.packageName = packageName;
this.flags = flags;
this.userId = userId;
}
@Override
public String toString() {
return String.format(
"ApplicationInfoQuery(packageName=\"%s\", flags=%s, userId=%s)",
packageName, flags, userId);
}
@Override
public int hashCode() {
int hash = Objects.hashCode(packageName);
hash = hash * 13 + Objects.hashCode(flags);
hash = hash * 13 + Objects.hashCode(userId);
return hash;
}
@Override
public boolean equals(@Nullable Object rval) {
if (rval == null) {
return false;
}
ApplicationInfoQuery other;
try {
other = (ApplicationInfoQuery) rval;
} catch (ClassCastException ex) {
return false;
}
return Objects.equals(packageName, other.packageName)
&& flags == other.flags
&& userId == other.userId;
}
}
private static ApplicationInfo getApplicationInfoAsUserUncached(
String packageName, @ApplicationInfoFlagsBits long flags, int userId) {
try {
return ActivityThread.getPackageManager()
.getApplicationInfo(packageName, flags, userId);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
private static final PropertyInvalidatedCache Example:
*
*
*
*/
public static final int MATCH_DIRECT_BOOT_AUTO = 0x10000000;
/** @hide */
@Deprecated
public static final int MATCH_DEBUG_TRIAGED_MISSING = MATCH_DIRECT_BOOT_AUTO;
/**
* @deprecated Use {@link #MATCH_CLONE_PROFILE_LONG} instead.
*
* @hide
*/
@Deprecated
@SystemApi
public static final int MATCH_CLONE_PROFILE = 0x20000000;
/**
* {@link PackageInfo} flag: include system apps that are in the uninstalled state and have
* been set to be hidden until installed via {@link #setSystemAppState}.
* @hide
*/
@SystemApi
public static final int MATCH_HIDDEN_UNTIL_INSTALLED_COMPONENTS = 0x20000000;
/**
* {@link PackageInfo} flag: include APEX packages that are currently
* installed. In APEX terminology, this corresponds to packages that are
* currently active, i.e. mounted and available to other processes of the OS.
* In particular, this flag alone will not match APEX files that are staged
* for activation at next reboot.
*/
public static final int MATCH_APEX = 0x40000000;
/**
* @deprecated Use {@link #GET_ATTRIBUTIONS_LONG} to avoid unintended sign extension.
*/
@Deprecated
public static final int GET_ATTRIBUTIONS = 0x80000000;
/**
* {@link PackageInfo} flag: return all attributions declared in the package manifest
*/
public static final long GET_ATTRIBUTIONS_LONG = 0x80000000L;
/**
* Flag parameter to also retrieve some information about archived packages.
* Packages can be archived through {@link PackageInstaller#requestArchive} and do not have any
* APKs stored on the device, but do keep the data directory.
*
*
*
* @hide
*/
public static final int INSTALL_REQUEST_DOWNGRADE = 0x00000080;
/**
* Flag parameter for package install to indicate that all requested permissions should be
* granted to the package. If {@link #INSTALL_ALL_USERS} is set the runtime permissions will
* be granted to all users, otherwise only to the owner.
*
* If this flag is set, {@link SessionParams#setPermissionState(String, int)} should not be
* called.
*
* @hide
*/
public static final int INSTALL_GRANT_ALL_REQUESTED_PERMISSIONS = 0x00000100;
/** {@hide} */
public static final int INSTALL_FORCE_VOLUME_UUID = 0x00000200;
/**
* Flag parameter for {@link #installPackage} to indicate that we always want to force
* the prompt for permission approval. This overrides any special behaviour for internal
* components.
*
* @hide
*/
public static final int INSTALL_FORCE_PERMISSION_PROMPT = 0x00000400;
/**
* Flag parameter for {@link #installPackage} to indicate that this package is
* to be installed as a lightweight "ephemeral" app.
*
* @hide
*/
public static final int INSTALL_INSTANT_APP = 0x00000800;
/**
* Flag parameter for {@link #installPackage} to indicate that this package contains
* a feature split to an existing application and the existing application should not
* be killed during the installation process.
*
* @hide
*/
public static final int INSTALL_DONT_KILL_APP = 0x00001000;
/**
* Flag parameter for {@link #installPackage} to indicate that this package is
* to be installed as a heavy weight app. This is fundamentally the opposite of
* {@link #INSTALL_INSTANT_APP}.
*
* @hide
*/
public static final int INSTALL_FULL_APP = 0x00004000;
/**
* Flag parameter for {@link #installPackage} to indicate that this package
* is critical to system health or security, meaning the system should use
* {@link StorageManager#FLAG_ALLOCATE_AGGRESSIVE} internally.
*
* @hide
*/
public static final int INSTALL_ALLOCATE_AGGRESSIVE = 0x00008000;
/**
* Flag parameter for {@link #installPackage} to indicate that this package
* is a virtual preload.
*
* @hide
*/
public static final int INSTALL_VIRTUAL_PRELOAD = 0x00010000;
/**
* Flag parameter for {@link #installPackage} to indicate that this package
* is an APEX package
*
* @hide
*/
public static final int INSTALL_APEX = 0x00020000;
/**
* Flag parameter for {@link #installPackage} to indicate that rollback
* should be enabled for this install.
*
* @hide
*/
public static final int INSTALL_ENABLE_ROLLBACK = 0x00040000;
/**
* Flag parameter for {@link #installPackage} to indicate that package verification should be
* disabled for this package.
*
* @hide
*/
public static final int INSTALL_DISABLE_VERIFICATION = 0x00080000;
/**
* Flag parameter for {@link #installPackage} to indicate that
* {@link #INSTALL_REQUEST_DOWNGRADE} should be allowed.
*
* @hide
*/
public static final int INSTALL_ALLOW_DOWNGRADE = 0x00100000;
/**
* Flag parameter for {@link #installPackage} to indicate that this package
* is being installed as part of a staged install.
*
* @hide
*/
public static final int INSTALL_STAGED = 0x00200000;
/**
* Flag parameter for {@link #installPackage} to indicate that all restricted
* permissions should be allowlisted. If {@link #INSTALL_ALL_USERS}
* is set the restricted permissions will be allowlisted for all users, otherwise
* only to the owner.
*
*
*
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_IDENTITY_CREDENTIAL_HARDWARE =
"android.hardware.identity_credential";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature(String, int)}: If this feature is supported, the device supports
* {@link android.security.identity.IdentityCredentialStore} implemented in secure hardware
* with direct access at the given feature version.
* See {@link #FEATURE_IDENTITY_CREDENTIAL_HARDWARE} for known feature versions.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_IDENTITY_CREDENTIAL_HARDWARE_DIRECT_ACCESS =
"android.hardware.identity_credential_direct_access";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports one or more methods of
* reporting current location.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_LOCATION = "android.hardware.location";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device has a Global Positioning System
* receiver and can report precise location.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_LOCATION_GPS = "android.hardware.location.gps";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device can report location with coarse
* accuracy using a network-based geolocation system.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_LOCATION_NETWORK = "android.hardware.location.network";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports FeliCa communication, which is based on
* ISO/IEC 18092 and JIS X 6319-4.
*
* @hide
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_FELICA = "android.hardware.felica";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device's
* {@link ActivityManager#isLowRamDevice() ActivityManager.isLowRamDevice()} method returns
* true.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_RAM_LOW = "android.hardware.ram.low";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device's
* {@link ActivityManager#isLowRamDevice() ActivityManager.isLowRamDevice()} method returns
* false.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_RAM_NORMAL = "android.hardware.ram.normal";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device can record audio via a
* microphone.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_MICROPHONE = "android.hardware.microphone";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device can communicate using Near-Field
* Communications (NFC).
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_NFC = "android.hardware.nfc";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports host-
* based NFC card emulation.
*
* TODO remove when depending apps have moved to new constant.
* @hide
* @deprecated
*/
@Deprecated
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_NFC_HCE = "android.hardware.nfc.hce";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports host-
* based NFC card emulation.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_NFC_HOST_CARD_EMULATION = "android.hardware.nfc.hce";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports host-
* based NFC-F card emulation.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_NFC_HOST_CARD_EMULATION_NFCF = "android.hardware.nfc.hcef";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports uicc-
* based NFC card emulation.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_NFC_OFF_HOST_CARD_EMULATION_UICC =
"android.hardware.nfc.uicc";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports eSE-
* based NFC card emulation.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_NFC_OFF_HOST_CARD_EMULATION_ESE = "android.hardware.nfc.ese";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports NFC charging.
*/
@SdkConstant(SdkConstantType.FEATURE)
@FlaggedApi(android.nfc.Flags.FLAG_ENABLE_NFC_CHARGING)
public static final String FEATURE_NFC_CHARGING = "android.hardware.nfc.charging";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The Beam API is enabled on the device.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_NFC_BEAM = "android.sofware.nfc.beam";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports any
* one of the {@link #FEATURE_NFC}, {@link #FEATURE_NFC_HOST_CARD_EMULATION},
* {@link #FEATURE_NFC_HOST_CARD_EMULATION_NFCF}, or {@link #FEATURE_NFC_CHARGING} features.
*
* @hide
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_NFC_ANY = "android.hardware.nfc.any";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device contains support for installing SDKs to a work
* profile.
*
* @hide
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_SDK_SANDBOX_WORK_PROFILE_INSTALL =
"android.software.sdksandbox.sdk_install_work_profile";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports Open Mobile API capable UICC-based secure
* elements.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_SE_OMAPI_UICC = "android.hardware.se.omapi.uicc";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports Open Mobile API capable eSE-based secure
* elements.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_SE_OMAPI_ESE = "android.hardware.se.omapi.ese";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature}: The device supports Open Mobile API capable SD-based secure
* elements.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_SE_OMAPI_SD = "android.hardware.se.omapi.sd";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: The device is
* compatible with Android’s security model.
*
* 202009: corresponds to the features included in the Identity Credential
* API shipped in Android 11.
* 202101: corresponds to the features included in the Identity Credential
* API shipped in Android 12.
* 202201: corresponds to the features included in the Identity Credential
* API shipped in Android 13.
*
*
*
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_VULKAN_HARDWARE_LEVEL = "android.hardware.vulkan.level";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature(String, int)}: If this feature is supported, the Vulkan
* implementation on this device is hardware accelerated, and the Vulkan native API will
* enumerate at least one {@code VkPhysicalDevice}, and the feature version will indicate what
* level of optional compute features that device supports beyond the Vulkan 1.0 requirements.
*
*
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_VULKAN_HARDWARE_COMPUTE = "android.hardware.vulkan.compute";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature(String, int)}: If this feature is supported, the Vulkan
* implementation on this device is hardware accelerated, and the feature version will indicate
* the highest {@code VkPhysicalDeviceProperties::apiVersion} supported by the physical devices
* that support the hardware level indicated by {@link #FEATURE_VULKAN_HARDWARE_LEVEL}. The
* feature version uses the same encoding as Vulkan version numbers:
*
*
* A version of 1.1.0 or higher also indicates:
*
*
* A subset of devices that support Vulkan 1.1 do so via software emulation. For more
* information, see
* Vulkan Design Guidelines.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_VULKAN_HARDWARE_VERSION = "android.hardware.vulkan.version";
/**
* Feature for {@link #getSystemAvailableFeatures} and
* {@link #hasSystemFeature(String, int)}: If this feature is supported, the feature version
* specifies a date such that the device is known to pass the Vulkan dEQP test suite associated
* with that date. The date is encoded as follows:
*
*
*
*
*
*
*
*
* This feature version is guaranteed to be set for all devices launching with Android 12 and
* may be set on devices launching with an earlier version. If the feature version is set, it
* will at least have the value 40. If it's not set the device may have a version of
* hardware-backed keystore but it may not support all features listed above.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_HARDWARE_KEYSTORE = "android.hardware.hardware_keystore";
/**
* Feature for {@link #getSystemAvailableFeatures}, {@link #hasSystemFeature(String)}, and
* {@link #hasSystemFeature(String, int)}: If this feature is supported, the device implements
* the Android Keystore backed by a dedicated secure processor referred to as
*
* StrongBox. If this feature has a version, the version number indicates which features are
* implemented in StrongBox:
*
*
* If a device has StrongBox, this feature version number is guaranteed to be set for all
* devices launching with Android 12 and may be set on devices launching with an earlier
* version. If the feature version is set, it will at least have the value 40. If it's not
* set the device may have StrongBox but it may not support all features listed above.
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_STRONGBOX_KEYSTORE =
"android.hardware.strongbox_keystore";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
* The device does not have slices implementation.
* @hide
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_SLICES_DISABLED = "android.software.slices_disabled";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
* The device supports device-unique Keystore attestations. Only available on devices that
* also support {@link #FEATURE_STRONGBOX_KEYSTORE}, and can only be used by device owner
* apps (see {@link android.app.admin.DevicePolicyManager#generateKeyPair}).
* @hide
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_DEVICE_UNIQUE_ATTESTATION =
"android.hardware.device_unique_attestation";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}:
* The device has a Keymaster implementation that supports Device ID attestation.
*
* @see DevicePolicyManager#isDeviceIdAttestationSupported
* @hide
*/
@SdkConstant(SdkConstantType.FEATURE)
public static final String FEATURE_DEVICE_ID_ATTESTATION =
"android.software.device_id_attestation";
/**
* Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: The device has
* the requisite kernel support for multinetworking-capable IPsec tunnels.
*
* null if neither are found.
*
* packageName.
*
* @param packageName The name of the package to inspect.
*
* @return A fully-qualified {@link Intent} that can be used to launch the
* main activity in the package. Returns null if the package
* does not contain such an activity, or if packageName is not
* recognized.
*
* @see #getLaunchIntentSenderForPackage(String)
*/
public abstract @Nullable Intent getLaunchIntentForPackage(@NonNull String packageName);
/**
* Return a "good" intent to launch a front-door Leanback activity in a
* package, for use for example to implement an "open" button when browsing
* through packages. The current implementation will look for a main
* activity in the category {@link Intent#CATEGORY_LEANBACK_LAUNCHER}, or
* return null if no main leanback activities are found.
*
* @param packageName The name of the package to inspect.
* @return Returns either a fully-qualified Intent that can be used to launch
* the main Leanback activity in the package, or null if the package
* does not contain such an activity.
*/
public abstract @Nullable Intent getLeanbackLaunchIntentForPackage(@NonNull String packageName);
/**
* Return a "good" intent to launch a front-door Car activity in a
* package, for use for example to implement an "open" button when browsing
* through packages. The current implementation will look for a main
* activity in the category {@link Intent#CATEGORY_CAR_LAUNCHER}, or
* return null if no main car activities are found.
*
* @param packageName The name of the package to inspect.
* @return Returns either a fully-qualified Intent that can be used to launch
* the main Car activity in the package, or null if the package
* does not contain such an activity.
* @hide
*/
@SuppressWarnings("HiddenAbstractMethod")
public abstract @Nullable Intent getCarLaunchIntentForPackage(@NonNull String packageName);
/**
* Returns an {@link IntentSender} that can be used to launch a front-door activity in a
* package. This is used, for example, to implement an "open" button when browsing through
* packages. The current implementation is the same with
* {@link #getLaunchIntentForPackage(String)}. Instead of returning the {@link Intent}, it
* returns the {@link IntentSender} which is not restricted by the package visibility.
*
* There are four allowlists:
*
*
*
* There are four whitelists:
*
*
*
* There are four whitelists:
*
*
*
* null or an empty array clears the cookie.
* null.
* 0 and is
* reset every boot.
* @param sequenceNumber The first sequence number for which to retrieve package changes.
* @see android.provider.Settings.Global#BOOT_COUNT
*/
public abstract @Nullable ChangedPackages getChangedPackages(
@IntRange(from=0) int sequenceNumber);
/**
* Get a list of features that are available on the
* system.
*
* @return An array of FeatureInfo classes describing the features
* that are available on the system, or null if there are none(!!).
*/
@NonNull
public abstract FeatureInfo[] getSystemAvailableFeatures();
/**
* Check whether the given feature name is one of the available features as
* returned by {@link #getSystemAvailableFeatures()}. This tests for the
* presence of any version of the given feature name; use
* {@link #hasSystemFeature(String, int)} to check for a minimum version.
*
* @return Returns true if the devices supports the feature, else false.
*/
public abstract boolean hasSystemFeature(@NonNull String featureName);
/**
* Check whether the given feature name and version is one of the available
* features as returned by {@link #getSystemAvailableFeatures()}. Since
* features are defined to always be backwards compatible, this returns true
* if the available feature version is greater than or equal to the
* requested version.
*
* @return Returns true if the devices supports the feature, else false.
*/
public abstract boolean hasSystemFeature(@NonNull String featureName, int version);
/**
* Determine the best action to perform for a given Intent. This is how
* {@link Intent#resolveActivity} finds an activity if a class has not been
* explicitly specified.
*
* Uri uri = Uri.parse("content://com.example.app.provider/table1");
* ProviderInfo info = packageManager.resolveContentProvider(uri.getAuthority(), flags);
*
*
* Use {@link #resolveContentProvider(String, ComponentInfoFlags)} when long flags are needed.
*
* @param authority The authority of the provider to find.
* @param flags Additional option flags to modify the data returned.
* @return A {@link ProviderInfo} object containing information about the
* provider. If a provider was not found, returns null.
*/
@Nullable
public abstract ProviderInfo resolveContentProvider(@NonNull String authority,
int flags);
/**
* See {@link #resolveContentProvider(String, int)}.
*/
@Nullable
public ProviderInfo resolveContentProvider(@NonNull String authority,
@NonNull ComponentInfoFlags flags) {
throw new UnsupportedOperationException(
"resolveContentProvider not implemented in subclass");
}
/**
* Find a single content provider by its base path name.
*
* Use {@link #resolveContentProviderAsUser(String, ComponentInfoFlags, int)} when long flags
* are needed.
*
* @param providerName The name of the provider to find.
* @param flags Additional option flags to modify the data returned.
* @param userId The user id.
* @return A {@link ProviderInfo} object containing information about the
* provider. If a provider was not found, returns null.
* @hide
*/
@SuppressWarnings("HiddenAbstractMethod")
@Nullable
@UnsupportedAppUsage
public abstract ProviderInfo resolveContentProviderAsUser(@NonNull String providerName,
int flags, @UserIdInt int userId);
/**
* See {@link #resolveContentProviderAsUser(String, int, int)}.
* @hide
*/
@Nullable
public ProviderInfo resolveContentProviderAsUser(@NonNull String providerName,
@NonNull ComponentInfoFlags flags, @UserIdInt int userId) {
throw new UnsupportedOperationException(
"resolveContentProviderAsUser not implemented in subclass");
}
/**
* Retrieve content provider information.
*
*
*
* @param targetPackage The installed package whose installer will be changed.
* @param installerPackageName The package name of the new installer. May be
* null to clear the association.
*/
public abstract void setInstallerPackageName(@NonNull String targetPackage,
@Nullable String installerPackageName);
/** @hide */
@SuppressWarnings("HiddenAbstractMethod")
@SystemApi
@RequiresPermission(Manifest.permission.INSTALL_PACKAGES)
public abstract void setUpdateAvailable(@NonNull String packageName, boolean updateAvaialble);
/**
* Attempts to delete a package. Since this may take a little while, the
* result will be posted back to the given observer. A deletion will fail if
* the calling context lacks the
* {@link android.Manifest.permission#DELETE_PACKAGES} permission, if the
* named package cannot be found, or if the named package is a system
* package.
*
* @param packageName The name of the package to delete
* @param observer An observer callback to get notified when the package
* deletion is complete.
* {@link android.content.pm.IPackageDeleteObserver#packageDeleted}
* will be called when that happens. observer may be null to
* indicate that no callback is desired.
* @hide
*/
@SuppressWarnings("HiddenAbstractMethod")
@RequiresPermission(Manifest.permission.DELETE_PACKAGES)
@UnsupportedAppUsage
public abstract void deletePackage(@NonNull String packageName,
@Nullable IPackageDeleteObserver observer, @DeleteFlags int flags);
/**
* Attempts to delete a package. Since this may take a little while, the
* result will be posted back to the given observer. A deletion will fail if
* the named package cannot be found, or if the named package is a system
* package.
*
* @param packageName The name of the package to delete
* @param observer An observer callback to get notified when the package
* deletion is complete.
* {@link android.content.pm.IPackageDeleteObserver#packageDeleted}
* will be called when that happens. observer may be null to
* indicate that no callback is desired.
* @param userId The user Id
* @hide
*/
@SuppressWarnings("HiddenAbstractMethod")
@RequiresPermission(anyOf = {
Manifest.permission.DELETE_PACKAGES,
Manifest.permission.INTERACT_ACROSS_USERS_FULL})
@UnsupportedAppUsage
public abstract void deletePackageAsUser(@NonNull String packageName,
@Nullable IPackageDeleteObserver observer, @DeleteFlags int flags,
@UserIdInt int userId);
/**
* Retrieve the package name of the application that installed a package. This identifies
* which market the package came from.
*
* @param packageName The name of the package to query
* @throws IllegalArgumentException if the given package name is not installed
*
* @deprecated use {@link #getInstallSourceInfo(String)} instead
*/
@SuppressWarnings("HiddenAbstractMethod")
@Deprecated
@Nullable
public abstract String getInstallerPackageName(@NonNull String packageName);
/**
* Retrieves information about how a package was installed or updated.
*
*
* Note: When the parserFunction is invoked, the client can read the AndroidManifest.xml
* information by the XmlResourceParser object. After leaving the parserFunction, the
* XmlResourceParser object will be closed. The caller should also handle the exception for
* calling this method.
*
* @param apkFile The file of an application apk.
* @param parserFunction The parserFunction will be invoked with the XmlResourceParser object
* after getting the AndroidManifest.xml of an application package.
*
* @return Returns the result of the {@link Function#apply(Object)}.
*
* @throws IOException if the AndroidManifest.xml of an application package cannot be
* read or accessed.
*/
@FlaggedApi(android.content.pm.Flags.FLAG_GET_PACKAGE_INFO)
@WorkerThread
public
* Bundle result;
* try {
* result = getContext().getPackageManager().parseAndroidManifest(apkFile,
* xmlResourceParser -> {
* Bundle bundle = new Bundle();
* // Search the start tag
* int type;
* while ((type = xmlResourceParser.next()) != XmlPullParser.START_TAG
* && type != XmlPullParser.END_DOCUMENT) {
* }
* if (type != XmlPullParser.START_TAG) {
* return bundle;
* }
*
* // Start to read the tags and attributes from the xmlResourceParser
* if (!xmlResourceParser.getName().equals("manifest")) {
* return bundle;
* }
* String packageName = xmlResourceParser.getAttributeValue(null, "package");
* bundle.putString("package", packageName);
*
* // Continue to read the tags and attributes from the xmlResourceParser
*
* return bundle;
* });
* } catch (IOException e) {
* }
*