Stay organized with collections
Save and categorize content based on your preferences.
DynamicFeatureBuildType
interface DynamicFeatureBuildType : BuildType, DynamicFeatureVariantDimension
Build types define certain properties that Gradle uses when building and packaging your app, and
are typically configured for different stages of your development lifecycle.
Dynamic features must have exactly the same build types (by name) as the app that
includes them, however settings can be different between the application and the dynamic feature.
Properties on dynamic feature build types fall in to three categories.
- Properties global to the application that affect the build flow, and so must be explicitly set
in the dynamic feature.
For example, whether the build type is debuggable must match the application that includes this
dynamic feature.
- Properties global to the application that do not affect the build flow. These are set in the
com.android.application
project, and are automatically configured on the dynamic feature,
they cannot be set on the dynamic feature.
For example, application ID suffix and signing cannot be configured on the dynamic feature and
are not present on this interface.
- Properties that can vary between the app and the dynamic feature.
For example,
resValues
can be used independently from the app in a dynamic feature.
See ApplicationProductFlavor
Summary
Inherited functions
|
From class VariantDimension
Unit |
addManifestPlaceholders(manifestPlaceholders: Map<String, Any>)
Adds manifest placeholders.
See
Inject Build Variables into the Manifest.
|
Unit |
buildConfigField(type: String, name: String, value: String)
Adds a new field to the generated BuildConfig class.
The field is generated as: <type> <name> = <value>;
This means each of these must have valid Java content. If the type is a String, then the
value should include quotes.
|
Unit |
externalNativeBuild(action: ExternalNativeBuildOptions.() -> Unit)
Encapsulates per-variant CMake and ndk-build configurations for your external native build.
To learn more, see
Add C and C++ Code to Your Project.
|
Unit |
javaCompileOptions(action: JavaCompileOptions.() -> Unit)
Options for configuring Java compilation.
|
Unit |
ndk(action: Ndk.() -> Unit)
Encapsulates per-variant configurations for the NDK, such as ABI filters.
|
Any |
proguardFile(proguardFile: Any)
Adds a new ProGuard configuration file.
proguardFile getDefaultProguardFile('proguard-android.txt')
There are two ProGuard rules files that ship with the Android plugin and are used by
default:
- proguard-android.txt
- proguard-android-optimize.txt
proguard-android-optimize.txt is identical to proguard-android.txt ,
except with optimizations enabled. You can use getDefaultProguardFileString
to return the full path of the files.
This method has a return value for legacy reasons.
|
Any |
proguardFiles(vararg files: Any)
Adds new ProGuard configuration files.
There are two ProGuard rules files that ship with the Android plugin and are used by
default:
- proguard-android.txt
- proguard-android-optimize.txt
proguard-android-optimize.txt is identical to proguard-android.txt ,
except with optimizations enabled. You can use getDefaultProguardFileString
to return the full path of the files.
This method has a return value for legacy reasons.
|
Unit |
resValue(type: String, name: String, value: String)
Adds a new generated resource.
This is equivalent to specifying a resource in res/values.
See Resource Types.
|
Void? |
setManifestPlaceholders(manifestPlaceholders: Map<String, Any>)
|
Any |
setProguardFiles(proguardFileIterable: Iterable<*>)
Replaces the ProGuard configuration files.
This method has a return value for legacy reasons.
|
Unit |
shaders(action: Shaders.() -> Unit)
Configure the shader compiler options.
|
Any |
testProguardFile(proguardFile: Any)
Adds a proguard rule file to be used when processing test code.
Test code needs to be processed to apply the same obfuscation as was done to main code.
This method has a return value for legacy reasons.
|
Any |
testProguardFiles(vararg proguardFiles: Any)
Adds proguard rule files to be used when processing test code.
Test code needs to be processed to apply the same obfuscation as was done to main code.
This method has a return value for legacy reasons.
|
|
|
Properties
|
abstract Boolean? |
Whether to crunch PNGs.
|
Inherited properties
|
|
From class BuildType
Boolean |
isJniDebuggable
Whether this build type is configured to generate an APK with debuggable native code.
|
Boolean |
isMinifyEnabled
Specifies whether to enable code shrinking for this build type.
By default, when you enable code shrinking by setting this property to true ,
the Android plugin uses ProGuard.
To learn more, read
Shrink Your Code and Resources.
|
Boolean |
isPseudoLocalesEnabled
Specifies whether the plugin should generate resources for pseudolocales.
A pseudolocale is a locale that simulates characteristics of languages that cause UI,
layout, and other translation-related problems when an app is localized. Pseudolocales can
aid your development workflow because you can test and make adjustments to your UI before you
finalize text for translation.
When you set this property to true as shown below, the plugin generates
resources for the following pseudo locales and makes them available in your connected
device's language preferences: en-XA and ar-XB .
android {
buildTypes {
debug {
pseudoLocalesEnabled true
}
}
}
When you build your app, the plugin includes the pseudolocale resources in your APK. If
you notice that your APK does not include those locale resources, make sure your build
configuration isn't limiting which locale resources are packaged with your APK, such as using
the resourceConfigurations property to
remove unused locale resources.
To learn more, read
Test Your App with Pseudolocales.
|
Boolean |
isRenderscriptDebuggable
Whether the build type is configured to generate an apk with debuggable RenderScript code.
|
Boolean |
isShrinkResources
Specifies whether to enable shrinking resources for this build type.
To learn more, read
Shrink Your Code and Resources.
|
Boolean |
isTestCoverageEnabled
Whether test coverage is enabled for this build type.
If enabled this uses Jacoco to capture coverage and creates a report in the build
directory.
The version of Jacoco can be configured with:
android {
testCoverage {
jacocoVersion = '0.6.2.201302030002'
}
}
|
Boolean |
isZipAlignEnabled
|
MutableList<String> |
matchingFallbacks
Specifies a sorted list of build types that the plugin should try to use when a direct
variant match with a local module dependency is not possible.
Android plugin 3.0.0 and higher try to match each variant of your module with the same one
from its dependencies. For example, when you build a "freeDebug" version of your app, the
plugin tries to match it with "freeDebug" versions of the local library modules the app
depends on.
However, there may be situations in which your app includes build types that adependency does not. For example, consider if your app includes a "stage" build type, but
a dependency includes only a "debug" and "release" build type. When the plugin tries to build
the "stage" version of your app, it won't know which version of the dependency to use, and
you'll see an error message similar to the following:
Error:Failed to resolve: Could not resolve project :mylibrary.
Required by:
project :app
In this situation, you can use matchingFallbacks to specify alternative
matches for the app's "stage" build type, as shown below:
// In the app's build.gradle file.
android {
buildTypes {
release {
// Because the dependency already includes a "release" build type,
// you don't need to provide a list of fallbacks here.
}
stage {
// Specifies a sorted list of fallback build types that the
// plugin should try to use when a dependency does not include a
// "stage" build type. You may specify as many fallbacks as you
// like, and the plugin selects the first build type that's
// available in the dependency.
matchingFallbacks = ['debug', 'qa', 'release']
}
}
}
Note that there is no issue when a library dependency includes a build type that your app
does not. That's because the plugin simply never requests that build type from the
dependency.
|
PostProcessing |
postprocessing
|
Int |
renderscriptOptimLevel
Optimization level to use by the renderscript compiler.
|
|
Properties
isCrunchPngs
abstract var isCrunchPngs: Boolean?
Whether to crunch PNGs.
Setting this property to true
reduces of PNG resources that are not already
optimally compressed. However, this process increases build times.
PNG crunching is enabled by default in the release build type and disabled by default in
the debug build type.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[]]