NMConfigurationSettings Class Reference

Inherits <NSObject>.

Instance Methods
(nullable instancetype)	- initWithCustomResourcesPath:offlineMapsPath:innerFilesPath:mapSchemeId:

Class Methods
(nullable instancetype)	+ settingsWithCustomResourcesPath:offlineMapsPath:innerFilesPath:mapSchemeId:

Properties
NSString *	customResourcesPath
NSString *	offlineMapsPath
NSString *	innerFilesPath
BOOL	useBetaMapServer
BOOL	useBetaRoutingServer
NSString *	mapSchemeId
NSURL *	urlForTrafficServer
BOOL	pauseGraphicsWhenEnteringBackground

Detailed Description

NMConfigurationSettings class describes the SDK initialization settings.

Method Documentation

initWithCustomResourcesPath:offlineMapsPath:innerFilesPath:mapSchemeId:()

- (nullable instancetype) initWithCustomResourcesPath:		(nullable NSString *)	customResourcesPath
offlineMapsPath:		(nullable NSString *)	offlineMapsPath
innerFilesPath:		(nullable NSString *)	innerFilesPath
mapSchemeId:		(nullable NSString *)	mapSchemeId

Returns instance of NMConfigurationSettings class.

settingsWithCustomResourcesPath:offlineMapsPath:innerFilesPath:mapSchemeId:()

+ (nullable instancetype) settingsWithCustomResourcesPath:		(nullable NSString *)	customResourcesPath
offlineMapsPath:		(nullable NSString *)	offlineMapsPath
innerFilesPath:		(nullable NSString *)	innerFilesPath
mapSchemeId:		(nullable NSString *)	mapSchemeId

Returns instance of NMConfigurationSettings class.

Property Documentation

customResourcesPath

- (NSString*) customResourcesPath

readwritenonatomiccopy

Path to a folder containing resources to customize map view. Specify this folder if you want to create your own map style.

innerFilesPath

- (NSString*) innerFilesPath

readwritenonatomiccopy

Path to a folder where the SDK will put files created at runtime. The default path is 'NMData' folder in NSApplicationSupportDirectory.

mapSchemeId

- (NSString*) mapSchemeId

readwritenonatomiccopy

The ID of the scheme, which will be used to render map.

offlineMapsPath

- (NSString*) offlineMapsPath

readwritenonatomiccopy

Path to a folder containing offline maps. Specify this folder to provide the SDK with maps, which will be used in the offline version of the SDK.

pauseGraphicsWhenEnteringBackground

- (BOOL) pauseGraphicsWhenEnteringBackground

readwritenonatomicassign

Indicates whether the SDK should pause graphics when the application enters the background and resume graphics when the application enters the foreground. If 'NO' is specified, the SDK doesn't pause and resume graphics itself. In this case the SDK user should manage pausing and resuming graphics himself using pauseGraphics and resumeGraphics methods of NMSdk. If 'YES' is specified, the SDK manages pausing and resuming graphics itself.

Default value is 'YES'.

urlForTrafficServer

- (NSURL*) urlForTrafficServer

readwritenonatomiccopy

URL to the traffic server used by the SDK. If not set, default server will be used.

useBetaMapServer

- (BOOL) useBetaMapServer

readwritenonatomicassign

Indicates that the SDK should use server with beta map tiles.

Note

If SDK uses offline maps, changing this setting has no effect.

Default value is 'NO'.

useBetaRoutingServer

- (BOOL) useBetaRoutingServer

readwritenonatomicassign

Indicates that the SDK should use routing server based on beta maps.

Note

If SDK calculates routes offline, changing this setting has no effect.

Default value is 'NO'.