Struct android_manifest::Application

source · [−]

pub struct Application {Show 51 fields
    pub allow_task_reparenting: Option<bool>,
    pub allow_backup: Option<bool>,
    pub allow_clear_user_data: Option<bool>,
    pub allow_native_heap_pointer_tagging: Option<bool>,
    pub backup_agent: Option<String>,
    pub backup_in_foreground: Option<bool>,
    pub banner: Option<Resource<DrawableResource>>,
    pub debuggable: Option<bool>,
    pub description: Option<Resource<StringResource>>,
    pub direct_boot_aware: Option<bool>,
    pub enabled: Option<bool>,
    pub extract_native_libs: Option<bool>,
    pub full_backup_content: Option<Resource<XmlResource>>,
    pub full_backup_only: Option<bool>,
    pub gwp_asan_mode: Option<GwpAsanMode>,
    pub has_code: Option<bool>,
    pub has_fragile_user_data: Option<bool>,
    pub hardware_accelerated: Option<bool>,
    pub icon: Option<MipmapOrDrawableResource>,
    pub is_game: Option<bool>,
    pub kill_after_restore: Option<bool>,
    pub large_heap: Option<bool>,
    pub label: Option<StringResourceOrString>,
    pub logo: Option<Resource<DrawableResource>>,
    pub manage_space_activity: Option<String>,
    pub name: Option<String>,
    pub network_security_config: Option<Resource<XmlResource>>,
    pub permission: Option<String>,
    pub persistent: Option<bool>,
    pub process: Option<String>,
    pub restore_any_version: Option<bool>,
    pub request_legacy_external_storage: Option<bool>,
    pub required_account_type: Option<String>,
    pub resizeable_activity: Option<bool>,
    pub restricted_account_type: Option<String>,
    pub supports_rtl: Option<bool>,
    pub task_affinity: Option<String>,
    pub test_only: Option<bool>,
    pub theme: Option<Resource<StyleResource>>,
    pub ui_options: Option<UiOptions>,
    pub uses_cleartext_traffic: Option<bool>,
    pub vm_safe_mode: Option<bool>,
    pub activity: Vec<Activity>,
    pub service: Vec<Service>,
    pub receiver: Vec<Receiver>,
    pub provider: Vec<Provider>,
    pub activity_alias: Vec<ActivityAlias>,
    pub meta_data: Vec<MetaData>,
    pub uses_library: Vec<UsesLibrary>,
    pub profileable: Option<Profileable>,
    pub uses_native_library: Vec<UsesNativeLibrary>,
}

Expand description

The declaration of the application.

This element contains subelements that declare each of the application’s components and has attributes that can affect all the components. Many of these attributes (such as icon, label, permission, process, taskAffinity, and allowTaskReparenting) set default values for corresponding attributes of the component elements. Others (such as debuggable, enabled, description, and allowClearUserData) set values for the application as a whole and cannot be overridden by the components.

XML Syntax

<application android:allowTaskReparenting=["true" | "false"]
             android:allowBackup=["true" | "false"]
             android:allowClearUserData=["true" | "false"]
             android:allowNativeHeapPointerTagging=["true" | "false"]
             android:backupAgent="string"
             android:backupInForeground=["true" | "false"]
             android:banner="drawable resource"
             android:debuggable=["true" | "false"]
             android:description="string resource"
             android:directBootAware=["true" | "false"]
             android:enabled=["true" | "false"]
             android:extractNativeLibs=["true" | "false"]
             android:fullBackupContent="xml resource"
             android:fullBackupOnly=["true" | "false"]
             android:gwpAsanMode=["always" | "never"]
             android:hasCode=["true" | "false"]
             android:hasFragileUserData=["true" | "false"]
             android:hardwareAccelerated=["true" | "false"]
             android:icon="drawable resource"
             android:isGame=["true" | "false"]
             android:killAfterRestore=["true" | "false"]
             android:largeHeap=["true" | "false"]
             android:label="string resource"
             android:logo="drawable resource"
             android:manageSpaceActivity="string"
             android:name="string"
             android:networkSecurityConfig="xml resource"
             android:permission="string"
             android:persistent=["true" | "false"]
             android:process="string"
             android:restoreAnyVersion=["true" | "false"]
             android:requestLegacyExternalStorage=["true" | "false"]
             android:requiredAccountType="string"
             android:resizeableActivity=["true" | "false"]
             android:restrictedAccountType="string"
             android:supportsRtl=["true" | "false"]
             android:taskAffinity="string"
             android:testOnly=["true" | "false"]
             android:theme="resource or theme"
             android:uiOptions=["none" | "splitActionBarWhenNarrow"]
             android:usesCleartextTraffic=["true" | "false"]
             android:vmSafeMode=["true" | "false"] >
      ...
