MMKMapKit
|
class MMKMapKit : NSObject |
Note
MapKit holds listener/delegate objects by weak references.
Provides access to all services in the SDK.
Initialize the MapKit factory before using this class.
You need to have strong references to them somewhere in the client code.
Summary
Instance methods
|
func setUserIdWithId(_ id: String) |
|
func setLocationManagerWith( locationManager: MMKLocationManager_) |
|
func resetLocationManagerToDefault() |
|
func onStart() |
|
func onStop() |
|
func createLocationManager() -> MMKLocationManager |
|
func createLocationSimulator(withGeometry geometry: MMKPolyline) -> MMKLocationSimulator |
|
func createLocationSimulator() -> MMKLocationSimulator |
|
func createDummyLocationManager() -> MMKDummyLocationManager |
|
func createTrafficLayer(with mapWindow: MMKMapWindow) -> MMKTrafficLayer |
|
func createRoadEventsManager() -> MMKRoadEventsManager |
|
func createUserLocationLayer(with mapWindow: MMKMapWindow) -> MMKUserLocationLayer |
Properties
|
var offlineCacheManager: MMKOfflineCacheManager { get } |
|
var storageManager: MMKStorageManager { get } |
|
var version: String { get } |
|
var isValid: Bool { get } |
Instance methods
setUserIdWithId(_:)
|
func setUserIdWithId(_ id: String) |
Sets the user id. Don't use this method directly. Use MapKitFactory.setUserId instead
|
Parameters |
|
|
id |
User id is your own identifier for all mapkit requests |
setLocationManagerWith(_:)
|
func setLocationManagerWith( locationManager: MMKLocationManager_) |
Sets single global location manager that is used by every module in MapKit by default. The provided location manager must have async implementation in it. Any location manager created by MapKit has async implementation. To provide your own source of location please use MMKDummyLocationManager. Application can change location manager at any moment, all MapKit modules will start receiving new location immediately.
resetLocationManagerToDefault()
|
func resetLocationManagerToDefault() |
Resets the global location manager to a default one, that is a location manager that is created by MMKMapKit::createLocationManager call.
onStart()
|
func onStart() |
Notifies MapKit when the application resumes the foreground state.
onStop()
|
func onStop() |
Notifies MapKit when the application pauses and goes to the background.
createLocationManager()
|
func createLocationManager() -> MMKLocationManager |
Creates a manager that allows to listen for device location updates.
createLocationSimulator(withGeometry:)
|
func createLocationSimulator(withGeometry geometry: MMKPolyline) -> MMKLocationSimulator |
Creates a suspended LocationSimulator object with the given geometry.
createLocationSimulator()
|
func createLocationSimulator() -> MMKLocationSimulator |
Creates a suspended LocationSimulator object. Geometry must be set manually.
createDummyLocationManager()
|
func createDummyLocationManager() -> MMKDummyLocationManager |
Creates a manager that functions as a location proxy.
createTrafficLayer(with:)
|
func createTrafficLayer(with mapWindow: MMKMapWindow) -> MMKTrafficLayer |
Creates the traffic layer.
createRoadEventsManager()
|
func createRoadEventsManager() -> MMKRoadEventsManager |
Creates a manager that allows to interact with road events.
createUserLocationLayer(with:)
|
func createUserLocationLayer(with mapWindow: MMKMapWindow) -> MMKUserLocationLayer |
Create layer with the user location icon.
Properties
offlineCacheManager
|
var offlineCacheManager: MMKOfflineCacheManager { get } |
Note
This feature is not available in the free MapKit version.
Returns a manager that handles offline maps, search index and road graph.
storageManager
|
var storageManager: MMKStorageManager { get } |
Returns a manager that handles disk size and IO errors.
version
|
var version: String { get } |
Returns the version of the MapKit bundle.
isValid
|
var isValid: Bool { get } |
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.