sdk-search / com.tomtom.online.sdk.search.information / Summary

Summary

@PublicPreview("2021.06") data class Summary : Serializable

The summary of a Search API call.

Parameters

query - The query that resulted in this response.

queryType - The type of the query.

queryTime - The time it took to process this query.

numResults - The number of results returned in this batch.

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

totalResults - The total number of results.

fuzzyLevel - The fuzzy level in Fuzzy Search.

positionBias - The position used to bias the results.

Properties

fuzzyLevel

val fuzzyLevel: Int

The fuzzy level in Fuzzy Search.

numResults

val numResults: Int

The number of results returned in this batch.

offset

val offset: Int

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

positionBias

val positionBias: LatLng?

The position used to bias the results.

query

val query: String

The query that resulted in this response.

queryTime

val queryTime: Int

The time it took to process this query.

queryType

val queryType: String

The type of the query.

totalResults

val totalResults: Int

The total number of results.