Warning

This feature is available in the Full MapKit SDK version

MMKSearchBusinessFilter

@interface MMKSearchBusinessFilter : NSObject

A filter that could be applied to search results.

Filters can be either boolean (that is Wi-Fi availability in a cafe) or enumerated (that is cuisine type in a restaurant). Enumerated filters support multiple selected values (OR-combined), to search, for example, for restaurants with Armenian or Georgian cuisine at once.

This class is used in two separate ways: server response contains all filters applicable to current search request and client can use some of these filters to get more specific results in the following search requests

Summary

Class methods

+ (nonnull MMKSearchBusinessFilter *)businessFilterWithId:(nonnull NSString *)id
                                                     name:(nullable NSString *)name
                                                 disabled:(nullable NSNumber *)disabled
                                                iconLight:(nullable MMKImage *)iconLight
                                                 iconDark:(nullable MMKImage *)iconDark
                                             singleSelect:(nullable NSNumber *)singleSelect
                                                   values:(nonnull MMKSearchBusinessFilterValues *)values;

Properties

@property (nonatomic, readonly, nonnull) NSString *id;
Filter id

@property (nonatomic, readonly, nullable) NSString *name;
Human-readable filter name

@property (nonatomic, readonly, nullable) NSNumber *disabled;
The filter should not be used by the client, because filter is either used already (selected:true, disabled:true) or nothing would be found * (selected:false, disabled:true)

@property (nonatomic, readonly, nullable) MMKImage *iconLight;
Optional field, can be nil

@property (nonatomic, readonly, nullable) MMKImage *iconDark;
Optional field, can be nil

@property (nonatomic, readonly, nullable) NSNumber *singleSelect;
Only one of multiple available values should be selected

@property (nonatomic, readonly, nonnull) MMKSearchBusinessFilterValues *values;
Filter values

Class methods

businessFilterWithId:name:disabled:iconLight:iconDark:singleSelect:values:

+ (nonnull MMKSearchBusinessFilter *)businessFilterWithId:(nonnull NSString *)id
                                                     name:(nullable NSString *)name
                                                 disabled:(nullable NSNumber *)disabled
                                                iconLight:(nullable MMKImage *)iconLight
                                                 iconDark:(nullable MMKImage *)iconDark
                                             singleSelect:(nullable NSNumber *)singleSelect
                                                   values:(nonnull MMKSearchBusinessFilterValues *)values;

Properties

id

@property (nonatomic, readonly, nonnull) NSString *id;

Filter id.


name

@property (nonatomic, readonly, nullable) NSString *name;

Human-readable filter name.

Optional field, can be nil.


disabled

@property (nonatomic, readonly, nullable) NSNumber *disabled;

The filter should not be used by the client, because filter is either used already (selected:true, disabled:true) or nothing would be found * (selected:false, disabled:true).

Optional field, can be nil.


iconLight

@property (nonatomic, readonly, nullable) MMKImage *iconLight;

Optional field, can be nil.


iconDark

@property (nonatomic, readonly, nullable) MMKImage *iconDark;

Optional field, can be nil.


singleSelect

@property (nonatomic, readonly, nullable) NSNumber *singleSelect;

Only one of multiple available values should be selected.

Optional field, can be nil.


values

@property (nonatomic, readonly, nonnull) MMKSearchBusinessFilterValues *values;

Filter values.


Previous
MMKSearchAvailability
Next
MMKSearchBusinessFilterBooleanValue