</application>

Contained in

<manifest>

Can contain

Introduced in

API Level 1

Fields

allow_task_reparenting: Option<bool>

Whether or not activities that the application defines can move from the task that started them to the task they have an affinity for when that task is next brought to the front — “true” if they can move, and “false” if they must remain with the task where they started.

The default value is “false”.

The <activity> element has its own allowTaskReparenting attribute that can override the value set here. See that attribute for more information.

allow_backup: Option<bool>

Whether to allow the application to participate in the backup and restore infrastructure. If this attribute is set to false, no backup or restore of the application will ever be performed, even by a full-system backup that would otherwise cause all application data to be saved via adb.

The default value of this attribute is “true”.

Note

If your app targets Android 11 (API level 30) or higher, you cannot disable device-to-device migration of your app’s files. The system automatically allows this functionality.

You can still disable cloud-based backup and restore of your app’s files by setting this attribute to “false”, even if your app targets Android 11 (API level 30) or higher.

allow_clear_user_data: Option<bool>

Whether to allow the application to reset user data. This data includes flags—such as whether the user has seen introductory tooltips—as well as user-customizable settings and preferences.

The default value of this attribute is “true”.

For more information, see Restoring User Data on New Devices.

Note

Only apps that are part of the system image can declare this attribute explicitly. Third-party apps cannot include this attribute in their manifest files.

allow_native_heap_pointer_tagging: Option<bool>

Whether or not the app has the Heap pointer tagging feature enabled.

The default value of this attribute is true.

Note

Disabling this feature does not address the underlying code health issue. Future hardware devices may not support this manifest tag.

For more information, see Tagged Pointers.

backup_agent: Option<String>

The name of the class that implements the application’s backup agent, a subclass of BackupAgent. The attribute value should be a fully qualified class name (such as, "com.example.project.MyBackupAgent"). However, as a shorthand, if the first character of the name is a period (for example, ".MyBackupAgent"), it is appended to the package name specified in the <manifest> element.

There is no default. The name must be specified.

backup_in_foreground: Option<bool>

Indicates that Auto Backup operations may be performed on this app even if the app is in a foreground-equivalent state. The system shuts down an app during auto backup operation, so use this attribute with caution. Setting this flag to true can impact app behavior while the app is active.

The default value is “false”, which means that the OS will avoid backing up the app while it is running in the foreground (such as a music app that is actively playing music via a service in the startForeground() state).

banner: Option<Resource<DrawableResource>>

A drawable resource providing an extended graphical banner for its associated item. Use with the <application> tag to supply a default banner for all application activities, or with the <activity> tag to supply a banner for a specific activity.

The system uses the banner to represent an app in the Android TV home screen. Since the banner is displayed only in the home screen, it should only be specified by applications with an activity that handles the CATEGORY_LEANBACK_LAUNCHER intent.

This attribute must be set as a reference to a drawable resource containing the image (for example "@drawable/banner"). There is no default banner.

See Provide a home screen banner in Get Started with TV Apps for more information.

debuggable: Option<bool>

Whether or not the application can be debugged, even when running on a device in user mode — “true” if it can be, and “false” if not. The default value is “false”.

description: Option<Resource<StringResource>>

User-readable text about the application, longer and more descriptive than the application label. The value must be set as a reference to a string resource. Unlike the label, it cannot be a raw string.

There is no default value.

direct_boot_aware: Option<bool>

Whether or not the application is direct-boot aware; that is, whether or not it can run before the user unlocks the device. If you’re using a custom subclass of Application, and if any component inside your application is direct-boot aware, then your entire custom applicationis considered to be direct-boot aware.

The default value is “false”.

Note

During Direct Boot, your application can only access the data that is stored in device protected storage.

enabled: Option<bool>

