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

PlacesConnectionInterface

interface PlacesConnectionInterface

Inheritors

PlacesConnection

Types

object Companion

Functions

abstract fun acceptResult(searchString: String, url: String)

url is a string and not a URL because accept_result handles malformed urls

applyObservation

abstract fun applyObservation(visit: VisitObservation)

bookmarksCountBookmarksInTrees

abstract fun bookmarksCountBookmarksInTrees(folderGuids: List<Guid>): UInt

Counts the number of bookmarks in the bookmark tree under the specified GUID. Does not count the passed item, so an empty folder will return zero, as will a non-existing GUID or the guid of a non-folder item. Counts only bookmark items - ie, sub-folders and separators are not counted.

bookmarksDelete

abstract fun bookmarksDelete(id: Guid): Boolean

bookmarksDeleteEverything

abstract fun bookmarksDeleteEverything()

bookmarksGetAllWithUrl

abstract fun bookmarksGetAllWithUrl(url: String): List<BookmarkItem>

bookmarksGetByGuid

abstract fun bookmarksGetByGuid(guid: Guid, getDirectChildren: Boolean): BookmarkItem?

bookmarksGetRecent

abstract fun bookmarksGetRecent(limit: Int): List<BookmarkItem>

bookmarksGetTree

abstract fun bookmarksGetTree(itemGuid: Guid): BookmarkItem?

bookmarksGetUrlForKeyword

abstract fun bookmarksGetUrlForKeyword(keyword: String): Url?

bookmarksInsert

abstract fun bookmarksInsert(bookmark: InsertableBookmarkItem): Guid

bookmarksSearch

abstract fun bookmarksSearch(query: String, limit: Int): List<BookmarkItem>

bookmarksUpdate

abstract fun bookmarksUpdate(data: BookmarkUpdateInfo)

deleteEverythingHistory

abstract fun deleteEverythingHistory()

abstract fun deleteVisit(url: String, timestamp: PlacesTimestamp)

deleteVisitsBetween

abstract fun deleteVisitsBetween(start: PlacesTimestamp, end: PlacesTimestamp)

deleteVisitsFor

abstract fun deleteVisitsFor(url: String)

getHistoryHighlights

abstract fun getHistoryHighlights(weights: HistoryHighlightWeights, limit: Int): List<HistoryHighlight>

getHistoryMetadataBetween

abstract fun getHistoryMetadataBetween(start: PlacesTimestamp, end: PlacesTimestamp): List<HistoryMetadata>

getHistoryMetadataSince

abstract fun getHistoryMetadataSince(since: PlacesTimestamp): List<HistoryMetadata>

getLatestHistoryMetadataForUrl

abstract fun getLatestHistoryMetadataForUrl(url: Url): HistoryMetadata?

getTopFrecentSiteInfos

abstract fun getTopFrecentSiteInfos(numItems: Int, thresholdOption: FrecencyThresholdOption): List<TopFrecentSiteInfo>

abstract fun getVisitCount(excludeTypes: VisitTransitionSet): Long

abstract fun getVisited(urls: List<String>): List<Boolean>

getVisitedUrlsInRange

abstract fun getVisitedUrlsInRange(start: PlacesTimestamp, end: PlacesTimestamp, includeRemote: Boolean): List<Url>

abstract fun getVisitInfos(startDate: PlacesTimestamp, endDate: PlacesTimestamp, excludeTypes: VisitTransitionSet): List<HistoryVisitInfo>

abstract fun getVisitPage(offset: Long, count: Long, excludeTypes: VisitTransitionSet): List<HistoryVisitInfo>

getVisitPageWithBound

abstract fun getVisitPageWithBound(bound: Long, offset: Long, count: Long, excludeTypes: VisitTransitionSet): HistoryVisitInfosWithBound

abstract fun matchUrl(query: String): Url?

abstract fun metadataDelete(url: Url, referrerUrl: Url?, searchTerm: String?)

metadataDeleteOlderThan

abstract fun metadataDeleteOlderThan(olderThan: PlacesTimestamp)

newInterruptHandle

abstract fun newInterruptHandle(): SqlInterruptHandle

noteHistoryMetadataObservation

abstract fun noteHistoryMetadataObservation(data: HistoryMetadataObservation, options: NoteHistoryMetadataObservationOptions)

placesHistoryImportFromIos

abstract fun placesHistoryImportFromIos(dbPath: String, lastSyncTimestamp: Long): HistoryMigrationResult

queryAutocomplete

abstract fun queryAutocomplete(search: String, limit: Int): List<SearchResult>

queryHistoryMetadata

abstract fun queryHistoryMetadata(query: String, limit: Int): List<HistoryMetadata>

runMaintenanceCheckpoint

abstract fun runMaintenanceCheckpoint()

Run maintenance on the places DB (checkpoint step)

runMaintenanceOptimize

abstract fun runMaintenanceOptimize()

Run maintenance on the places DB (optimize step)

runMaintenancePrune

abstract fun runMaintenancePrune(dbSizeLimit: UInt, pruneLimit: UInt): RunMaintenanceMetrics

Run maintenance on the places DB (prune step)

runMaintenanceVacuum

abstract fun runMaintenanceVacuum()

Run maintenance on the places DB (vacuum step)