# EncryptedFile.Builder

Artifact: [androidx.security:security-crypto](https://developer.android.com/jetpack/androidx/releases/security) [View Source](https://cs.android.com/search?q=file:androidx/security/crypto/EncryptedFile.java+class:androidx.security.crypto.EncryptedFile.Builder) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/security#1.0.0) Deprecated in [1.1.0](https://developer.android.com/jetpack/androidx/releases/security#1.1.0)

*** ** * ** ***


```
class EncryptedFile.Builder
```

<br />

*** ** * ** ***

> [!CAUTION]
> **This class is deprecated.**   
>
> Use `https://developer.android.com/reference/java/io/File.html` instead.

Builder class to configure EncryptedFile

## Summary

| ### Public constructors |
|---|
| `[Builder](https://developer.android.com/reference/kotlin/androidx/security/crypto/EncryptedFile.Builder#Builder(android.content.Context,java.io.File,androidx.security.crypto.MasterKey,androidx.security.crypto.EncryptedFile.FileEncryptionScheme))( context: https://developer.android.com/reference/android/content/Context.html, file: https://developer.android.com/reference/java/io/File.html, masterKey: https://developer.android.com/reference/kotlin/androidx/security/crypto/MasterKey, fileEncryptionScheme: https://developer.android.com/reference/kotlin/androidx/security/crypto/EncryptedFile.FileEncryptionScheme )` **This function is deprecated.** Deprecated in Java |
| `[Builder](https://developer.android.com/reference/kotlin/androidx/security/crypto/EncryptedFile.Builder#Builder(java.io.File,android.content.Context,java.lang.String,androidx.security.crypto.EncryptedFile.FileEncryptionScheme))( file: https://developer.android.com/reference/java/io/File.html, context: https://developer.android.com/reference/android/content/Context.html, masterKeyAlias: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, fileEncryptionScheme: https://developer.android.com/reference/kotlin/androidx/security/crypto/EncryptedFile.FileEncryptionScheme )` **This function is deprecated.** Use `https://developer.android.com/reference/kotlin/androidx/security/crypto/EncryptedFile.Builder#Builder(android.content.Context,java.io.File,androidx.security.crypto.MasterKey,androidx.security.crypto.EncryptedFile.FileEncryptionScheme)` instead. <br /> |

| ### Public functions |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/security/crypto/EncryptedFile` | `[build](https://developer.android.com/reference/kotlin/androidx/security/crypto/EncryptedFile.Builder#build())()` **This function is deprecated.** Deprecated in Java |
| `https://developer.android.com/reference/kotlin/androidx/security/crypto/EncryptedFile.Builder` | `[setKeysetAlias](https://developer.android.com/reference/kotlin/androidx/security/crypto/EncryptedFile.Builder#setKeysetAlias(java.lang.String))(keysetAlias: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` **This function is deprecated.** Deprecated in Java |
| `https://developer.android.com/reference/kotlin/androidx/security/crypto/EncryptedFile.Builder` | `[setKeysetPrefName](https://developer.android.com/reference/kotlin/androidx/security/crypto/EncryptedFile.Builder#setKeysetPrefName(java.lang.String))(keysetPrefName: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` **This function is deprecated.** Deprecated in Java |

## Public constructors

### Builder

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/security#1.1.0) Deprecated in [1.1.0](https://developer.android.com/jetpack/androidx/releases/security#1.1.0)

```
[Builder](https://developer.android.com/reference/kotlin/androidx/security/crypto/EncryptedFile.Builder#Builder(android.content.Context,java.io.File,androidx.security.crypto.MasterKey,androidx.security.crypto.EncryptedFile.FileEncryptionScheme))(
    context: Context,
    file: File,
    masterKey: MasterKey,
    fileEncryptionScheme: EncryptedFile.FileEncryptionScheme
)
```

> [!CAUTION]
> **This function is deprecated.**   
> Deprecated in Java

Builder for an EncryptedFile.

### Builder

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/security#1.0.0) Deprecated in [1.1.0](https://developer.android.com/jetpack/androidx/releases/security#1.1.0)

```
[Builder](https://developer.android.com/reference/kotlin/androidx/security/crypto/EncryptedFile.Builder#Builder(java.io.File,android.content.Context,java.lang.String,androidx.security.crypto.EncryptedFile.FileEncryptionScheme))(
    file: File,
    context: Context,
    masterKeyAlias: String,
    fileEncryptionScheme: EncryptedFile.FileEncryptionScheme
)
```

> [!CAUTION]
> **This function is deprecated.**   
>
> Use `https://developer.android.com/reference/kotlin/androidx/security/crypto/EncryptedFile.Builder#Builder(android.content.Context,java.io.File,androidx.security.crypto.MasterKey,androidx.security.crypto.EncryptedFile.FileEncryptionScheme)` instead.

Builder for an EncryptedFile.

If the `masterKeyAlias` used here is for a key that is not yet created, this method will not be thread safe. Use the alternate signature that is not deprecated for multi-threaded contexts.

## Public functions

### build

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/security#1.0.0) Deprecated in [1.1.0](https://developer.android.com/jetpack/androidx/releases/security#1.1.0)

```
fun [build](https://developer.android.com/reference/kotlin/androidx/security/crypto/EncryptedFile.Builder#build())(): EncryptedFile
```

> [!CAUTION]
> **This function is deprecated.**   
> Deprecated in Java

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/security/crypto/EncryptedFile` | An EncryptedFile with the specified parameters. |

| Throws |
|---|---|
| `https://developer.android.com/reference/java/security/GeneralSecurityException.html` |   |
| `https://developer.android.com/reference/java/io/IOException.html` |   |

### setKeysetAlias

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/security#1.0.0) Deprecated in [1.1.0](https://developer.android.com/jetpack/androidx/releases/security#1.1.0)

```
fun [setKeysetAlias](https://developer.android.com/reference/kotlin/androidx/security/crypto/EncryptedFile.Builder#setKeysetAlias(java.lang.String))(keysetAlias: String): EncryptedFile.Builder
```

> [!CAUTION]
> **This function is deprecated.**   
> Deprecated in Java

| Parameters |
|---|---|
| `keysetAlias: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The alias in the SharedPreferences file to store the keyset. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/security/crypto/EncryptedFile.Builder` | This Builder |

### setKeysetPrefName

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/security#1.0.0) Deprecated in [1.1.0](https://developer.android.com/jetpack/androidx/releases/security#1.1.0)

```
fun [setKeysetPrefName](https://developer.android.com/reference/kotlin/androidx/security/crypto/EncryptedFile.Builder#setKeysetPrefName(java.lang.String))(keysetPrefName: String): EncryptedFile.Builder
```

> [!CAUTION]
> **This function is deprecated.**   
> Deprecated in Java

| Parameters |
|---|---|
| `keysetPrefName: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The SharedPreferences file to store the keyset. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/security/crypto/EncryptedFile.Builder` | This Builder |