LibraryExtension

public interface LibraryExtension extends 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 methods
`abstract Collection<@NonNull String>`	`@Incubating getAidlPackagedList()` Aidl files to package in the aar.
`abstract @NonNull NamedDomainObjectContainer<@NonNull Prefab>`	`@Incubating getPrefab()` container of Prefab options
`abstract @NonNull LibraryPublishing`	`getPublishing()` Customizes publishing build variant artifacts from library module to a Maven repository.
`abstract void`	`publishing( @ExtensionFunctionType @NonNull Function1<@NonNull LibraryPublishing, Unit> action )` Customizes publishing build variant artifacts from library module to a Maven repository.

Inherited methods

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

`abstract void`	`aaptOptions( @ExtensionFunctionType @NonNull Function1<@NonNull AaptOptions, Unit> action )` This method is deprecated. Replaced by
`abstract void`	`adbOptions( @ExtensionFunctionType @NonNull Function1<@NonNull AdbOptions, Unit> action )` This method is deprecated. Replaced by installation
`abstract void`	`androidResources( @ExtensionFunctionType @NonNull Function1<@NonNull LibraryAndroidResources, Unit> action )` Specifies options related to the processing of Android Resources.
`abstract void`	`buildFeatures( @ExtensionFunctionType @NonNull Function1<@NonNull LibraryBuildFeatures, Unit> action )` A list of build features that can be enabled or disabled on the Android Project.
`abstract void`	`buildToolsVersion(@NonNull String buildToolsVersion)` This method is deprecated. Replaced by buildToolsVersion property
`abstract void`	`buildTypes( @ExtensionFunctionType @NonNull Function1<@NonNull NamedDomainObjectContainer<@NonNull LibraryBuildType>, Unit> action )` Encapsulates all build type configurations for this project.
`abstract void`	`compileOptions( @ExtensionFunctionType @NonNull Function1<@NonNull CompileOptions, Unit> action )` Specifies Java compiler options, such as the language level of the Java source code and generated bytecode.
`abstract void`	`compileSdkAddon(@NonNull String vendor, @NonNull String name, int version)` Specify an SDK add-on to compile your project against.
`abstract void`	`compileSdkVersion(int apiLevel)` This method is deprecated. Replaced by compileSdk
`abstract void`	`compileSdkVersion(@NonNull String version)` This method is deprecated. Replaced by compileSdkPreview
`abstract void`	`composeOptions( @ExtensionFunctionType @NonNull Function1<@NonNull ComposeOptions, Unit> action )`
`abstract void`	`dataBinding( @ExtensionFunctionType @NonNull Function1<@NonNull DataBinding, Unit> action )` Specifies options for the Data Binding Library.
`abstract void`	`orgKt.debug( @NonNull NamedDomainObjectContainer<@NonNull LibraryBuildType> receiver, @ExtensionFunctionType @NonNull Function1<@NonNull LibraryBuildType, Unit> action )` Shortcut extension method to allow easy access to the predefined `debug` `BuildType`
`abstract void`	`defaultConfig( @ExtensionFunctionType @NonNull Function1<@NonNull LibraryDefaultConfig, Unit> action )` Specifies defaults for variant properties that the Android plugin applies to all build variants.
`abstract void`	`externalNativeBuild( @ExtensionFunctionType @NonNull Function1<@NonNull ExternalNativeBuild, Unit> action )` Specifies options for external native build using CMake or ndk-build.
`abstract void`	`flavorDimensions(@NonNull String dimensions)` This method is deprecated. Replaced by flavorDimensions property
`abstract @NonNull AaptOptions`	`getAaptOptions()` Specifies options for the Android Asset Packaging Tool (AAPT).
`abstract @NonNull AdbOptions`	`getAdbOptions()` Specifies options for the Android Debug Bridge (ADB), such as APK installation options.
`abstract @NonNull LibraryAndroidResources`	`getAndroidResources()` Specifies options related to the processing of Android Resources.
`abstract @NonNull LibraryBuildFeatures`	`getBuildFeatures()` A list of build features that can be enabled or disabled on the Android Project.
`abstract @NonNull String`	`getBuildToolsVersion()` Specifies the version of the SDK Build Tools to use when building your project.
`abstract @NonNull NamedDomainObjectContainer<@NonNull LibraryBuildType>`	`getBuildTypes()` Encapsulates all build type configurations for this project.
`abstract @NonNull CompileOptions`	`getCompileOptions()` Specifies Java compiler options, such as the language level of the Java source code and generated bytecode.
`abstract Integer`	`getCompileSdk()` Specifies the API level to compile your project against.
`abstract Integer`	`getCompileSdkExtension()` Specifies the SDK Extension level to compile your project against.
`abstract String`	`getCompileSdkPreview()` Specify a preview API to compile your project against.
`abstract @NonNull ComposeOptions`	`getComposeOptions()`
`abstract @NonNull DataBinding`	`getDataBinding()` Specifies options for the Data Binding Library.
`abstract @NonNull LibraryDefaultConfig`	`getDefaultConfig()` Specifies defaults for variant properties that the Android plugin applies to all build variants.
`abstract @NonNull File`	`getDefaultProguardFile(@NonNull String name)`
`abstract @NonNull Map<@NonNull String, @NonNull Object>`	`@Incubating getExperimentalProperties()` Additional per module experimental properties.
`abstract @NonNull ExternalNativeBuild`	`getExternalNativeBuild()` Specifies options for external native build using CMake or ndk-build.
`abstract @NonNull List<@NonNull String>`	`getFlavorDimensions()` Specifies the names of product flavor dimensions for this project.
`abstract @NonNull Installation`	`getInstallation()` Specifies options for the Android Debug Bridge (ADB), such as APK installation options.
`abstract @NonNull JacocoOptions`	`@Incubating getJacoco()` Configure the gathering of code-coverage from tests.
`abstract @NonNull Lint`	`getLint()` Specifies options for the lint tool.
`abstract @NonNull LintOptions`	`@Incubating getLintOptions()` Specifies options for the lint tool.
`abstract String`	`getNamespace()` The namespace of the generated R and BuildConfig classes.
`abstract String`	`getNdkPath()` Requires the specified path to NDK be used.
`abstract @NonNull String`	`getNdkVersion()` Requires the specified NDK version to be used.
`abstract @NonNull Packaging`	`getPackaging()` Specifies options and rules that determine which files the Android plugin packages into your APK.
`abstract @NonNull Packaging`	`getPackagingOptions()` Specifies options and rules that determine which files the Android plugin packages into your APK.
`abstract @NonNull NamedDomainObjectContainer<@NonNull LibraryProductFlavor>`	`getProductFlavors()` Encapsulates all product flavors configurations for this project.
`abstract String`	`getResourcePrefix()` Specifies this project's resource prefix to Android Studio for editor features, such as Lint checks.
`abstract @NonNull SdkComponents`	`getSdkComponents()`
`abstract @NonNull NamedDomainObjectContainer<@NonNull ApkSigningConfig>`	`getSigningConfigs()` Encapsulates signing configurations that you can apply to [ ] and [ ] configurations.
`abstract @NonNull NamedDomainObjectContainer<@NonNull AndroidSourceSet>`	`getSourceSets()` Encapsulates source set configurations for all variants.
`abstract @NonNull Splits`	`getSplits()` Specifies configurations for building multiple APKs or APK splits.
`abstract @NonNull TestCoverage`	`getTestCoverage()` Configure the gathering of code-coverage from tests.
`abstract @NonNull TestOptions`	`@Incubating getTestOptions()` Specifies options for how the Android plugin should run local and instrumented tests.
`abstract @NonNull ViewBinding`	`getViewBinding()` Specifies options for the View Binding Library.
`abstract void`	`installation( @ExtensionFunctionType @NonNull Function1<@NonNull Installation, Unit> action )` Specifies options for the Android Debug Bridge (ADB), such as APK installation options.
`abstract void`	`@Incubating jacoco( @ExtensionFunctionType @NonNull Function1<@NonNull JacocoOptions, Unit> action )` This method is deprecated. Renamed to testCoverage
`abstract void`	`lint(@ExtensionFunctionType @NonNull Function1<@NonNull Lint, Unit> action)` Specifies options for the lint tool.
`abstract void`	`@Incubating lintOptions( @ExtensionFunctionType @NonNull Function1<@NonNull LintOptions, Unit> action )` This method is deprecated. Renamed to lint
`abstract void`	`packaging( @ExtensionFunctionType @NonNull Function1<@NonNull Packaging, Unit> action )` Specifies options and rules that determine which files the Android plugin packages into your APK.
`abstract void`	`packagingOptions( @ExtensionFunctionType @NonNull Function1<@NonNull Packaging, Unit> action )` This method is deprecated. Renamed to packaging
`abstract void`	`productFlavors( @ExtensionFunctionType @NonNull Function1<@NonNull NamedDomainObjectContainer<@NonNull LibraryProductFlavor>, Unit> action )` Encapsulates all product flavors configurations for this project.
`abstract void`	`orgKt.release( @NonNull NamedDomainObjectContainer<@NonNull LibraryBuildType> receiver, @ExtensionFunctionType @NonNull Function1<@NonNull LibraryBuildType, Unit> action )` Shortcut extension method to allow easy access to the predefined `release` `BuildType`
`abstract void`	`setBuildToolsVersion(@NonNull String buildToolsVersion)` Specifies the version of the SDK Build Tools to use when building your project.
`abstract void`	`setCompileSdk(Integer compileSdk)` Specifies the API level to compile your project against.
`abstract void`	`setCompileSdkExtension(Integer compileSdkExtension)` Specifies the SDK Extension level to compile your project against.
`abstract void`	`setCompileSdkPreview(String compileSdkPreview)` Specify a preview API to compile your project against.
`abstract void`	`setNamespace(String namespace)` The namespace of the generated R and BuildConfig classes.
`abstract void`	`setNdkPath(String ndkPath)` Requires the specified path to NDK be used.
`abstract void`	`setNdkVersion(@NonNull String ndkVersion)` Requires the specified NDK version to be used.
`abstract void`	`setResourcePrefix(String resourcePrefix)` Specifies this project's resource prefix to Android Studio for editor features, such as Lint checks.
`abstract void`	`signingConfigs( @ExtensionFunctionType @NonNull Function1<@NonNull NamedDomainObjectContainer<@NonNull ApkSigningConfig>, Unit> action )` Encapsulates signing configurations that you can apply to `BuildType` and `ProductFlavor` configurations.
`abstract void`	`sourceSets( @ExtensionFunctionType @NonNull Function1<@NonNull NamedDomainObjectContainer<@NonNull AndroidSourceSet>, Unit> action )` Encapsulates source set configurations for all variants.
`abstract void`	`splits( @ExtensionFunctionType @NonNull Function1<@NonNull Splits, Unit> action )` Specifies configurations for building multiple APKs or APK splits.
`abstract void`	`testCoverage( @ExtensionFunctionType @NonNull Function1<@NonNull TestCoverage, Unit> action )` Configure the gathering of code-coverage from tests.
`abstract void`	`@Incubating testOptions( @ExtensionFunctionType @NonNull Function1<@NonNull TestOptions, Unit> action )` Specifies options for how the Android plugin should run local and instrumented tests.
`abstract void`	`useLibrary(@NonNull String name)` Includes the specified library to the classpath.
`abstract void`	`useLibrary(@NonNull String name, boolean required)` Includes the specified library to the classpath.
`abstract void`	`viewBinding( @ExtensionFunctionType @NonNull Function1<@NonNull ViewBinding, Unit> action )` Specifies options for the View Binding Library.

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

