setUpdatesEnabled

fun setUpdatesEnabled(updatesEnabled: Boolean)

Enables or disables map updates.

When updates are enabled automatic update operations (including map extension and repair of unusable regions) are started, according to the configuration.

If map updates are disabled, this component will not write to the map for any reason. Automatic updates will not run. Updates that were running are safely interrupted. In such case, call to this method will block until all ongoing updates, if any, have stopped.

Note: When an update of the map is interrupted unexpectedly (e.g. power loss), the region that was being updated could become unusable.

Note: If updates are enabled with this method, the component will first try to fix unusable map regions. After that, the automatic map updates that were configured will run again, unless previously disallowed using allowAutomaticUpdates(false).

Note: If the updates are enabled, all clients of the NdsStoreAccess must participate in the access synchronization, through NdsStoreAccessSync. Failure to do so may result in unexpected behavior, including application crashes.

Parameters

updatesEnabled

true if map updates are enabled, false otherwise.

Defaults to false.

Below table shows the behavior of map updates when enabled or disabled:

Automatic Updates Updates Behavior
Allowed Enabled Automatic updates run as configured.
Allowed Disabled All manual and automatic updates are stopped.
Disallowed Enabled No automatic updates triggered.
Disallowed Disabled Manual map updates are stopped too.