MapKit Mobile SDK

Warning

This feature is available in the Full MapKit SDK version

MMKSearchMetadata

class MMKSearchMetadata : NSObject, MMKBaseMetadata

Additional info for search response;

Summary

Class methods

 init(found: Int,
 displayType: MMKSearchDisplayType,
 boundingBox: MMKBoundingBox?,
       sort: MMKSearchSort?,
    toponym: MMKGeoObject?,
 toponymResultMetadata: MMKSearchToponymResultMetadata?,
 businessResultMetadata: MMKSearchBusinessResultMetadata?,
      reqid: String,
    context: String,
 requestText: String,
 correctedRequestText: String?,
 request requestBoundingBox: MMKBoundingBox?)

Properties

var found: Int { get }
Approximate number of found objects

var displayType: MMKSearchDisplayType { get }
Display type

var boundingBox: MMKBoundingBox? { get }
Bounding box of the response as a whole

var sort: MMKSearchSort? { get }
Server-chosen sorting

var toponym: MMKGeoObject? { get }
Geocoder response to the toponym part of the query

var toponymResultMetadata: MMKSearchToponymResultMetadata? { get }
Additional info for the response from toponym search

var businessResultMetadata: MMKSearchBusinessResultMetadata? { get }
Additional info for the response from organization search

var reqid: String { get }
Server-generated request ID

var context: String { get }
Server-generated request context

var requestText: String { get }
Initial request text

var correctedRequestText: String? { get }
Initial request text with correction of spelling mistakes

var requestBoundingBox: MMKBoundingBox? { get }
Initial request bounding box

Class methods

init(found:displayType:boundingBox:sort:toponym:toponymResultMetadata:businessResultMetadata:reqid:context:requestText:correctedRequestText:request:)

 init(found: Int,
 displayType: MMKSearchDisplayType,
 boundingBox: MMKBoundingBox?,
       sort: MMKSearchSort?,
    toponym: MMKGeoObject?,
 toponymResultMetadata: MMKSearchToponymResultMetadata?,
 businessResultMetadata: MMKSearchBusinessResultMetadata?,
      reqid: String,
    context: String,
 requestText: String,
 correctedRequestText: String?,
 request requestBoundingBox: MMKBoundingBox?)

Properties

found

var found: Int { get }

Approximate number of found objects.


displayType

var displayType: MMKSearchDisplayType { get }

Display type.


boundingBox

var boundingBox: MMKBoundingBox? { get }

Bounding box of the response as a whole.

Optional field, can be nil.


sort

var sort: MMKSearchSort? { get }

Server-chosen sorting.

Optional field, can be nil.


toponym

var toponym: MMKGeoObject? { get }

Geocoder response to the toponym part of the query.

Optional field, can be nil.


toponymResultMetadata

var toponymResultMetadata: MMKSearchToponymResultMetadata? { get }

Additional info for the response from toponym search.

Optional field, can be nil.


businessResultMetadata

var businessResultMetadata: MMKSearchBusinessResultMetadata? { get }

Additional info for the response from organization search.

Optional field, can be nil.


reqid

var reqid: String { get }

Server-generated request ID.


context

var context: String { get }

Server-generated request context.


requestText

var requestText: String { get }

Initial request text.


correctedRequestText

var correctedRequestText: String? { get }

Initial request text with correction of spelling mistakes.

Optional field, can be nil.


requestBoundingBox

var requestBoundingBox: MMKBoundingBox? { get }

Initial request bounding box.

Optional field, can be nil.


In this article: