Warning

This feature is available in the Full MapKit SDK version

MMKSearchMetadata

@interface MMKSearchMetadata : NSObject <MMKBaseMetadata>

Additional info for search response;

Summary

Class methods

+ (nonnull MMKSearchMetadata *)searchMetadataWithFound:( NSInteger)found
                                           displayType:( MMKSearchDisplayType)displayType
                                           boundingBox:(nullable MMKBoundingBox *)boundingBox
                                                  sort:(nullable MMKSearchSort *)sort
                                               toponym:(nullable MMKGeoObject *)toponym
                                 toponymResultMetadata:(nullable MMKSearchToponymResultMetadata *)toponymResultMetadata
                                businessResultMetadata:(nullable MMKSearchBusinessResultMetadata *)businessResultMetadata
                                                 reqid:(nonnull NSString *)reqid
                                               context:(nonnull NSString *)context
                                           requestText:(nonnull NSString *)requestText
                                  correctedRequestText:(nullable NSString *)correctedRequestText
                                    requestBoundingBox:(nullable MMKBoundingBox *)requestBoundingBox;

Properties

@property (nonatomic, readonly) NSInteger found;
Approximate number of found objects

@property (nonatomic, readonly) MMKSearchDisplayType displayType;
Display type

@property (nonatomic, readonly, nullable) MMKBoundingBox *boundingBox;
Bounding box of the response as a whole

@property (nonatomic, readonly, nullable) MMKSearchSort *sort;
Server-chosen sorting

@property (nonatomic, readonly, nullable) MMKGeoObject *toponym;
Geocoder response to the toponym part of the query

@property (nonatomic, readonly, nullable)
    MMKSearchToponymResultMetadata *toponymResultMetadata;

Additional info for the response from toponym search

@property (nonatomic, readonly, nullable)
    MMKSearchBusinessResultMetadata *businessResultMetadata;

Additional info for the response from organization search

@property (nonatomic, readonly, nonnull) NSString *reqid;
Server-generated request ID

@property (nonatomic, readonly, nonnull) NSString *context;
Server-generated request context

@property (nonatomic, readonly, nonnull) NSString *requestText;
Initial request text

@property (nonatomic, readonly, nullable) NSString *correctedRequestText;
Initial request text with correction of spelling mistakes

@property (nonatomic, readonly, nullable) MMKBoundingBox *requestBoundingBox;
Initial request bounding box

Class methods

searchMetadataWithFound:displayType:boundingBox:sort:toponym:toponymResultMetadata:businessResultMetadata:reqid:context:requestText:correctedRequestText:requestBoundingBox:

+ (nonnull MMKSearchMetadata *)searchMetadataWithFound:( NSInteger)found
                                           displayType:( MMKSearchDisplayType)displayType
                                           boundingBox:(nullable MMKBoundingBox *)boundingBox
                                                  sort:(nullable MMKSearchSort *)sort
                                               toponym:(nullable MMKGeoObject *)toponym
                                 toponymResultMetadata:(nullable MMKSearchToponymResultMetadata *)toponymResultMetadata
                                businessResultMetadata:(nullable MMKSearchBusinessResultMetadata *)businessResultMetadata
                                                 reqid:(nonnull NSString *)reqid
                                               context:(nonnull NSString *)context
                                           requestText:(nonnull NSString *)requestText
                                  correctedRequestText:(nullable NSString *)correctedRequestText
                                    requestBoundingBox:(nullable MMKBoundingBox *)requestBoundingBox;


Properties

found

@property (nonatomic, readonly) NSInteger found;

Approximate number of found objects.


displayType

@property (nonatomic, readonly) MMKSearchDisplayType displayType;

Display type.


boundingBox

@property (nonatomic, readonly, nullable) MMKBoundingBox *boundingBox;

Bounding box of the response as a whole.

Optional field, can be nil.


sort

@property (nonatomic, readonly, nullable) MMKSearchSort *sort;

Server-chosen sorting.

Optional field, can be nil.


toponym

@property (nonatomic, readonly, nullable) MMKGeoObject *toponym;

Geocoder response to the toponym part of the query.

Optional field, can be nil.


toponymResultMetadata

@property (nonatomic, readonly, nullable)
    MMKSearchToponymResultMetadata *toponymResultMetadata;

Additional info for the response from toponym search.

Optional field, can be nil.


businessResultMetadata

@property (nonatomic, readonly, nullable)
    MMKSearchBusinessResultMetadata *businessResultMetadata;

Additional info for the response from organization search.

Optional field, can be nil.


reqid

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

Server-generated request ID.


context

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

Server-generated request context.


requestText

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

Initial request text.


correctedRequestText

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

Initial request text with correction of spelling mistakes.

Optional field, can be nil.


requestBoundingBox

@property (nonatomic, readonly, nullable) MMKBoundingBox *requestBoundingBox;

Initial request bounding box.

Optional field, can be nil.