summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjmkiley <jordan.kiley@mapbox.com>2019-07-09 15:02:55 -0700
committerjmkiley <jordan.kiley@mapbox.com>2019-07-09 15:03:39 -0700
commit7ddc8471f07b0cfea3926afdb53f5d1208147284 (patch)
treee679b4883d7ace8e05eb6856ebd6d9e21372880b
parent3db52c9765f2c1164ad71068f4992c246ce16cd2 (diff)
downloadqtlocation-mapboxgl-7ddc8471f07b0cfea3926afdb53f5d1208147284.tar.gz
[ios] updated docs
-rw-r--r--platform/darwin/src/MGLOfflineStorage.h12
1 files changed, 8 insertions, 4 deletions
diff --git a/platform/darwin/src/MGLOfflineStorage.h b/platform/darwin/src/MGLOfflineStorage.h
index 10f092ccc2..939d0d1718 100644
--- a/platform/darwin/src/MGLOfflineStorage.h
+++ b/platform/darwin/src/MGLOfflineStorage.h
@@ -303,7 +303,10 @@ MGL_EXPORT
- (void)removePack:(MGLOfflinePack *)pack withCompletionHandler:(nullable MGLOfflinePackRemovalCompletionHandler)completion;
/**
- Forces the offline pack to revalidate its tiles with tiles from the server.
+ Checks that the tiles in the specified offline pack match those from the
+ server. Local tiles that do not match the latest version on the server
+ are updated.
+
This is more efficient than deleting the offline pack and downloading it
again. If the data stored locally matches that on the server, new data will
not be downloaded.
@@ -366,7 +369,7 @@ MGL_EXPORT
ambient cache size to 30 MB and offline packs use 20 MB, there may only be 10 MB
reserved for the ambient cache.
- This method should be called before the map and map style have been loade.
+ This method should be called before the map and map style have been loaded.
This method is potentially expensive, as the ambient cache will trim cached data
to prevent the database from being larger than the specified amount.
@@ -379,8 +382,9 @@ MGL_EXPORT
- (void)setMaximumAmbientCacheSize:(NSInteger)cacheSize withCallback:(void (^)(NSError *_Nullable error))completion;
/**
- Forces ambient cache tiles to be revalidated. The local tiles are checked
- against those on the tile server to ensure that they are the latest version.
+ Checks that the tiles in the ambient cache match those from the server. Local
+ tiles that do not match the latest version on the server are updated.
+
This is more efficient than cleaning the cache because valid local tiles will
not be downloaded again.