# KotlinMultiplatformAndroidComponentsExtension

# KotlinMultiplatformAndroidComponentsExtension

[View Source](https://cs.android.com/search?q=file:com/android/build/api/variant/KotlinMultiplatformAndroidComponentsExtension.kt+class:com.android.build.api.variant.KotlinMultiplatformAndroidComponentsExtension)  
Added in 8.2.0  

<br />

```
@Incubating
interface KotlinMultiplatformAndroidComponentsExtension : DslLifecycle, AndroidComponents
```

<br />

*** ** * ** ***

Components extension for KMP Android Gradle Plugin related components.

## Summary

|                             ### Public functions                             |
|------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [onVariant](https://developer.android.com/reference/tools/gradle-api/8.6/com/android/build/api/variant/KotlinMultiplatformAndroidComponentsExtension#onVariant(org.gradle.api.Action))`(callback: `[Action](https://docs.gradle.org/current/javadoc/org/gradle/api/Action.html)`<`[KotlinMultiplatformAndroidVariant](https://developer.android.com/reference/tools/gradle-api/8.6/com/android/build/api/variant/KotlinMultiplatformAndroidVariant)`>)` [Action](https://docs.gradle.org/current/javadoc/org/gradle/api/Action.html)based version of[onVariant](https://developer.android.com/reference/tools/gradle-api/8.6/com/android/build/api/variant/KotlinMultiplatformAndroidComponentsExtension#onVariant(kotlin.Function1))above.                                                                                                                                                                                                                                                                                                                         |
| [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [onVariant](https://developer.android.com/reference/tools/gradle-api/8.6/com/android/build/api/variant/KotlinMultiplatformAndroidComponentsExtension#onVariant(kotlin.Function1))`(callback: (`[KotlinMultiplatformAndroidVariant](https://developer.android.com/reference/tools/gradle-api/8.6/com/android/build/api/variant/KotlinMultiplatformAndroidVariant)`) `->` `[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` Allow for registration of a[callback](https://developer.android.com/reference/tools/gradle-api/8.6/com/android/build/api/variant/KotlinMultiplatformAndroidComponentsExtension#onVariant(kotlin.Function1))to be called with variant instances of type[KotlinMultiplatformAndroidExtension](https://developer.android.com/reference/tools/gradle-api/8.6/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension)once the list of[com.android.build.api.artifact.Artifact](https://developer.android.com/reference/tools/gradle-api/8.6/com/android/build/api/artifact/Artifact)has been determined. |

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         ### Inherited functions                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From[com.android.build.api.variant.DslLifecycle](https://developer.android.com/reference/tools/gradle-api/8.6/com/android/build/api/variant/DslLifecycle) |------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [finalizeDsl](https://developer.android.com/reference/tools/gradle-api/8.6/com/android/build/api/variant/DslLifecycle#finalizeDsl(org.gradle.api.Action))`(callback: `[Action](https://docs.gradle.org/current/javadoc/org/gradle/api/Action.html)`<`[KotlinMultiplatformAndroidExtension](https://developer.android.com/reference/tools/gradle-api/8.6/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension)`>)` [Action](https://docs.gradle.org/current/javadoc/org/gradle/api/Action.html)based version of[finalizeDsl](https://developer.android.com/reference/tools/gradle-api/8.6/com/android/build/api/variant/DslLifecycle#finalizeDsl(kotlin.Function1))above. | | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [finalizeDsl](https://developer.android.com/reference/tools/gradle-api/8.6/com/android/build/api/variant/DslLifecycle#finalizeDsl(kotlin.Function1))`(callback: (`[KotlinMultiplatformAndroidExtension](https://developer.android.com/reference/tools/gradle-api/8.6/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension)`) `->` `[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` API to customize the DSL Objects programmatically after they have been evaluated from the build files and before used in the build process next steps like variant or tasks creation.                                                                 | |

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           ### Inherited properties                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From[com.android.build.api.variant.AndroidComponents](https://developer.android.com/reference/tools/gradle-api/8.6/com/android/build/api/variant/AndroidComponents) |---------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [AndroidPluginVersion](https://developer.android.com/reference/tools/gradle-api/8.6/com/android/build/api/AndroidPluginVersion) | [pluginVersion](https://developer.android.com/reference/tools/gradle-api/8.6/com/android/build/api/variant/AndroidComponents#pluginVersion()) The version of the Android Gradle Plugin currently in use.                     | | [SdkComponents](https://developer.android.com/reference/tools/gradle-api/8.6/com/android/build/api/dsl/SdkComponents)           | [sdkComponents](https://developer.android.com/reference/tools/gradle-api/8.6/com/android/build/api/variant/AndroidComponents#sdkComponents()) Provides access to underlying Android SDK and build-tools components like adb. | |

## Public functions

### onVariant

Added in 8.2.0  

```
fun onVariant(callback: Action<KotlinMultiplatformAndroidVariant>): Unit
```

[Action](https://docs.gradle.org/current/javadoc/org/gradle/api/Action.html)based version of[onVariant](https://developer.android.com/reference/tools/gradle-api/8.6/com/android/build/api/variant/KotlinMultiplatformAndroidComponentsExtension#onVariant(kotlin.Function1))above.  

### onVariant

Added in 8.2.0  

```
fun onVariant(callback: (KotlinMultiplatformAndroidVariant) -> Unit): Unit
```

Allow for registration of a[callback](https://developer.android.com/reference/tools/gradle-api/8.6/com/android/build/api/variant/KotlinMultiplatformAndroidComponentsExtension#onVariant(kotlin.Function1))to be called with variant instances of type[KotlinMultiplatformAndroidExtension](https://developer.android.com/reference/tools/gradle-api/8.6/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension)once the list of[com.android.build.api.artifact.Artifact](https://developer.android.com/reference/tools/gradle-api/8.6/com/android/build/api/artifact/Artifact)has been determined.

At this stage, access to the DSL objects is disallowed

Because the list of artifacts (including private ones) is final, one cannot change the build flow anymore as[org.gradle.api.Task](https://docs.gradle.org/current/javadoc/org/gradle/api/Task.html)s are now expecting those artifacts as inputs. However users can modify such artifacts by replacing or transforming them, see[com.android.build.api.artifact.Artifacts](https://developer.android.com/reference/tools/gradle-api/8.6/com/android/build/api/artifact/Artifacts)for details.

Code executing in the[callback](https://developer.android.com/reference/tools/gradle-api/8.6/com/android/build/api/variant/KotlinMultiplatformAndroidComponentsExtension#onVariant(kotlin.Function1))also has access to the[KotlinMultiplatformAndroidExtension](https://developer.android.com/reference/tools/gradle-api/8.6/com/android/build/api/dsl/KotlinMultiplatformAndroidExtension)information which is used to configure[org.gradle.api.Task](https://docs.gradle.org/current/javadoc/org/gradle/api/Task.html)inputs (for example, the buildConfigFields). Such information represented as[org.gradle.api.provider.Property](https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Property.html)can still be modified ensuring that all[org.gradle.api.Task](https://docs.gradle.org/current/javadoc/org/gradle/api/Task.html)s created by the Android Gradle Plugin use the updated value.