`abstract @NonNull String`	`getTestBuildType()` Specifies the build type that the plugin should use to test the module.
`abstract @NonNull TestFixtures`	`@Incubating getTestFixtures()` Options to configure the test fixtures.
`abstract String`	`getTestNamespace()` The namespace used by the android test and unit test components for the generated R and BuildConfig classes.
`abstract void`	`setTestBuildType(@NonNull String testBuildType)` Specifies the build type that the plugin should use to test the module.
`abstract void`	`setTestNamespace(String testNamespace)` The namespace used by the android test and unit test components for the generated R and BuildConfig classes.
`abstract void`	`@Incubating testFixtures( @ExtensionFunctionType @NonNull Function1<@NonNull TestFixtures, Unit> action )` Options to configure the test fixtures.

Public methods

getAidlPackagedList

@Incubating
abstract Collection<@NonNull String> getAidlPackagedList()

Aidl files to package in the aar.

getPrefab

@Incubating
abstract @NonNull NamedDomainObjectContainer<@NonNull Prefab> getPrefab()

container of Prefab options

getPublishing

abstract @NonNull LibraryPublishing getPublishing()

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

publishing

abstract void publishing(
    @ExtensionFunctionType @NonNull Function1<@NonNull LibraryPublishing, Unit> action
)

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