StorageDomain

Artifact: androidx.test.backup:backup-host

View Source

Added in 1.0.0-alpha04

---

Kotlin |Java

sealed class StorageDomain

Known direct subclasses

StorageDomain.BinaryFile, StorageDomain.CustomData, StorageDomain.DataStorePreference, StorageDomain.Database, StorageDomain.ExcludedData, StorageDomain.Preference, StorageDomain.TextFile

StorageDomain.BinaryFile	Targets local raw binary files stored within internal app storage.
StorageDomain.CustomData	Targets data that device actions of your own seed and verify, such as a restore credential that only the app's code can create and read.
StorageDomain.DataStorePreference	Targets a preference of an on-device Preferences DataStore.
StorageDomain.Database	Targets structured SQLite/Room database records.
StorageDomain.ExcludedData	Targets data that the restore doesn't bring back, such as data that the app's backup rules exclude.
StorageDomain.Preference	Targets on-device SharedPreferences XML files.
StorageDomain.TextFile	Targets local raw text files stored within internal app storage.

---

Defines target data coordinates in the device sandbox that are seeded and verified.

Provides strongly-typed, compile-time safe data structures for zero-boilerplate testing. The framework uses these to automatically drive the bundled storage actions, or the actions of a CustomData.

Note: This sealed class is open to future additions. Consumers should use a non-exhaustive 'when' pattern-matching approach (incorporating an explicit 'else' branch) to ensure binary compatibility when new subclasses are introduced.

Summary

Nested types
class StorageDomain.BinaryFile : StorageDomain Targets local raw binary files stored within internal app storage.
class StorageDomain.CustomData : StorageDomain Targets data that device actions of your own seed and verify, such as a restore credential that only the app's code can create and read.
class StorageDomain.DataStorePreference : StorageDomain Targets a preference of an on-device Preferences DataStore.
class StorageDomain.Database : StorageDomain Targets structured SQLite/Room database records.
class StorageDomain.ExcludedData : StorageDomain Targets data that the restore doesn't bring back, such as data that the app's backup rules exclude.
class StorageDomain.Preference : StorageDomain Targets on-device SharedPreferences XML files.
class StorageDomain.TextFile : StorageDomain Targets local raw text files stored within internal app storage.

Protected constructors
StorageDomain()

Protected constructors

StorageDomain

protected StorageDomain()