ApplicationProductFlavor

@Incubating interface ApplicationProductFlavor<SigningConfigT : SigningConfig> : ApplicationBaseFlavor<SigningConfigT>, ProductFlavor

com.android.build.api.dsl.ApplicationProductFlavor

Summary

Inherited functions

From class VariantDimension

`Unit`	`addManifestPlaceholders(manifestPlaceholders: Map<String, Any>)` Adds manifest placeholders. See Inject Build Variables into the Manifest.
`Unit`	`addManifestPlaceholders(manifestPlaceholders: Map<String, Any>)` Adds manifest placeholders. See Inject Build Variables into the Manifest.
`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`	`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`	`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`	`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`	`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`	`javaCompileOptions(action: JavaCompileOptions.() -> Unit)` Options for configuring Java compilation.
`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`	`ndk(action: Ndk.() -> Unit)` Encapsulates per-variant configurations for the NDK, such as ABI filters.
`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`	`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`	`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.
`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.
`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.
`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.
`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.
`Unit`	`shaders(action: Shaders.() -> Unit)` Configure the shader compiler options.
`Unit`	`shaders(action: Shaders.() -> Unit)` Configure the shader compiler options.
`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`	`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`	`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.
`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.
`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.

From class BaseFlavor

String

getName()

The name of the flavor.

Unit

vectorDrawables(action: VectorDrawables.() -> Unit)

Configures VectorDrawables.

Unit

vectorDrawables(action: VectorDrawables.() -> Unit)

Configures VectorDrawables.

Properties
abstract Boolean	`isDefault` Whether this product flavor should be selected in Studio by default

Inherited properties

From class ApplicationBaseFlavor

`String?`	`applicationId` The application ID. See Set the Application ID
`Int?`	`maxSdk` The maxSdkVersion, or null if not specified. This is only the value set on this produce flavor. See uses-sdk element documentation.
`Int?`	`targetSdk` The target SDK version. Setting this it will override previous calls of targetSdk and targetSdkPreview setters. Only one of targetSdk and targetSdkPreview should be set. See uses-sdk element documentation.
`String?`	`targetSdkPreview` The target SDK version. Setting this it will override previous calls of targetSdk and targetSdkPreview setters. Only one of targetSdk and targetSdkPreview should be set. See uses-sdk element documentation.
`Int?`	`versionCode` Version code. See Versioning Your Application
`String?`	`versionName` Version name. See Versioning Your Application

From class ApplicationVariantDimension

`String?`	`applicationIdSuffix` Application id suffix. It is appended to the "base" application id when calculating the final application id for a variant. In case there are product flavor dimensions specified, the final application id suffix will contain the suffix from the default product flavor, followed by the suffix from product flavor of the first dimension, second dimension and so on. All of these will have a dot in between e.g. "defaultSuffix.dimension1Suffix.dimensions2Suffix".
`Boolean?`	`multiDexEnabled` Returns whether multi-dex is enabled. This can be null if the flag is not set, in which case the default value is used.
`SigningConfigT?`	`signingConfig` The associated signing config or null if none are set on the variant dimension.
`String?`	`versionNameSuffix` Version name suffix. It is appended to the "base" version name when calculating the final version name for a variant. In case there are product flavor dimensions specified, the final version name suffix will contain the suffix from the default product flavor, followed by the suffix from product flavor of the first dimension, second dimension and so on.

From class ProductFlavor

String?

dimension

Specifies the flavor dimension that this product flavor belongs to.

When configuring product flavors with Android plugin 3.0.0 and higher, you must specify at least one flavor dimension, using the flavorDimensions property, and then assign each flavor to a dimension. Otherwise, you will get the following build error:

Error:All flavors must now belong to a named flavor dimension.
The flavor 'flavor_name' is not assigned to a flavor dimension.

By default, when you specify only one dimension, all flavors you configure automatically belong to that dimension. If you specify more than one dimension, you need to manually assign each flavor to a dimension, as shown in the sample below:

