PlacesConnection Class Reference


                    
                    
                    init(unsafeFromRawPointer:)

Declaration

Swift

required public init(unsafeFromRawPointer pointer: UnsafeMutableRawPointer)


                    
                    
                    acceptResult(searchString:url:)

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

Declaration

Swift

open func acceptResult(searchString: String, url: String) throws


                    
                    
                    applyObservation(visit:)

Declaration

Swift

open func applyObservation(visit: VisitObservation) throws


                    
                    
                    bookmarksCountBookmarksInTrees(folderGuids:)

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.

Declaration

Swift

open func bookmarksCountBookmarksInTrees(folderGuids: [Guid]) throws -> UInt32


                    
                    
                    bookmarksDelete(id:)

Declaration

Swift

open func bookmarksDelete(id: Guid) throws -> Bool


                    
                    
                    bookmarksDeleteEverything()

Declaration

Swift

open func bookmarksDeleteEverything() throws


                    
                    
                    bookmarksGetAllWithUrl(url:)

Declaration

Swift

open func bookmarksGetAllWithUrl(url: String) throws -> [BookmarkItem]


                    
                    
                    bookmarksGetByGuid(guid:getDirectChildren:)

Declaration

Swift

open func bookmarksGetByGuid(guid: Guid, getDirectChildren: Bool) throws -> BookmarkItem?


                    
                    
                    bookmarksGetRecent(limit:)

Declaration

Swift

open func bookmarksGetRecent(limit: Int32) throws -> [BookmarkItem]


                    
                    
                    bookmarksGetTree(itemGuid:)

Declaration

Swift

open func bookmarksGetTree(itemGuid: Guid) throws -> BookmarkItem?


                    
                    
                    bookmarksGetUrlForKeyword(keyword:)

Declaration

Swift

open func bookmarksGetUrlForKeyword(keyword: String) throws -> Url?


                    
                    
                    bookmarksInsert(bookmark:)

Declaration

Swift

open func bookmarksInsert(bookmark: InsertableBookmarkItem) throws -> Guid


                    
                    
                    bookmarksSearch(query:limit:)

Declaration

Swift

open func bookmarksSearch(query: String, limit: Int32) throws -> [BookmarkItem]


                    
                    
                    bookmarksUpdate(data:)

Declaration

Swift

open func bookmarksUpdate(data: BookmarkUpdateInfo) throws


                    
                    
                    deleteEverythingHistory()

Declaration

Swift

open func deleteEverythingHistory() throws


                    
                    
                    deleteVisit(url:timestamp:)

Declaration

Swift

open func deleteVisit(url: String, timestamp: PlacesTimestamp) throws


                    
                    
                    deleteVisitsBetween(start:end:)

Declaration

Swift

open func deleteVisitsBetween(start: PlacesTimestamp, end: PlacesTimestamp) throws


                    
                    
                    deleteVisitsFor(url:)

Declaration

Swift

open func deleteVisitsFor(url: String) throws


                    
                    
                    getHistoryHighlights(weights:limit:)

Declaration

Swift

open func getHistoryHighlights(weights: HistoryHighlightWeights, limit: Int32) throws -> [HistoryHighlight]


                    
                    
                    getHistoryMetadataBetween(start:end:)

Declaration

Swift

open func getHistoryMetadataBetween(start: PlacesTimestamp, end: PlacesTimestamp) throws -> [HistoryMetadata]


                    
                    
                    getHistoryMetadataSince(since:)

Declaration

Swift

open func getHistoryMetadataSince(since: PlacesTimestamp) throws -> [HistoryMetadata]


                    
                    
                    getLatestHistoryMetadataForUrl(url:)

Declaration

Swift

open func getLatestHistoryMetadataForUrl(url: Url) throws -> HistoryMetadata?


                    
                    
                    getTopFrecentSiteInfos(numItems:thresholdOption:)

Declaration

Swift

open func getTopFrecentSiteInfos(numItems: Int32, thresholdOption: FrecencyThresholdOption) throws -> [TopFrecentSiteInfo]


                    
                    
                    getVisitCount(excludeTypes:)

Declaration

Swift

open func getVisitCount(excludeTypes: VisitTransitionSet) throws -> Int64


                    
                    
                    getVisitInfos(startDate:endDate:excludeTypes:)

Declaration

Swift

