MPLocationQuery

@interface MPLocationQuery : NSObject

Locations query object used in conjunction with the MPLocationsProvider

  • Free text search string

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *query;

    Swift

    var query: String! { get set }
  • Venue filter. Supports the venue key provided in MPVenue.venueKey and MPLocation.venue

    Declaration

    Objective-C

    @property (assign, readwrite, atomic) NSString *venue;

    Swift

    var venue: String! { get set }
  • Building filter. Supports the building key provided in MPLocation.building

    Declaration

    Objective-C

    @property (assign, readwrite, atomic) NSString *building;

    Swift

    var building: String! { get set }
  • Order by relevance, name, roomId, venue, building, floor. Default is relevance.

    Declaration

    Objective-C

    @property (assign, readwrite, atomic) NSString *orderBy;

    Swift

    var orderBy: String! { get set }
  • Apply a sort order. Can either be asc or desc. Default is asc

    Declaration

    Objective-C

    @property (assign, readwrite, atomic) NSString *sortOrder;

    Swift

    var sortOrder: String! { get set }
  • 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).

    Declaration

    Objective-C

    @property (assign, readwrite, atomic) MPPoint *near;

    Swift

    var near: MPPoint! { get set }
  • 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

    Declaration

    Objective-C

    @property (assign, readwrite, atomic) NSNumber *radius;

    Swift

    var radius: NSNumber! { get set }
  • Sets the zoom level. Currently has no effect on the search results.

    Declaration

    Objective-C

    @property (assign, readwrite, atomic) NSNumber *zoomLevel;

    Swift

    var zoomLevel: NSNumber! { get set }
  • Floor filter. Supports the floor index provided in MPMapControl.currentFloor and MPLocation.floor

    Declaration

    Objective-C

    @property (assign, readwrite, atomic) NSNumber *floor;

    Swift

    var floor: NSNumber! { get set }
  • Adds a geographic filter as a bounding box, specified by north, east, south and west

    Declaration

    Objective-C

    @property (assign, readwrite, atomic) MPMapExtend *mapExtend;

    Swift

    var mapExtend: MPMapExtend! { get set }
  • Category filter. Supports the category keys provided from the MPCategoriesProvider. Does not support the localized names of the categories.

    Declaration

    Objective-C

    @property (assign, readwrite, atomic) NSArray *categories;

    Swift

    var categories: [Any]! { get set }
  • Types filter. Supports the type strings provided from the MPSolutionsProvider.

    Declaration

    Objective-C

    @property (assign, readwrite, atomic) NSArray *types;

    Swift

    var types: [Any]! { get set }
  • Solution id. Mandatory field.

    Declaration

    Objective-C

    @property (assign, readwrite, atomic) NSString *solutionId;

    Swift

    var solutionId: String! { get set }
  • arg

    Previously used for solution id. Now using solutionId as Solution Id

    Declaration

    Objective-C

    @property (assign, readwrite, atomic) NSString *arg;

    Swift

    var arg: String! { get set }
  • max

    Limit the amount of results from the MPLocationsProvider

    Declaration

    Objective-C

    @property (assign, readwrite, atomic) int max;

    Swift

    var max: Int32 { get set }
  • Parses an url, identifies query elements and returns a query object

    Declaration

    Objective-C

    + (MPLocationQuery *)queryWithUrl:(NSURL *)url;

    Swift

    /*not inherited*/ init!(url: URL!)