VariantBuilder
interface VariantBuilder : ComponentBuilder
ApplicationVariantBuilder |
Model for application components that only contains configuration-time properties that impacts the build flow. |
DynamicFeatureVariantBuilder |
Model for dynamic feature components that only contains configuration-time properties that impacts the build flow. |
LibraryVariantBuilder |
Model for library components that only contains configuration-time properties that impacts the build flow. |
TestVariantBuilder |
Model for test components that only contains configuration-time properties that impacts the build flow. |
Model for variant components that only contains configuration-time properties that impacts the build flow.
Variant components are the main output of the plugin (e.g. APKs, AARs). They contain references to optional secondary components (tests, fixtures). Their presence can be controlled in select subtypes of VariantBuilder.
It is the object passed to the AndroidComponentsExtension.beforeVariants method, like this:
androidComponents {
beforeVariants(selector().all()) { variant: VariantBuilder ->
}
}
Note that depending on the actual implementation of AndroidComponentsExtension, the object received may be a subtype. For instance ApplicationAndroidComponentsExtension.beforeVariants will pass ApplicationVariantBuilder to the lambda.
See here for more information
Summary
Public functions |
|
|---|---|
Unit |
<T : Any> registerExtension(type: Class<T>, instance: T)Registers an extension object to the variant object. |
Public properties |
|
|---|---|
Boolean |
This property is deprecated. Will be removed in AGP 9.0 - Use (variantBuilder as HasHostTestsBuilder).get(HasHostTestsBuilder.UNIT_TEST_TYPE).enable |
Int? |
Sets the maximum supported SDK Version for this variant. |
Int? |
Sets the minimum supported SDK Version for this variant. |
String? |
Sets the minimum supported SDK Version for this variant as a Preview codename. |
Int |
Specifies the bytecode version to be generated. |
Int? |
This property is deprecated. Will be removed in v9.0 - Use (variantBuilder as GeneratesApkBuilder).targetSdk |
String? |
This property is deprecated. Will be removed in v9.0 - Use (variantBuilder as GeneratesApkBuilder).targetSdkPreview |
Boolean |
This property is deprecated. Will be removed in AGP 9.0 - Use (variantBuilder as HasHostTestsBuilder).get(HasHostTestsBuilder.UNIT_TEST_TYPE).enable |
Inherited properties |
|---|
Public functions
registerExtension
fun <T : Any> registerExtension(type: Class<T>, instance: T): Unit
Registers an extension object to the variant object. Extension objects can be looked up during the AndroidComponentsExtension.onVariants callbacks by using the Variant.getExtension API.
This is very useful for third party plugins that want to attach some variant specific configuration object to the Android Gradle Plugin variant object and make it available to other plugins.
| Parameters | |
|---|---|
type: Class<T> |
the registered object type (can be a supertype of |
instance: T |
the object to associate to the AGP Variant object. |
Public properties
enableUnitTest
var enableUnitTest: Boolean
Set to true if the variant's has any unit tests, false otherwise. Value is Boolean#True by default.
maxSdk
var maxSdk: Int?
Sets the maximum supported SDK Version for this variant.
It is not safe to read this value. Use Variant.maxSdk instead.
minSdk
var minSdk: Int?
Sets the minimum supported SDK Version for this variant. Setting this it will override previous calls of minSdk and minSdkPreview setters. Only one of minSdk and minSdkPreview should be set.
It is not safe to read this value. Use Variant.minSdk instead.
| Returns | |
|---|---|
Int? |
the minimum supported SDK Version or null if |
minSdkPreview
var minSdkPreview: String?
Sets the minimum supported SDK Version for this variant as a Preview codename. Setting this it will override previous calls of minSdk and minSdkPreview setters. Only one of minSdk and minSdkPreview should be set.
It is not safe to read this value. Use Variant.minSdk instead.
renderscriptTargetApi
var renderscriptTargetApi: Int
Specifies the bytecode version to be generated. We recommend you set this value to the lowest API level able to provide all the functionality you are using. -1 means unspecified.
It is not safe to read this value. Use GeneratesApk.renderscript instead
| Returns | |
|---|---|
Int |
the renderscript target api or -1 if not specified. |
targetSdk
var targetSdk: Int?
Sets the target SDK Version for this variant as a Preview codename. Setting this it will override previous calls of targetSdk and targetSdkPreview setters. Only one of targetSdk and targetSdkPreview should be set.
targetSdk is now managed by GeneratesApkBuilder instead of VariantBuilder.
| Returns | |
|---|---|
Int? |
the target SDK Version or null if |
targetSdkPreview
var targetSdkPreview: String?
Sets the target SDK Version for this variant as a Preview codename. Setting this it will override previous calls of targetSdk and targetSdkPreview setters. Only one of targetSdk and targetSdkPreview should be set.
targetSdkPreview is now managed by GeneratesApkBuilder instead of VariantBuilder.
| Returns | |
|---|---|
String? |
the target supported SDK Version or null if |
unitTestEnabled
var unitTestEnabled: Boolean
Set to true if the variant's has any unit tests, false otherwise. Value is Boolean#True by default.