GooglePlacesSwift Framework Reference


                    
                    
                    ==(_:_:)

Returns a Boolean value indicating whether two values are equal.

Equality is the inverse of inequality. For any values a and b, a == b implies that a != b is false.

Declaration

Swift

static func == (a: SearchByTextRequest, b: SearchByTextRequest) -> Bool


                    
                    
                    RankPreference

How results will be ranked in the response.

Declaration

Swift

enum RankPreference

extension SearchByTextRequest.RankPreference : CaseIterable, Equatable, Hashable, Identifiable, Sendable, SendableMetatype


                    
                    
                    evSearchOptions

Set the searchable EV options of a place search request.

Declaration

Swift

var evSearchOptions: EVSearchOptions? { get }


                    
                    
                    includedType

The requested place type.

See https://developers.google.com/maps/documentation/places/web-service/search-textual#supported-types for the most up-to-date list of supported types available

Declaration

Swift

var includedType: PlaceType? { get }


                    
                    
                    init(textQuery:placeProperties:locationBias:includedType:maxResultCount:minRating:isOpenNow:priceLevels:rankPreference:regionCode:isStrictTypeFiltering:shouldIncludePureServiceAreaBusinesses:evSearchOptions:routingParameters:searchAlongRouteParameters:shouldIncludeRoutingSummaries:shouldIncludeSearchURL:)

Instantiates a SearchByTextRequest with a text query and place properties to return.

Declaration

Swift

init(textQuery: String, placeProperties: [PlaceProperty], locationBias: any CoordinateRegionBias, includedType: PlaceType? = nil, maxResultCount: Int = 20, minRating: Float = 0.0, isOpenNow: Bool = true, priceLevels: Set<PriceLevel>? = nil, rankPreference: SearchByTextRequest.RankPreference = .distance, regionCode: String? = nil, isStrictTypeFiltering: Bool = false, shouldIncludePureServiceAreaBusinesses: Bool = false, evSearchOptions: EVSearchOptions? = nil, routingParameters: RoutingParameters? = nil, searchAlongRouteParameters: SearchAlongRouteParameters? = nil, shouldIncludeRoutingSummaries: Bool = false, shouldIncludeSearchURL: Bool = false)

Parameters

`textQuery`	The string query for the search request.
`placeProperties`	The `placeProperty`s that should be included in place results. Must not be empty. An empty list will result in an error when trying to send the request. When used in a `PlaceSearchView` context, this parameter will be ignored, as the place properties will be automatically determined.
`locationBias`	The biased region to search.
`includedType`	The requested place type.
`maxResultCount`	The maximum number of results to return. Must be between 1 and 20 (default), inclusive.
`minRating`	The minimum average user rating for places to be included in the results, between 0.0 (default) and 5.0, inclusive.
`isOpenNow`	Filter results to places that are currently open. Defaults to `true`.
`priceLevels`	A set of `PriceLevel` values to filter places included in the results.
`rankPreference`	The `RankPreference` to sort the results. Defaults to `.distance`.
`regionCode`	The unicode country/region code (CLDR) of the request location.
`isStrictTypeFiltering`	Defines if only results of `includedType` should be returned. Defaults to `false`.
`shouldIncludePureServiceAreaBusinesses`	Defines whether to include pure service area businesses in the results. Defaults to `false`.
`evSearchOptions`	The `EVSearchOptions` to filter places included in the results.
`routingParameters`	The `RoutingParameters` to filter places included in the results.
`searchAlongRouteParameters`	The `SearchAlongRouteParameters` to filter places included in the results.
`shouldIncludeRoutingSummaries`	Defines whether to include routing summaries in the results. Defaults to `false`. Setting `shouldIncludeRoutingSummaries` to `true` without also including either the `routingParameters.origin` parameter or the `searchAlongRouteParameters.polyline.encodedPolyline` parameter in the request causes an error.
`shouldIncludeSearchURL`	Defines whether to include a URL to search in Google Maps. Defaults to `false`.


                    
                    
                    init(textQuery:placeProperties:locationRestriction:includedType:maxResultCount:minRating:isOpenNow:priceLevels:rankPreference:regionCode:isStrictTypeFiltering:shouldIncludePureServiceAreaBusinesses:evSearchOptions:routingParameters:searchAlongRouteParameters:shouldIncludeRoutingSummaries:shouldIncludeSearchURL:)

Instantiates a SearchByTextRequest with a text query and place properties to return.

Declaration

Swift

init(textQuery: String, placeProperties: [PlaceProperty], locationRestriction: any CoordinateRegionRestriction, includedType: PlaceType? = nil, maxResultCount: Int = 20, minRating: Float = 0.0, isOpenNow: Bool = true, priceLevels: Set<PriceLevel>? = nil, rankPreference: SearchByTextRequest.RankPreference = .distance, regionCode: String? = nil, isStrictTypeFiltering: Bool = false, shouldIncludePureServiceAreaBusinesses: Bool = false, evSearchOptions: EVSearchOptions? = nil, routingParameters: RoutingParameters? = nil, searchAlongRouteParameters: SearchAlongRouteParameters? = nil, shouldIncludeRoutingSummaries: Bool = false, shouldIncludeSearchURL: Bool = false)

Parameters

