# AndroidResources

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


```
interface AndroidResources
```

<br />

Known direct subclasses [AaptOptions](https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/dsl/AaptOptions), [ApplicationAndroidResources](https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/dsl/ApplicationAndroidResources), [DynamicFeatureAndroidResources](https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/dsl/DynamicFeatureAndroidResources), [LibraryAndroidResources](https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/dsl/LibraryAndroidResources), [TestAndroidResources](https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/dsl/TestAndroidResources)

|---|---|
| `https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/dsl/AaptOptions` | **This interface is deprecated.** Renamed to AndroidResources |
| `https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/dsl/ApplicationAndroidResources` | DSL object for configuring Android resource options for Application plugins. |
| `https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/dsl/DynamicFeatureAndroidResources` | DSL object for configuring Android resource options for Dynamic Feature plugins. |
| `https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/dsl/LibraryAndroidResources` | DSL object for configuring Android resource options for Library plugins. |
| `https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/dsl/TestAndroidResources` | DSL object for configuring Android resource options for Test plugins. |

*** ** * ** ***

DSL object for configuring Android resource options.

This is accessed via `https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/dsl/CommonExtension#androidResources()`

## Summary

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `[additionalParameters](https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/dsl/AndroidResources#additionalParameters(kotlin.String))(params: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` **This function is deprecated.** Replaced with property additionalParameters |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `[additionalParameters](https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/dsl/AndroidResources#additionalParameters(kotlin.Array))(vararg params: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` **This function is deprecated.** Replaced with property additionalParameters |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `[noCompress](https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/dsl/AndroidResources#noCompress(kotlin.String))(noCompress: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` **This function is deprecated.** Replaced with property noCompress |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `[noCompress](https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/dsl/AndroidResources#noCompress(kotlin.Array))(vararg noCompress: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` **This function is deprecated.** Replaced with property noCompress |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html>` | `https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/dsl/AndroidResources#additionalParameters()` List of additional parameters to pass to `aapt`. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/dsl/AndroidResources#failOnMissingConfigEntry()` Forces aapt to return an error if it fails to find an entry for a configuration. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html?` | `https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/dsl/AndroidResources#ignoreAssetsPattern()` Pattern describing assets to be ignored. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-collection/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html>` | `https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/dsl/AndroidResources#ignoreAssetsPatterns()` Patterns describing assets to be ignored. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-collection/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html>` | `https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/dsl/AndroidResources#noCompress()` File extensions of Android resources, assets, and Java resources to be stored uncompressed in the APK. |

## Public functions

### additionalParameters

Added in 7.0.0 Deprecated in 8.0.2

```
fun [additionalParameters](https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/dsl/AndroidResources#additionalParameters(kotlin.String))(params: String): Unit
```

> [!CAUTION]
> **This function is deprecated.**   
> Replaced with property additionalParameters

Adds additional parameters to be passed to `aapt`.

### additionalParameters

Added in 7.0.0 Deprecated in 8.0.2

```
fun [additionalParameters](https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/dsl/AndroidResources#additionalParameters(kotlin.Array))(vararg params: String): Unit
```

> [!CAUTION]
> **This function is deprecated.**   
> Replaced with property additionalParameters

Adds additional parameters to be passed to `aapt`.

### noCompress

Added in 7.0.0 Deprecated in 8.0.2

```
fun [noCompress](https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/dsl/AndroidResources#noCompress(kotlin.String))(noCompress: String): Unit
```

> [!CAUTION]
> **This function is deprecated.**   
> Replaced with property noCompress

Adds a file extension of Android resources, assets, and Java resources to be stored uncompressed in the APK. Adding an empty extension (i.e., `noCompress('')`) will disable compression for all Android resources, assets, and Java resources.

### noCompress

Added in 7.0.0 Deprecated in 8.0.2

```
fun [noCompress](https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/dsl/AndroidResources#noCompress(kotlin.Array))(vararg noCompress: String): Unit
```

> [!CAUTION]
> **This function is deprecated.**   
> Replaced with property noCompress

Adds file extensions of Android resources, assets, and Java resources to be stored uncompressed in the APK. Adding an empty extension (e.g., `noCompress('')`) will disable compression for all Android resources, assets, and Java resources.

## Public properties

### additionalParameters

Added in 7.0.0

```
val additionalParameters: MutableList<String>
```

List of additional parameters to pass to `aapt`.

These are passed to every AAPT2 resource link invocation for this module. For application and dynamic-feature modules that includes the link that produces the Android App Bundle, as well as the one that produces the APK, so parameters that remove resources affect the bundle too.

This is the supported way to target a single screen density, now that the screen density support in `https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/dsl/BaseFlavor#resourceConfigurations()` is deprecated:

```
android {
    androidResources {
        additionalParameters += ["--preferred-density", "hdpi"]
    }
}
```

Note that this also removes the other densities from the bundle, which is rarely intended, since a bundle is normally expected to contain every density so that density-specific APKs can be generated from it.

### failOnMissingConfigEntry

Added in 7.0.0

```
var failOnMissingConfigEntry: Boolean
```

Forces aapt to return an error if it fails to find an entry for a configuration.

See `aapt --help`

### ignoreAssetsPattern

Added in 7.0.0

```
var ignoreAssetsPattern: String?
```

Pattern describing assets to be ignored.

This is `https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/dsl/AndroidResources#ignoreAssetsPatterns()` joined by ':'.

### ignoreAssetsPatterns

Added in 7.3.0

```
val ignoreAssetsPatterns: MutableCollection<String>
```

Patterns describing assets to be ignored.

If empty, defaults to `["!.svn", "!.git", "!.ds_store", "!*.scc", ".*", "<dir>_*", "!CVS", "!thumbs.db", "!picasa.ini", "!*~"]`

### noCompress

Added in 7.0.0

```
val noCompress: MutableCollection<String>
```

File extensions of Android resources, assets, and Java resources to be stored uncompressed in the APK. Adding an empty extension (e.g., setting `noCompress ''`) will disable compression for all Android resources, assets, and Java resources.