android-components / mozilla.components.service.sync.logins

Package mozilla.components.service.sync.logins

Types

Name Summary
AsyncLoginsStorage interface AsyncLoginsStorage : AutoCloseable
An interface equivalent to the LoginsStorage interface, but where operations are asynchronous.
AsyncLoginsStorageAdapter open class AsyncLoginsStorageAdapter<T : LoginsStorage> : AsyncLoginsStorage, AutoCloseable
A helper class to wrap a synchronous LoginsStorage implementation and make it asynchronous.
SyncableLoginsStore data class SyncableLoginsStore : SyncableStore
Wraps AsyncLoginsStorage instance along with a lazy encryption key.

Type Aliases

Name Summary
IdCollisionException typealias IdCollisionException = IdCollisionException
This is thrown if add() is given a record whose id is not blank, and collides with a record already known to the storage instance.
InvalidKeyException typealias InvalidKeyException = InvalidKeyException
This error is emitted in two cases:
InvalidRecordException typealias InvalidRecordException = InvalidRecordException
This is thrown on attempts to insert or update a record so that it is no longer valid, where “invalid” is defined as such:
LoginsStorageException typealias LoginsStorageException = LoginsStorageException
The base class of all errors emitted by logins storage.
MismatchedLockException typealias MismatchedLockException = MismatchedLockException
This is thrown if lock()/unlock() pairs don’t match up.
NoSuchRecordException typealias NoSuchRecordException = NoSuchRecordException
This is thrown if update() is performed with a record whose ID does not exist.
RequestFailedException typealias RequestFailedException = RequestFailedException
This error is emitted if a request to a sync server failed.
ServerPassword typealias ServerPassword = ServerPassword
Raw password data that is stored by the storage implementation.
SyncAuthInvalidException typealias SyncAuthInvalidException = SyncAuthInvalidException
This indicates that the authentication information (e.g. the SyncUnlockInfo) provided to AsyncLoginsStorage.sync is invalid. This often indicates that it’s stale and should be refreshed with FxA (however, care should be taken not to get into a loop refreshing this information).
SyncUnlockInfo typealias SyncUnlockInfo = SyncUnlockInfo
This type contains the set of information required to successfully connect to the server and sync.

Functions

Name Summary
into fun SyncAuthInfo.into(): SyncUnlockInfo
Conversion from a generic AuthInfo type into a type ‘logins’ lib uses at the interface boundary.