ApplicationProductFlavor

Added in 4.2.0

interface ApplicationProductFlavor : ApplicationBaseFlavor, ProductFlavor

Encapsulates all product flavors properties for application projects.

Product flavors represent different versions of your project that you expect to co-exist on a single device, the Google Play store, or repository. For example, you can configure 'demo' and 'full' product flavors for your app, and each of those flavors can specify different features, device requirements, resources, and application ID's--while sharing common source code and resources. So, product flavors allow you to output different versions of your project by simply changing only the components and settings that are different between them.

Configuring product flavors is similar to configuring build types: add them to the productFlavors block of your project's build.gradle file and configure the settings you want.

Product flavors support the same properties as the DefaultConfig block—this is because defaultConfig defines a ProductFlavor object that the plugin uses as the base configuration for all other flavors. Each flavor you configure can then override any of the default values in defaultConfig, such as the applicationId.

When using Android plugin 3.0.0 and higher, each flavor must belong to a dimension.

When you configure product flavors, the Android plugin automatically combines them with your BuildType configurations to create build variants. If the plugin creates certain build variants that you don't want, you can filter variants using android.variantFilter.

Summary

Public properties
`Boolean`	`isDefault` Whether this product flavor should be selected in Studio by default

Inherited functions

From com.android.build.api.dsl.ApplicationBaseFlavor

`Unit`	`maxSdkVersion(maxSdkVersion: Int)` This function is deprecated. Replaced by maxSdk property
`Unit`	`setTargetSdkVersion(targetSdkVersion: String?)` This function is deprecated. Replaced by targetSdkPreview property
`Unit`	`targetSdkVersion(targetSdkVersion: Int)` This function is deprecated. Replaced by targetSdk property
`Unit`	`targetSdkVersion(targetSdkVersion: String?)` This function is deprecated. Replaced by targetSdkPreview property

From com.android.build.api.dsl.BaseFlavor

`String`	`getName()` The name of the flavor.
`Unit`	`initWith(that: BaseFlavor)` Copies all properties from the given flavor.
`Unit`	`minSdkVersion(minSdkVersion: Int)` This function is deprecated. Replaced by minSdk property
`Unit`	`minSdkVersion(minSdkVersion: String?)` This function is deprecated. Replaced by minSdkPreview property
`Unit`	`missingDimensionStrategy(dimension: String, requestedValue: String)` Specifies a flavor that the plugin should try to use from a given dimension in a dependency.
`Unit`	`missingDimensionStrategy( dimension: String, requestedValues: List<String> )` Specifies a sorted list of flavors that the plugin should try to use from a given dimension in a dependency.
`Unit`	`missingDimensionStrategy( dimension: String, vararg requestedValues: String )` Specifies a sorted list of flavors that the plugin should try to use from a given dimension in a dependency.
`Unit`	`resConfig(config: String)` This function is deprecated. Replaced by resourceConfigurations field
`Unit`	`resConfigs(config: Collection<String>)` This function is deprecated. Replaced by resourceConfigurations field
`Unit`	`resConfigs(vararg config: String)` This function is deprecated. Replaced by resourceConfigurations field
`Unit`	`setMinSdkVersion(minSdkVersion: Int)` This function is deprecated. Replaced by minSdk property
`Unit`	`setMinSdkVersion(minSdkVersion: String?)` This function is deprecated. Replaced by minSdkPreview property
`Any?`	`setTestFunctionalTest(testFunctionalTest: Boolean)` This function is deprecated. Replaced by testFunctionalTest property
`Any?`	`setTestHandleProfiling(testHandleProfiling: Boolean)` This function is deprecated. Replaced by testFunctionalTest property
`Any?`	`setTestInstrumentationRunnerArguments( testInstrumentationRunnerArguments: MutableMap<String, String> )` This function is deprecated. Replaced by testInstrumentationRunnerArguments property
`Unit`	`testInstrumentationRunnerArgument(key: String, value: String)` This function is deprecated. Replaced by testInstrumentationRunnerArguments property
`Unit`	`testInstrumentationRunnerArguments(args: Map<String, String>)` This function is deprecated. Replaced by testInstrumentationRunnerArguments property
`Unit`	`vectorDrawables(action: VectorDrawables.() -> Unit)` Configures `VectorDrawables`.

From org.gradle.api.plugins.ExtensionAware

ExtensionContainer

@Internal
getExtensions()

From com.android.build.api.dsl.ProductFlavor

`Void?`	`setDimension(dimension: String?)` This function is deprecated. Replaced with the dimension property
`Unit`	`setMatchingFallbacks(fallbacks: List<String>)` This function is deprecated. Replaced with property matchingFallbacks
`Unit`	`setMatchingFallbacks(vararg fallbacks: String)` This function is deprecated. Replaced with property matchingFallbacks

