AutocompleteSummary

public class AutocompleteSummary

AutocompleteSummary provides information about an autocomplete request that was performed.

This class is part of the AutocompleteResponse definition. It contains the query phrase and geo-bias information.

Lifecycle

  • Creates an AutocompleteSummary instance to describe the execution of an autocomplete request.

    Declaration

    Swift

    required public init(query: String, geoBias: AutocompleteGeoBias? = nil)

    Parameters

    query

    The query phrase to be autocompleted.
    geoBias

    Defines the geographical area for the autocompletion request.

Public

  • The query passed to the autocomplete search.

    Declaration

    Swift

    public let query: String

  • Represents position and radius used by Search.autocomplete() to prioritize autocomplete results within the defined area.

    If geoBias is nil, the autocomplete results are not biased to any location.

    Declaration

    Swift

    public let geoBias: AutocompleteGeoBias?