kotlin-components-docs/mozilla.appservices.search

Package-level declarations

Types

Disposable

interface Disposable

InternalException

class InternalException(message: String) : Exception

JsonEngineMethod

enum JsonEngineMethod : Enum<JsonEngineMethod>

The list of possible submission methods for search engine urls.

JsonEngineUrl

data class JsonEngineUrl( var base: String?, var method: JsonEngineMethod?, var params: List<SearchUrlParam>?, var searchTermParamName: String?)

Defines an individual search engine URL. This is defined separately to types::SearchEngineUrl as various fields may be optional in the supplied configuration.

JsonEngineUrls

data class JsonEngineUrls(var search: JsonEngineUrl?, var suggestions: JsonEngineUrl?, var trending: JsonEngineUrl?, var searchForm: JsonEngineUrl?)

Reflects types::SearchEngineUrls, but using EngineUrl.

RefinedSearchConfig

data class RefinedSearchConfig(var engines: List<SearchEngineDefinition>, var appDefaultEngineId: String?, var appPrivateDefaultEngineId: String?)

Details of the search engines to display to the user, generated as a result of processing the search configuration.

SearchApiException

sealed class SearchApiException : Exception

SearchApplicationName

enum SearchApplicationName : Enum<SearchApplicationName>

The list of possible application names that are currently supported.

SearchDeviceType

enum SearchDeviceType : Enum<SearchDeviceType>

SearchEngineClassification

enum SearchEngineClassification : Enum<SearchEngineClassification>

The list of acceptable classifications for a search engine.

SearchEngineDefinition

data class SearchEngineDefinition( var aliases: List<String>, var charset: String, var classification: SearchEngineClassification, var identifier: String, var name: String, var optional: Boolean, var partnerCode: String, var telemetrySuffix: String, var urls: SearchEngineUrls, var orderHint: UInt?, var clickUrl: String?)

A definition for an individual search engine to be presented to the user.

SearchEngineSelector

open class SearchEngineSelector : Disposable, AutoCloseable, SearchEngineSelectorInterface

SearchEngineSelector parses the JSON configuration for search engines and returns the applicable engines depending on their region + locale.

SearchEngineSelectorInterface

interface SearchEngineSelectorInterface

SearchEngineSelector parses the JSON configuration for search engines and returns the applicable engines depending on their region + locale.

SearchEngineUrl

data class SearchEngineUrl(var base: String, var method: String, var params: List<SearchUrlParam>, var searchTermParamName: String?)

Defines an individual search engine URL.

SearchEngineUrls

data class SearchEngineUrls( var search: SearchEngineUrl, var suggestions: SearchEngineUrl?, var trending: SearchEngineUrl?, var searchForm: SearchEngineUrl?)

The URLs associated with the search engine.

SearchUpdateChannel

enum SearchUpdateChannel : Enum<SearchUpdateChannel>

The list of possible update channels for a user's build. Use default for a self-build or an unknown channel.

SearchUrlParam

data class SearchUrlParam(var name: String, var value: String?, var enterpriseValue: String?, var experimentConfig: String?)

Parameter definitions for search engine URLs. The name property is always specified, along with one of value, experiment_config or search_access_point.

SearchUserEnvironment

data class SearchUserEnvironment( var locale: String, var region: String, var updateChannel: SearchUpdateChannel, var distributionId: String, var experiment: String, var appName: SearchApplicationName, var version: String, var deviceType: SearchDeviceType)

The user's environment that is used for filtering the search configuration.