core/de.raphaelebner.roomdatabasebackup.core/RoomBackup

RoomBackup

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Constructors

RoomBackup

constructor(context: Context)

Types

Companion

object Companion

Properties

context

var context: Context

Functions

backup

fun backup()

Start Backup process, and set onComplete Listener to success, if no error occurred, else onComplete Listener success is false and error message is passed

backupIsEncrypted

fun backupIsEncrypted(backupIsEncrypted: Boolean): RoomBackup

Set file encryption to true / false can be used for backup and restore

backupLocation

fun backupLocation(backupLocation: Int): RoomBackup

Set you backup location. Available values see: BACKUP_FILE_LOCATION_INTERNAL, BACKUP_FILE_LOCATION_EXTERNAL, BACKUP_FILE_LOCATION_CUSTOM_DIALOG or BACKUP_FILE_LOCATION_CUSTOM_FILE

backupLocationCustomFile

fun backupLocationCustomFile(backupLocationCustomFile: File): RoomBackup

Set a custom file where to save or restore a backup. can be used for backup and restore

customBackupFileName

fun customBackupFileName(customBackupFileName: String): RoomBackup

Set custom Backup File Name, default = "$dbName-$currentTime.sqlite3"

customEncryptPassword

fun customEncryptPassword(encryptPassword: String): RoomBackup

Set custom backup encryption password

customLogTag

fun customLogTag(customLogTag: String): RoomBackup

Set custom log tag, for detailed debugging

customRestoreDialogTitle

fun customRestoreDialogTitle(customRestoreDialogTitle: String): RoomBackup

Set custom Restore Dialog Title, default = "Choose file to restore"

database

fun database(roomDatabase: RoomDatabase): RoomBackup

Set RoomDatabase instance

enableLogDebug

fun enableLogDebug(enableLogDebug: Boolean): RoomBackup

Set LogDebug enabled / disabled

maxFileCount

fun maxFileCount(maxFileCount: Int): RoomBackup

Set max backup files count if fileCount is maxFileCount the oldest backup file will be deleted is for both internal and external storage

onCompleteListener

fun onCompleteListener(onCompleteListener: OnCompleteListener): RoomBackup

fun onCompleteListener(listener: (success: Boolean, message: String, exitCode: Int) -> Unit): RoomBackup

Set onCompleteListener, to run code when tasks completed

restartApp

fun restartApp(restartIntent: Intent): RoomBackup

Set Intent in which to boot after App restart

restore

fun restore()

Start Restore process, and set onComplete Listener to success, if no error occurred, else onComplete Listener success is false and error message is passed