Whether or not the Android system can instantiate components of the application — “true” if it can, and “false” if not. If the value is “true”, each component’s enabled attribute determines whether that component is enabled or not. If the value is “false”, it overrides the component-specific values; all components are disabled.

The default value is “true”.

extract_native_libs: Option<bool>

Whether or not the package installer extracts native libraries from the APK to the filesystem. If set to “false”, then your native libraries must be page aligned and stored uncompressed in the APK. Although your APK might be larger, your application should load faster because the libraries are directly loaded from the APK at runtime. On the other hand, if set to “true”, native libraries in the APK can be compressed. During installation, the installer decompresses the libraries, and the linker loads the decompressed libraries at runtime; in this case, the APK would be smaller, but installation time might be slightly longer.

The default value is “true” if extractNativeLibs is not configured in AndroidManifest.xml. However, when building your app using Android Gradle plugin 3.6.0 or higher, this property is reset to “false” if it is NOT configured in AndroidManifest.xml; so if your native libraries in the APK are compressed, you must explicitly set it to “true” in AndroidManifest.xml.

full_backup_content: Option<Resource<XmlResource>>

This attribute points to an XML file that contains full backup rules for Auto Backup. These rules determine what files get backed up. For more information, see XML Config Syntax for Auto Backup.

This attribute is optional. If it is not specified, by default, Auto Backup includes most of your app’s files. For more information, see Files that are backed up.

full_backup_only: Option<bool>

This attribute indicates whether or not to use Auto Backup on devices where it is available. If set to “true”, then your app performs Auto Backup when installed on a device running Android 6.0 (API level 23) or higher. On older devices, your app ignores this attribute and performs Key/Value Backups.

The default value is “false”.

gwp_asan_mode: Option<GwpAsanMode>

This attribute indicates whether or not to use GWP-ASan, which is a native memory allocator feature that helps find use-after-free and heap-buffer-overflow bugs.

The default value is “never”.

has_code: Option<bool>

Whether or not the application contains any code — “true” if it does, and “false” if not. When the value is “false”, the system does not try to load any application code when launching components.

The default value is “true”.

For example, if your app supports Play Feature Delivery and includes feature modules that do not generate any DEX files—which is bytecode optimized for the Android platform—you need to set this property to “false” in the module’s manifest file. Otherwise, you may get runtime errors.

has_fragile_user_data: Option<bool>

When the user uninstalls an app, whether or not to show the user a prompt to keep the app’s data.

The default value is “false”.

hardware_accelerated: Option<bool>

Whether or not hardware-accelerated rendering should be enabled for all activities and views in this application — “true” if it should be enabled, and “false” if not. The default value is “true” if you’ve set either minSdkVersion or targetSdkVersion to “14” or higher; otherwise, it’s “false”.

Starting from Android 3.0 (API level 11), a hardware-accelerated OpenGL renderer is available to applications, to improve performance for many common 2D graphics operations. When the hardware-accelerated renderer is enabled, most operations in Canvas, Paint, Xfermode, ColorFilter, Shader, and Camera are accelerated. This results in smoother animations, smoother scrolling, and improved responsiveness overall, even for applications that do not explicitly make use the framework’s OpenGL libraries.

For more information, read the Hardware Acceleration guide.

Note

Not all of the OpenGL 2D operations are accelerated. If you enable the hardware-accelerated renderer, test your application to ensure that it can make use of the renderer without errors.

icon: Option<MipmapOrDrawableResource>

An icon for the application as whole, and the default icon for each of the application’s components. See the individual icon attributes for <activity>, <activity-alias>, <service>, <receiver>, and <provider> elements.

This attribute must be set as a reference to a drawable resource containing the image (for example "@drawable/icon").

There is no default icon.

is_game: Option<bool>

Whether or not the application is a game. The system may group together applications classifed as games or display them separately from other applications.

The default is false.

kill_after_restore: Option<bool>

Whether the application in question should be terminated after its settings have been restored during a full-system restore operation. Single-package restore operations will never cause the application to be shut down. Full-system restore operations typically only occur once, when the phone is first set up. Third-party applications will not normally need to use this attribute.

The default is “true”, which means that after the application has finished processing its data during a full-system restore, it will be terminated.

large_heap: Option<bool>

