TomTom SDK for iOS CompositeRegionState

CompositeRegionState

public struct CompositeRegionState : Equatable

The state information of the CompositeRegion.

Important

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

  • The summarized current operations for all the update regions of the CompositeRegion.

    Inside the CompositeRegion there could be multiple map operations (update & install / uninstall) in execution or waiting to be executed. A nil value means no operation being executed or waiting to be executed.

    Declaration

    Swift

    public let currentOperation: CurrentCompositeRegionOperation?

  • The combined install state of all the update regions of the CompositeRegion.

    Declaration

    Swift

    public let installState: InstallState

  • The summarized completed map operation of the CompositeRegion.

    A nil value means that no completed map operations are known.

    Performing a map operation on a CompositeRegion could result in multiple subsequent map operations in execution or waiting to be executed. The lastCompletedOperation will be determined when all the sub-sequenced map operations of the CompositeRegion are finished.

    Declaration

    Swift

    public let lastCompletedOperation: CompletedMapOperation?

  • The information about the available CompositeRegion.

    The information is nil if the map region is up-to-date, collecting update information is in progress, or if no information about updates is available.

    Declaration

    Swift

    public let updateInfo: UpdateInfo?

  • The combined update state of all the update regions of the MapRegion.

    A nil value means the installState is inconsistent, or that no information about updates is available.

    Declaration

    Swift

    public let updateState: UpdateState?