LibraryExtension

View Source

Added in 4.2.0

interface LibraryExtension : CommonExtension, TestedExtension

---

Extension for the Android Library Gradle Plugin.

This is the android block when the com.android.library plugin is applied.

Only the Android Gradle Plugin should create instances of interfaces in com.android.build.api.dsl.

Summary

Public functions
Unit	androidResources(action: LibraryAndroidResources.() -> Unit) Specifies options related to the processing of Android Resources.
Unit	buildFeatures(action: LibraryBuildFeatures.() -> Unit) A list of build features that can be enabled or disabled on the Android Project.
Unit	buildTypes(action: NamedDomainObjectContainer<LibraryBuildType>.() -> Unit) Encapsulates all build type configurations for this project.
Unit	NamedDomainObjectContainer<LibraryBuildType>.debug(action: LibraryBuildType.() -> Unit) Shortcut extension method to allow easy access to the predefined debug LibraryBuildType
Unit	defaultConfig(action: LibraryDefaultConfig.() -> Unit) Specifies defaults for variant properties that the Android plugin applies to all build variants.
Unit	installation(action: LibraryInstallation.() -> Unit) Specifies options for the Android Debug Bridge (ADB), such as APK installation options.
Unit	privacySandbox(action: PrivacySandbox.() -> Unit)
Unit	productFlavors(action: NamedDomainObjectContainer<LibraryProductFlavor>.() -> Unit) Encapsulates all product flavors configurations for this project.
Unit	publishing(action: LibraryPublishing.() -> Unit) Customizes publishing build variant artifacts from library module to a Maven repository.
Unit	NamedDomainObjectContainer<LibraryBuildType>.release(     action: LibraryBuildType.() -> Unit ) Shortcut extension method to allow easy access to the predefined release LibraryBuildType

Public properties
MutableCollection<String>?	aidlPackagedList Aidl files to package in the aar.
LibraryAndroidResources	androidResources Specifies options related to the processing of Android Resources.
LibraryBuildFeatures	buildFeatures A list of build features that can be enabled or disabled on the Android Project.
NamedDomainObjectContainer<LibraryBuildType>	buildTypes Encapsulates all build type configurations for this project.
LibraryDefaultConfig	defaultConfig Specifies defaults for variant properties that the Android plugin applies to all build variants.
LibraryInstallation	installation Specifies options for the Android Debug Bridge (ADB), such as APK installation options.
NamedDomainObjectContainer<Prefab>	prefab container of Prefab options
PrivacySandbox	privacySandbox
NamedDomainObjectContainer<LibraryProductFlavor>	productFlavors Encapsulates all product flavors configurations for this project.
LibraryPublishing	publishing Customizes publishing build variant artifacts from library module to a Maven repository.

Inherited functions
From com.android.build.api.dsl.CommonExtension Unit aaptOptions(action: AaptOptions.() -> Unit) This function is deprecated. Replaced by Unit adbOptions(action: AdbOptions.() -> Unit) This function is deprecated. Replaced by installation Unit buildToolsVersion(buildToolsVersion: String) This function is deprecated. Replaced by buildToolsVersion property Unit compileOptions(action: CompileOptions.() -> Unit) Specifies Java compiler options, such as the language level of the Java source code and generated bytecode. Unit compileSdk(action: CompileSdkSpec.() -> Unit) Configures all aspects regarding compile Sdk version, see CompileSdkSpec for more details. Unit compileSdkAddon(vendor: String, name: String, version: Int) Specify an SDK add-on to compile your project against. Unit compileSdkVersion(apiLevel: Int) This function is deprecated. Will be removed in AGP 10.0, replaced by the compileSdk block Unit compileSdkVersion(version: String) This function is deprecated. Will be removed in AGP 10.0, replaced by the compileSdk block Unit composeOptions(action: ComposeOptions.() -> Unit) Unit dataBinding(action: DataBinding.() -> Unit) Specifies options for the Data Binding Library. Unit externalNativeBuild(action: ExternalNativeBuild.() -> Unit) Specifies options for external native build using CMake or ndk-build. File getDefaultProguardFile(name: String) Unit @Incubating jacoco(action: JacocoOptions.() -> Unit) This function is deprecated. Renamed to testCoverage Unit lint(action: Lint.() -> Unit) Specifies options for the lint tool. Unit @Incubating lintOptions(action: LintOptions.() -> Unit) This function is deprecated. Renamed to lint Unit packaging(action: Packaging.() -> Unit) Specifies options and rules that determine which files the Android plugin packages into your APK. Unit packagingOptions(action: Packaging.() -> Unit) This function is deprecated. Renamed to packaging Unit signingConfigs(action: NamedDomainObjectContainer<ApkSigningConfig>.() -> Unit) Encapsulates signing configurations that you can apply to BuildType and ProductFlavor configurations. Unit sourceSets(action: NamedDomainObjectContainer<AndroidSourceSet>.() -> Unit) Encapsulates source set configurations for all variants. Unit splits(action: Splits.() -> Unit) Specifies configurations for building multiple APKs or APK splits. Unit testCoverage(action: TestCoverage.() -> Unit) Configure the gathering of code-coverage from tests. Unit testOptions(action: TestOptions.() -> Unit) Specifies options for how the Android plugin should run local and instrumented tests. Unit useLibrary(name: String) Includes the specified library to the classpath. Unit useLibrary(name: String, required: Boolean) Includes the specified library to the classpath. Unit viewBinding(action: ViewBinding.() -> Unit) Specifies options for the View Binding Library.
From com.android.build.api.dsl.TestedExtension Unit @Incubating testFixtures(action: TestFixtures.() -> Unit) Options to configure the test fixtures.

