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

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.

Constructors

JsonEngineUrl

constructor(base: String?, method: JsonEngineMethod?, params: List<SearchUrlParam>?, searchTermParamName: String?)

Types

Companion

object Companion

Properties

base

var base: String?

The PrePath and FilePath of the URL. May include variables for engines which have a variable FilePath, e.g. {searchTerm} for when a search term is within the path of the url.

method

var method: JsonEngineMethod?

The HTTP method to use to send the request (GET or POST). If the engine definition has not specified the method, it defaults to GET.

params

var params: List<SearchUrlParam>?

The parameters for this URL.

searchTermParamName

var searchTermParamName: String?

The name of the query parameter for the search term. Automatically appended to the end of the query. This may be skipped if {searchTerm} is included in the base.