EncryptedFileKt

Added in 1.1.0-alpha07

public final class EncryptedFileKt

Summary

Public methods
static final @NonNull EncryptedFile
EncryptedFile(
    @NonNull Context context,
    @NonNull File file,
    @NonNull MasterKey masterKey,
    @NonNull EncryptedFile.FileEncryptionScheme fileEncryptionScheme,
    String keysetPrefName,
    String keysetAlias
)

Creates an EncryptedFile

Public methods

EncryptedFile

public static final @NonNull EncryptedFile EncryptedFile(
    @NonNull Context context,
    @NonNull File file,
    @NonNull MasterKey masterKey,
    @NonNull EncryptedFile.FileEncryptionScheme fileEncryptionScheme,
    String keysetPrefName,
    String keysetAlias
)

Creates an EncryptedFile

Parameters
@NonNull Context context

The context to work with.
@NonNull File file

The backing File.
@NonNull MasterKey masterKey

The MasterKey that should be used.
@NonNull EncryptedFile.FileEncryptionScheme fileEncryptionScheme

The FileEncryptionScheme to use, defaulting to FileEncryptionScheme.AES256_GCM_HKDF_4KB.
String keysetPrefName

The SharedPreferences file to store the keyset for this EncryptedFile.
String keysetAlias

The alias in the SharedPreferences file to store the keyset for this EncryptedFile.