summaryrefslogtreecommitdiff
path: root/platform/darwin/src/MGLOfflineStorage.h
diff options
context:
space:
mode:
authorJosh Erb <josh.erb@mapbox.com>2018-10-30 18:03:56 -0400
committerJosh Erb <josherb4@gmail.com>2018-11-13 11:39:39 -0800
commitb891a8d6b0dc9e92a283756448b4671bef3da71f (patch)
tree23f717df2919ad7f6d1ef78054476575829f7021 /platform/darwin/src/MGLOfflineStorage.h
parentbf8b24fa8d30df374ee36be781b6a572036187b9 (diff)
downloadqtlocation-mapboxgl-b891a8d6b0dc9e92a283756448b4671bef3da71f.tar.gz
[ios][documentation] link API documentation to ios-sdk/examples
Diffstat (limited to 'platform/darwin/src/MGLOfflineStorage.h')
-rw-r--r--platform/darwin/src/MGLOfflineStorage.h10
1 files changed, 10 insertions, 0 deletions
diff --git a/platform/darwin/src/MGLOfflineStorage.h b/platform/darwin/src/MGLOfflineStorage.h
index 387045f845..0b2b5221cf 100644
--- a/platform/darwin/src/MGLOfflineStorage.h
+++ b/platform/darwin/src/MGLOfflineStorage.h
@@ -26,6 +26,11 @@ NS_ASSUME_NONNULL_BEGIN
If you only need to observe changes in a particular pack’s progress, you can
alternatively observe KVO change notifications to the pack’s `progress` key
path.
+
+ #### Related examples
+ See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/offline-pack/">
+ Download an offline map</a> example to learn how to calculate the progress
+ of an offline download.
*/
FOUNDATION_EXTERN MGL_EXPORT const NSNotificationName MGLOfflinePackProgressChangedNotification;
@@ -177,6 +182,11 @@ typedef NS_ENUM(NSUInteger, MGLResourceKind) {
packs. All of this class’s instance methods are asynchronous, reflecting the
fact that offline resources are stored in a database. The shared object
maintains a canonical collection of offline packs in its `packs` property.
+
+ #### Related examples
+ See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/offline-pack/">
+ Download an offline map</a> example to learn how to create and register an
+ offline pack for a defined region.
*/
MGL_EXPORT
@interface MGLOfflineStorage : NSObject