Class Index

This interface is deprecated. Renamed to AndroidResources

Variant object for configuring AAR metadata.

DSL object for configuring metadata that is embedded in the AAR.

DSL object for configuring per-abi splits options.

This interface is deprecated. Renamed to Installation

Type of the attribute holding Android Gradle Plugin version.

Provides structured access to various AIDL tools such as the aidl compiler executable and aidl framework.

Common plugin applied by all plugins.

Generic extension for Android Gradle Plugin related components.

Represents a version of the Android Gradle Plugin

Defines a variant's aapt options.

DSL object for configuring aapt options.

An AndroidSourceDirectorySet represents a set of directory inputs for an Android project.

An AndroidSourceFile represents a single file input for an Android project.

An AndroidSourceSet represents a logical group of Java, aidl and RenderScript sources as well as Android and non-Android (Java-style) resources.

Properties for the android test Variant of a module.

Options for configuring Java annotation processor.

Common extension properties for the Android Gradle Plugin Application and Dynamic Feature plugins.

Defines an APK variant's packaging options.

DSL object to configure signing configs.

The plugin applied with `com.android.application'

Extension for the Android Application Gradle Plugin components.

A list of build features that can be disabled or enabled in an Android Application project.

Build types define certain properties that Gradle uses when building and packaging your app, and are typically configured for different stages of your development lifecycle.

Specifies defaults for properties that the Android application plugin applies to all build variants.

Extension for the Android Gradle Plugin Application plugin.

Encapsulates all product flavors properties for application projects.

Maven publishing DSL object for configuring options related to publishing APK and AAB.

Single variant publishing options for application projects.

Properties for the main Variant of an application.

Application specific variant object that contains properties that will determine the variant's build flow.

Shared properties between DSL objects that contribute to an application variant.

Defines a type of artifact handled by the Android Gradle Plugin.

Denotes an artifact type that can be appended to.

Defines the kind of artifact type. this will be used to determine the output file location for instance.

Supported ArtifactKind

Denotes a single DIRECTORY that may contain zero to many com.android.build.api.variant.BuiltArtifact.

Denotes possible multiple FileSystemLocation instances for this artifact type.

Denotes an artifact type that can be replaced.

Denotes a single FileSystemLocation instance of this artifact type at a given time.

Denotes an artifact type that can transformed.

Exhaustive list of artifact file representations supported by the Android Gradle plugin.

When a Directory contains more than one artifact (for example, consider SingleArtifact.APK with multiple APKs for different screen densities), this object will abstract away having to deal with BuiltArtifacts and manually load and write the metadata files.

Access to the artifacts on a Variant object.

A factory to create class visitor objects to instrument classes.

Extension properties for the Asset Pack plugin.

Shared properties between DSL objects ProductFlavor and DefaultConfig

Base class for the plugin.

Field definition for the generated BuildConfig class.

A list of build features that can be disabled or enabled in an Android project.

Build types define certain properties that Gradle uses when building and packaging your app, and are typically configured for different stages of your development lifecycle.

Type for the attribute holding BuildType information.

Represents a built artifact that is present in the file system.

Represents a Collection of BuiltArtifact produced by a org.gradle.api.Task.

Specialized version of Gradle's WorkParameters so we can retrieve the output file generated when transforming an instance of BuiltArtifacts into a new one.

Facility to load BuiltArtifacts instances from metadata files in the file system.

Features that apply to distribution by the bundle

Information related to the actions creating a bundle (.aab) file for the variant.

Interface for component that can shrink resources

Interface for component builder that can shrink resources

Interface for component that can minify code

Interface for component builder that can minify code

Data about the class to be instrumented.

DSL object for per-module CMake configurations, such as the path to your CMakeLists.txt build script and external native build output directory.

DSL object for per-variant CMake options, such as CMake arguments and compiler flags.

Common extension properties for the Android Application.

Java compilation options.

Component object that contains properties that must be set during configuration time as it changes the build flow for the variant.

Variant Configuration represents the identify of a variant

Optional settings for the Compose feature.

This interface is deprecated.

DSL object for configuring databinding options.

Specifies defaults for variant properties that the Android plugin applies to all build variants.

This interface is deprecated. Density-based apk split feature is deprecated and will be removed in AGP 9.0.Use Android App Bundle (https://developer.android.com/guide/app-bundle)to generate optimized APKs.

Read-only object to access dependencies information properties during com.android.build.api.variant.AndroidComponentsExtension#onVariants

DSL object to specify whether to include SDK dependency information in APKs and Bundles.

Interface for component builder that specifies whether to include SDK dependency information in APKs and Bundles for the variant

Top-level interface for all devices to run applications by tasks in the Android Gradle Plugin.

A group of devices to be run with tests using the Unified Test Platform.

Packaging options for Dex (Android Dalvik Executable) files

Defines an APK variant's packaging options for dex files.

This interface is deprecated.

Third party DSL extension configuration.

Creates a Builder to instance to create a DslExtension containing all desired extension points to the Android Gradle Plugin DSL.

DSL object to configure dynamic delivery of an asset pack.

Extension for the Android Dynamic Feature Gradle Plugin components.

Shared properties between DSL objects ProductFlavor and DefaultConfig for dynamic features.

A list of build features that can be disabled or enabled in an Android Dynamic Feature project.

Build types define certain properties that Gradle uses when building and packaging your app, and are typically configured for different stages of your development lifecycle.

Specifies defaults for properties that the Android dynamic-feature plugin applies to all build variants.

Extension for the Android Dynamic Feature Gradle Plugin.

The plugin applied with `com.android.dynamic-feature'

