sdk-search / com.tomtom.online.sdk.search.data.common / Summary

Summary

open class Summary : Serializable

The summary of a response to a Search request.

Constructors

<init>

Summary()

Empty constructor for the Summary.

Summary(query: String!, queryType: String!, queryTime: Int, numResults: Int, offset: Int, totalResults: Int, fuzzyLevel: Int, geoBias: LatLng!)

Default constructor for the Summary.

Properties

fuzzyLevel

var fuzzyLevel: Int

The fuzzy level in Fuzzy Search.

geoBias

var geoBias: LatLng!

The position used to bias the results.

numResults

var numResults: Int

The number of results returned in this batch.

offset

var offset: Int

The offset of the results in the collection of all results.

query

var query: String!

The query that resulted in this response.

queryTime

var queryTime: Int

The time it took to process this query.

queryType

var queryType: String!

The type of the query.

totalResults

var totalResults: Int

The total number of results.

Functions

getFuzzyLevel

open fun getFuzzyLevel(): Int

Returns the fuzzy level in Fuzzy Search.

getGeoBias

open fun getGeoBias(): LatLng!

Returns the position used to bias the results.

getNumResults

open fun getNumResults(): Int

Returns the number of results returned in this batch.

getOffset

open fun getOffset(): Int

Returns the offset of the results in the collection of all results.

getQuery

open fun getQuery(): String!

Returns the query that resulted in this response.

getQueryTime

open fun getQueryTime(): Int

Returns the time it took to process this query.

getQueryType

open fun getQueryType(): String!

Returns the type of the query.

getTotalResults

open fun getTotalResults(): Int

Returns the total number of results.

toString

open fun toString(): String