Google is committed to advancing racial equity for Black communities. See how.

BaseFlavor

@Incubating interface BaseFlavor : VariantDimension
com.android.build.api.dsl.BaseFlavor

Shared properties between DSL objects ProductFlavor and DefaultConfig

Summary

Public methods

abstract String

The name of the flavor.

abstract Unit

Configures VectorDrawables.

Inherited functions

Properties

abstract Int?

The minimum SDK version.

abstract String?

The minimum SDK version.

abstract Boolean?

Whether the renderscript code should be compiled to generate C/C++ bindings.

abstract Boolean?

Whether the renderscript BLAS support lib should be used to make it compatible with older versions of Android.

abstract Boolean?

Whether the renderscript code should be compiled in support mode to make it compatible with older versions of Android.

abstract Int?

The renderscript target api, or null if not specified.

abstract MutableSet<String>

Specifies a list of alternative resources to keep.

abstract String?

Test application ID.

abstract Boolean?

See instrumentation.

abstract Boolean?

See instrumentation.

abstract String?

Test instrumentation runner class name.

abstract MutableMap<String, String>

Test instrumentation runner custom arguments.

abstract VectorDrawables

Options to configure the build-time support for vector drawables.

abstract Boolean?

Whether to enable unbundling mode for embedded wear app.

Inherited properties

Public methods

getName

abstract fun getName(): String

The name of the flavor.

vectorDrawables

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

Configures VectorDrawables.

Properties

minSdk

abstract var minSdk: Int?

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.

minSdkPreview

abstract var minSdkPreview: String?

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.

renderscriptNdkModeEnabled

abstract var renderscriptNdkModeEnabled: Boolean?

Whether the renderscript code should be compiled to generate C/C++ bindings. True for C/C++ generation, false for Java, null if not specified.

renderscriptSupportModeBlasEnabled

abstract var renderscriptSupportModeBlasEnabled: Boolean?

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.

renderscriptSupportModeEnabled

abstract var renderscriptSupportModeEnabled: Boolean?

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.

renderscriptTargetApi

abstract var renderscriptTargetApi: Int?

The renderscript target api, or null if not specified. This is only the value set on this product flavor.

resourceConfigurations

abstract val resourceConfigurations: MutableSet<String>

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.

testApplicationId

abstract var testApplicationId: String?

Test application ID.

See Set the Application ID

testFunctionalTest

abstract var testFunctionalTest: Boolean?

See instrumentation.

testHandleProfiling

abstract var testHandleProfiling: Boolean?

See instrumentation.

testInstrumentationRunner

abstract var testInstrumentationRunner: String?

Test instrumentation runner class name.

This is a fully qualified class name of the runner, e.g. android.test.InstrumentationTestRunner

See instrumentation.

testInstrumentationRunnerArguments

abstract val testInstrumentationRunnerArguments: MutableMap<String, String>

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

abstract val vectorDrawables: VectorDrawables

Options to configure the build-time support for vector drawables.

wearAppUnbundled

abstract var wearAppUnbundled: Boolean?

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.