search:search-client-api/com.tomtom.sdk.search.model.summary/AlongRouteSummary

AlongRouteSummary

data class AlongRouteSummary(val query: String, val queryTime: Duration, val numResults: Int, val offset: Int, val totalResults: Int)

The summary of an Along Route Search API call.

Important: This is a Public Preview API. It may be changed or removed at any time.

Parameters

query

The query that resulted in this response.

queryTime

The time it took to process the 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.

Constructors

AlongRouteSummary

fun AlongRouteSummary(query: String, queryTime: Duration, numResults: Int, offset: Int, totalResults: Int)

Properties

val numResults: Int

val offset: Int

val query: String

val queryTime: Duration

val totalResults: Int