`textQuery`	The string query for the search request.
`placeProperties`	The `placeProperty`s that should be included in place results. Must not be empty. An empty list will result in an error when trying to send the request. When used in a `PlaceSearchView` context, this parameter will be ignored, as the place properties will be automatically determined.
`locationRestriction`	The restricted region to search.
`includedType`	The requested place type.
`maxResultCount`	The maximum number of results to return. Must be between 1 and 20 (default), inclusive.
`minRating`	The minimum average user rating for places to be included in the results, between 0.0 (default) and 5.0, inclusive.
`isOpenNow`	Filter results to places that are currently open. Defaults to `true`.
`priceLevels`	A set of `PriceLevel` values to filter places included in the results.
`rankPreference`	The `RankPreference` to sort the results. Defaults to `.distance`.
`regionCode`	The unicode country/region code (CLDR) of the request location.
`isStrictTypeFiltering`	Defines if only results of `includedType` should be returned. Defaults to `false`.
`shouldIncludePureServiceAreaBusinesses`	Defines whether to include pure service area businesses in the results. Defaults to `false`.
`evSearchOptions`	The `EVSearchOptions` to filter places included in the results.
`routingParameters`	The `RoutingParameters` to filter places included in the results.
`searchAlongRouteParameters`	The `SearchAlongRouteParameters` to filter places included in the results.
`shouldIncludeRoutingSummaries`	Defines whether to include routing summaries in the results. Defaults to `false`. Setting `shouldIncludeRoutingSummaries` to `true` without also including either the `routingParameters.origin` parameter or the `searchAlongRouteParameters.polyline.encodedPolyline` parameter in the request causes an error.
`shouldIncludeSearchURL`	Defines whether to include a URL to search in Google Maps. Defaults to `false`.


                    
                    
                    isOpenNow

Filter results to places that are currently open. */

Declaration

Swift

var isOpenNow: Bool { get }


                    
                    
                    isStrictTypeFiltering

Defines whether only results of includedType should be returned.

Default value is false`.

Declaration

Swift

var isStrictTypeFiltering: Bool { get }


                    
                    
                    locationBias

The biased region to search.

This location serves as a bias, which means there is a preference for results in the given location.

If set along with locationRestriction`, this will be ignored.

Declaration

Swift

var locationBias: (any CoordinateRegionBias)? { get }


                    
                    
                    locationRestriction

The restricted region to search.

This location serves as a restriction which means results outside the given location will not be returned.

Cannot be used with locationBias`.

Declaration

Swift

var locationRestriction: (any CoordinateRegionRestriction)? { get }


                    
                    
                    maxResultCount

Returns the maximum number of results to return between PlaceResultCountMinResultCount and PlaceResultCountMaxResultCount.

The allowed range of this field can be found at https://developers.google.com/maps/documentation/places/web-service/search-textual#maxresultcount. Defaults to the upper limit.

Declaration

Swift

var maxResultCount: Int { get }


                    
                    
                    minRating

The minimum average user rating for places to be included in the results. Rating will be within a range between 0.0 and 5.0.

The specified rating will be rounded up to the nearest 0.5. See Place rating property.

Declaration

Swift

var minRating: Float { get }


                    
                    
                    placeProperties

The array of PlaceProperty that should be included in place results.

Declaration

Swift

var placeProperties: [PlaceProperty] { get }


                    
                    
                    priceLevels

An array of the PriceLevel values that should filter the places included in the results.

Any combination of price levels can be selected; default is all price levels.

Declaration

Swift

var priceLevels: Set<PriceLevel>? { get }


                    
                    
                    rankPreference

The RankPreference used to sort the results returned from the request.

Declaration

Swift

var rankPreference: SearchByTextRequest.RankPreference { get }


                    
                    
                    regionCode

The unicode country/region code (CLDR) of the location where the request is coming from.

It is used to display the place details, like region-specific place name, if available.

See https://unicode.org/cldr/charts/latest/supplemental/territory_containment_un_m_49.html for region codes.

Declaration

Swift

var regionCode: String? { get }


                    
                    
                    routingParameters

Additional parameters for routing to results.

Declaration

Swift

var routingParameters: RoutingParameters? { get }


                    
                    
                    searchAlongRouteParameters

Additional parameters for search along a route.

Declaration

Swift

var searchAlongRouteParameters: SearchAlongRouteParameters? { get }


                    
                    
                    shouldIncludePureServiceAreaBusinesses

A pure service area business is a business that visits or delivers to customers directly, but does not serve customers at their business address. For example, businesses like cleaning services or plumbers. Those businesses do not have a physical address or location on Google Maps.

Default value is false.

Declaration

Swift

var shouldIncludePureServiceAreaBusinesses: Bool { get }


                    
                    
                    shouldIncludeRoutingSummaries

Defines whether to include routing summaries in the results.

Default value is false.

Declaration

Swift

var shouldIncludeRoutingSummaries: Bool { get }


                    
                    
                    textQuery

The text query for the search.

Declaration

Swift

var textQuery: String { get }

GooglePlacesSwift Framework Reference Stay organized with collections Save and categorize content based on your preferences.

SearchByTextRequest

Declaration

Declaration

Declaration

Declaration

Declaration

Parameters

Declaration

Parameters

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration