com.tomtom.sdk.search:structured-search/com.tomtom.sdk.search.structuredsearch.model/StructuredSearchCandidate

StructuredSearchCandidate

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.

Constructors

constructor(candidateType: CandidateType, place: Place, displayString: String, supplementaryString: String = "")

Properties

candidateType

val candidateType: CandidateType

The address level within the hierarchical type.

displayString

val displayString: String

The string representing the candidate and usually used to display to end user. The string depends on the language of StructuredSearch.createSearchSession. E.g. "Tokyo" in English, and "東京都" in Japanese.

place

val place: Place

The Place object associated with the candidate.

supplementaryString

val supplementaryString: String

The supplementary string is an alternative representation of the candidate, the string is not for displaying but maybe used to create interface elements such as buttons or selection tools. The context and usage depend on language and region, and could be empty if not applicable. E.g. the supplementary string is "トウキヨウ" (Tokyo written in Katakana) while the display string is "東京都" (Tokyo written in Kanji).