NearbySearchFilter class

Structure of the body of Nearby Search requests:

Documentation: https://developers.google.com/maps/documentation/places/web-service/reference/rest/v1/places/searchNearby#request-body

Inheritance
Available extensions
Annotations
  • @JsonSerializable()
  • @CopyWith()

Constructors

NearbySearchFilter.new({String? languageCode, String? regionCode, List<PlaceType>? includedTypes, List<PlaceType>? excludedTypes, List<PlaceType>? includedPrimaryTypes, List<PlaceType>? excludedPrimaryTypes, int? maxResultCount, required LocationRestrictionCircle locationRestriction, RankPreferenceType? rankPreference, RoutingParameters? routingParameters})
NearbySearchFilter.fromJson(Map<String, dynamic> json)
factory

Properties

copyWith → _$NearbySearchFilterCWProxy

Available on NearbySearchFilter, provided by the $NearbySearchFilterCopyWith extension

Returns a callable class that can be used as follows: instanceOfNearbySearchFilter.copyWith(...).
no setter
excludedPrimaryTypes → List<PlaceType>?
Excluded primary Place type (e.g. "restaurant" or "gas_station") from https://developers.google.com/maps/documentation/places/web-service/place-types.
final
excludedTypes → List<PlaceType>?
Excluded Place type (eg, "restaurant" or "gas_station") from https://developers.google.com/maps/documentation/places/web-service/place-types.
final
hashCode → int
The hash code for this object.
no setterinherited
includedPrimaryTypes → List<PlaceType>?
Included primary Place type (e.g. "restaurant" or "gas_station") from https://developers.google.com/maps/documentation/places/web-service/place-types. A place can only have a single primary type from the supported types table associated with it.
final
includedTypes → List<PlaceType>?
Included Place type (eg, "restaurant" or "gas_station") from https://developers.google.com/maps/documentation/places/web-service/place-types.
final
languageCode → String?
Place details will be displayed with the preferred language if available.
finalinherited
locationRestriction → LocationRestrictionCircle
The region to search specified as a circle, defined by center point and radius in meters. The radius must be between 1.0 and 50000.0, inclusive. The default radius is 500.0. You must set it in your request to a value greater than 0.0.
final
maxResultCount → int?
Maximum number of results to return. It must be between 1 and 20 (default), inclusively. If the number is unset, it falls back to the upper limit. If the number is set to negative or exceeds the upper limit, an INVALID_ARGUMENT error is returned.
final
rankPreference → RankPreferenceType?
The type of ranking to use. If this parameter is omitted, results are ranked by RankPreferenceType.popularity.
final
regionCode → String?
The Unicode country/region code (CLDR) of the location where the request is coming from. This parameter is used to display the place details, like region-specific place name, if available. The parameter can affect results based on applicable law. For more information, see https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html.
finalinherited
routingParameters → RoutingParameters?
Parameters that affect the routing to the search results.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

fromJsonList(List? jsonList) → List<NearbySearchFilter>?
inherited
fromJsonMap(Map<String, dynamic>? json) → NearbySearchFilter?
override
fromJsonString(String? json) → NearbySearchFilter?
inherited
fromJsonStringList(String? jsonStringList) → List<NearbySearchFilter>?
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toFieldsMask({String? parentKey}) → List<String>
inherited
toJson() → Map<String, dynamic>
override
toJsonMap() → Map<String, dynamic>
inherited
toJsonString() → String
inherited
toString() → String
This is just to suggest children to implement a named constructor to support creating objects fromJson(...) and fromJsonString(...) as easy as T.build().fromJson(...) or T.build().fromJsonString(...)
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited