# KotlinMultiplatformAndroidExtension # KotlinMultiplatformAndroidExtension
``` @Incubating public interface KotlinMultiplatformAndroidExtension ```
Known direct subclasses [KotlinMultiplatformAndroidTarget](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidTarget) |------------------------------------------------------------------------------------------------------------------------------------------------------------------|---| | [KotlinMultiplatformAndroidTarget](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidTarget) | | *** ** * ** *** Extension properties for Kotlin multiplatform Android libraries. Only the Kotlin Multiplatform Android Plugin should create instances of this interface. Warning: this is an experimental API and will change in the near future, and you shouldn't publish plugins depending on it. ## Summary | ### Public methods | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `abstract void` | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [aarMetadata](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#aarMetadata(kotlin.Function1))`(` ` @`[ExtensionFunctionType](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-extension-function-type/index.html)` @`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` Function1<@`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[AarMetadata](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/AarMetadata)`, `[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`> action` `)` Options for configuring AAR metadata. | | `abstract void` | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [dependencyVariantSelection](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#dependencyVariantSelection(kotlin.Function1))`(` ` @`[ExtensionFunctionType](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-extension-function-type/index.html)` @`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` Function1<@`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[DependencyVariantSelection](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/DependencyVariantSelection)`, `[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`> action` `)` Specifies options for doing variant selection for external Android dependencies based on build types and product flavours | | `abstract @`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[AarMetadata](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/AarMetadata) | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [getAarMetadata](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#getAarMetadata())`()` Options for configuring AAR metadata. | | `abstract @`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html) | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [getBuildToolsVersion](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#getBuildToolsVersion())`()` Specifies the version of the[SDK Build Tools](https://developer.android.com/studio/releases/build-tools.html)to use when building your project. | | `abstract `[Integer](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html) | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [getCompileSdk](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#getCompileSdk())`()` Specifies the API level to compile your project against. | | `abstract `[Integer](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html) | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [getCompileSdkExtension](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#getCompileSdkExtension())`()` | | `abstract `[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html) | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [getCompileSdkPreview](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#getCompileSdkPreview())`()` | | `abstract @`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[DependencyVariantSelection](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/DependencyVariantSelection) | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [getDependencyVariantSelection](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#getDependencyVariantSelection())`()` Specifies options for doing variant selection for external Android dependencies based on build types and product flavours | | `abstract @`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[Map](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html)`<@`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html)`, @`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[Object](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html)`>` | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [getExperimentalProperties](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#getExperimentalProperties())`()` Additional per module experimental properties. | | `abstract @`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[Lint](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/Lint) | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [getLint](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#getLint())`()` Specifies options for the lint tool. | | `abstract `[Integer](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html) | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [getMaxSdk](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#getMaxSdk())`()` The maxSdkVersion, or null if not specified. | | `abstract `[Integer](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html) | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [getMinSdk](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#getMinSdk())`()` The minimum SDK version. | | `abstract `[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html) | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [getMinSdkPreview](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#getMinSdkPreview())`()` | | `abstract `[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html) | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [getNamespace](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#getNamespace())`()` The namespace of the generated R and BuildConfig classes. | | `abstract @`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[KmpOptimization](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KmpOptimization) | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [getOptimization](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#getOptimization())`()` Specifies options for the R8/D8 optimization tool. | | `abstract @`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[Packaging](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/Packaging) | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [getPackaging](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#getPackaging())`()` Specifies options and rules that determine which files the Android plugin packages into your APK. | | `abstract @`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[TestCoverage](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/TestCoverage) | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [getTestCoverage](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#getTestCoverage())`()` Configure the gathering of code-coverage from tests. | | `abstract `[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html) | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [getTestNamespace](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#getTestNamespace())`()` The namespace used by the android test and unit test components for the generated R and BuildConfig classes. | | `abstract boolean` | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [isCoreLibraryDesugaringEnabled](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#getIsCoreLibraryDesugaringEnabled())`()` Whether core library desugaring is enabled. | | `abstract void` | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [lint](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#lint(kotlin.Function1))`(@`[ExtensionFunctionType](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-extension-function-type/index.html)` @`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` Function1<@`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[Lint](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/Lint)`, `[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`> action)` Specifies options for the lint tool. | | `abstract void` | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [optimization](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#optimization(kotlin.Function1))`(` ` @`[ExtensionFunctionType](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-extension-function-type/index.html)` @`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` Function1<@`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[KmpOptimization](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KmpOptimization)`, `[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`> action` `)` Specifies options for the R8/D8 optimization tool. | | `abstract void` | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [packaging](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#packaging(kotlin.Function1))`(` ` @`[ExtensionFunctionType](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-extension-function-type/index.html)` @`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` Function1<@`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[Packaging](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/Packaging)`, `[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`> action` `)` Specifies options and rules that determine which files the Android plugin packages into your APK. | | `abstract void` | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [setBuildToolsVersion](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#setBuildToolsVersion(kotlin.String))`(@`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html)` buildToolsVersion)` Specifies the version of the[SDK Build Tools](https://developer.android.com/studio/releases/build-tools.html)to use when building your project. | | `abstract void` | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [setCompileSdk](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#setCompileSdk(kotlin.Int))`(`[Integer](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html)` compileSdk)` Specifies the API level to compile your project against. | | `abstract void` | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [setCompileSdkExtension](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#setCompileSdkExtension(kotlin.Int))`(`[Integer](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html)` compileSdkExtension)` | | `abstract void` | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [setCompileSdkPreview](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#setCompileSdkPreview(kotlin.String))`(`[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html)` compileSdkPreview)` | | `abstract void` | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [setCoreLibraryDesugaringEnabled](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#setIsCoreLibraryDesugaringEnabled(kotlin.Boolean))`(` ` boolean isCoreLibraryDesugaringEnabled` `)` Whether core library desugaring is enabled. | | `abstract void` | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [setMaxSdk](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#setMaxSdk(kotlin.Int))`(`[Integer](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html)` maxSdk)` The maxSdkVersion, or null if not specified. | | `abstract void` | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [setMinSdk](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#setMinSdk(kotlin.Int))`(`[Integer](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html)` minSdk)` The minimum SDK version. | | `abstract void` | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [setMinSdkPreview](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#setMinSdkPreview(kotlin.String))`(`[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html)` minSdkPreview)` | | `abstract void` | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [setNamespace](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#setNamespace(kotlin.String))`(`[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html)` namespace)` The namespace of the generated R and BuildConfig classes. | | `abstract void` | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [setTestNamespace](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#setTestNamespace(kotlin.String))`(`[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html)` testNamespace)` The namespace used by the android test and unit test components for the generated R and BuildConfig classes. | | `abstract void` | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [useLibrary](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#useLibrary(kotlin.String))`(@`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html)` name)` Includes the specified library to the classpath. | | `abstract void` | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [useLibrary](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#useLibrary(kotlin.String,kotlin.Boolean))`(@`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html)` name, boolean required)` Includes the specified library to the classpath. | | `abstract void` | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [withAndroidTestOnDevice](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#withAndroidTestOnDevice(kotlin.Function1))`(` ` @`[ExtensionFunctionType](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-extension-function-type/index.html)` @`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` Function1<@`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[KotlinMultiplatformAndroidTestOnDevice](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidTestOnDevice)`, `[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`> action` `)` Creates and configures a compilation for tests that run on the device (previously referred to as instrumented tests). | | `abstract @`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[HasConfigurableValue](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/HasConfigurableValue)`<@`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[KotlinMultiplatformAndroidTestOnDevice](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidTestOnDevice)`>` | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [withAndroidTestOnDeviceBuilder](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#withAndroidTestOnDeviceBuilder(kotlin.Function1))`(` ` @`[ExtensionFunctionType](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-extension-function-type/index.html)` @`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` Function1<@`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[KotlinMultiplatformAndroidCompilationBuilder](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidCompilationBuilder)`, `[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`> action` `)` Creates and configures a compilation for tests that run on the device (previously referred to as instrumented tests). | | `abstract void` | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [withAndroidTestOnJvm](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#withAndroidTestOnJvm(kotlin.Function1))`(` ` @`[ExtensionFunctionType](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-extension-function-type/index.html)` @`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` Function1<@`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[KotlinMultiplatformAndroidTestOnJvm](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidTestOnJvm)`, `[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`> action` `)` Creates and configures a compilation for tests that run on the JVM (previously referred to as unit tests). | | `abstract @`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[HasConfigurableValue](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/HasConfigurableValue)`<@`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[KotlinMultiplatformAndroidTestOnJvm](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidTestOnJvm)`>` | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [withAndroidTestOnJvmBuilder](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#withAndroidTestOnJvmBuilder(kotlin.Function1))`(` ` @`[ExtensionFunctionType](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-extension-function-type/index.html)` @`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` Function1<@`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[KotlinMultiplatformAndroidCompilationBuilder](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidCompilationBuilder)`, `[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`> action` `)` Creates and configures a compilation for tests that run on the JVM (previously referred to as unit tests). | ## Public methods ### aarMetadata ``` @Incubating abstract void aarMetadata(     @ExtensionFunctionType @NonNull Function1<@NonNull AarMetadata, Unit> action ) ``` Options for configuring AAR metadata. ### dependencyVariantSelection ``` @Incubating abstract void dependencyVariantSelection(     @ExtensionFunctionType @NonNull Function1<@NonNull DependencyVariantSelection, Unit> action ) ``` Specifies options for doing variant selection for external Android dependencies based on build types and product flavours For more information about the properties you can configure in this block, see[DependencyVariantSelection](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/DependencyVariantSelection). ### getAarMetadata ``` @Incubating abstract @NonNull AarMetadata getAarMetadata() ``` Options for configuring AAR metadata. ### getBuildToolsVersion ``` @Incubating abstract @NonNull String getBuildToolsVersion() ``` Specifies the version of the[SDK Build Tools](https://developer.android.com/studio/releases/build-tools.html)to use when building your project. By default, the plugin uses the minimum version of the build tools required by the[version of the plugin](https://developer.android.com/studio/releases/gradle-plugin.html#revisions)you're using. To specify a different version of the build tools for the plugin to use, specify the version as follows: ```kotlin android { // Specifying this property is optional. buildToolsVersion "26.0.0" } ``` For a list of build tools releases, read[the release notes](https://developer.android.com/studio/releases/build-tools.html#notes). Note that the value assigned to this property is parsed and stored in a normalized form, so reading it back may give a slightly different result. ### getCompileSdk ``` @Incubating abstract Integer getCompileSdk() ``` Specifies the API level to compile your project against. The Android plugin requires you to configure this property. This means your code can use only the Android APIs included in that API level and lower. You can configure the compile sdk version by adding the following to the`android`block:`compileSdk = 26`. You should generally[use the most up-to-date API level](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)available. If you are planning to also support older API levels, it's good practice to[use the Lint tool](https://developer.android.com/studio/write/lint.html)to check if you are using APIs that are not available in earlier API levels. The value you assign to this property is parsed and stored in a normalized form, so reading it back may return a slightly different value. ### getCompileSdkExtension ``` @Incubating abstract Integer getCompileSdkExtension() ``` ### getCompileSdkPreview ``` @Incubating abstract String getCompileSdkPreview() ``` ### getDependencyVariantSelection ``` @Incubating abstract @NonNull DependencyVariantSelection getDependencyVariantSelection() ``` Specifies options for doing variant selection for external Android dependencies based on build types and product flavours For more information about the properties you can configure in this block, see[DependencyVariantSelection](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/DependencyVariantSelection). ### getExperimentalProperties ``` @Incubating abstract @NonNull Map<@NonNull String, @NonNull Object> getExperimentalProperties() ``` Additional per module experimental properties. ### getLint ``` @Incubating abstract @NonNull Lint getLint() ``` Specifies options for the lint tool. For more information about the properties you can configure in this block, see[Lint](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/Lint). ### getMaxSdk ``` @Incubating abstract Integer getMaxSdk() ``` The maxSdkVersion, or null if not specified. This is only the value set on this produce flavor. See[uses-sdk element documentation](http://developer.android.com/guide/topics/manifest/uses-sdk-element.html). ### getMinSdk ``` @Incubating abstract Integer getMinSdk() ``` The minimum SDK version. Setting this it will override previous calls of[minSdk](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#minSdk())and[minSdkPreview](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#minSdkPreview())setters. Only one of[minSdk](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#minSdk())and[minSdkPreview](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#minSdkPreview())should be set. See[uses-sdk element documentation](http://developer.android.com/guide/topics/manifest/uses-sdk-element.html). ### getMinSdkPreview ``` @Incubating abstract String getMinSdkPreview() ``` ### getNamespace ``` @Incubating abstract String getNamespace() ``` The namespace of the generated R and BuildConfig classes. Also, the namespace used to resolve any relative class names that are declared in the AndroidManifest.xml. ### getOptimization ``` @Incubating abstract @NonNull KmpOptimization getOptimization() ``` Specifies options for the R8/D8 optimization tool. For more information about the properties you can configure in this block, see[KmpOptimization](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KmpOptimization). ### getPackaging ``` @Incubating abstract @NonNull Packaging getPackaging() ``` Specifies options and rules that determine which files the Android plugin packages into your APK. For more information about the properties you can configure in this block, see[Packaging](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/Packaging). ### getTestCoverage ``` @Incubating abstract @NonNull TestCoverage getTestCoverage() ``` Configure the gathering of code-coverage from tests. ### getTestNamespace ``` @Incubating abstract String getTestNamespace() ``` The namespace used by the android test and unit test components for the generated R and BuildConfig classes. ### isCoreLibraryDesugaringEnabled ``` @Incubating abstract boolean isCoreLibraryDesugaringEnabled() ``` Whether core library desugaring is enabled. ### lint ``` @Incubating abstract void lint(@ExtensionFunctionType @NonNull Function1<@NonNull Lint, Unit> action) ``` Specifies options for the lint tool. For more information about the properties you can configure in this block, see[Lint](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/Lint). ### optimization ``` @Incubating abstract void optimization(     @ExtensionFunctionType @NonNull Function1<@NonNull KmpOptimization, Unit> action ) ``` Specifies options for the R8/D8 optimization tool. For more information about the properties you can configure in this block, see[KmpOptimization](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KmpOptimization). ### packaging ``` @Incubating 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. For more information about the properties you can configure in this block, see[Packaging](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/Packaging). ### setBuildToolsVersion ``` @Incubating abstract void setBuildToolsVersion(@NonNull String buildToolsVersion) ``` Specifies the version of the[SDK Build Tools](https://developer.android.com/studio/releases/build-tools.html)to use when building your project. By default, the plugin uses the minimum version of the build tools required by the[version of the plugin](https://developer.android.com/studio/releases/gradle-plugin.html#revisions)you're using. To specify a different version of the build tools for the plugin to use, specify the version as follows: ```kotlin android { // Specifying this property is optional. buildToolsVersion "26.0.0" } ``` For a list of build tools releases, read[the release notes](https://developer.android.com/studio/releases/build-tools.html#notes). Note that the value assigned to this property is parsed and stored in a normalized form, so reading it back may give a slightly different result. ### setCompileSdk ``` @Incubating abstract void setCompileSdk(Integer compileSdk) ``` Specifies the API level to compile your project against. The Android plugin requires you to configure this property. This means your code can use only the Android APIs included in that API level and lower. You can configure the compile sdk version by adding the following to the`android`block:`compileSdk = 26`. You should generally[use the most up-to-date API level](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)available. If you are planning to also support older API levels, it's good practice to[use the Lint tool](https://developer.android.com/studio/write/lint.html)to check if you are using APIs that are not available in earlier API levels. The value you assign to this property is parsed and stored in a normalized form, so reading it back may return a slightly different value. ### setCompileSdkExtension ``` @Incubating abstract void setCompileSdkExtension(Integer compileSdkExtension) ``` ### setCompileSdkPreview ``` @Incubating abstract void setCompileSdkPreview(String compileSdkPreview) ``` ### setCoreLibraryDesugaringEnabled ``` @Incubating abstract void setCoreLibraryDesugaringEnabled(     boolean isCoreLibraryDesugaringEnabled ) ``` Whether core library desugaring is enabled. ### setMaxSdk ``` @Incubating abstract void setMaxSdk(Integer maxSdk) ``` The maxSdkVersion, or null if not specified. This is only the value set on this produce flavor. See[uses-sdk element documentation](http://developer.android.com/guide/topics/manifest/uses-sdk-element.html). ### setMinSdk ``` @Incubating abstract void setMinSdk(Integer minSdk) ``` The minimum SDK version. Setting this it will override previous calls of[minSdk](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#minSdk())and[minSdkPreview](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#minSdkPreview())setters. Only one of[minSdk](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#minSdk())and[minSdkPreview](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#minSdkPreview())should be set. See[uses-sdk element documentation](http://developer.android.com/guide/topics/manifest/uses-sdk-element.html). ### setMinSdkPreview ``` @Incubating abstract void setMinSdkPreview(String minSdkPreview) ``` ### setNamespace ``` @Incubating abstract void setNamespace(String namespace) ``` The namespace of the generated R and BuildConfig classes. Also, the namespace used to resolve any relative class names that are declared in the AndroidManifest.xml. ### setTestNamespace ``` @Incubating abstract void setTestNamespace(String testNamespace) ``` The namespace used by the android test and unit test components for the generated R and BuildConfig classes. ### useLibrary ``` @Incubating abstract void useLibrary(@NonNull String name) ``` Includes the specified library to the classpath. You typically use this property to support optional platform libraries that ship with the Android SDK. The following sample adds the Apache HTTP API library to the project classpath: ```kotlin android { // Adds a platform library that ships with the Android SDK. useLibrary 'org.apache.http.legacy' } ``` To include libraries that do not ship with the SDK, such as local library modules or binaries from remote repositories,[add the libraries as dependencies](https://developer.android.com/studio/build/dependencies.html)in the`dependencies`block. Note that Android plugin 3.0.0 and later introduce[new dependency configurations](https://developer.android.com/studio/build/gradle-plugin-3-0-0-migration.html#new_configurations). To learn more about Gradle dependencies, read[Dependency Management Basics](https://docs.gradle.org/current/userguide/artifact_dependencies_tutorial.html). | Parameters | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| | `@`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html)` name` | the name of the library. | ### useLibrary ``` @Incubating abstract void useLibrary(@NonNull String name, boolean required) ``` Includes the specified library to the classpath. You typically use this property to support optional platform libraries that ship with the Android SDK. The following sample adds the Apache HTTP API library to the project classpath: ```kotlin android { // Adds a platform library that ships with the Android SDK. useLibrary 'org.apache.http.legacy' } ``` To include libraries that do not ship with the SDK, such as local library modules or binaries from remote repositories, "https://developer.android.com/studio/build/dependencies.html in the`dependencies`block. Note that Android plugin 3.0.0 and later introduce new dependency configurations. To learn more about Gradle dependencies, read[Dependency Management Basics](https://docs.gradle.org/current/userguide/artifact_dependencies_tutorial.html) | Parameters | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------| | `@`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html)` name` | the name of the library. | | `boolean required` | if using the library requires a manifest entry, the entry will indicate that the library is not required. | ### withAndroidTestOnDevice ``` @Incubating abstract void withAndroidTestOnDevice(     @ExtensionFunctionType @NonNull Function1<@NonNull KotlinMultiplatformAndroidTestOnDevice, Unit> action ) ``` Creates and configures a compilation for tests that run on the device (previously referred to as instrumented tests). Invoking this method will create a[KotlinMultiplatformAndroidTestOnDeviceCompilation](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidTestOnDeviceCompilation)object with the following defaults: - compilation name is "testOnDevice" - default sourceSet name is "androidTestOnDevice" (sources would be located at`$project/src/androidTestOnDevice`) - sourceSet tree is`null`, which means that the`commonTest`sourceSet will**not**be included in the compilation. Only a single compilation of this test type can be created. If you want to configure[KotlinMultiplatformAndroidTestOnDevice](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidTestOnDevice)options, you can modify it on the kotlin compilation as follows: ```kotlin kotlin { androidLibrary { compilations.withType(com.android.build.api.dsl.KotlinMultiplatformAndroidTestOnDevice::class.java) { // configure options } } } ``` ### withAndroidTestOnDeviceBuilder ``` @Incubating abstract @NonNull HasConfigurableValue<@NonNull KotlinMultiplatformAndroidTestOnDevice> withAndroidTestOnDeviceBuilder(     @ExtensionFunctionType @NonNull Function1<@NonNull KotlinMultiplatformAndroidCompilationBuilder, Unit> action ) ``` Creates and configures a compilation for tests that run on the device (previously referred to as instrumented tests). Invoking this method will create a[KotlinMultiplatformAndroidTestOnDeviceCompilation](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidTestOnDeviceCompilation)object using the values set in the[KotlinMultiplatformAndroidCompilationBuilder](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidCompilationBuilder). The returned object can be used to configure[KotlinMultiplatformAndroidTestOnDevice](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidTestOnDevice)as follows: ```kotlin kotlin { androidLibrary { withAndroidTestOnDeviceBuilder { compilationName = "instrumentedTest" defaultSourceSetName = "androidInstrumentedTest" }.configure { instrumentationRunner = "androidx.test.runner.AndroidJUnitRunner" } } } ``` Only a single compilation of this test type can be created. If you want to configure[KotlinMultiplatformAndroidTestOnDevice](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidTestOnDevice)options, you can modify it on the kotlin compilation as follows: ```kotlin kotlin { androidLibrary { compilations.withType(com.android.build.api.dsl.KotlinMultiplatformAndroidTestOnDevice::class.java) { // configure options } } } ``` ### withAndroidTestOnJvm ``` @Incubating abstract void withAndroidTestOnJvm(     @ExtensionFunctionType @NonNull Function1<@NonNull KotlinMultiplatformAndroidTestOnJvm, Unit> action ) ``` Creates and configures a compilation for tests that run on the JVM (previously referred to as unit tests). Invoking this method will create a[KotlinMultiplatformAndroidTestOnJvmCompilation](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidTestOnJvmCompilation)object with the following defaults (You can change these defaults by using[withAndroidTestOnJvmBuilder](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension#withAndroidTestOnJvmBuilder(kotlin.Function1))instead): - compilation name is "testOnJvm" - default sourceSet name is "androidTestOnJvm" (sources would be located at`$project/src/androidTestOnJvm`) - sourceSet tree is`test`, which means that the`commonTest`sourceSet would be included in the compilation. Only a single compilation of this test type can be created. If you want to configure[KotlinMultiplatformAndroidTestOnJvm](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidTestOnJvm)options, you can modify it on the kotlin compilation as follows: ```kotlin kotlin { androidLibrary { compilations.withType(com.android.build.api.dsl.KotlinMultiplatformAndroidTestOnJvm::class.java) { // configure options } } } ``` ### withAndroidTestOnJvmBuilder ``` @Incubating abstract @NonNull HasConfigurableValue<@NonNull KotlinMultiplatformAndroidTestOnJvm> withAndroidTestOnJvmBuilder(     @ExtensionFunctionType @NonNull Function1<@NonNull KotlinMultiplatformAndroidCompilationBuilder, Unit> action ) ``` Creates and configures a compilation for tests that run on the JVM (previously referred to as unit tests). Invoking this method will create a[KotlinMultiplatformAndroidTestOnJvmCompilation](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidTestOnJvmCompilation)object using the values set in the[KotlinMultiplatformAndroidCompilationBuilder](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidCompilationBuilder). The returned object can be used to configure[KotlinMultiplatformAndroidTestOnJvm](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidTestOnJvm)as follows: ```kotlin kotlin { androidLibrary { withAndroidTestOnJvmBuilder { compilationName = "unitTest" defaultSourceSetName = "androidUnitTest" }.configure { isIncludeAndroidResources = true } } } ``` Only a single compilation of this test type can be created. If you want to configure[KotlinMultiplatformAndroidTestOnJvm](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/KotlinMultiplatformAndroidTestOnJvm)options, you can modify it on the kotlin compilation as follows: ```kotlin kotlin { androidLibrary { compilations.withType(com.android.build.api.dsl.KotlinMultiplatformAndroidTestOnJvm::class.java) { // configure options } } } ```