com.tomtom.sdk.search:search-common/com.tomtom.sdk.search.structuredsearch.model

Package-level declarations

Includes the Structured Search related models, applicable in the implementation of the Structured Search provider.

Types

Link copied to clipboard
@JvmInline
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
value class CandidateType

CandidateType represents the address level type for each StructuredSearchCandidate.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
data class StructuredSearchCandidate(val candidateType: CandidateType, val place: Place, val displayString: String, val supplementaryString: String = "")

Class represents a step in the structured search process or the final destination. A user proceeds with structured search using StructuredSearchSession by selecting next candidate.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
interface StructuredSearchSession : AutoCloseable

A session represents the current state of the structured search process.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
data class StructuredSearchState(val selectedCandidates: List<StructuredSearchCandidate>, val availableCandidates: List<StructuredSearchCandidate>)

Represents current state of StructuredSearchSession during the structured (hierarchical) search. StructuredSearchState is provided by the search session until the search reaches the destination.