Warning

This feature is available in the Full MapKit SDK version

YMKSearchBusinessResultMetadata

@interface YMKSearchBusinessResultMetadata : NSObject

Common info for business search response.

Summary

Class methods

+ (nonnull YMKSearchBusinessResultMetadata *)businessResultMetadataWithCategories:(nonnull NSArray<YMKSearchCategory *> *)categories
                                                                           chains:(nonnull NSArray<YMKSearchChain *> *)chains
                                                                  businessFilters:(nonnull NSArray<YMKSearchBusinessFilter *> *)businessFilters
                                                                 importantFilters:(nullable YMKSearchFilterSet *)importantFilters
                                                                 pricesCurrencies:(nonnull NSArray<NSString *> *)pricesCurrencies;

Properties

@property (nonatomic, readonly, nonnull)
    NSArray<YMKSearchCategory *> *categories;

List of categories (also known as rubrics) present in response

@property (nonatomic, readonly, nonnull) NSArray<YMKSearchChain *> *chains;
List of chains present in response

@property (nonatomic, readonly, nonnull)
    NSArray<YMKSearchBusinessFilter *> *businessFilters;

List of applicable filters

@property (nonatomic, readonly, nullable) YMKSearchFilterSet *importantFilters;
Collection of filters that probably are of utmost interest to the user

@property (nonatomic, readonly, nonnull) NSArray<NSString *> *pricesCurrencies;
Relevant currency for the prices

Class methods

businessResultMetadataWithCategories:chains:businessFilters:importantFilters:pricesCurrencies:

+ (nonnull YMKSearchBusinessResultMetadata *)businessResultMetadataWithCategories:(nonnull NSArray<YMKSearchCategory *> *)categories
                                                                           chains:(nonnull NSArray<YMKSearchChain *> *)chains
                                                                  businessFilters:(nonnull NSArray<YMKSearchBusinessFilter *> *)businessFilters
                                                                 importantFilters:(nullable YMKSearchFilterSet *)importantFilters
                                                                 pricesCurrencies:(nonnull NSArray<NSString *> *)pricesCurrencies;


Properties

categories

@property (nonatomic, readonly, nonnull)
    NSArray<YMKSearchCategory *> *categories;

List of categories (also known as rubrics) present in response. Non-empty list means that the request was treated as a 'category request' by the server (for example requests like "where to eat", "cinema", and other).


chains

@property (nonatomic, readonly, nonnull) NSArray<YMKSearchChain *> *chains;

List of chains present in response. Non-empty list means that the request was treaded as 'chain request' (for example "mcdonalds", "starbucks", and other).


businessFilters

@property (nonatomic, readonly, nonnull)
    NSArray<YMKSearchBusinessFilter *> *businessFilters;

List of applicable filters.


importantFilters

@property (nonatomic, readonly, nullable) YMKSearchFilterSet *importantFilters;

Collection of filters that probably are of utmost interest to the user.

Optional field, can be nil.


pricesCurrencies

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

Relevant currency for the prices