# ConsumerKeepRules

# ConsumerKeepRules

<br />

```
@Incubating
public interface ConsumerKeepRules extends ConfigurableFiles
```

<br />

*** ** * ** ***

## Summary

|                                                                                                                                                                                                     ### Public methods                                                                                                                                                                                                      |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `abstract @`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[Set](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html)`<@`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html)`>` | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [getIgnoreFrom](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ConsumerKeepRules#getIgnoreFrom())`()` Ignore keep rules from listed external dependencies.                                                                                                              |
| `abstract boolean`                                                                                                                                                                                                                                                                                                                                                                                                          | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [getIgnoreFromAllExternalDependencies](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ConsumerKeepRules#getIgnoreFromAllExternalDependencies())`()` Ignore keep rules from all the external dependencies.                                                               |
| `abstract boolean`                                                                                                                                                                                                                                                                                                                                                                                                          | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [getPublish](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ConsumerKeepRules#getPublish())`()` Publishing consumer proguard rules as part of a kmp library is an opt-in feature.                                                                                       |
| `abstract void`                                                                                                                                                                                                                                                                                                                                                                                                             | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [setIgnoreFromAllExternalDependencies](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ConsumerKeepRules#setIgnoreFromAllExternalDependencies(kotlin.Boolean))`(` ` boolean ignoreFromAllExternalDependencies` `)` Ignore keep rules from all the external dependencies. |
| `abstract void`                                                                                                                                                                                                                                                                                                                                                                                                             | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [setPublish](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ConsumerKeepRules#setPublish(kotlin.Boolean))`(boolean publish)` Publishing consumer proguard rules as part of a kmp library is an opt-in feature.                                                          |

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ### Inherited methods                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From[com.android.build.api.dsl.ConfigurableFiles](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ConfigurableFiles) |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `abstract void`                                                                                                                                                                                                                                                                                                                                                                                                         | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [file](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ConfigurableFiles#file(kotlin.Any))`(@`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[Object](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html)` file)`      | | `abstract void`                                                                                                                                                                                                                                                                                                                                                                                                         | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [files](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ConfigurableFiles#files(kotlin.Array))`(@`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[Object](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html)` files)` | | `abstract @`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[List](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html)`<@`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[File](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html)`>` | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [getFiles](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ConfigurableFiles#getFiles())`()`                                                                                                                                                                                                                       | |

## Public methods

### getIgnoreFrom

```
@Incubating
abstract @NonNull Set<@NonNull String> getIgnoreFrom()
```

Ignore keep rules from listed external dependencies. External dependencies can be specified via GAV coordinates(e.g. "groupId:artifactId:version") or in the format of "groupId:artifactId" in which case dependencies are ignored as long as they match groupId \& artifactId.  

### getIgnoreFromAllExternalDependencies

```
@Incubating
abstract boolean getIgnoreFromAllExternalDependencies()
```

Ignore keep rules from all the external dependencies.  

### getPublish

```
@Incubating
abstract boolean getPublish()
```

Publishing consumer proguard rules as part of a kmp library is an opt-in feature. By default, consumer proguard rules will not be published.

To enable it, set this property to`true`  

### setIgnoreFromAllExternalDependencies

```
@Incubating
abstract void setIgnoreFromAllExternalDependencies(
    boolean ignoreFromAllExternalDependencies
)
```

Ignore keep rules from all the external dependencies.  

### setPublish

```
@Incubating
abstract void setPublish(boolean publish)
```

Publishing consumer proguard rules as part of a kmp library is an opt-in feature. By default, consumer proguard rules will not be published.

To enable it, set this property to`true`