kotlin-components-docs/mozilla.appservices.suggest

Package-level declarations

Types

AlternateNames

data class AlternateNames(var primary: String, var localized: String?, var abbreviation: String?)

A set of names for a single entity.

AmpMatchingStrategy

enum AmpMatchingStrategy : Enum<AmpMatchingStrategy>

Disposable

interface Disposable

FfiConverterTypeJsonValue

typealias FfiConverterTypeJsonValue = FfiConverterString

FtsMatchInfo

data class FtsMatchInfo(var prefix: Boolean, var stemming: Boolean)

Additional data about how an FTS match was made

Geoname

data class Geoname(var geonameId: Long, var geonameType: GeonameType, var name: String, var countryCode: String, var featureClass: String, var featureCode: String, var adminDivisionCodes: Map<UByte, String>, var population: ULong, var latitude: String, var longitude: String)

A single geographic place.

GeonameAlternates

data class GeonameAlternates(var geoname: AlternateNames, var country: AlternateNames?, var adminDivisions: Map<UByte, AlternateNames>)

Alternate names for a geoname and its country and admin divisions.

GeonameMatch

data class GeonameMatch(var geoname: Geoname, var matchType: GeonameMatchType, var prefix: Boolean)

A fetched geoname with info on how it was matched.

GeonameMatchType

enum GeonameMatchType : Enum<GeonameMatchType>

GeonameType

sealed class GeonameType

The type of a geoname.

InternalException

class InternalException(message: String) : Exception

InterruptKind

enum InterruptKind : Enum<InterruptKind>

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

JsonValue

typealias JsonValue = 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.

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

Suggestion

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. Please preserve the integer values after removing or adding providers. Provider configs are associated with integer keys stored in the database.

SuggestionProviderConstraints

data class SuggestionProviderConstraints(var dynamicSuggestionTypes: List<String>? = null, var ampAlternativeMatching: AmpMatchingStrategy? = 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.

SuggestStore

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

YelpSubjectType

enum YelpSubjectType : Enum<YelpSubjectType>

Subject type for Yelp suggestion.

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.