Whether your application’s processes should be created with a large Dalvik heap. This applies to all processes created for the application. It only applies to the first application loaded into a process; if you’re using a shared user ID to allow multiple applications to use a process, they all must use this option consistently or they will have unpredictable results.

Most apps should not need this and should instead focus on reducing their overall memory usage for improved performance. Enabling this also does not guarantee a fixed increase in available memory, because some devices are constrained by their total available memory.

To query the available memory size at runtime, use the methods getMemoryClass() or getLargeMemoryClass().

label: Option<StringResourceOrString>

A user-readable label for the application as a whole, and a default label for each of the application’s components. See the individual label attributes for <activity>, <activity-alias>, <service>, <receiver>, and <provider> elements.

The label should be set as a reference to a string resource, so that it can be localized like other strings in the user interface. However, as a convenience while you’re developing the application, it can also be set as a raw string.

logo: Option<Resource<DrawableResource>>

A logo for the application as whole, and the default logo for activities. This attribute must be set as a reference to a drawable resource containing the image (for example "@drawable/logo").

There is no default logo.

manage_space_activity: Option<String>

The fully qualified name of an Activity subclass that the system can launch to let users manage the memory occupied by the application on the device. The activity should also be declared with an <activity> element.

name: Option<String>

The fully qualified name of an Application subclass implemented for the application. When the application process is started, this class is instantiated before any of the application’s components.

The subclass is optional; most applications won’t need one. In the absence of a subclass, Android uses an instance of the base Application class.

network_security_config: Option<Resource<XmlResource>>

Specifies the name of the XML file that contains your application’s Network Security Configuration. The value must be a reference to the XML resource file containing the configuration.

This attribute was added in API level 24.

permission: Option<String>

The name of a permission that clients must have in order to interact with the application. This attribute is a convenient way to set a permission that applies to all of the application’s components. It can be overwritten by setting the permission attributes of individual components.

For more information on permissions, see the Permissions section in the introduction and another document, Security and Permissions.

persistent: Option<bool>

Whether or not the application should remain running at all times — “true” if it should, and “false” if not. The default value is “false”. Applications should not normally set this flag; persistence mode is intended only for certain system applications.

process: Option<String>

The name of a process where all components of the application should run. Each component can override this default by setting its own process attribute.

By default, Android creates a process for an application when the first of its components needs to run. All components then run in that process. The name of the default process matches the package name set by the <manifest> element.

By setting this attribute to a process name that’s shared with another application, you can arrange for components of both applications to run in the same process — but only if the two applications also share a user ID and be signed with the same certificate.

If the name assigned to this attribute begins with a colon (‘:’), a new process, private to the application, is created when it’s needed. If the process name begins with a lowercase character, a global process of that name is created. A global process can be shared with other applications, reducing resource usage.

restore_any_version: Option<bool>

Indicates that the application is prepared to attempt a restore of any backed-up data set, even if the backup was stored by a newer version of the application than is currently installed on the device. Setting this attribute to “true” will permit the Backup Manager to attempt restore even when a version mismatch suggests that the data are incompatible. Use with caution!

The default value of this attribute is false.

request_legacy_external_storage: Option<bool>

Whether or not the application wants to opt out of scoped storage.

Note

Depending on changes related to policy or app compatibility, the system might not honor this opt-out request.

required_account_type: Option<String>

Specifies the account type required by the application in order to function. If your app requires an Account, the value for this attribute must correspond to the account authenticator type used by your app (as defined by AuthenticatorDescription), such as “com.google”.

The default value is null and indicates that the application can work without any accounts.

Because restricted profiles currently cannot add accounts, specifying this attribute makes your app unavailable from a restricted profile unless you also declare android:restrictedAccountType with the same value.

This attribute was added in API level 18.

Caution

If the account data may reveal personally identifiable information, it’s important that you declare this attribute and leave android:restrictedAccountType null, so that restricted profiles cannot use your app to access personal information that belongs to the owner user.

resizeable_activity: Option<bool>

Specifies whether the app supports multi-window display. You can set this attribute in either the <activity> or <application> element.

If you set this attribute to true, the user can launch the activity in split-screen and freeform modes. If you set the attribute to false, the activity does not support multi-window mode. If this value is false, and the user attempts to launch the activity in multi-window mode, the activity takes over the full screen.

If your app targets API level 24 or higher, but you do not specify a value for this attribute, the attribute’s value defaults to true.

