Stay organized with collections Save and categorize content based on your preferences.

LibraryExtension

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

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

Public properties

MutableCollection<String>?

Aidl files to package in the aar.

NamedDomainObjectContainer<Prefab>

container of Prefab options

LibraryPublishing

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

Inherited functions

From class com.android.build.api.dsl.CommonExtension
@Incubating Unit

This function is deprecated. Replaced by

@Incubating Unit

This function is deprecated. Replaced by installation

Unit

Specifies options related to the processing of Android Resources.

@Incubating Unit

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

@Incubating Unit
buildToolsVersion(buildToolsVersion: String)

This function is deprecated. Replaced by buildToolsVersion property

Unit

Encapsulates all build type configurations for this project.

Unit

Specifies Java compiler options, such as the language level of the Java source code and generated bytecode.

Unit
compileSdkAddon(vendor: String, name: String, version: Int)

Specify an SDK add-on to compile your project against.

@Incubating Unit

This function is deprecated. Replaced by compileSdk

@Incubating Unit

This function is deprecated. Replaced by compileSdkPreview

Unit
Unit

Specifies options for the Data Binding Library.

Unit

Shortcut extension method to allow easy access to the predefined debugBuildType

Unit

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

Unit

Specifies options for external native build using CMake or ndk-build.

@Incubating Unit
flavorDimensions(vararg dimensions: String)

This function is deprecated. Replaced by flavorDimensions property

@Incubating File
Unit

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

@Incubating Unit

This function is deprecated. Renamed to testCoverage

Unit

Specifies options for the lint tool.

@Incubating Unit

This function is deprecated. Renamed to lint

@Incubating Unit

Specifies options and rules that determine which files the Android plugin packages into your APK.

Unit

Encapsulates all product flavors configurations for this project.

Unit

Shortcut extension method to allow easy access to the predefined releaseBuildType

Unit

Encapsulates signing configurations that you can apply to BuildType and ProductFlavor configurations.

@Incubating Unit

Encapsulates source set configurations for all variants.

Unit

Specifies configurations for building multiple APKs or APK splits.

Unit

Configure the gathering of code-coverage from tests.

@Incubating Unit

Specifies options for how the Android plugin should run local and instrumented tests.

@Incubating Unit

Includes the specified library to the classpath.

@Incubating Unit
useLibrary(name: String, required: Boolean)

Includes the specified library to the classpath.

Unit

Specifies options for the View Binding Library.

From class com.android.build.api.dsl.TestedExtension
@Incubating Unit

Options to configure the test fixtures.

Inherited properties

From class com.android.build.api.dsl.CommonExtension
AaptOptions

This property is deprecated. Replaced by

AdbOptions

This property is deprecated. Replaced by installation

AndroidResources

Specifies options related to the processing of Android Resources.

LibraryBuildFeatures

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

String

Specifies the version of the SDK Build Tools to use when building your project.

NamedDomainObjectContainer<LibraryBuildType>

Encapsulates all build type configurations for this project.

CompileOptions

Specifies Java compiler options, such as the language level of the Java source code and generated bytecode.

Int?

Specifies the API level to compile your project against.

Int?

Specifies the SDK Extension level to compile your project against.

String?

Specify a preview API to compile your project against.

ComposeOptions
DataBinding

Specifies options for the Data Binding Library.

LibraryDefaultConfig

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

MutableMap<StringAny>

Additional per module experimental properties.

ExternalNativeBuild

Specifies options for external native build using CMake or ndk-build.

MutableList<String>

Specifies the names of product flavor dimensions for this project.

Installation

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

JacocoOptions

This property is deprecated. Renamed to testCoverage

Lint

Specifies options for the lint tool.

LintOptions

This property is deprecated. Renamed to lint

String?

The namespace of the generated R and BuildConfig classes.

String?

Requires the specified path to NDK be used.

String?

Requires the specified NDK version to be used.

PackagingOptions

Specifies options and rules that determine which files the Android plugin packages into your APK.

NamedDomainObjectContainer<LibraryProductFlavor>

Encapsulates all product flavors configurations for this project.

String?

Specifies this project's resource prefix to Android Studio for editor features, such as Lint checks.

SdkComponents

This property is deprecated. This API will be removed in AGP 7.0, replaced with AndroidComponents::sdkComponents

NamedDomainObjectContainer<ApkSigningConfig>

Encapsulates signing configurations that you can apply to [ ] and [ ] configurations.

NamedDomainObjectContainer<AndroidSourceSet>

Encapsulates source set configurations for all variants.

Splits

Specifies configurations for building multiple APKs or APK splits.

TestCoverage

Configure the gathering of code-coverage from tests.

TestOptions

Specifies options for how the Android plugin should run local and instrumented tests.

ViewBinding

Specifies options for the View Binding Library.

From class com.android.build.api.dsl.TestedExtension
String

Specifies the build type that the plugin should use to test the module.

TestFixtures

Options to configure the test fixtures.

String?

The namespace used by the android test and unit test components for the generated R and BuildConfig classes.

Public functions

publishing

fun publishing(action: @ExtensionFunctionType 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

Public properties

aidlPackagedList

val aidlPackagedListMutableCollection<String>?

Aidl files to package in the aar.

prefab

val prefabNamedDomainObjectContainer<Prefab>

container of Prefab options

publishing

val publishingLibraryPublishing

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