android-components / mozilla.components.service.fxa / SyncEngine

SyncEngine

sealed class SyncEngine (source)

Describes possible sync engines that device can support.

Types

Name Summary
Bookmarks object Bookmarks : SyncEngine
A bookmarks engine.
History object History : SyncEngine
A history engine.
Other data class Other : SyncEngine
An engine that’s none of the above, described by name.
Passwords object Passwords : SyncEngine
A ‘logins/passwords’ engine. When using this engine, make sure to set an encryption key used to unlock the store as ‘passwords_key’ via SecureAbove22Preferences.

Properties

Name Summary
nativeName val nativeName: String
Internally, Rust SyncManager represents engines as strings. Forward-compatibility with new engines is one of the reasons for this. E.g. during any sync, an engine may appear that we do not know about. At the public API level, we expose a concrete SyncEngine type to allow for more robust integrations. We do not expose “unknown” engines via our public API, but do handle them internally (by persisting their enabled/disabled status).

Extension Functions

Name Summary
loadResourceAsString fun Any.loadResourceAsString(path: String): String
Loads a file from the resources folder and returns its content as a string object.

Inheritors

Name Summary
Bookmarks object Bookmarks : SyncEngine
A bookmarks engine.
History object History : SyncEngine
A history engine.
Other data class Other : SyncEngine
An engine that’s none of the above, described by name.
Passwords object Passwords : SyncEngine
A ‘logins/passwords’ engine. When using this engine, make sure to set an encryption key used to unlock the store as ‘passwords_key’ via SecureAbove22Preferences.