diff options
author | Josh Erb <josh.erb@mapbox.com> | 2018-12-13 16:34:31 -0500 |
---|---|---|
committer | Josh Erb <josherb4@gmail.com> | 2019-01-30 13:18:45 -0500 |
commit | 5d891b4b2a7ce4f71bfb5b31a08aafa64db0a003 (patch) | |
tree | 1e93304dc2f5aa3c53c1ec257aa3ea566e513449 /platform/darwin/src/MGLOfflinePack.h | |
parent | 8faee2554692ae13da5fbb68d3eef2ebb09a0c86 (diff) | |
download | qtlocation-mapboxgl-5d891b4b2a7ce4f71bfb5b31a08aafa64db0a003.tar.gz |
[ios][documenation] add additional code snippets to API docs
Diffstat (limited to 'platform/darwin/src/MGLOfflinePack.h')
-rw-r--r-- | platform/darwin/src/MGLOfflinePack.h | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/platform/darwin/src/MGLOfflinePack.h b/platform/darwin/src/MGLOfflinePack.h index 3d22f74e72..7b241e0248 100644 --- a/platform/darwin/src/MGLOfflinePack.h +++ b/platform/darwin/src/MGLOfflinePack.h @@ -103,6 +103,20 @@ typedef struct __attribute__((objc_boxable)) MGLOfflinePackProgress { To create an instance of `MGLOfflinePack`, use the `+[MGLOfflineStorage addPackForRegion:withContext:completionHandler:]` method. A pack created using `-[MGLOfflinePack init]` is immediately invalid. + + ### Example + ```swift + MGLOfflineStorage.shared.addPack(for: region, withContext: context!) { (pack, error) in + guard error == nil else { + // If download fails, log the error to the console + print("Error: \(error?.localizedDescription ?? "unknown error")") + return + } + + // Start an MGLOfflinePack download + pack!.resume() + } + ``` */ MGL_EXPORT @interface MGLOfflinePack : NSObject |