LibraryBaseFlavor

Added in 4.2.0

interface LibraryBaseFlavor : BaseFlavor, LibraryVariantDimension

Known direct subclasses
LibraryDefaultConfig

Specifies defaults for properties that the Android library plugin applies to all build variants.
LibraryProductFlavor

Encapsulates all product flavors properties for library projects.

Shared properties between LibraryProductFlavor and LibraryDefaultConfig

See ProductFlavor and DefaultConfig for more information.

Summary

Public functions
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

Public properties
Int?

This property is deprecated. Will be removed from library DSL in v9.0.
String?

This property is deprecated. Will be removed from library DSL in v9.0

Inherited functions
From com.android.build.api.dsl.BaseFlavor
String

The name of the flavor.
Unit

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

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

This function is deprecated. Replaced by testInstrumentationRunnerArguments property
Unit

This function is deprecated. Replaced by testInstrumentationRunnerArguments property
Unit

Configures VectorDrawables.
From com.android.build.api.dsl.LibraryVariantDimension
Unit
aarMetadata(action: AarMetadata.() -> Unit)

Options for configuring AAR metadata.
Any
consumerProguardFile(proguardFile: Any)

Adds a proguard rule file to be included in the published AAR.
Any
consumerProguardFiles(vararg proguardFiles: Any)

Adds proguard rule files to be included in the published AAR.
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

Encapsulates per-variant CMake and ndk-build configurations for your external native build.
Unit

Options for configuring Java compilation.
Unit
ndk(action: Ndk.() -> Unit)

Encapsulates per-variant configurations for the NDK, such as ABI filters.
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.BaseFlavor
Int?

The minimum SDK version.
String?

The minimum SDK version.
Boolean?

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

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

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

The renderscript target api, or null if not specified.
MutableSet<String>

Specifies a list of alternative resources to keep.
String?

Test application ID.
Boolean?

See instrumentation.
Boolean?

See instrumentation.
String?

Test instrumentation runner class name.
MutableMap<String, String>

Test instrumentation runner custom arguments.
VectorDrawables

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

Whether to enable unbundling mode for embedded wear app.
From com.android.build.api.dsl.LibraryVariantDimension
AarMetadata

Options for configuring AAR metadata.
MutableList<File>

ProGuard rule files to be included in the published AAR.
Boolean?

Returns whether multi-dex is enabled.
ApkSigningConfig?

The associated signing config or null if none are set on the variant dimension.
From com.android.build.api.dsl.VariantDimension
ExternalNativeBuildFlags

Encapsulates per-variant CMake and ndk-build configurations for your external native build.
JavaCompileOptions

Options for configuring Java compilation.
MutableMap<String, Any>

The manifest placeholders.
File?

This property is deprecated. This property is deprecated.
File?

Text file with additional ProGuard rules to be used to determine which classes are compiled into the main dex file.
Ndk

Encapsulates per-variant configurations for the NDK, such as ABI filters.
Optimization
MutableList<File>

Specifies the ProGuard configuration files that the plugin should use.
Shaders

Options for configuring the shader compiler.
MutableList<File>

The collection of proguard rule files to be used when processing test code.

Public functions

setTargetSdkVersion

Added in 7.0.0
Deprecated in 7.0.0
fun setTargetSdkVersion(targetSdkVersion: String?): Unit

targetSdkVersion

Added in 7.0.0
Deprecated in 7.0.0
fun targetSdkVersion(targetSdkVersion: Int): Unit

targetSdkVersion

Added in 7.0.0
Deprecated in 7.0.0
fun targetSdkVersion(targetSdkVersion: String?): Unit

Public properties

targetSdk

Added in 7.0.0
Deprecated in 7.4.0
var targetSdk: Int?

The target SDK version used for building the test APK.

This is propagated in the library manifest, but that is only advisory for libraries that depend on this library.

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.

targetSdkPreview

Added in 7.0.0
Deprecated in 7.4.0
var targetSdkPreview: String?

The target SDK version used for building the test APK.

This is propagated in the library manifest, but that is only advisory for libraries that depend on this library.

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.