Warning

This feature is available in the Full MapKit SDK version

YMKSearchFilterCollection

@interface YMKSearchFilterCollection : NSObject

Filters for search request. Use builder to setup this class.

Summary

Class methods

+ (nonnull YMKSearchFilterCollection *)filterCollectionWithBooleanFilters:(nonnull NSArray<NSString *> *)booleanFilters
                                                              enumFilters:(nonnull NSDictionary<NSString *, NSArray<NSString *> *> *)enumFilters
                                                             rangeFilters:(nonnull NSDictionary<NSString *, YMKSearchFilterCollectionNumberRange *> *)rangeFilters
                                                              dateFilters:(nonnull NSDictionary<NSString *, YMKSearchFilterCollectionDateRange *> *)dateFilters;

Properties

@property (nonatomic, readonly, nonnull) NSArray<NSString *> *booleanFilters;
List of boolean filter ids to be set

@property (nonatomic, readonly, nonnull)
    NSDictionary<NSString *, NSArray<NSString *> *> *enumFilters;
Mapping of enum filter ids to list of enum value ids

@property (nonatomic, readonly, nonnull)
    NSDictionary<NSString *, YMKSearchFilterCollectionNumberRange *>
        *rangeFilters;
Mapping of range filter ids to number range

@property (nonatomic, readonly, nonnull)
    NSDictionary<NSString *, YMKSearchFilterCollectionDateRange *> *dateFilters;
Mapping of date filter ids to date range

Class methods

filterCollectionWithBooleanFilters:enumFilters:rangeFilters:dateFilters:

+ (nonnull YMKSearchFilterCollection *)filterCollectionWithBooleanFilters:(nonnull NSArray<NSString *> *)booleanFilters
                                                              enumFilters:(nonnull NSDictionary<NSString *, NSArray<NSString *> *> *)enumFilters
                                                             rangeFilters:(nonnull NSDictionary<NSString *, YMKSearchFilterCollectionNumberRange *> *)rangeFilters
                                                              dateFilters:(nonnull NSDictionary<NSString *, YMKSearchFilterCollectionDateRange *> *)dateFilters;

Properties

booleanFilters

@property (nonatomic, readonly, nonnull) NSArray<NSString *> *booleanFilters;

List of boolean filter ids to be set.


enumFilters

@property (nonatomic, readonly, nonnull)
    NSDictionary<NSString *, NSArray<NSString *> *> *enumFilters;

Mapping of enum filter ids to list of enum value ids.


rangeFilters

@property (nonatomic, readonly, nonnull)
    NSDictionary<NSString *, YMKSearchFilterCollectionNumberRange *>
        *rangeFilters;

Mapping of range filter ids to number range.


dateFilters

@property (nonatomic, readonly, nonnull)
    NSDictionary<NSString *, YMKSearchFilterCollectionDateRange *> *dateFilters;

Mapping of date filter ids to date range.


Previous
YMKSearchFeatureVariantValue
Next
YMKSearchFilterCollectionBuilder
In this article: