kotlin-components-docs/mozilla.appservices.autofill

Package-level declarations

Types

data class Address(var guid: String, var name: String, var organization: String, var streetAddress: String, var addressLevel3: String, var addressLevel2: String, var addressLevel1: String, var postalCode: String, var country: String, var tel: String, var email: String, var timeCreated: Long, var timeLastUsed: Long?, var timeLastModified: Long, var timesUsed: Long)

What you get back as an address.

AddressBulkResultEntry

sealed class AddressBulkResultEntry

A bulk insert result entry, returned per input record by add_many_addresses_with_meta

AddressBulkTombstoneResultEntry

sealed class AddressBulkTombstoneResultEntry

Per-record result of add_many_address_tombstones.

AddressesBridgedEngine

open class AddressesBridgedEngine : Disposable, AutoCloseable, AddressesBridgedEngineInterface

The bridged sync engine for addresses. The canonical docs are in services/interfaces/mozIBridgedSyncEngine.idl. NOTE: all timestamps here are milliseconds.

AddressesBridgedEngineInterface

interface AddressesBridgedEngineInterface

The bridged sync engine for addresses. The canonical docs are in services/interfaces/mozIBridgedSyncEngine.idl. NOTE: all timestamps here are milliseconds.

AddressMeta

data class AddressMeta(var guid: String, var timeCreated: Long, var timeLastUsed: Long?, var timeLastModified: Long, var timesUsed: Long, var syncChangeCounter: Long)

Metadata fields managed internally by the library: the guid, timestamps and local sync state. These are automatically set on add_address and updated on operations like touch and update_address. Not included in UpdatableAddressFields; use add_address_with_meta when importing records that already have metadata.

AddressTombstone

data class AddressTombstone(var guid: String, var timeDeleted: Long)

A tombstone for a record deleted locally but not yet uploaded, supplied to add_many_address_tombstones when migrating from another store.

AutofillApiException

sealed class AutofillApiException : Exception

CreditCard

data class CreditCard(var guid: String, var ccName: String, var ccNumberEnc: String, var ccNumberLast4: String, var ccExpMonth: Long, var ccExpYear: Long, var ccType: String, var timeCreated: Long, var timeLastUsed: Long?, var timeLastModified: Long, var timesUsed: Long)

What you get back as a credit-card.

CreditCardsDeletionMetrics

data class CreditCardsDeletionMetrics(var totalScrubbedRecords: ULong)

Metrics tracking scrubbing of credit cards that cannot be decrypted, see

Disposable

interface Disposable

InternalException

class InternalException(message: String) : Exception

Passport

data class Passport(var guid: String, var name: String, var country: String, var passportNumber: String, var issueDateMonth: Long, var issueDateDay: Long, var issueDateYear: Long, var expiryDateMonth: Long, var expiryDateDay: Long, var expiryDateYear: Long, var timeCreated: Long, var timeLastUsed: Long?, var timeLastModified: Long, var timesUsed: Long)

What you get back as a passport.

Store

open class Store : Disposable, AutoCloseable, StoreInterface

StoreInterface

interface StoreInterface

UpdatableAddressFields

data class UpdatableAddressFields(var name: String, var organization: String, var streetAddress: String, var addressLevel3: String, var addressLevel2: String, var addressLevel1: String, var postalCode: String, var country: String, var tel: String, var email: String)

What you pass to create or update an address.

UpdatableAddressFieldsWithMeta

data class UpdatableAddressFieldsWithMeta(var fields: UpdatableAddressFields, var meta: AddressMeta)

An address together with its metadata, passed to add_address_with_meta and update_address_with_meta when importing a record from another store.

UpdatableCreditCardFields

data class UpdatableCreditCardFields(var ccName: String, var ccNumberEnc: String, var ccNumberLast4: String, var ccExpMonth: Long, var ccExpYear: Long, var ccType: String)

What you pass to create or update a credit-card.

UpdatablePassportFields

data class UpdatablePassportFields(var name: String, var country: String, var passportNumber: String, var issueDateMonth: Long, var issueDateDay: Long, var issueDateYear: Long, var expiryDateMonth: Long, var expiryDateDay: Long, var expiryDateYear: Long)

What you pass to create or update a passport.

Functions

createAutofillKey

fun createAutofillKey(): String

Create a new, random, encryption key.

decryptString

fun decryptString(key: String, ciphertext: String): String

Decrypt an arbitrary string - key must have come from create_key() and ciphertext must have come from encrypt_string()

encryptString

fun encryptString(key: String, cleartext: String): String

Encrypt an arbitrary string - key must have come from create_key()