Encapsulates all product flavors properties for dynamic feature projects.

Shared properties between DSL objects that contribute to an dynamic feature variant.

Options for configuring Android Emulator Access

Options for configuring Android Test Retention.

Parameters to use when building native components.

DSL object to configure external native builds using CMake or ndk-build

DSL object for per-variant CMake and ndk-build configurations, such as toolchain arguments and compiler flags.

Interface for ndk-build per-variant info.

This interface is deprecated. Renamed to EmulatorSnapshots

Immutable filter configuration.

Split dimension type

This enum is deprecated.

Indicates the frame computation mode that will be applied to the bytecode of the classes instrumented by ASM visitors registered through Component.transformClassesWith.

Cross cutting interface for Component subtypes that are producing APK files.

Cross-cutting interface for components builders that produce APK files.

Variants that optionally have instrumented tests.

Interface that mark the potential existence of android tests associated with a variant.

For build types and product flavors, they can be initialized from the current state of another.

Variants that optionally have test fixtures.

Interface that mark the potential existence of test fixtures associated with a variant.

Variants that optionally have unit test component

Interface that mark the potential existence of unit tests associated with a variant.

Operations performed by a Task with a single RegularFile or Directory output.

Options for the adb tool.

Options to register asm class visitors and to configure the instrumentation process.

Instrumentation context data that will be injected to AsmClassVisitorFactory on instantiation.

Parameters for a registered AsmClassVisitorFactory.

This interface is deprecated. Renamed to TestCoverage

This interface is deprecated.

DSL object for javaCompileOptions.

Defines an APK variant's packaging options for native library (.so) files.

Defines a variant's packaging options for native library (.so) files.

Packaging options for native library (.so) files

DSL object for external library dependencies keep rules configurations.

Extension for the Android Library Gradle Plugin components.

A list of build features that can be disabled or enabled in an Android Library project.

Build types define certain properties that Gradle uses when building and packaging your library, and are typically configured for different stages of your development lifecycle.

Specifies defaults for properties that the Android library plugin applies to all build variants.

Extension for the Android Library Gradle Plugin.

The plugin applied with 'com.android.library'

Encapsulates all product flavors properties for library projects.

Maven publishing DSL object for configuring options related to publishing AAR.

Single variant publishing options for library projects.

Variant for Library projects

VariantBuilder type for library projects

Shared properties between DSL objects that contribute to a library variant.

DSL object for configuring lint options.

This interface is deprecated. Renamed to Lint

Plugin for running lint without the Android Gradle plugin, such as in a pure Kotlin project.

Options for Managed Devices

Device type for emulators to be managed by the Android Gradle Plugin.

Public Artifact for Android Gradle plugin.

Text files with additional ProGuard rules to be used to determine which classes are compiled into the main dex file.

Directories with native debug metadata

Directories with debug symbol table

Multi variant publishing options.

DSL object for per-variant NDK settings, such as the ABI filter.

