# ApkSigningConfig

# ApkSigningConfig

<br />

```
public interface ApkSigningConfig extends SigningConfig, Named
```

<br />

*** ** * ** ***

DSL object to configure signing configs.

## Summary

|                                            ### Public methods                                             |
|-----------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `abstract `[Boolean](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html) | [getEnableV1Signing](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ApkSigningConfig#getEnableV1Signing())`()` Enable signing using JAR Signature Scheme (aka v1 signing).                                                                                                                                  |
| `abstract `[Boolean](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html) | [getEnableV2Signing](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ApkSigningConfig#getEnableV2Signing())`()` Enable signing using APK Signature Scheme v2 (aka v2 signing).                                                                                                                               |
| `abstract `[Boolean](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html) | [getEnableV3Signing](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ApkSigningConfig#getEnableV3Signing())`()` Enable signing using APK Signature Scheme v3 (aka v3 signing).                                                                                                                               |
| `abstract `[Boolean](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html) | [getEnableV4Signing](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ApkSigningConfig#getEnableV4Signing())`()` Enable signing using APK Signature Scheme v4 (aka v4 signing).                                                                                                                               |
| `abstract boolean`                                                                                        | [isV1SigningEnabled](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ApkSigningConfig#getIsV1SigningEnabled())`()` Whether signing using JAR Signature Scheme (aka v1 signing) is enabled.                                                                                                                   |
| `abstract boolean`                                                                                        | [isV2SigningEnabled](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ApkSigningConfig#getIsV2SigningEnabled())`()` Whether signing using APK Signature Scheme v2 (aka v2 signing) is enabled.                                                                                                                |
| `abstract void`                                                                                           | [setEnableV1Signing](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ApkSigningConfig#setEnableV1Signing(kotlin.Boolean))`(`[Boolean](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html)` enableV1Signing)` Enable signing using JAR Signature Scheme (aka v1 signing).    |
| `abstract void`                                                                                           | [setEnableV2Signing](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ApkSigningConfig#setEnableV2Signing(kotlin.Boolean))`(`[Boolean](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html)` enableV2Signing)` Enable signing using APK Signature Scheme v2 (aka v2 signing). |
| `abstract void`                                                                                           | [setEnableV3Signing](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ApkSigningConfig#setEnableV3Signing(kotlin.Boolean))`(`[Boolean](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html)` enableV3Signing)` Enable signing using APK Signature Scheme v3 (aka v3 signing). |
| `abstract void`                                                                                           | [setEnableV4Signing](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ApkSigningConfig#setEnableV4Signing(kotlin.Boolean))`(`[Boolean](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html)` enableV4Signing)` Enable signing using APK Signature Scheme v4 (aka v4 signing). |
| `abstract void`                                                                                           | [setV1SigningEnabled](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ApkSigningConfig#setIsV1SigningEnabled(kotlin.Boolean))`(boolean isV1SigningEnabled)` Whether signing using JAR Signature Scheme (aka v1 signing) is enabled.                                                                          |
| `abstract void`                                                                                           | [setV2SigningEnabled](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ApkSigningConfig#setIsV2SigningEnabled(kotlin.Boolean))`(boolean isV2SigningEnabled)` Whether signing using APK Signature Scheme v2 (aka v2 signing) is enabled.                                                                       |

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ### Inherited methods                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From[org.gradle.api.Named](https://docs.gradle.org/current/javadoc/org/gradle/api/Named.html) |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------| | `abstract @`[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) | [getName](https://docs.gradle.org/current/javadoc/org/gradle/api/Named.html#getName--)`()` |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| From[com.android.build.api.dsl.SigningConfig](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/SigningConfig) |---------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `abstract `[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html) | [getKeyAlias](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/SigningConfig#getKeyAlias())`()` Key alias used when signing.                                                                                                                                                                                                                                                                                                       | | `abstract `[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html) | [getKeyPassword](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/SigningConfig#getKeyPassword())`()` Key password used when signing.                                                                                                                                                                                                                                                                                              | | `abstract `[File](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html)       | [getStoreFile](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/SigningConfig#getStoreFile())`()` Store file used when signing.                                                                                                                                                                                                                                                                                                    | | `abstract `[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html) | [getStorePassword](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/SigningConfig#getStorePassword())`()` Store password used when signing.                                                                                                                                                                                                                                                                                        | | `abstract `[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html) | [getStoreType](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/SigningConfig#getStoreType())`()` Store type used when signing.                                                                                                                                                                                                                                                                                                    | | `abstract void`                                                                                         | [initWith](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/SigningConfig#initWith(com.android.build.api.dsl.SigningConfig))`(@`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[SigningConfig](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/SigningConfig)` that)` Copies all properties from the given signing config. | | `abstract void`                                                                                         | [setKeyAlias](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/SigningConfig#setKeyAlias(kotlin.String))`(`[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html)` keyAlias)` Key alias used when signing.                                                                                                                                                                                   | | `abstract void`                                                                                         | [setKeyPassword](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/SigningConfig#setKeyPassword(kotlin.String))`(`[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html)` keyPassword)` Key password used when signing.                                                                                                                                                                       | | `abstract void`                                                                                         | [setStoreFile](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/SigningConfig#setStoreFile(java.io.File))`(`[File](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html)` storeFile)` Store file used when signing.                                                                                                                                                                                      | | `abstract void`                                                                                         | [setStorePassword](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/SigningConfig#setStorePassword(kotlin.String))`(`[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html)` storePassword)` Store password used when signing.                                                                                                                                                               | | `abstract void`                                                                                         | [setStoreType](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/SigningConfig#setStoreType(kotlin.String))`(`[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html)` storeType)` Store type used when signing.                                                                                                                                                                               | |

## Public methods

### getEnableV1Signing

```
abstract Boolean getEnableV1Signing()
```

Enable signing using JAR Signature Scheme (aka v1 signing). If null, a default value is used.

See[Signing Your Applications](http://developer.android.com/tools/publishing/app-signing.html)  

### getEnableV2Signing

```
abstract Boolean getEnableV2Signing()
```

Enable signing using APK Signature Scheme v2 (aka v2 signing). If null, a default value is used.

See[Signing Your Applications](http://developer.android.com/tools/publishing/app-signing.html)  

### getEnableV3Signing

```
abstract Boolean getEnableV3Signing()
```

Enable signing using APK Signature Scheme v3 (aka v3 signing). If null, a default value is used.

See[APK Signature Scheme v3](https://source.android.com/security/apksigning/v3)  

### getEnableV4Signing

```
abstract Boolean getEnableV4Signing()
```

Enable signing using APK Signature Scheme v4 (aka v4 signing). If null, a default value is used.  

### isV1SigningEnabled

```
abstract boolean isV1SigningEnabled()
```

Whether signing using JAR Signature Scheme (aka v1 signing) is enabled.

See[Signing Your Applications](http://developer.android.com/tools/publishing/app-signing.html)  

### isV2SigningEnabled

```
abstract boolean isV2SigningEnabled()
```

Whether signing using APK Signature Scheme v2 (aka v2 signing) is enabled.

See[Signing Your Applications](http://developer.android.com/tools/publishing/app-signing.html)  

### setEnableV1Signing

```
abstract void setEnableV1Signing(Boolean enableV1Signing)
```

Enable signing using JAR Signature Scheme (aka v1 signing). If null, a default value is used.

See[Signing Your Applications](http://developer.android.com/tools/publishing/app-signing.html)  

### setEnableV2Signing

```
abstract void setEnableV2Signing(Boolean enableV2Signing)
```

Enable signing using APK Signature Scheme v2 (aka v2 signing). If null, a default value is used.

See[Signing Your Applications](http://developer.android.com/tools/publishing/app-signing.html)  

### setEnableV3Signing

```
abstract void setEnableV3Signing(Boolean enableV3Signing)
```

Enable signing using APK Signature Scheme v3 (aka v3 signing). If null, a default value is used.

See[APK Signature Scheme v3](https://source.android.com/security/apksigning/v3)  

### setEnableV4Signing

```
abstract void setEnableV4Signing(Boolean enableV4Signing)
```

Enable signing using APK Signature Scheme v4 (aka v4 signing). If null, a default value is used.  

### setV1SigningEnabled

```
abstract void setV1SigningEnabled(boolean isV1SigningEnabled)
```

Whether signing using JAR Signature Scheme (aka v1 signing) is enabled.

See[Signing Your Applications](http://developer.android.com/tools/publishing/app-signing.html)  

### setV2SigningEnabled

```
abstract void setV2SigningEnabled(boolean isV2SigningEnabled)
```

Whether signing using APK Signature Scheme v2 (aka v2 signing) is enabled.

See[Signing Your Applications](http://developer.android.com/tools/publishing/app-signing.html)