Class YMKMapKit

Provides access to all services in the SDK.

Initialize the MapKit factory before using this class.

Note: MapKit holds listener/delegate objects by weak references. You need to have strong references to them somewhere in the client code.

Instance Methods


- createDrivingRouter	Creates a manager that builds driving routes using the specified endpoints and other route parameters.
- createLocationManager	Creates a manager that allows to listen for device location updates.
- createLocationSimulatorWithGeometry:	Creates a suspended LocationSimulator object with the given geometry.
- createMapWindowWithPlatformView:	Creates an internal "window" object that is used to show the map.
- createMasstransitRouter	Creates a manager that builds public transit routes using the origin and destination points.
- createPanoramaPlayerWithPlatformView:	Creates an internal "window" object needed to show the panorama viewer.
- createPanoramaService	Creates a service that allows to find a panorama closest to the chosen point.
- createPedestrianRouter	Creates a manager that builds pedestrian routes using the origin and destination points.
- createSearchManagerWithSearchManagerType:	Creates a manager that allows to search for various geographical objects using a variety of parameters.
- onStart	Notifies MapKit when the application resumes the foreground state.
- onStop	Notifies MapKit when the application pauses and goes to the background.
- setCompletionHandler:forBackgroundURLSession:


- createDrivingRouter	Creates a manager that builds driving routes using the specified endpoints and other route parameters.
- createLocationManager	Creates a manager that allows to listen for device location updates.
- createLocationSimulatorWithGeometry:	Creates a suspended LocationSimulator object with the given geometry.
- createMapWindowWithPlatformView:	Creates an internal "window" object that is used to show the map.
- createMasstransitRouter	Creates a manager that builds public transit routes using the origin and destination points.
- createPanoramaPlayerWithPlatformView:	Creates an internal "window" object needed to show the panorama viewer.
- createPanoramaService	Creates a service that allows to find a panorama closest to the chosen point.
- createPedestrianRouter	Creates a manager that builds pedestrian routes using the origin and destination points.
- createSearchManagerWithSearchManagerType:	Creates a manager that allows to search for various geographical objects using a variety of parameters.
- onStart	Notifies MapKit when the application resumes the foreground state.
- onStop	Notifies MapKit when the application pauses and goes to the background.
- setCompletionHandler:forBackgroundURLSession:

Class Methods


+ mapKit
+ setApiKey:
+ sharedInstance

Properties


offlineCacheManager
valid	Tells if this object is valid or no.
version	Returns the version of the mapkit bundle.

Method Detail

-createDrivingRouter

- (nullable YMKDrivingRouter *)createDrivingRouter

Creates a manager that builds driving routes using the specified endpoints and other route parameters.

-createLocationManager

- (nullable YMKLocationManager *)createLocationManager

Creates a manager that allows to listen for device location updates.

-createLocationSimulatorWithGeometry:

- (nullable YMKLocationSimulator *)createLocationSimulatorWithGeometry:(nonnull YMKPolyline *)geometry

Creates a suspended LocationSimulator object with the given geometry.

-createMapWindowWithPlatformView:

- (nullable YMKMapWindow *)createMapWindowWithPlatformView:(nullable YRTView *)platformView

Creates an internal "window" object that is used to show the map.

Do not call this method - it is for internal use only. To show the map, please use the corresponding map "view" object.

-createMasstransitRouter

- (nullable YMKMasstransitRouter *)createMasstransitRouter

Creates a manager that builds public transit routes using the origin and destination points.

-createPanoramaPlayerWithPlatformView:

- (nullable YMKPanoramaPlayer *)createPanoramaPlayerWithPlatformView:(nullable YRTView *)platformView

Creates an internal "window" object needed to show the panorama viewer.

Do not call this method - it is for internal use only. To open the panorama viewer, please use the corresponding panorama "view" object.

-createPanoramaService

- (nullable YMKPanoramaService *)createPanoramaService

Creates a service that allows to find a panorama closest to the chosen point.

-createPedestrianRouter

- (nullable YMKPedestrianRouter *)createPedestrianRouter

Creates a manager that builds pedestrian routes using the origin and destination points.

-createSearchManagerWithSearchManagerType:

- (nullable YMKSearchManager *)createSearchManagerWithSearchManagerType:(YMKSearchSearchManagerType)searchManagerType

Creates a manager that allows to search for various geographical objects using a variety of parameters.

+mapKit

+ (instancetype)mapKit

-onStart

- (void)onStart

Notifies MapKit when the application resumes the foreground state.

-onStop

- (void)onStop

Notifies MapKit when the application pauses and goes to the background.

+setApiKey:

+ (void)setApiKey:(NSString *)apiKey

-setCompletionHandler:forBackgroundURLSession:

- (void)setCompletionHandler:(void(^)(void))completionHandler
     forBackgroundURLSession:(NSString *)identifier

+sharedInstance

+ (instancetype)sharedInstance

Property Detail

offlineCacheManager

(assign, readonly) YMKOfflineCacheManager * offlineCacheManager

Attention.

This feature is not available in the free MapKit version.

Returns a manager that handles cached resources offline.

valid

(assign, readonly, getter=isValid) BOOL valid

Tells if this object is valid or no.

Any method called on an invalid object will throw an exception. The object becomes invalid only on UI thread, and only when its implementation depends on objects already destroyed by now. Please refer to general docs about the interface for details on its invalidation.

version

(assign, readonly) NSString * version

Returns the version of the mapkit bundle.