BackupDeviceAction

const val KEY_DB_NAME: String

Key specifying the SQLite database filename.

const val KEY_ERROR: String

Key containing the error message in BackupDeviceActionResult upon failure.

Present when KEY_STATUS is STATUS_FAILURE.

const val KEY_EXPECTED: String

Key specifying the expected value in verification.

const val KEY_EXPECTED_COL: String

Key specifying the column containing the expected value in SQL verification.

const val KEY_EXPECTED_VAL: String

Key specifying the expected column value in SQL verification.

Must be passed as a string representation of the expected column value (e.g., "true" or "false" for SQLite booleans, or string values).

const val KEY_EXPECT_NULL: String

Key specifying whether to assert that a preference or value is null.

Accepted values are "true" or "false". When "true", verification asserts that the preference key, column, or file does not exist.

const val KEY_IS_BINARY: String

Key specifying whether a file value is base64-encoded binary data.

Accepted values are "true" or "false". When "true", file contents are decoded using android.util.Base64.DEFAULT.

const val KEY_IS_DEVICE_PROTECTED: String

Key specifying whether device-protected storage context should be used.

When set to "true", operations target android.content.Context.createDeviceProtectedStorageContext instead of default credential-encrypted storage. Accepted values are "true" or "false".

const val KEY_KEY_COL: String

Key specifying the primary key column name in SQL query verification.

const val KEY_KEY_VAL: String

Key specifying the primary key column value to filter on in SQL verification.

const val KEY_PATH: String

Key specifying a relative or absolute file path.

const val KEY_PREF_KEY: String

Key specifying the SharedPreferences preference key.

const val KEY_PREF_NAME: String

Key specifying the SharedPreferences filename.

const val KEY_STATUS: String

Key indicating the execution status in BackupDeviceActionResult.

The returned value will be one of the status constants: STATUS_SUCCESS or STATUS_FAILURE. Since this key tracks non-binary, extensible status categories (e.g., which could include future warnings or partial success info), it is represented as a string rather than a simple boolean.

const val KEY_STORAGE_TYPE: String

Key specifying the target storage medium.

Must be set to one of the following storage type constants:

• STORAGE_TYPE_PREFS

• STORAGE_TYPE_DATABASE

• STORAGE_TYPE_FILES

const val KEY_TABLE: String

Key specifying the table name inside the SQLite database.

const val KEY_VALUE: String

Key specifying the value to write or verify.

const val KEY_VALUES: String

Key specifying query or insert key-value pairs formatted as an ampersand-separated string.

For example, "column1=value1&column2=value2".

const val KEY_VALUE_TYPE: String

Key specifying the primitive value type for SharedPreferences entries.

Must be one of "INT", "LONG", "BOOLEAN", "FLOAT", or "STRING".

const val PHASE_POPULATE = 1: Int

Seeds data inside the application sandbox before a backup.

const val PHASE_VERIFY = 2: Int

Verifies restored data inside the application sandbox after a restore.

const val STATUS_FAILURE: String

Status value indicating failed execution.

const val STATUS_SUCCESS: String

Status value indicating successful execution.

const val STORAGE_TYPE_DATABASE: String

Storage type value indicating SQLite database.

const val STORAGE_TYPE_FILES: String

Storage type value indicating raw file storage.

const val STORAGE_TYPE_PREFS: String

Storage type value indicating SharedPreferences.

fun execute(context: Context, args: BackupDeviceActionArgs): BackupDeviceActionResult

Runs the action payload.

val phase: Int

Lifecycle phase when this action runs.