TKPlacesQuery
@interface TKPlacesQuery : NSObject <NSCopying, NSMutableCopying>
Query object used for fetching specific collections of TKPlace
objects.
To perform regional queries, use either quadKeys
(preferred) or bounds
property to specify the area of your interest.
-
Search term to use. Usable for searching through English and localised names.
Declaration
Objective-C
@property (readwrite, copy, nonatomic, nullable) NSString *searchTerm;
Swift
var searchTerm: String? { get set }
-
Declaration
Objective-C
@property (assign, readwrite, atomic) TKPlaceLevel levels;
Swift
var levels: TKPlaceLevel { get set }
-
Listed map quad keys to query.
Note
Length:1
–18
. All requested quad keys should be of the same length.Declaration
Objective-C
@property (readwrite, copy, nonatomic, nullable) NSArray<NSString *> *quadKeys;
Swift
var quadKeys: [String]? { get set }
-
Desired area of the map.
Declaration
Objective-C
@property (readwrite, strong, nonatomic, nullable) TKMapRegion *bounds;
Swift
var bounds: TKMapRegion? { get set }
-
Division of each map tile when spreading.
Note
Accepted values:
0
–3
. Implicit value is0
.Warning
Value of
limit
must be divisible by4^mapSpread
.Declaration
Objective-C
@property (readwrite, strong, nonatomic, nullable) NSNumber *mapSpread;
Swift
var mapSpread: NSNumber? { get set }
-
Array of the desired Category slugs.
Note
Matches Places having ALL of the requested categories. Switching to ANY is possible by using the
categoriesMatching
property.See
Declaration
Objective-C
@property (assign, readwrite, atomic) TKPlaceCategory categories;
Swift
var categories: TKPlaceCategory { get set }
-
Flag controlling the matching rule for
categories
.Declaration
Objective-C
@property (assign, readwrite, atomic) TKPlacesQueryMatching categoriesMatching;
Swift
var categoriesMatching: TKPlacesQueryMatching { get set }
-
Plain-text array of the desired Tag keys.
Note
Matches Places having ALL of the requested tags. Switching to ANY is possible by using the
tagsMatching
property.See
Declaration
Objective-C
@property (readwrite, copy, nonatomic, nullable) NSArray<NSString *> *tags;
Swift
var tags: [String]? { get set }
-
Flag controlling the matching rule for
tags
.Declaration
Objective-C
@property (assign, readwrite, atomic) TKPlacesQueryMatching tagsMatching;
Swift
var tagsMatching: TKPlacesQueryMatching { get set }
-
Desired identifiers of parent nodes.
Note
Matches Places having ALL of the requested parents. Switching to ANY is possible by using the
parentIDsMatching
property.Declaration
Objective-C
@property (readwrite, copy, nonatomic, nullable) NSArray<NSString *> *parentIDs;
Swift
var parentIDs: [String]? { get set }
-
Flag controlling the matching rule for
parentIDs
.Declaration
Objective-C
@property (assign, readwrite, atomic) TKPlacesQueryMatching parentIDsMatching;
Swift
var parentIDsMatching: TKPlacesQueryMatching { get set }
-
Maximum number of results returned.
Note
Accepted values:
0
–512
.Note
If multiple quad keys specified, the limit applies to each map tile separately.
Warning
The value requested must be divisible by
4^mapSpread
.Declaration
Objective-C
@property (readwrite, strong, nonatomic, nullable) NSNumber *limit;
Swift
var limit: NSNumber? { get set }