mapwize-sdk-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

OfflineManager is the entry point to download Mapwize offline data. It can be instantiated using createOfflineManager(mapwizeConfiguration:MapwizeConfiguration)

Hierarchy

  • OfflineManager

Index

Properties

Properties

checkForUpdate

checkForUpdate: (offlineRegion: OfflineRegion) => Promise<Boolean>

check if there is an update for a given offline region

Type declaration

downloadData

downloadData: (offlineRegion: OfflineRegion, onProgress: (progress: number) => void) => Promise<OfflineRegion>

Download offline data for the given (venue, universe) pair

Type declaration

    • Parameters

      • offlineRegion: OfflineRegion
      • onProgress: (progress: number) => void
          • (progress: number): void

          • Parameters

            • progress: number

            Returns void

      Returns Promise<OfflineRegion>

getOfflineRegion

getOfflineRegion: (venue: Venue, universe: Universe) => Promise<OfflineRegion>

Get an offline region using a (venue, universe) pair if it exists

param

the venue that has been downloaded.

param

the universe that has been downloaded.

Type declaration

getOfflineRegions

getOfflineRegions: () => Promise<OfflineRegion[]>

Get all the offline regions

Type declaration

hasOfflineRegion

hasOfflineRegion: (venue: Venue, universe: Universe) => Promise<boolean>

Check if a pair of venue universe is accessible offline

param

the venue to be downloaded.

param

the universe to be downloaded.

Type declaration

removeData

removeData: (offlineRegion: OfflineRegion) => Promise<void>

remove an offline region

Type declaration

updateData

updateData: (offlineRegion: OfflineRegion, onProgress: (progress: number) => void) => Promise<OfflineRegion>

Update the offline data for a given offline region if something has changed.

Type declaration

    • Parameters

      • offlineRegion: OfflineRegion
      • onProgress: (progress: number) => void
          • (progress: number): void

          • Parameters

            • progress: number

            Returns void

      Returns Promise<OfflineRegion>

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Inherited property

Generated using TypeDoc