@magiclane/maps-sdk
    Preparing search index...

    Class AutoUpdateSettings

    Configuration for auto update

    Index

    Constructors

    constructor

    Properties

    isAutoUpdateForCarModelEnabled isAutoUpdateForComputerVoiceEnabled isAutoUpdateForHumanVoiceEnabled isAutoUpdateForResourcesEnabled isAutoUpdateForRoadMapEnabled isAutoUpdateForViewStyleHighResEnabled isAutoUpdateForViewStyleLowResEnabled onAutoUpdateComplete?

    Methods

    isUpdateAllowedForType allDisabled allEnabled

    Constructors

    • Constructor for initializing the auto-update settings with default values.

      Parameters

      • __namedParameters: {
            isAutoUpdateForCarModelEnabled?: boolean;
            isAutoUpdateForComputerVoiceEnabled?: boolean;
            isAutoUpdateForHumanVoiceEnabled?: boolean;
            isAutoUpdateForResourcesEnabled?: boolean;
            isAutoUpdateForRoadMapEnabled?: boolean;
            isAutoUpdateForViewStyleHighResEnabled?: boolean;
            isAutoUpdateForViewStyleLowResEnabled?: boolean;
            onAutoUpdateComplete?: (type: ContentType, error: GemError) => void;
        } = {}

      Returns AutoUpdateSettings

    Properties

    isAutoUpdateForCarModelEnabled: boolean

    Whether the update for the car models is enabled

    isAutoUpdateForComputerVoiceEnabled: boolean

    Whether the update for the computer voices is enabled

    isAutoUpdateForHumanVoiceEnabled: boolean

    Whether the update for the human voices is enabled

    isAutoUpdateForResourcesEnabled: boolean

    Whether the update for the resources (icons, translations) is enabled

    isAutoUpdateForRoadMapEnabled: boolean

    Whether the update for the road maps is enabled

    isAutoUpdateForViewStyleHighResEnabled: boolean

    Whether the update for the map styles high resolution is enabled

    isAutoUpdateForViewStyleLowResEnabled: boolean

    Whether the update for the map styles low resolution is enabled

    onAutoUpdateComplete?: (type: ContentType, error: GemError) => void

    Callback to be called when an auto update is completed Provides the content type and the error code

    Methods

    • Determines if updates are allowed for a given content type. Returns true if the content type is enabled for auto-update, otherwise returns false.

      Parameters

      Returns boolean

    • Factory method to create an instance where all update options are disabled.

      Parameters

      • __namedParameters: { onAutoUpdateComplete?: (type: ContentType, error: GemError) => void } = {}

      Returns AutoUpdateSettings

    • Factory method to create an instance where all update options are enabled.

      Parameters

      • __namedParameters: { onAutoUpdateComplete?: (type: ContentType, error: GemError) => void } = {}

      Returns AutoUpdateSettings

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods