KotlinMultiplatformAndroidVariant

Added in 8.2.0

@Incubating
interface KotlinMultiplatformAndroidVariant : HasDeviceTests, HasAndroidTest, HasUnitTest, HasHostTests

Properties for the main Variant of a kotlin multiplatform android library

Summary

Public properties
`Artifacts`	`artifacts` Access to the variant's buildable artifacts for build customization.
`FileCollection`	`compileClasspath` Access to the variant's compile classpath.
`Configuration`	`compileConfiguration` Access to the variant's compile `Configuration`; androidMainCompileClasspath `Configuration` for the main variant.
`Instrumentation`	`instrumentation` Access to the variant's instrumentation options.
`LifecycleTasks`	`lifecycleTasks` Provides access to the `LifecycleTasks` created for this component.
`AndroidVersion`	`minSdk` Gets the minimum supported SDK Version for this variant.
`String`	`name` The name of the variant
`List<Component>`	`nestedComponents` List of the components nested in the main variant, the returned list may contain:
`Sources`	`sources`

Inherited properties

From com.android.build.api.variant.HasAndroidTest

`AndroidTest?`	`androidTest` Variant's `AndroidTest` configuration, or null if android tests are disabled for this variant.
`TestedComponentPackaging`	`packaging` Variant's packagingOptions, initialized by the corresponding global DSL element.

From com.android.build.api.variant.HasDeviceTests

Map<String, DeviceTest>

deviceTests

Variant's Map of DeviceTest configurations, or empty if all devices tests (like android tests) are disabled for this variant.

From com.android.build.api.variant.HasHostTests

Map<String, HostTest>

hostTests

Map of Variant's HostTest, or empty if all host tests (like unit test) for this variant are disabled.

From com.android.build.api.variant.HasUnitTest

UnitTest?

unitTest

Variant's UnitTest, or null if the unit tests for this variant are disabled.

Public properties

artifacts

Added in 8.2.0

val artifacts: Artifacts

Access to the variant's buildable artifacts for build customization.

compileClasspath

Added in 8.2.0

val compileClasspath: FileCollection

Access to the variant's compile classpath.

The returned FileCollection should not be resolved until execution time.

compileConfiguration

Added in 8.9.0-alpha07

val compileConfiguration: Configuration

Access to the variant's compile Configuration; androidMainCompileClasspath Configuration for the main variant.

The returned Configuration should not be resolved until execution time.

instrumentation

Added in 8.2.0

val instrumentation: Instrumentation

Access to the variant's instrumentation options.

lifecycleTasks

Added in 8.3.1

val lifecycleTasks: LifecycleTasks

Provides access to the LifecycleTasks created for this component.

minSdk

Added in 8.9.0-alpha07

val minSdk: AndroidVersion

Gets the minimum supported SDK Version for this variant.

name

Added in 8.2.0

val name: String

The name of the variant

nestedComponents

Added in 8.3.1

val nestedComponents: List<Component>

List of the components nested in the main variant, the returned list may contain:

UnitTest component if the unit tests for this variant are enabled,
AndroidTest component if this variant HasDeviceTests and android tests for this variant are enabled,

Use this list to do operations on all nested components of this variant without having to manually check whether the variant has each component.

Example:

androidComponents {
   onVariant { variant ->
       variant.nestedComponents.forEach { component ->
           component.instrumentation.transformClassesWith(
               AsmClassVisitorFactoryImpl.class,
               InstrumentationScope.Project) { params -> params.x = "value" }
           instrumentation.setAsmFramesComputationMode(COMPUTE_FRAMES_FOR_INSTRUMENTED_METHODS)
       }
   }
}

sources

Added in 8.9.0-alpha07

val sources: Sources