NDSStoreConfiguration

public struct NDSStoreConfiguration

Configuration of the NDSStore.

Important

This is a Public Preview API. It may be changed or removed at any time.

Lifecycle


                    
                    
                    init(mapDataPath:keystorePath:accessPermit:ndsStoreUpdateConfig:geopoliticalView:)

Creates an instance of NDSStoreConfiguration.

Declaration

Swift

public init(
    mapDataPath: String,
    keystorePath: String? = nil,
    accessPermit: NDSStoreAccessPermit? = nil,
    ndsStoreUpdateConfig: NDSStoreUpdateConfig? = nil,
    geopoliticalView: String? = nil
)

Parameters

`mapDataPath`	See `mapDataPath`.
`keystorePath`	See `keystorePath`.
`accessPermit`	See `accessPermit`.
`ndsStoreUpdateConfig`	See `ndsStoreUpdateConfig`.
`geopoliticalView`	See `geopoliticalView`.

Public

mapDataPath
The path to the nds store, the directory that contains the ‘ROOT.NDS’ file.

The directory and its content must be accessible. In case map updates are configured, that location also needs to be writable.
Declaration
Swift

public let mapDataPath: String
keystorePath
Path to the keystore file containing encryption keys for the NDS store files.

If the NDS store is encrypted, the keystore file is required.
Declaration
Swift

public let keystorePath: String?
accessPermit
The access permit for the NDS store. If the keystore file is encrypted, this permit is required.
Declaration
Swift

public let accessPermit: NDSStoreAccessPermit?
ndsStoreUpdateConfig
The configuration for the updates of the NDS store.

If not specified, map updates are not configured and the methods of the NDSStore are no-ops.
Declaration
Swift

public let ndsStoreUpdateConfig: NDSStoreUpdateConfig?
geopoliticalView
Set the country whose view on disputant areas should be used.

Only the update regions belonging to the chosen geopolitical view are subject to updates.

The value must be a country specifier in ISO 3166-1 alpha-2 form (e.g. “TR”).

If not provided or there is no special view defined in the map for the given country, the international geopolitical view will be used.
Declaration
Swift

public let geopoliticalView: String?