MPLocationQuery Class Reference

#include <MPLocationQuery.h>

Inheritance diagram for MPLocationQuery:

Class Methods
(nullable MPLocationQuery *)	+ queryWithUrl:

Properties
NSString *	query
NSString *	venue
NSString *	building
NSString *	orderBy
NSString *	sortOrder
MPPoint *	near
NSNumber *	radius
NSNumber *	zoomLevel
NSNumber *	floor
MPMapExtend *	mapExtend
NSArray< NSString * > *	categories
NSArray< NSString * > *	types
int	max
MPLocationQueryMode	queryMode
NSUInteger	queryGeneration

Detailed Description

Locations query object used in conjunction with the MPLocationsProvider

Method Documentation

queryWithUrl:

+ (nullable MPLocationQuery *) queryWithUrl:

(nonnull NSURL *)

url

Parses an url, identifies query elements and returns a query object

Property Documentation

building

- (NSString*) building

readwritenonatomicstrong

Building filter. Supports the building key provided in MPLocation.building

categories

- (NSArray<NSString*>*) categories

readwritenonatomicstrong

Category filter. Supports the category keys provided from the MPCategoriesProvider. Does not support the localized names of the categories.

floor

- (NSNumber*) floor

readwritenonatomicstrong

Floor filter. Supports the floor index provided in MPMapControl.currentFloor and MPLocation.floor

mapExtend

- (MPMapExtend*) mapExtend

readwritenonatomicstrong

Adds a geographic filter as a bounding box, specified by north, east, south and west

max

- (int) max

readwriteatomic

Limit the amount of results from the MPLocationsProvider

near

- (MPPoint*) near

readwritenonatomicstrong

Set a reference position coordinate. Distances to this position will affect the relevance of the search results. Only applies when ordering by relevance (default sort order).

orderBy

- (NSString*) orderBy

readwritenonatomicstrong

Order by "relevance", "name", "roomId", "venue", "building", "floor". Default is "relevance".

query

- (NSString*) query

readwritenonatomicstrong

Free text search string

queryGeneration

- (NSUInteger) queryGeneration

readatomicassign

Query Generation - if the query is reused for multiple searches this will hold the most recent query generation

queryMode

- (MPLocationQueryMode) queryMode

readwriteatomic

Location query mode. Defaults to MPLocationQueryModeNormal.

The location query mode determines what happens when a MPLocationQuery is re-used, and executed multiple time.

MPLocationQueryModeNormal: Results will be delivered for all executions of the query.

MPLocationQueryModeAutocomplete: If a query is already executing it will be cancelled when a new query is started. This allows starting a query as th euser types, where only the result of the last query is relevant.

radius

- (NSNumber*) radius

readwritenonatomicstrong

Sets a radius limit in meters. Only to be used in conjunction with near property. This will cap the search results to the locations which distance to the near-position is less than specified as radius

sortOrder

- (NSString*) sortOrder

readwritenonatomicstrong

Apply a sort order. Can either be "asc" or "desc". Default is "asc"

types

- (NSArray<NSString*>*) types

readwritenonatomicstrong

Types filter. Supports the type strings provided from the MPSolutionsProvider.

venue

- (NSString*) venue

readwritenonatomicstrong

Venue filter. Supports the venue key provided in MPVenue.venueKey and MPLocation.venue

zoomLevel

- (NSNumber*) zoomLevel

readwritenonatomicstrong

Sets the zoom level. Currently has no effect on the search results.