TKCollectionsQuery

 
@interface TKCollectionsQuery : NSObject

A query object used for fetching specific collections of TKCollection objects.

  • Place ID to limit collections in.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) NSString *parentPlaceID;

    Swift

    var parentPlaceID: String? { get set }

  • An array of Place IDs indicating a lookup for collections containing the specified Places.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) NSArray<NSString *> *placeIDs;

    Swift

    var placeIDs: [String]? { get set }

  • Flag controlling the matching rule for parentIDs.

    Declaration

    Objective-C

    @property (assign, readwrite, atomic)
    TKCollectionsQueryMatching placeIDsMatching;

    Swift

    var placeIDsMatching: TKCollectionsQueryMatching { get set }

  • Tags to look for. All entries are being matched.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) NSArray<NSString *> *tags;

    Swift

    var tags: [String]? { get set }

  • Tags not to look for. All entries are being matched.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) NSArray<NSString *> *tagsToOmit;

    Swift

    var tagsToOmit: [String]? { get set }

  • 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 }

  • Maximum number of results returned.

    Note

    The default value is 10. Accepted values: 1–30.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable) NSNumber *limit;

    Swift

    var limit: NSNumber? { get set }

  • Paging offset.

    Note

    The implicit value is 0 to return the results starting with the first one.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable) NSNumber *offset;

    Swift

    var offset: NSNumber? { get set }

  • Collections with unique places have increased rating.

    Note

    This parameter is used only if parentPlaceID is set.

    Declaration

    Objective-C

    @property (assign, readwrite, atomic) BOOL preferUnique;

    Swift

    var preferUnique: Bool { get set }