Warning

This feature is available in the Full MapKit SDK version

MMKSearchToponymObjectMetadata

@interface MMKSearchToponymObjectMetadata : NSObject <MMKBaseMetadata>

Additional data for toponym objects.

Summary

Class methods

+ (nonnull MMKSearchToponymObjectMetadata *)toponymObjectMetadataWithAddress:(nonnull MMKSearchAddress *)address
                                                                   precision:(nullable NSNumber *)precision
                                                                  formerName:(nullable NSString *)formerName
                                                                balloonPoint:(nonnull MMKPoint *)balloonPoint
                                                                          id:(nullable NSString *)id;

Properties

@property (nonatomic, readonly, nonnull) MMKSearchAddress *address;
Structured toponym address

@property (nonatomic, readonly, nullable) NSNumber *precision;
Toponym precision

@property (nonatomic, readonly, nullable) NSString *formerName;
Former name for toponym if any

@property (nonatomic, readonly, nonnull) MMKPoint *balloonPoint;
Point where balloon for the toponym should be shown

@property (nonatomic, readonly, nullable) NSString *id;
Persistent toponym id (available for Mappable-owned regions)

Class methods

toponymObjectMetadataWithAddress:precision:formerName:balloonPoint:id:

+ (nonnull MMKSearchToponymObjectMetadata *)toponymObjectMetadataWithAddress:(nonnull MMKSearchAddress *)address
                                                                   precision:(nullable NSNumber *)precision
                                                                  formerName:(nullable NSString *)formerName
                                                                balloonPoint:(nonnull MMKPoint *)balloonPoint
                                                                          id:(nullable NSString *)id;


Properties

address

@property (nonatomic, readonly, nonnull) MMKSearchAddress *address;

Structured toponym address


precision

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

Toponym precision.

Optional field, can be nil.


formerName

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

Former name for toponym if any.

Optional field, can be nil.


balloonPoint

@property (nonatomic, readonly, nonnull) MMKPoint *balloonPoint;

Point where balloon for the toponym should be shown. Differs for direct and reverse search modes: Direct mode -- toponym center. Reverse mode -- toponym nearest point to the given coordinates.


id

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

Persistent toponym id (available for Mappable-owned regions).

Optional field, can be nil.