kotlin-components-docs/mozilla.appservices.search/SearchEngineDefinition

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.

Constructors

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

Types

Companion

object Companion

Properties

aliases

var aliases: List<String>

A list of aliases for this engine.

charset

var charset: String

The character set this engine uses for queries.

classification

var classification: SearchEngineClassification

The classification of search engine according to the main search types (e.g. general, shopping, travel, dictionary). Currently, only marking as a general search engine is supported. On Android, only general search engines may be selected as "default" search engines.

clickUrl

var clickUrl: String?

The url used for reporting clicks.

identifier

var identifier: String

The identifier of the search engine. This is used as an internal identifier, e.g. for saving the user's settings for the engine. It is also used to form the base telemetry id and may be extended by telemetrySuffix.

name

var name: String

The user visible name of the search engine.

optional

var optional: Boolean

This search engine is presented as an option that the user may enable. The application should not include these in the default list of the user's engines. If not supported, it should filter them out.

orderHint

var orderHint: UInt?

A hint to the order that this engine should be in the engine list. This is derived from the engineOrders section of the search configuration. The higher the number, the nearer to the front it should be. If the number is not specified, other methods of sorting may be relied upon (e.g. alphabetical).

partnerCode

var partnerCode: String

The partner code for the engine. This will be inserted into parameters which include {partnerCode}. May be the empty string.

telemetrySuffix

var telemetrySuffix: String

Optional suffix that is appended to the search engine identifier following a dash, i.e. <identifier>-<suffix>. If it is an empty string no dash should be appended.

urls

var urls: SearchEngineUrls

The URLs associated with the search engine.