android {
    ...
    // Specifies the flavor dimensions you want to use. The order in which you
    // list each dimension determines its priority, from highest to lowest,
    // when Gradle merges variant sources and configurations. You must assign
    // each product flavor you configure to one of the flavor dimensions.
    flavorDimensions 'api', 'version'

    productFlavors {
        demo {
            // Assigns this product flavor to the 'version' flavor dimension.
            dimension 'version'
            ...
        }

        full {
            dimension 'version'
            ...
        }

        minApi24 {
            // Assigns this flavor to the 'api' dimension.
            dimension 'api'
            minSdkVersion '24'
            versionNameSuffix "-minApi24"
            ...
        }

        minApi21 {
            dimension "api"
            minSdkVersion '21'
            versionNameSuffix "-minApi21"
            ...
        }
    }
}

To learn more about configuring flavor dimensions, read Combine multiple flavors.

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.

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, for a given flavor dimension that exists in both the app and its library dependencies, your app includes flavors that a dependencydoes not. For example, consider if both your app and its library dependencies include a "tier" flavor dimension. However, the "tier" dimension in the app includes "free" and "paid" flavors, but one of its dependencies includes only "demo" and "paid" flavors for the same dimension. When the plugin tries to build the "free" 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 should use matchingFallbacks to specify alternative matches for the app's "free" product flavor, as shown below:

// In the app's build.gradle file.
android {
    flavorDimensions 'tier'
    productFlavors {
        paid {
            dimension 'tier'
            // Because the dependency already includes a "paid" flavor in its
            // "tier" dimension, you don't need to provide a list of fallbacks
            // for the "paid" flavor.
        }
        free {
            dimension 'tier'
            // Specifies a sorted list of fallback flavors that the plugin
            // should try to use when a dependency's matching dimension does
            // not include a "free" flavor. You may specify as many
            // fallbacks as you like, and the plugin selects the first flavor
            // that's available in the dependency's "tier" dimension.
            matchingFallbacks = ['demo', 'trial']
        }
    }
}

Note that, for a given flavor dimension that exists in both the app and its library dependencies, there is no issue when a library includes a product flavor that your app does not. That's because the plugin simply never requests that flavor from the dependency.

If instead you are trying to resolve an issue in which a library dependency includes aflavor dimension that your app does not, use missingDimensionStrategy.

From class VariantDimension

`ExternalNativeBuildOptions`	`externalNativeBuild` 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.
`ExternalNativeBuildOptions`	`externalNativeBuild` 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.
`ExternalNativeBuildOptions`	`externalNativeBuild` 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.
`JavaCompileOptions`	`javaCompileOptions` Options for configuring Java compilation.
`JavaCompileOptions`	`javaCompileOptions` Options for configuring Java compilation.
`JavaCompileOptions`	`javaCompileOptions` Options for configuring Java compilation.
`MutableMap<String, Any>`	`manifestPlaceholders` The manifest placeholders. See Inject Build Variables into the Manifest.
`MutableMap<String, Any>`	`manifestPlaceholders` The manifest placeholders. See Inject Build Variables into the Manifest.
`MutableMap<String, Any>`	`manifestPlaceholders` The manifest placeholders. See Inject Build Variables into the Manifest.
`File?`	`multiDexKeepFile` Text file that specifies additional classes that will be compiled into the main dex file. Classes specified in the file are appended to the main dex classes computed using `aapt`. If set, the file should contain one class per line, in the following format: `com/example/MyClass.class`
`File?`	`multiDexKeepFile` Text file that specifies additional classes that will be compiled into the main dex file. Classes specified in the file are appended to the main dex classes computed using `aapt`. If set, the file should contain one class per line, in the following format: `com/example/MyClass.class`
`File?`	`multiDexKeepFile` Text file that specifies additional classes that will be compiled into the main dex file. Classes specified in the file are appended to the main dex classes computed using `aapt`. If set, the file should contain one class per line, in the following format: `com/example/MyClass.class`
`File?`	`multiDexKeepProguard` Text file with additional ProGuard rules to be used to determine which classes are compiled into the main dex file. If set, rules from this file are used in combination with the default rules used by the build system.
`File?`	`multiDexKeepProguard` Text file with additional ProGuard rules to be used to determine which classes are compiled into the main dex file. If set, rules from this file are used in combination with the default rules used by the build system.
`File?`	`multiDexKeepProguard` Text file with additional ProGuard rules to be used to determine which classes are compiled into the main dex file. If set, rules from this file are used in combination with the default rules used by the build system.
`Ndk`	`ndk` Encapsulates per-variant configurations for the NDK, such as ABI filters.
`Ndk`	`ndk` Encapsulates per-variant configurations for the NDK, such as ABI filters.
`Ndk`	`ndk` Encapsulates per-variant configurations for the NDK, such as ABI filters.
`MutableList<File>`	`proguardFiles` Specifies the ProGuard configuration files that the plugin should use. 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.
`MutableList<File>`	`proguardFiles` Specifies the ProGuard configuration files that the plugin should use. 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.
`MutableList<File>`	`proguardFiles` Specifies the ProGuard configuration files that the plugin should use. 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.
`Shaders`	`shaders` Options for configuring the shader compiler.
`Shaders`	`shaders` Options for configuring the shader compiler.
`Shaders`	`shaders` Options for configuring the shader compiler.
`MutableList<File>`	`testProguardFiles` The collection of 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.
`MutableList<File>`	`testProguardFiles` The collection of 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.
`MutableList<File>`	`testProguardFiles` The collection of 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.