DSL object for per-module ndk-build configurations, such as the path to your Android.mk build script and external native build output directory.

DSL object for per-variant ndk-build options, such as ndk-build arguments and compiler flags.

DSL object for configurations aimed for optimizing build process(e.g. speed, correctness).

Operations performed by a Task with a single RegularFile or Directory output.

Defines a variant's packaging options.

DSL object for configuring postProcessing: removing dead code, obfuscating etc.

Options for including Prefab packages in AARs.

Encapsulates all product flavors properties for this project.

Type for the attribute holding ProductFlavor information.

Maven publishing DSL object for configuring options related to publishing Android variants to a Maven repository.

Maven publishing options shared by SingleVariant and MultipleVariants.

This interface is deprecated.

A content type that is requested through the transform API.

The type of of the content.

The scope of the content.

Definition of a scope.

Resource to be generated by the build system.

a generated resource is identified by its type+name as you can create

Packaging options for java resource files

List of ScopedArtifacts.Scope artifacts.

.class files, result of sources compilation and/or external dependencies depending on the scope

Scoped artifacts are artifacts that can be made available in the current variant scope, or may be optionally include the project's dependencies in the results.

Defines possible scopes.

Defines all possible operations on a ScopedArtifact artifact type.

This class is deprecated.

This interface is deprecated.

Interface used for the android DSL in the settings.gradle[.kts] file, after the com.android.settings plugin is applied.

The plugin applied with `com.android.settings'

Options for configuring scoped shader options.

Defines a variant's signing config.

DSL object for configuring options related to signing for APKs and bundles.

Public Artifact for Android Gradle plugin.

The final AAR file as it would be published.

Directory where APK files will be located.

Universal APK that contains assets for all screen densities.

Assets that will be packaged in the resulting APK or Bundle.

The final Bundle ready for consumption at Play Store.

Merged manifest file that will be used in the APK, Bundle and InstantApp packages.

The directory containing all the native library (.so) files that will be packaged in the APK, AAR, or Bundle.

The metadata for the library dependencies.

A file containing the list of public resources exported by a library project.

Single variant publishing options.

Defines all common behaviors to sources access in AGP.

Represents all the source folders for a source type in the variant.

Represent a collection of directories that have overlay properties to each other.

Provides access to all source directories for a Variant.

Base data representing how an FULL_APK should be split for a given dimension (density, abi).

Options to configure Multiple APKs.

This enum is deprecated.

Interface with methods to wire input and output method references to Task-based operations.

Extension for the Android Test Gradle Plugin components.

A list of build features that can be disabled or enabled in an Android Test project.

Build types define certain properties that Gradle uses when building and packaging your library, and are typically configured for different stages of your development lifecycle.

Settings related to the gathering of code-coverage data from tests

Specifies defaults for properties that the Android test plugin applies to all build variants.

Extension for the Android Test Gradle Plugin.

DSL object for configuring test fixtures.

Options for running tests.

The plugin applied with 'com.android.test'

Encapsulates all product flavors properties for test projects.

Variant for test-only modules.

VariantBuilder type for tests associated with a module.

Shared properties between DSL objects that contribute to a separate-test-project variant.

Common extension properties for the Android Application.

This class is deprecated.

This API is planned to be removed in Android Gradle Plugin 8.0.

This class is deprecated.

This interface is deprecated.

This interface is deprecated.

This interface is deprecated.

This interface is deprecated. Use the com.android.build.api.variant package

Options for controlling unit tests execution.

Parent interface for all types of variants.

Variant object that contains properties that must be set during configuration time as it changes the build flow for the variant.

Shared properties between DSL objects that contribute to a variant.

Marker type for Variant extension objects.

Configuration object passed to the lambda responsible for creating a com.android.build.api.variant.VariantExtension for each com.android.build.api.variant.Variant instance.

This interface is deprecated. Use AndroidComponentsExtension.beforeVariants API to disable specific variants

This interface is deprecated.

Defines a variant output.

Type of package file, either the main APK or a full split APK file containing resources for a particular split dimension.

Selector to reduce the number of variants that are of interests when calling any of the variant API like AndroidComponentsExtension.beforeVariants.

DSL object used to configure vector drawable options.

DSL object for configuring viewbinding options.