kotlin-components-docs/mozilla.appservices.places.uniffi

Package-level declarations

Types

data class BookmarkData( var guid: Guid, var parentGuid: Guid, var position: UInt, var dateAdded: PlacesTimestamp, var lastModified: PlacesTimestamp, var url: Url, var title: String?)

BookmarkFolder

data class BookmarkFolder( var guid: Guid, var dateAdded: PlacesTimestamp, var lastModified: PlacesTimestamp, var parentGuid: Guid?, var position: UInt, var title: String?, var childGuids: List<Guid>?, var childNodes: List<BookmarkItem>?)

BookmarkItem

sealed class BookmarkItem

BookmarkPosition

sealed class BookmarkPosition

Where the item should be placed.

BookmarkSeparator

data class BookmarkSeparator( var guid: Guid, var dateAdded: PlacesTimestamp, var lastModified: PlacesTimestamp, var parentGuid: Guid, var position: UInt)

BookmarkUpdateInfo

data class BookmarkUpdateInfo(var guid: Guid, var title: String?, var url: String?, var parentGuid: Guid?, var position: UInt?)

ConnectionType

enum ConnectionType : Enum<ConnectionType>

Disposable

interface Disposable

DocumentType

enum DocumentType : Enum<DocumentType>

Dummy

data class Dummy(var md: List<HistoryMetadata>?)

Exists just to convince uniffi to generate liftSequence* helpers!

FfiConverterTypeGuid

typealias FfiConverterTypeGuid = FfiConverterString

FfiConverterTypePlacesTimestamp

typealias FfiConverterTypePlacesTimestamp = FfiConverterLong

FfiConverterTypeUrl

typealias FfiConverterTypeUrl = FfiConverterString

FfiConverterTypeVisitTransitionSet

typealias FfiConverterTypeVisitTransitionSet = FfiConverterInt

FrecencyThresholdOption

enum FrecencyThresholdOption : Enum<FrecencyThresholdOption>

Frecency threshold options for fetching top frecent sites. Requests a page that was visited with a frecency score greater or equal to the value associated with the enums

Guid

typealias Guid = String

Typealias from the type name used in the UDL file to the builtin type. This is needed because the UDL type name is used in function/method signatures. It's also what we have an external type that references a custom type.

HistoryHighlight

data class HistoryHighlight(var score: Double, var placeId: Int, var url: String, var title: String?, var previewImageUrl: String?)

HistoryHighlightWeights

data class HistoryHighlightWeights(var viewTime: Double, var frequency: Double)

HistoryMetadata

data class HistoryMetadata( var url: String, var title: String?, var previewImageUrl: String?, var createdAt: Long, var updatedAt: Long, var totalViewTime: Int, var searchTerm: String?, var documentType: DocumentType, var referrerUrl: String?)

This is what is returned.

HistoryMetadataObservation

data class HistoryMetadataObservation( var url: String, var referrerUrl: String? = null, var searchTerm: String? = null, var viewTime: Int? = null, var documentType: DocumentType? = null, var title: String? = null)

This is used as an "input" to the api.

HistoryMetadataPageMissingBehavior

enum HistoryMetadataPageMissingBehavior : Enum<HistoryMetadataPageMissingBehavior>

The action to take when recording a history metadata observation for a page that doesn't have an entry in the history database.

HistoryMigrationResult

data class HistoryMigrationResult(var numTotal: UInt, var numSucceeded: UInt, var numFailed: UInt, var totalDuration: ULong)

HistoryVisitInfo

data class HistoryVisitInfo( var url: Url, var title: String?, var timestamp: PlacesTimestamp, var visitType: VisitType, var isHidden: Boolean, var previewImageUrl: Url?, var isRemote: Boolean)

HistoryVisitInfosWithBound

data class HistoryVisitInfosWithBound(var infos: List<HistoryVisitInfo>, var bound: Long, var offset: Long)

InsertableBookmark

data class InsertableBookmark( var guid: Guid? = null, var parentGuid: Guid, var position: BookmarkPosition, var dateAdded: PlacesTimestamp? = null, var lastModified: PlacesTimestamp? = null, var url: Url, var title: String? = null)

InsertableBookmarkFolder

data class InsertableBookmarkFolder( var guid: Guid? = null, var parentGuid: Guid, var position: BookmarkPosition, var dateAdded: PlacesTimestamp? = null, var lastModified: PlacesTimestamp? = null, var title: String? = null, var children: List<InsertableBookmarkItem>)

InsertableBookmarkItem

sealed class InsertableBookmarkItem

InsertableBookmarkSeparator

data class InsertableBookmarkSeparator( var guid: Guid? = null, var parentGuid: Guid, var position: BookmarkPosition, var dateAdded: PlacesTimestamp? = null, var lastModified: PlacesTimestamp? = null)

InternalException

class InternalException(message: String) : Exception

NoteHistoryMetadataObservationOptions

data class NoteHistoryMetadataObservationOptions( var ifPageMissing: HistoryMetadataPageMissingBehavior = HistoryMetadataPageMissingBehavior.IGNORE_OBSERVATION)

Options for recording history metadata observations.

PlacesApi

open class PlacesApi : Disposable, AutoCloseable, PlacesApiInterface

PlacesApiException

sealed class PlacesApiException : Exception

PlacesApiInterface

interface PlacesApiInterface

PlacesConnection

open class PlacesConnection : Disposable, AutoCloseable, PlacesConnectionInterface

PlacesConnectionInterface

interface PlacesConnectionInterface

PlacesTimestamp

typealias PlacesTimestamp = Long

RunMaintenanceMetrics

data class RunMaintenanceMetrics(var prunedVisits: Boolean, var dbSizeBefore: UInt, var dbSizeAfter: UInt)

SearchResult

data class SearchResult(var url: Url, var title: String, var frecency: Long)

SqlInterruptHandle

open class SqlInterruptHandle : Disposable, AutoCloseable, SqlInterruptHandleInterface

SqlInterruptHandleInterface

interface SqlInterruptHandleInterface

TopFrecentSiteInfo

data class TopFrecentSiteInfo(var url: Url, var title: String?)

Url

typealias Url = String

VisitObservation

data class VisitObservation( var url: Url, var title: String? = null, var visitType: VisitType?, var isError: Boolean? = null, var isRedirectSource: Boolean? = null, var isPermanentRedirectSource: Boolean? = null, var at: PlacesTimestamp? = null, var referrer: Url? = null, var isRemote: Boolean? = null, var previewImageUrl: Url? = null)

Encapsulates either information about a visit to a page, or meta information about the page, or both. Use VisitType.UPDATE_PLACE to differentiate an update from a visit.

VisitTransitionSet

typealias VisitTransitionSet = Int

VisitType

enum VisitType : Enum<VisitType>

Functions

placesApiNew

fun placesApiNew(dbPath: String): PlacesApi