setUpdatesEnabled

Enables or disables map updates.

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).

Parameters

enabled

true if map updates are enabled, false otherwise.

Note: when NdsStore is instantiated, map update is disabled.

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.