Inherited properties
From com.android.build.api.dsl.CommonExtension AaptOptions aaptOptions This property is deprecated. Replaced by AdbOptions adbOptions This property is deprecated. Replaced by installation String buildToolsVersion Specifies the version of the SDK Build Tools to use when building your project. CompileOptions compileOptions Specifies Java compiler options, such as the language level of the Java source code and generated bytecode. Int? compileSdk Specifies the API level to compile your project against. Int? compileSdkExtension Specifies the SDK Extension level to compile your project against. Int? compileSdkMinor Specify a minor API version for the compile SDK. String? compileSdkPreview Specify a preview API to compile your project against. ComposeOptions composeOptions DataBinding dataBinding Specifies options for the Data Binding Library. MutableMap<String, Any> experimentalProperties Additional per module experimental properties. ExternalNativeBuild externalNativeBuild Specifies options for external native build using CMake or ndk-build. MutableList<String> flavorDimensions Specifies the names of product flavor dimensions for this project. JacocoOptions jacoco This property is deprecated. Renamed to testCoverage Lint lint Specifies options for the lint tool. LintOptions lintOptions This property is deprecated. Renamed to lint String? namespace The namespace of the generated R and BuildConfig classes. String? ndkPath Requires the specified path to NDK be used. String ndkVersion Requires the specified NDK version to be used. Packaging packaging Specifies options and rules that determine which files the Android plugin packages into your APK. Packaging packagingOptions This property is deprecated. Renamed to packaging String? resourcePrefix Specifies this project's resource prefix to Android Studio for editor features, such as Lint checks. SdkComponents sdkComponents NamedDomainObjectContainer<ApkSigningConfig> signingConfigs Encapsulates signing configurations that you can apply to [ ] and [ ] configurations. NamedDomainObjectContainer<AndroidSourceSet> sourceSets Encapsulates source set configurations for all variants. Splits splits Specifies configurations for building multiple APKs or APK splits. TestCoverage testCoverage Configure the gathering of code-coverage from tests. TestOptions testOptions Specifies options for how the Android plugin should run local and instrumented tests. ViewBinding viewBinding Specifies options for the View Binding Library.
From com.android.build.api.dsl.TestedExtension String testBuildType Specifies the build type that the plugin should use to test the module. TestFixtures testFixtures Options to configure the test fixtures. String? testNamespace The namespace used by the android test and unit test components for the generated R and BuildConfig classes.

Public functions

androidResources

Added in 9.0.0-alpha02

fun androidResources(action: LibraryAndroidResources.() -> Unit): Unit

Specifies options related to the processing of Android Resources.

For more information about the properties you can configure in this block, see LibraryAndroidResources.

buildFeatures

Added in 9.0.0-alpha02

fun buildFeatures(action: LibraryBuildFeatures.() -> Unit): Unit

A list of build features that can be enabled or disabled on the Android Project.

buildTypes

Added in 9.0.0-alpha02