This attribute was added in API level 24.

Note

A task’s root activity value is applied to all additional activities launched in the task. That is, if the root activity of a task is resizable then the system treats all other activities in the task as resizable. If the root activity is not resizable, the other activities in the task are not resizable

restricted_account_type: Option<String>

Specifies the account type required by this application and indicates that restricted profiles are allowed to access such accounts that belong to the owner user. If your app requires an Account and restricted profiles are allowed to access the primary user’s accounts, the value for this attribute must correspond to the account authenticator type used by your app (as defined by AuthenticatorDescription), such as “com.google”.

The default value is null and indicates that the application can work without any accounts.

Caution

Specifying this attribute allows restricted profiles to use your app with accounts that belong to the owner user, which may reveal personally identifiable information. If the account may reveal personal details, you should not use this attribute and you should instead declare the android:requiredAccountType attribute to make your app unavailable to restricted profiles.

This attribute was added in API level 18.

supports_rtl: Option<bool>

Declares whether your application is willing to support right-to-left (RTL) layouts. If set to “true” and targetSdkVersion is set to 17 or higher, various RTL APIs will be activated and used by the system so your app can display RTL layouts. If set to “false” or if targetSdkVersion is set to 16 or lower, the RTL APIs will be ignored or will have no effect and your app will behave the same regardless of the layout direction associated to the user’s Locale choice (your layouts will always be left-to-right).

The default value of this attribute is “false”.

This attribute was added in API level 17.

task_affinity: Option<String>

An affinity name that applies to all activities within the application, except for those that set a different affinity with their own taskAffinity attributes. See that attribute for more information.

By default, all activities within an application share the same affinity. The name of that affinity is the same as the package name set by the <manifest> element.

test_only: Option<bool>

Indicates whether this application is only for testing purposes. For example, it may expose functionality or data outside of itself that would cause a security hole, but is useful for testing. This kind of APK can be installed only through adb — you cannot publish it to Google Play.

Android Studio automatically adds this attribute when you click Run.

theme: Option<Resource<StyleResource>>

A reference to a style resource defining a default theme for all activities in the application. Individual activities can override the default by setting their own theme attributes. For more information, see the Styles and Themes developer guide.

ui_options: Option<UiOptions>

Extra options for an activity’s UI.

For more information about the app bar, see the Adding the App Bar training class.

This attribute was added in API level 14.

uses_cleartext_traffic: Option<bool>

Indicates whether the app intends to use cleartext network traffic, such as cleartext HTTP. The default value for apps that target API level 27 or lower is “true”. Apps that target API level 28 or higher default to “false”.

When the attribute is set to “false”, platform components (for example, HTTP and FTP stacks, DownloadManager, and MediaPlayer) will refuse the app’s requests to use cleartext traffic. Third-party libraries are strongly encouraged to honor this setting as well. The key reason for avoiding cleartext traffic is the lack of confidentiality, authenticity, and protections against tampering; a network attacker can eavesdrop on transmitted data and also modify it without being detected.

This flag is honored on a best-effort basis because it’s impossible to prevent all cleartext traffic from Android applications given the level of access provided to them. For example, there’s no expectation that the Socket API will honor this flag because it cannot determine whether its traffic is in cleartext. However, most network traffic from applications is handled by higher-level network stacks/components, which can honor this flag by either reading it from ApplicationInfo.flags or NetworkSecurityPolicy.isCleartextTrafficPermitted().

Note

WebView honors this attribute for applications targeting API level 26 and higher.

During app development, StrictMode can be used to identify any cleartext traffic from the app. See StrictMode.VmPolicy.Builder.detectCleartextNetwork() for more information.

This attribute was added in API level 23.

This flag is ignored on Android 7.0 (API level 24) and above if an Android Network Security Config is present.

vm_safe_mode: Option<bool>

Indicates whether the app would like the virtual machine (VM) to operate in safe mode. The default value is “false”.

This attribute was added in API level 8 where a value of “true” disabled the Dalvik just-in-time (JIT) compiler.

This attribute was adapted in API level 22 where a value of “true” disabled the ART ahead-of-time (AOT) compiler.

activity: Vec<Activity>

List of <activity> tags.

service: Vec<Service>

List of <service> tags.

receiver: Vec<Receiver>

List of <receiver> tags.