From com.android.build.api.dsl.VariantDimension

`Unit`	`addManifestPlaceholders(manifestPlaceholders: Map<String, Any>)` Adds manifest placeholders.
`Unit`	`buildConfigField(type: String, name: String, value: String)` Adds a new field to the generated BuildConfig class.
`Unit`	`@Incubating externalNativeBuild(action: ExternalNativeBuildFlags.() -> Unit)` Encapsulates per-variant CMake and ndk-build configurations for your external native build.
`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.
`Unit`	`@Incubating optimization(action: Optimization.() -> Unit)`
`Any`	`proguardFile(proguardFile: Any)` Adds a new ProGuard configuration file.
`Any`	`proguardFiles(vararg files: Any)` Adds new ProGuard configuration files.
`Unit`	`resValue(type: String, name: String, value: String)` Adds a new generated resource.
`Void?`	`setManifestPlaceholders(manifestPlaceholders: Map<String, Any>)` This function is deprecated. Use manifestPlaceholders property instead
`Any`	`setProguardFiles(proguardFileIterable: Iterable<*>)` Replaces the ProGuard configuration files.
`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.
`Any`	`testProguardFiles(vararg proguardFiles: Any)` Adds proguard rule files to be used when processing test code.

Inherited properties

From com.android.build.api.dsl.ApplicationBaseFlavor

`String?`	`applicationId` The application ID.
`Int?`	`maxSdk` The maxSdkVersion, or null if not specified.
`Int?`	`targetSdk` The target SDK version.
`String?`	`targetSdkPreview` The target SDK version.
`Int?`	`versionCode` Version code.
`String?`	`versionName` Version name.

From com.android.build.api.dsl.ApplicationVariantDimension

`String?`	`applicationIdSuffix` Application id suffix.
`Boolean?`	`multiDexEnabled` Returns whether multi-dex is enabled.
`ApkSigningConfig?`	`signingConfig` The associated signing config or null if none are set on the variant dimension.
`String?`	`versionNameSuffix` Version name suffix.

From com.android.build.api.dsl.BaseFlavor

`Int?`	`minSdk` The minimum SDK version.
`String?`	`minSdkPreview` The minimum SDK version.
`Boolean?`	`renderscriptNdkModeEnabled` Whether the renderscript code should be compiled to generate C/C++ bindings.
`Boolean?`	`renderscriptSupportModeBlasEnabled` Whether the renderscript BLAS support lib should be used to make it compatible with older versions of Android.
`Boolean?`	`renderscriptSupportModeEnabled` Whether the renderscript code should be compiled in support mode to make it compatible with older versions of Android.
`Int?`	`renderscriptTargetApi` The renderscript target api, or null if not specified.
`MutableSet<String>`	`resourceConfigurations` Specifies a list of alternative resources to keep.
`String?`	`testApplicationId` Test application ID.
`Boolean?`	`testFunctionalTest` See instrumentation.
`Boolean?`	`testHandleProfiling` See instrumentation.
`String?`	`testInstrumentationRunner` Test instrumentation runner class name.
`MutableMap<String, String>`	`testInstrumentationRunnerArguments` Test instrumentation runner custom arguments.
`VectorDrawables`	`vectorDrawables` Options to configure the build-time support for `vector` drawables.
`Boolean?`	`wearAppUnbundled` Whether to enable unbundling mode for embedded wear app.

From com.android.build.api.dsl.ProductFlavor

`String?`	`dimension` Specifies the flavor dimension that this product flavor belongs to.
`MutableList<String>`	`matchingFallbacks` Specifies a sorted list of product flavors that the plugin should try to use when a direct variant match with a local module dependency is not possible.

From com.android.build.api.dsl.VariantDimension

`ExternalNativeBuildFlags`	`externalNativeBuild` Encapsulates per-variant CMake and ndk-build configurations for your external native build.
`JavaCompileOptions`	`javaCompileOptions` Options for configuring Java compilation.
`MutableMap<String, Any>`	`manifestPlaceholders` The manifest placeholders.
`File?`	`multiDexKeepFile` This property is deprecated. This property is deprecated.
`File?`	`multiDexKeepProguard` Text file with additional ProGuard rules to be used to determine which classes are compiled into the main dex file.
`Ndk`	`ndk` Encapsulates per-variant configurations for the NDK, such as ABI filters.
`Optimization`	`optimization`
`MutableList<File>`	`proguardFiles` Specifies the ProGuard configuration files that the plugin should use.
`Shaders`	`shaders` Options for configuring the shader compiler.
`MutableList<File>`	`testProguardFiles` The collection of proguard rule files to be used when processing test code.

Public properties

isDefault

Added in 4.2.0

var isDefault: Boolean

Whether this product flavor should be selected in Studio by default