ApplicationVariant

interface ApplicationVariant : GeneratesApk, Variant

Properties for the main Variant of an application.

Summary

Inherited functions

T? getExtension(type: Class<T>)

Returns an extension object registered via the VariantBuilder.registerExtension API or null if none were registered under the passed type.

ResValue.Key makeResValueKey(type: String, name: String)

Make a ResValue.Key to interact with resValues's MapProperty

Properties

abstract AndroidTest?

Variant's AndroidTest configuration, or null if android tests are disabled for this variant.

abstract Property<String>

Variant's application ID as present in the final manifest file of the APK.

abstract DependenciesInfo

Specify whether to include SDK dependency information in APKs and Bundles.

abstract List<VariantOutput>

Returns the final list of variant outputs.

abstract SigningConfig?

Variant's signingConfig, initialized by the corresponding DSL element.

Inherited properties

AndroidResources androidResources

Variant's android resources processing configuration, initialized by the corresponding global DSL element.

ApkPackaging packaging

Variant's packagingOptions, initialized by the corresponding global DSL element.

Renderscript? renderscript

Variant specific settings for the renderscript compiler. This will return null when com.android.build.api.dsl.BuildFeatures.renderScript is false.

MapProperty<String, BuildConfigField<out Serializable>> buildConfigFields

Variant's BuildConfigField which will be generated in the BuildConfig class.

MapProperty<String, Any> experimentalProperties

Additional per variant experimental properties.

Initialized from com.android.build.api.dsl.CommonExtension.experimentalProperties

ExternalNativeBuild? externalNativeBuild

Variant's cmake ExternalNativeBuild, initialized by merging the product flavor values or null if no cmake external build is configured for this variant.

MapProperty<String, String> manifestPlaceholders

MapProperty of the variant's manifest placeholders.

Placeholders are organized with a key and a value. The value is a String that will be used as is in the merged manifest.

Int? maxSdkVersion

Gets the maximum supported SDK Version for this variant.

AndroidVersion minSdkVersion

Gets the minimum supported SDK Version for this variant.

Provider<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.

This value supersedes any value specified by the package attribute in the source AndroidManifest.xml, but doing a 'get' on this property will not retrieve the value specified in the AndroidManifest.xml.

ListProperty<RegularFile> proguardFiles

List of proguard configuration files for this variant. The list is initialized from the corresponding DSL element, and cannot be queried at configuration time. At configuration time, you can only add new elements to the list.

This list will be initialized from com.android.build.api.dsl.VariantDimension#proguardFile for non test related variants and from com.android.build.api.dsl.VariantDimension.testProguardFiles for test related variants.

AndroidVersion targetSdkVersion

Gets the target SDK Version for this variant.

UnitTest? unitTest

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

Property<Boolean> pseudoLocalesEnabled

Variant's is pseudo locales enabled, initialized by the corresponding DSL elements.

MapProperty<ResValue.Key, ResValue> resValues

Variant's ResValue which will be generated.

Properties

androidTest

abstract val androidTest: AndroidTest?

Variant's AndroidTest configuration, or null if android tests are disabled for this variant.

applicationId

abstract val applicationId: Property<String>

Variant's application ID as present in the final manifest file of the APK.

dependenciesInfo

abstract val dependenciesInfo: DependenciesInfo

Specify whether to include SDK dependency information in APKs and Bundles.

outputs

abstract val outputs: List<VariantOutput>

Returns the final list of variant outputs.

Return
read only list of VariantOutput for this variant.

signingConfig

abstract val signingConfig: SigningConfig?

Variant's signingConfig, initialized by the corresponding DSL element.

Return
Variant's config or null if the variant is not configured for signing.