StructuredSearchCandidate

public struct StructuredSearchCandidate : Equatable

A single candidate item

Important

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

Public

  • The address level type.

    Declaration

    Swift

    public let candidateType: CandidateType

  • The Place object associated to it.

    Declaration

    Swift

    public let place: Place

  • The string representing the candidate and usually used to display to end user. The string depends on the language of [StructuredSearchApi.createSearchSession]. E.g. “Tokyo” in English, and “東京都” in Japanese.

    Declaration

    Swift

    public let displayString: 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).

    Declaration

    Swift

    public let supplementaryString: String