FindAutocompletePredictionsRequest.Builder

public abstract @Nullable CancellationToken getCancellationToken()

Gets the CancellationToken used by PlacesClient to cancel any queued requests.

public abstract List<String> getCountries()

Gets the list of countries that restrict the location of the results.

See setCountries for details.

public abstract @Nullable Integer getInputOffset()

Gets the zero-based Unicode character offset indicating the cursor position in the query.

public abstract @Nullable LocationBias getLocationBias()

Gets the location bias applied for autocomplete predictions. See setLocationBias for details.

public abstract @Nullable LocationRestriction getLocationRestriction()

Gets the location restriction applied for autocomplete predictions. See setLocationRestriction for details.

public abstract @Nullable LatLng getOrigin()

Gets the location where getDistanceMeters is calculated from. If null, no distances will be included in the response.

public abstract @Nullable String getQuery()

Gets the user query string used to generate autocomplete predictions. If null or empty, no predictions will be included in the response.

public abstract @Nullable String getRegionCode()

Gets the region code specified as a CLDR two-character region code.

Specified as a CLDR two-character region code. This affects address formatting, result ranking, and may influence what results are returned.

This does not restrict results to the specified region. To restrict results to a region use countries or LocationRestriction

public abstract @Nullable AutocompleteSessionToken getSessionToken()

Gets the AutocompleteSessionToken for this request.

public abstract @Nullable TypeFilter getTypeFilter()

Gets the filter that restricts the type of the results included in the response.

Possible values:

• ADDRESS
• CITIES
• ESTABLISHMENT
• GEOCODE
• REGIONS

public abstract List<String> getTypesFilter()

Gets the filter that restricts the type(s) of results returned from the response.

If you enable Places API then a comprehensive list of the supported types can be found in com.google.android.libraries.places.api.model.PlaceTypes. The type collections specified in table 3 must be passed in as solo entries and cannot be combined with any other entries from table 1 or 2.

If you enable Places API (New), then types passed here are treated as primary types.

public abstract FindAutocompletePredictionsRequest.Builder setCancellationToken(@Nullable CancellationToken cancellationToken)

Sets the CancellationToken used by PlacesClient to cancel any queued requests.

public FindAutocompletePredictionsRequest.Builder setCountries(String[] countries)

See setCountries.

public abstract FindAutocompletePredictionsRequest.Builder setCountries(List<String> countries)

Sets the list of countries that restrict the location of the results.

This must be a list of ISO 3166-1 Alpha-2 country codes (case insensitive). If empty, country restrictions will not be applied.

This will override values set with setCountry.

Up to five countries are supported. See the components parameter here.

public FindAutocompletePredictionsRequest.Builder setCountry(@Nullable String countryCode)

See setCountries for details.

This will override countries set with setCountries.

public abstract FindAutocompletePredictionsRequest.Builder setInputOffset(@Nullable Integer inputOffset)

Sets the zero-based Unicode character offset indicating the cursor position in the query.

public abstract FindAutocompletePredictionsRequest.Builder setLocationBias(@Nullable LocationBias locationBias)

Sets the location bias applied for autocomplete predictions. If null, location biases will not be applied.

Note: the autocomplete predictions will not necessarily be within the location specified. To enforce a restriction, use setLocationRestriction. You may not set both LocationBias and LocationRestriction simultaneously.

The supported LocationBias type is based on which API version you are using.

If you enable Places API (New), then both and are supported.

If you enable Places API, then only is supported.

public abstract FindAutocompletePredictionsRequest.Builder setLocationRestriction(
    @Nullable LocationRestriction locationRestriction
)

Sets the location restriction applied for autocomplete predictions. If null, location restrictions will not be applied.

To impose a location bias instead, use setLocationBias. You may not set both LocationBias and LocationRestriction simultaneously.

The supported LocationRestriction type is based on which API version you are using.

If you enable Places API (New), then both and are supported.

If you enable Places API, then only is supported.

public abstract FindAutocompletePredictionsRequest.Builder setOrigin(@Nullable LatLng origin)

Sets the location where getDistanceMeters is calculated from. If null, no distances will be included in the response.

public abstract FindAutocompletePredictionsRequest.Builder setQuery(@Nullable String query)

Sets the user query string used to generate autocomplete predictions. If null or empty, no predictions will be included in the response.

public abstract FindAutocompletePredictionsRequest.Builder setRegionCode(@Nullable String regionCode)

Sets the region code specified as a CLDR two-character region code.

Specified as a CLDR two-character region code. This affects address formatting, result ranking, and may influence what results are returned.

This does not restrict results to the specified region. To restrict results to a region use countries or LocationRestriction

public abstract FindAutocompletePredictionsRequest.Builder setSessionToken(@Nullable AutocompleteSessionToken sessionToken)

Sets the AutocompleteSessionToken for this request.

public abstract FindAutocompletePredictionsRequest.Builder setTypeFilter(@Nullable TypeFilter typeFilter)

Sets the filter that restricts the type of the results included in the response.

Possible values:

• ADDRESS
• CITIES
• ESTABLISHMENT
• GEOCODE
• REGIONS

This property will be ignored if typesFilter is set using setTypesFilter}.

public abstract FindAutocompletePredictionsRequest.Builder setTypesFilter(List<String> placeTypes)

Sets the filter that restricts the type(s) of results returned from the response, up to 5 place types are supported.

This will override setTypeFilter if both are used.

If you enable Places API then a comprehensive list of the supported types can be found in com.google.android.libraries.places.api.model.PlaceTypes. The type collections specified in table 3 must be passed in as solo entries and cannot be combined with any other entries from table 1 or 2.

If you enable Places API (New), then types passed here are treated as primary types.