MMKDrivingAnnotation

Warning

This feature is available in the Full MapKit SDK version

@interface MMKDrivingAnnotation : NSObject

The annotation that is displayed on the map.

Summary

Class methods

+ (nonnull MMKDrivingAnnotation *)annotationWithAction:(nullable NSNumber *)action
                                               toponym:(nullable NSString *)toponym
                                       descriptionText:(nonnull NSString *)descriptionText
                                        actionMetadata:(nullable MMKDrivingActionMetadata *)actionMetadata
                                             landmarks:(nonnull NSArray<NSNumber *> *)landmarks
                                         toponymPhrase:(nonnull NSArray<MMKDrivingToponymPhrase *> *)toponymPhrase;

Properties

@property (nonatomic, readonly, nullable) NSNumber *action;
Driver action

@property (nonatomic, readonly, nullable) NSString *toponym;
The toponym of the location

@property (nonatomic, readonly, nonnull) NSString *descriptionText;
Description text to display

@property (nonatomic, readonly, nullable)
    MMKDrivingActionMetadata *actionMetadata;

Action metadata

@property (nonatomic, readonly, nonnull) NSArray<NSNumber *> *landmarks;
Significant landmarks

@property (nonatomic, readonly, nonnull)
    NSArray<MMKDrivingToponymPhrase *> *toponymPhrase;

Toponym phrases with positions for pronunciation

Class methods

annotationWithAction:toponym:descriptionText:actionMetadata:landmarks:toponymPhrase:

+ (nonnull MMKDrivingAnnotation *)annotationWithAction:(nullable NSNumber *)action
                                               toponym:(nullable NSString *)toponym
                                       descriptionText:(nonnull NSString *)descriptionText
                                        actionMetadata:(nullable MMKDrivingActionMetadata *)actionMetadata
                                             landmarks:(nonnull NSArray<NSNumber *> *)landmarks
                                         toponymPhrase:(nonnull NSArray<MMKDrivingToponymPhrase *> *)toponymPhrase;


Properties

action

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

Driver action.

Optional field, can be nil.


toponym

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

The toponym of the location.

Optional field, can be nil.


descriptionText

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

Description text to display.


actionMetadata

@property (nonatomic, readonly, nullable)
    MMKDrivingActionMetadata *actionMetadata;

Action metadata.

Optional field, can be nil.


landmarks

@property (nonatomic, readonly, nonnull) NSArray<NSNumber *> *landmarks;

Significant landmarks.


toponymPhrase

@property (nonatomic, readonly, nonnull)
    NSArray<MMKDrivingToponymPhrase *> *toponymPhrase;

Toponym phrases with positions for pronunciation.