From class BaseFlavor

`Int?`	`minSdk` The minimum SDK version. Setting this it will override previous calls of minSdk and minSdkPreview setters. Only one of minSdk and minSdkPreview should be set. See uses-sdk element documentation.
`Int?`	`minSdk` The minimum SDK version. Setting this it will override previous calls of minSdk and minSdkPreview setters. Only one of minSdk and minSdkPreview should be set. See uses-sdk element documentation.
`String?`	`minSdkPreview` The minimum SDK version. Setting this it will override previous calls of minSdk and minSdkPreview setters. Only one of minSdk and minSdkPreview should be set. See uses-sdk element documentation.
`String?`	`minSdkPreview` The minimum SDK version. Setting this it will override previous calls of minSdk and minSdkPreview setters. Only one of minSdk and minSdkPreview should be set. See uses-sdk element documentation.
`Boolean?`	`renderscriptNdkModeEnabled` Whether the renderscript code should be compiled to generate C/C++ bindings. True for C/C++ generation, false for Java, null if not specified.
`Boolean?`	`renderscriptNdkModeEnabled` Whether the renderscript code should be compiled to generate C/C++ bindings. True for C/C++ generation, false for Java, null if not specified.
`Boolean?`	`renderscriptSupportModeBlasEnabled` Whether the renderscript BLAS support lib should be used to make it compatible with older versions of Android. True if BLAS support lib is enabled, false if not, and null if not specified.
`Boolean?`	`renderscriptSupportModeBlasEnabled` Whether the renderscript BLAS support lib should be used to make it compatible with older versions of Android. True if BLAS support lib is enabled, false if not, and null if not specified.
`Boolean?`	`renderscriptSupportModeEnabled` Whether the renderscript code should be compiled in support mode to make it compatible with older versions of Android. True if support mode is enabled, false if not, and null if not specified.
`Boolean?`	`renderscriptSupportModeEnabled` Whether the renderscript code should be compiled in support mode to make it compatible with older versions of Android. True if support mode is enabled, false if not, and null if not specified.
`Int?`	`renderscriptTargetApi` The renderscript target api, or null if not specified. This is only the value set on this product flavor.
`Int?`	`renderscriptTargetApi` The renderscript target api, or null if not specified. This is only the value set on this product flavor.
`MutableSet<String>`	`resourceConfigurations` Specifies a list of alternative resources to keep. For example, if you are using a library that includes language resources (such as AppCompat or Google Play Services), then your APK includes all translated language strings for the messages in those libraries whether the rest of your app is translated to the same languages or not. If you'd like to keep only the languages that your app officially supports, you can specify those languages using the `resConfigs` property, as shown in the sample below. Any resources for languages not specified are removed. android { defaultConfig { ... // Keeps language resources for only the locales specified below. resConfigs "en", "fr" } } You can also use this property to filter resources for screen densities. For example, specifying `hdpi` removes all other screen density resources (such as `mdpi`, `xhdpi`, etc) from the final APK. Note: `auto` is no longer supported because it created a number of issues with multi-module projects. Instead, you should specify a list of locales that your app supports, as shown in the sample above. Android plugin 3.1.0 and higher ignore the `auto` argument, and Gradle packages all string resources your app and its dependencies provide. To learn more, see Remove unused alternative resources.
`MutableSet<String>`	`resourceConfigurations` Specifies a list of alternative resources to keep. For example, if you are using a library that includes language resources (such as AppCompat or Google Play Services), then your APK includes all translated language strings for the messages in those libraries whether the rest of your app is translated to the same languages or not. If you'd like to keep only the languages that your app officially supports, you can specify those languages using the `resConfigs` property, as shown in the sample below. Any resources for languages not specified are removed. android { defaultConfig { ... // Keeps language resources for only the locales specified below. resConfigs "en", "fr" } } You can also use this property to filter resources for screen densities. For example, specifying `hdpi` removes all other screen density resources (such as `mdpi`, `xhdpi`, etc) from the final APK. Note: `auto` is no longer supported because it created a number of issues with multi-module projects. Instead, you should specify a list of locales that your app supports, as shown in the sample above. Android plugin 3.1.0 and higher ignore the `auto` argument, and Gradle packages all string resources your app and its dependencies provide. To learn more, see Remove unused alternative resources.
`String?`	`testApplicationId` Test application ID. See Set the Application ID
`String?`	`testApplicationId` Test application ID. See Set the Application ID
`Boolean?`	`testFunctionalTest` See instrumentation.
`Boolean?`	`testFunctionalTest` See instrumentation.
`Boolean?`	`testHandleProfiling` See instrumentation.
`Boolean?`	`testHandleProfiling` See instrumentation.
`String?`	`testInstrumentationRunner` Test instrumentation runner class name. This is a fully qualified class name of the runner, e.g. `android.test.InstrumentationTestRunner` See instrumentation.
`String?`	`testInstrumentationRunner` Test instrumentation runner class name. This is a fully qualified class name of the runner, e.g. `android.test.InstrumentationTestRunner` See instrumentation.
`MutableMap<String, String>`	`testInstrumentationRunnerArguments` Test instrumentation runner custom arguments. e.g. `[key: "value"]` will give `adb shell am instrument -w -e key value com.example`... See instrumentation. Test runner arguments can also be specified from the command line: ./gradlew connectedAndroidTest -Pandroid.testInstrumentationRunnerArguments.size=medium ./gradlew connectedAndroidTest -Pandroid.testInstrumentationRunnerArguments.foo=bar
`MutableMap<String, String>`	`testInstrumentationRunnerArguments` Test instrumentation runner custom arguments. e.g. `[key: "value"]` will give `adb shell am instrument -w -e key value com.example`... See instrumentation. Test runner arguments can also be specified from the command line: ./gradlew connectedAndroidTest -Pandroid.testInstrumentationRunnerArguments.size=medium ./gradlew connectedAndroidTest -Pandroid.testInstrumentationRunnerArguments.foo=bar
`VectorDrawables`	`vectorDrawables` Options to configure the build-time support for `vector` drawables.
`VectorDrawables`	`vectorDrawables` Options to configure the build-time support for `vector` drawables.
`Boolean?`	`wearAppUnbundled` Whether to enable unbundling mode for embedded wear app. If true, this enables the app to transition from an embedded wear app to one distributed by the play store directly.
`Boolean?`	`wearAppUnbundled` Whether to enable unbundling mode for embedded wear app. If true, this enables the app to transition from an embedded wear app to one distributed by the play store directly.

Properties

isDefault

abstract var isDefault: Boolean

Whether this product flavor should be selected in Studio by default