open func getVisitInfos(startDate: PlacesTimestamp, endDate: PlacesTimestamp, excludeTypes: VisitTransitionSet) throws -> [HistoryVisitInfo]


                    
                    
                    getVisitPage(offset:count:excludeTypes:)

Declaration

Swift

open func getVisitPage(offset: Int64, count: Int64, excludeTypes: VisitTransitionSet) throws -> [HistoryVisitInfo]


                    
                    
                    getVisitPageWithBound(bound:offset:count:excludeTypes:)

Declaration

Swift

open func getVisitPageWithBound(bound: Int64, offset: Int64, count: Int64, excludeTypes: VisitTransitionSet) throws -> HistoryVisitInfosWithBound


                    
                    
                    getVisited(urls:)

Declaration

Swift

open func getVisited(urls: [String]) throws -> [Bool]


                    
                    
                    getVisitedUrlsInRange(start:end:includeRemote:)

Declaration

Swift

open func getVisitedUrlsInRange(start: PlacesTimestamp, end: PlacesTimestamp, includeRemote: Bool) throws -> [Url]


                    
                    
                    matchUrl(query:)

Declaration

Swift

open func matchUrl(query: String) throws -> Url?


                    
                    
                    metadataDelete(url:referrerUrl:searchTerm:)

Declaration

Swift

open func metadataDelete(url: Url, referrerUrl: Url?, searchTerm: String?) throws


                    
                    
                    metadataDeleteOlderThan(olderThan:)

Declaration

Swift

open func metadataDeleteOlderThan(olderThan: PlacesTimestamp) throws


                    
                    
                    newInterruptHandle()

Declaration

Swift

open func newInterruptHandle() -> SqlInterruptHandle


                    
                    
                    noteHistoryMetadataObservation(data:)

Declaration

Swift

open func noteHistoryMetadataObservation(data: HistoryMetadataObservation) throws


                    
                    
                    placesHistoryImportFromIos(dbPath:lastSyncTimestamp:)

Declaration

Swift

open func placesHistoryImportFromIos(dbPath: String, lastSyncTimestamp: Int64) throws -> HistoryMigrationResult


                    
                    
                    queryAutocomplete(search:limit:)

Declaration

Swift

open func queryAutocomplete(search: String, limit: Int32) throws -> [SearchResult]


                    
                    
                    queryHistoryMetadata(query:limit:)

Declaration

Swift

open func queryHistoryMetadata(query: String, limit: Int32) throws -> [HistoryMetadata]


                    
                    
                    runMaintenanceCheckpoint()

Run maintenance on the places DB (checkpoint step)

The run_maintenance_*() functions are intended to be run during idle time and will take steps to clean up / shrink the database. They’re split up so that we can time each one in the Kotlin wrapper code (This is needed because we only have access to the Glean API in Kotlin and it supports a stop-watch style API, not recording specific values).

Declaration

Swift

open func runMaintenanceCheckpoint() throws


                    
                    
                    runMaintenanceOptimize()

Run maintenance on the places DB (optimize step)

The run_maintenance_*() functions are intended to be run during idle time and will take steps to clean up / shrink the database. They’re split up so that we can time each one in the Kotlin wrapper code (This is needed because we only have access to the Glean API in Kotlin and it supports a stop-watch style API, not recording specific values).

Declaration

Swift

open func runMaintenanceOptimize() throws


                    
                    
                    runMaintenancePrune(dbSizeLimit:pruneLimit:)

Run maintenance on the places DB (prune step)

The run_maintenance_*() functions are intended to be run during idle time and will take steps to clean up / shrink the database. They’re split up so that we can time each one in the Kotlin wrapper code (This is needed because we only have access to the Glean API in Kotlin and it supports a stop-watch style API, not recording specific values).

db_size_limit is the approximate storage limit in bytes. If the database is using more space than this, some older visits will be deleted to free up space. Pass in a 0 to skip this.

prune_limit is the maximum number of visits to prune if the database is over db_size_limit

Declaration

Swift

open func runMaintenancePrune(dbSizeLimit: UInt32, pruneLimit: UInt32) throws -> RunMaintenanceMetrics


                    
                    
                    runMaintenanceVacuum()

Run maintenance on the places DB (vacuum step)

The run_maintenance_*() functions are intended to be run during idle time and will take steps to clean up / shrink the database. They’re split up so that we can time each one in the Kotlin wrapper code (This is needed because we only have access to the Glean API in Kotlin and it supports a stop-watch style API, not recording specific values).

Declaration

Swift

open func runMaintenanceVacuum() throws