fun buildTypes(action: NamedDomainObjectContainer<LibraryBuildType>.() -> Unit): Unit

Encapsulates all build type configurations for this project.

For more information about the properties you can configure in this block, see LibraryBuildType

debug

Added in 9.0.0-alpha02

fun NamedDomainObjectContainer<LibraryBuildType>.debug(action: LibraryBuildType.() -> Unit): Unit

Shortcut extension method to allow easy access to the predefined debug LibraryBuildType

For example:

 android {
     buildTypes {
         debug {
             // ...
         }
     }
}

defaultConfig

Added in 9.0.0-alpha02

fun defaultConfig(action: LibraryDefaultConfig.() -> Unit): Unit

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

You can override any defaultConfig property when configuring product flavors

For more information about the properties you can configure in this block, see LibraryDefaultConfig.

installation

Added in 9.0.0-alpha02

fun installation(action: LibraryInstallation.() -> Unit): Unit

Specifies options for the Android Debug Bridge (ADB), such as APK installation options.

For more information about the properties you can configure in this block, see AdbOptions.

privacySandbox

Added in 8.3.1

fun privacySandbox(action: PrivacySandbox.() -> Unit): Unit

productFlavors

Added in 9.0.0-alpha02

fun productFlavors(action: NamedDomainObjectContainer<LibraryProductFlavor>.() -> Unit): Unit

Encapsulates all product flavors configurations for this project.

For more information about the properties you can configure in this block, see ProductFlavor

publishing

Added in 7.1.0

fun publishing(action: LibraryPublishing.() -> Unit): Unit

Customizes publishing build variant artifacts from library module to a Maven repository.

For more information about the properties you can configure in this block, see LibraryPublishing

release

Added in 9.0.0-alpha02

fun NamedDomainObjectContainer<LibraryBuildType>.release(
    action: LibraryBuildType.() -> Unit
): Unit

Shortcut extension method to allow easy access to the predefined release LibraryBuildType

For example:

 android {
     buildTypes {
         release {
             // ...
         }
     }
}

Public properties

aidlPackagedList

Added in 4.2.0

val aidlPackagedList: MutableCollection<String>?

Aidl files to package in the aar.

androidResources

val androidResources: LibraryAndroidResources

Specifies options related to the processing of Android Resources.

For more information about the properties you can configure in this block, see LibraryAndroidResources.

buildFeatures

val buildFeatures: LibraryBuildFeatures

A list of build features that can be enabled or disabled on the Android Project.

buildTypes

val buildTypes: NamedDomainObjectContainer<LibraryBuildType>

Encapsulates all build type configurations for this project.

Unlike using LibraryProductFlavor to create different versions of your project that you expect to co-exist on a single device, build types determine how Gradle builds and packages each version of your project. Developers typically use them to configure projects for various stages of a development lifecycle. For example, when creating a new project from Android Studio, the Android plugin configures a 'debug' and 'release' build type for you. You can then combine build types with product flavors to create build variants.

See also
BuildType

defaultConfig

val defaultConfig: LibraryDefaultConfig

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

You can override any defaultConfig property when configuring product flavors

For more information about the properties you can configure in this block, see LibraryDefaultConfig.

installation

val installation: LibraryInstallation

Specifies options for the Android Debug Bridge (ADB), such as APK installation options.

For more information about the properties you can configure in this block, see AdbOptions.

prefab

Added in 4.2.0

val prefab: NamedDomainObjectContainer<Prefab>

container of Prefab options

privacySandbox

Added in 8.3.1

val privacySandbox: PrivacySandbox

productFlavors

val productFlavors: NamedDomainObjectContainer<LibraryProductFlavor>

Encapsulates all product flavors configurations for this project.

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 an 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 com.android.build.gradle.BaseExtension.html#com.android.build.gradle.BaseExtension:flavorDimensions(java.lang.String[]) value. By default, when you specify only one dimension, all flavors you configure belong to that dimension. If you specify more than one flavor dimension, you need to manually assign each flavor to a dimension. To learn more, read Use Flavor Dimensions for variant-aware dependency management.

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

See also
LibraryProductFlavor

publishing

Added in 7.1.0

val publishing: LibraryPublishing

Customizes publishing build variant artifacts from library module to a Maven repository.

For more information about the properties you can configure in this block, see LibraryPublishing