# EncryptedFileKt

Added in 1.1.0

*** ** * ** ***


```
public final class EncryptedFileKt
```

<br />

*** ** * ** ***

## Summary

| ### Public methods |
|---|---|
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/security/crypto/EncryptedFile` | `[EncryptedFile](https://developer.android.com/reference/androidx/security/crypto/EncryptedFileKt#EncryptedFile(android.content.Context,java.io.File,androidx.security.crypto.MasterKey,androidx.security.crypto.EncryptedFile.FileEncryptionScheme,kotlin.String,kotlin.String))( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/content/Context.html context, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/io/File.html file, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/security/crypto/MasterKey masterKey, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/security/crypto/EncryptedFile.FileEncryptionScheme fileEncryptionScheme, https://developer.android.com/reference/java/lang/String.html keysetPrefName, https://developer.android.com/reference/java/lang/String.html keysetAlias )` **This method is deprecated.** Use java.io.File instead |

## Public methods

### EncryptedFile

Artifact: [androidx.security:security-crypto-ktx](https://developer.android.com/jetpack/androidx/releases/security) [View Source](https://cs.android.com/search?q=file:androidx/security/crypto/EncryptedFile.kt+function:EncryptedFile) 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)

```
public static final @NonNull EncryptedFile [EncryptedFile](https://developer.android.com/reference/androidx/security/crypto/EncryptedFileKt#EncryptedFile(android.content.Context,java.io.File,androidx.security.crypto.MasterKey,androidx.security.crypto.EncryptedFile.FileEncryptionScheme,kotlin.String,kotlin.String))(
    @NonNull Context context,
    @NonNull File file,
    @NonNull MasterKey masterKey,
    @NonNull EncryptedFile.FileEncryptionScheme fileEncryptionScheme,
    String keysetPrefName,
    String keysetAlias
)
```

> [!CAUTION]
> **This method is deprecated.**   
> Use java.io.File instead

Creates an `https://developer.android.com/reference/androidx/security/crypto/package-summary#EncryptedFile(android.content.Context,java.io.File,androidx.security.crypto.MasterKey,androidx.security.crypto.EncryptedFile.FileEncryptionScheme,kotlin.String,kotlin.String)`

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/content/Context.html context` | The context to work with. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/io/File.html file` | The backing `https://developer.android.com/reference/java/io/File.html`. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/security/crypto/MasterKey masterKey` | The `https://developer.android.com/reference/androidx/security/crypto/MasterKey` that should be used. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/security/crypto/EncryptedFile.FileEncryptionScheme fileEncryptionScheme` | The `https://developer.android.com/reference/androidx/security/crypto/EncryptedFile.FileEncryptionScheme` to use, defaulting to `https://developer.android.com/reference/androidx/security/crypto/EncryptedFile.FileEncryptionScheme#AES256_GCM_HKDF_4KB`. |
| `https://developer.android.com/reference/java/lang/String.html keysetPrefName` | The `SharedPreferences` file to store the keyset for this `https://developer.android.com/reference/androidx/security/crypto/package-summary#EncryptedFile(android.content.Context,java.io.File,androidx.security.crypto.MasterKey,androidx.security.crypto.EncryptedFile.FileEncryptionScheme,kotlin.String,kotlin.String)`. |
| `https://developer.android.com/reference/java/lang/String.html keysetAlias` | The alias in the `SharedPreferences` file to store the keyset for this `https://developer.android.com/reference/androidx/security/crypto/package-summary#EncryptedFile(android.content.Context,java.io.File,androidx.security.crypto.MasterKey,androidx.security.crypto.EncryptedFile.FileEncryptionScheme,kotlin.String,kotlin.String)`. |