kotlin-components-docs/mozilla.appservices.suggest

Package-level declarations

Types

interface Disposable

InternalException

class InternalException(message: String) : Exception

enum InterruptKind : Enum<InterruptKind>

What should be interrupted when SuggestStore::interrupt is called?

LabeledTimingSample

data class LabeledTimingSample(var label: String, var value: ULong)

Single sample for a Glean labeled_timing_distribution

QueryWithMetricsResult

data class QueryWithMetricsResult(var suggestions: List<Suggestion>, var queryTimes: List<LabeledTimingSample>)

SuggestApiException

sealed class SuggestApiException : Exception

The error type for all Suggest component operations. These errors are exposed to your application, which should handle them as needed.

SuggestGlobalConfig

data class SuggestGlobalConfig(var showLessFrequentlyCap: Int)

Global Suggest configuration data.

SuggestIngestionConstraints

data class SuggestIngestionConstraints(var providers: List<SuggestionProvider>? = null, var providerConstraints: SuggestionProviderConstraints? = null, var emptyOnly: Boolean = false)

Constraints limit which suggestions to ingest from Remote Settings.

SuggestIngestionMetrics

data class SuggestIngestionMetrics(var ingestionTimes: List<LabeledTimingSample>, var downloadTimes: List<LabeledTimingSample>)

Ingestion metrics

sealed class Suggestion

A suggestion from the database to show in the address bar.

SuggestionProvider

enum SuggestionProvider : Enum<SuggestionProvider>

A provider is a source of search suggestions.

SuggestionProviderConstraints

data class SuggestionProviderConstraints(var exposureSuggestionTypes: List<String>? = null)

Some providers manage multiple suggestion subtypes. Queries, ingests, and other operations on those providers must be constrained to a desired subtype.

SuggestionQuery

data class SuggestionQuery(var keyword: String, var providers: List<SuggestionProvider>, var providerConstraints: SuggestionProviderConstraints? = null, var limit: Int? = null)

A query for suggestions to show in the address bar.

SuggestProviderConfig

sealed class SuggestProviderConfig

Per-provider configuration data.

open class SuggestStore : Disposable, AutoCloseable, SuggestStoreInterface

The store is the entry point to the Suggest component. It incrementally downloads suggestions from the Remote Settings service, stores them in a local database, and returns them in response to user queries.

SuggestStoreBuilder

open class SuggestStoreBuilder : Disposable, AutoCloseable, SuggestStoreBuilderInterface

Builder for SuggestStore

SuggestStoreBuilderInterface

interface SuggestStoreBuilderInterface

Builder for SuggestStore

SuggestStoreInterface

interface SuggestStoreInterface

The store is the entry point to the Suggest component. It incrementally downloads suggestions from the Remote Settings service, stores them in a local database, and returns them in response to user queries.

Functions

rawSuggestionUrlMatches

fun rawSuggestionUrlMatches(rawUrl: String, cookedUrl: String): Boolean

Determines whether a "raw" sponsored suggestion URL is equivalent to a "cooked" URL. The two URLs are equivalent if they are identical except for their replaced template parameters, which can be different.