TextSearchFilter class
Structure of the body of Text Search requests.
Documentation: https://developers.google.com/maps/documentation/places/web-service/reference/rest/v1/places/searchText#request-body
- Inheritance
-
- Object
- Jsonable<
TextSearchFilter> - BaseFilter<
TextSearchFilter> - TextSearchFilter
- Available extensions
- Annotations
-
- @JsonSerializable()
- @CopyWith()
Constructors
-
TextSearchFilter.new({String? languageCode, String? regionCode, required String textQuery, PlaceType? includedType, bool? includePureServiceAreaBusinesses, LocationMultiArea? locationBias, LocationMultiArea? locationRestriction, EvOptions? evOptions, double? minRating, bool? openNow, int? pageSize, String? pageToken, List<
PriceLevel> ? priceLevels, RankPreferenceType? rankPreference, bool? strictTypeFiltering}) -
TextSearchFilter.fromJson(Map<
String, dynamic> json) -
factory
Properties
- copyWith → _$TextSearchFilterCWProxy
-
Available on TextSearchFilter, provided by the $TextSearchFilterCopyWith extension
Returns a callable class that can be used as follows:instanceOfTextSearchFilter.copyWith(...)
.no setter - evOptions → EvOptions?
-
Specifies parameters for identifying available electric vehicle (EV) charging connectors and charging rates.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- includedType → PlaceType?
-
Restricts the results to places matching the specified type defined by Table A.
Only one type may be specified. For example:
final
- includePureServiceAreaBusinesses → bool?
-
If set to
true
, the response includes businesses that visit or deliver to customers directly, but don't have a physical business location. If set tofalse
, the API returns only businesses with a physical business location.final - languageCode → String?
-
Place details will be displayed with the preferred language if available.
finalinherited
- locationBias → LocationMultiArea?
-
Specifies an area to search. This location serves as a bias which means
results around the specified location can be returned, including results
outside the specified area.
final
- locationRestriction → LocationMultiArea?
-
Specifies an area to search. Results outside the specified area are not returned.
final
- minRating → double?
-
Restricts results to only those whose average user rating is greater than
or equal to this limit. Values must be between 0.0 and 5.0 (inclusive)
in increments of 0.5. For example: 0, 0.5, 1.0, ... , 5.0 inclusive.
Values are rounded up to the nearest 0.5. For example, a value of 0.6
eliminates all results with a rating less than 1.0.
final
- openNow → bool?
-
If
true
, return only those places that are open for business at the time the query is sent. Iffalse
, return all businesses regardless of open status. Places that don't specify opening hours in the Google Places database are returned if you set this parameter tofalse
.final - pageSize → int?
-
Specifies the number of results (between 1 and 20) to display per page.
For example, setting a pageSize value of 5 will return up to 5 results on
the first page. If there are more results that can be returned from the query,
the response includes a
nextPageToken
that you can pass into a subsequent request to access the next page.final - pageToken → String?
-
Specifies the
nextPageToken
from the response body of the previous page.final -
priceLevels
→ List<
PriceLevel> ? -
Restrict the search to places that are marked at certain price levels.
The default is to select all price levels.
final
- rankPreference → RankPreferenceType?
-
Specifies how the results are ranked in the response based on the type of query:
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
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- strictTypeFiltering → bool?
-
Used with the includedType parameter. When set to
true
, only places that match the specified types specified byincludeType
are returned. When false, the default, the response can contain places that don't match the specified types.final - textQuery → String
-
The text string on which to search, for example: "restaurant", "123 Main Street",
or "best place to visit in San Francisco". The API returns candidate matches
based on this string and orders the results based on their perceived relevance.
final
Methods
-
fromJsonList(
List? jsonList) → List< TextSearchFilter> ? -
inherited
-
fromJsonMap(
Map< String, dynamic> ? json) → TextSearchFilter? -
override
-
fromJsonString(
String? json) → TextSearchFilter? -
inherited
-
fromJsonStringList(
String? jsonStringList) → List< TextSearchFilter> ? -
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