CategoryQuery

public struct CategoryQuery : Hashable

The options to specify a query by categories.

  • List of categories to be included. A place can be assigned multiple categories. If any of them is in CategoryQuery.categories, but none are in CategoryQuery.excludeCategories, that place will be included in the response.

    Declaration

    Swift

    public var categories: [PlaceCategory]
  • List of categories and subcategories to be excluded. A place can be assigned multiple categories. If any of them is in CategoryQuery.excludeCategories, that place will not be included in the response, regardless of whether any of its assigned categories have been included in CategoryQuery.categories. In short, an exclusion will always win over an inclusion. This is especially useful for excluding specific subcategories from the main category.

    Declaration

    Swift

    public var excludeCategories: [PlaceCategory]
  • List of chains to be included. A place can be assigned multiple chains. If any of them is in CategoryQuery.includeChains, but none are in CategoryQuery.excludeChains, that place will be included in the response.

    Declaration

    Swift

    public var includeChains: [PlaceChain]
  • List of chains to be excluded. A place can be assigned multiple chains. If any of them is in CategoryQuery.excludeChains, that place will not be included in the response, regardless of whether any of its assigned chains have been included in CategoryQuery.includeChains. In short, an exclusion will always win over an inclusion.

    Declaration

    Swift

    public var excludeChains: [PlaceChain]
  • List of food types to be included. A place can be assigned multiple food types. If any of them is in CategoryQuery.includeFoodTypes, but none are in CategoryQuery.excludeFoodTypes, that place will be included in the response.

    Declaration

    Swift

    public var includeFoodTypes: [PlaceFoodType]
  • List of food types to be excluded. A place can be assigned multiple food types. If any of them is in CategoryQuery.excludeFoodTypes, that place will not be included in the response, regardless of whether any of its assigned food types have been included in CategoryQuery.includeFoodTypes. In short, an exclusion will always win over an inclusion.

    Declaration

    Swift

    public var excludeFoodTypes: [PlaceFoodType]
  • Full-text filter on POI names/titles. Results with a partial match are included in the response. By default the value is set to null and results will be based on other parameters provided.

    Declaration

    Swift

    public var filter: String?
  • The filter options to specify a place in query. Consists of fuel and truck options.

    Declaration

    Swift

    public var placeFilter: PlaceFilter
  • Area in which to provide the most relevant places.

    Declaration

    Swift

    public var area: CategoryQuery.Area
  • Constructs a new instance of this class from provided parameters.

    Declaration

    Swift

    public init(_ category: PlaceCategory, area: CategoryQuery.Area)

    Parameters

    category

    Category for query

    area

    Area in which to provide the most relevant places.

  • Constructs a new instance of this class from provided parameters.

    Declaration

    Swift

    public init(_ categories: [PlaceCategory], area: CategoryQuery.Area)

    Parameters

    categories

    List of categories.

    area

    Area in which to provide the most relevant places.

  • Constructs a new instance of this class from provided parameters.

    Declaration

    Swift

    public init(_ category: PlaceCategory, filter: String, area: CategoryQuery.Area)

    Parameters

    category

    Category for query

    filter

    Full-text filter on POI names/titles. Results with a partial match are included in the response.

    area

    Area in which to provide the most relevant places.

  • Constructs a new instance of this class from provided parameters.

    Declaration

    Swift

    public init(_ categories: [PlaceCategory], filter: String, area: CategoryQuery.Area)

    Parameters

    categories

    List of categories.

    filter

    Full-text filter on POI names/titles. Results with a partial match are included in the response.

    area

    Area in which to provide the most relevant places.

  • Area to perform search on.

    See more

    Declaration

    Swift

    public struct Area : Hashable