YMKSearchBusinessFilter

class YMKSearchBusinessFilter : 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

init(id: String,     name: String?,  disabled: NSNumber?,  iconLight: YMKImage?,  iconDark: YMKImage?,  singleSelect: NSNumber?,   values: YMKSearchBusinessFilterValues)

Properties

var id: String { get } Filter id

var name: String? { get } Human-readable filter name

var disabled: NSNumber? { get } 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)

var iconLight: YMKImage? { get } Optional field, can be nil

var iconDark: YMKImage? { get } Optional field, can be nil

var singleSelect: NSNumber? { get } Only one of multiple available values should be selected

var values: YMKSearchBusinessFilterValues { get } Filter values

Class methods

init(id:name:disabled:iconLight:iconDark:singleSelect:values:)

init(id: String,     name: String?,  disabled: NSNumber?,  iconLight: YMKImage?,  iconDark: YMKImage?,  singleSelect: NSNumber?,   values: YMKSearchBusinessFilterValues)

Properties

id

var id: String { get }

Filter id.

name

var name: String? { get }

Human-readable filter name.

Optional field, can be nil.

disabled

var disabled: NSNumber? { get }

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

var iconLight: YMKImage? { get }

Optional field, can be nil.

iconDark

var iconDark: YMKImage? { get }

Optional field, can be nil.

singleSelect

var singleSelect: NSNumber? { get }

Only one of multiple available values should be selected.

Optional field, can be nil.

values

var values: YMKSearchBusinessFilterValues { get }

Filter values.