AutoUpdateSettings - @magiclane/maps-sdk API Reference

AutoUpdateSettings class

Configuration for auto update

Core

Signature:

export declare class AutoUpdateSettings

Constructor	Modifiers	Description
(constructor)({ isAutoUpdateForRoadMapEnabled, isAutoUpdateForViewStyleHighResEnabled, isAutoUpdateForViewStyleLowResEnabled, isAutoUpdateForHumanVoiceEnabled, isAutoUpdateForComputerVoiceEnabled, isAutoUpdateForCarModelEnabled, isAutoUpdateForResourcesEnabled, onAutoUpdateComplete, }, input)		Constructor for initializing the auto-update settings with default values.

Property	Modifiers	Type	Description
isAutoUpdateForCarModelEnabled	`readonly`	boolean	Whether the update for the car models is enabled
isAutoUpdateForComputerVoiceEnabled	`readonly`	boolean	Whether the update for the computer voices is enabled
isAutoUpdateForHumanVoiceEnabled	`readonly`	boolean	Whether the update for the human voices is enabled
isAutoUpdateForResourcesEnabled	`readonly`	boolean	Whether the update for the resources (icons, translations) is enabled
isAutoUpdateForRoadMapEnabled	`readonly`	boolean	Whether the update for the road maps is enabled
isAutoUpdateForViewStyleHighResEnabled	`readonly`	boolean	Whether the update for the map styles high resolution is enabled
isAutoUpdateForViewStyleLowResEnabled	`readonly`	boolean	Whether the update for the map styles low resolution is enabled
onAutoUpdateComplete?	`readonly`	(type: ContentType, error: GemError) => void	(Optional) Callback to be called when an auto update is completed Provides the content type and the error code

Method	Modifiers	Description
allDisabled({ onAutoUpdateComplete, }, input)	`static`	Factory method to create an instance where all update options are disabled.
allEnabled({ onAutoUpdateComplete, }, input)	`static`	Factory method to create an instance where all update options are enabled.
isUpdateAllowedForType(type)		Determines if updates are allowed for a given content type. Returns `true` if the content type is enabled for auto-update, otherwise returns `false`.