ArcGIS Runtime SDK for iOS: AGSVectorTileCache Class Reference
ArcGIS Runtime SDK for iOS  100.12
AGSVectorTileCache Class Reference

Description

A cache of tiles in a vector tile package.

Instances of this class represent a cache of tiles in a local vector tile package (.vtpk file). Local tile caches are ideal for providing basemaps or less frequently changing contextual layers, where network access is limited or non-existent. They can be created and downloaded onto a device by using an AGSExportVectorTilesTask object, or alternatively can be provisioned directly to local storage.

Since
100.2
Inheritance diagram for AGSVectorTileCache:
AGSLoadableBase AGSObject <AGSLoadable>

Instance Methods

(void) - cancelLoad
 
(void) - doCancelLoading
 
(void) - doStartLoading:
 
(instancetype) - initWithFileURL:
 
(instancetype) - initWithName:
 
(void) - loadDidFinishWithError:
 
(void) - loadWithCompletion:
 
(void) - onLoadStatusChanged
 
(void) - retryLoadWithCompletion:
 

Class Methods

(instancetype) + vectorTileCacheWithFileURL:
 
(instancetype) + vectorTileCacheWithName:
 

Properties

NSURL * fileURL
 
NSError * loadError
 
AGSLoadStatus loadStatus
 
AGSVectorTileSourceInfosourceInfo
 
AGSImagethumbnail
 

Method Documentation

◆ cancelLoad

- (void) cancelLoad
requiredinherited

Cancels loading if it is in progress, otherwise it does nothing. This should be called carefully because other objects could be waiting for loadWithCompletion: or retryLoadWithCompletion: to complete and this will call them all back with the error of NSUserCancelledError

Since
100

◆ doCancelLoading

- (void) doCancelLoading

Never call this method directly. The framework calls this method on a background thread when cancelLoad (AGSLoadable-p) is called. It is meant to be overriden by subclasses. Subclasses should override this method to cancel loading their data and call loadDidFinishWithError: (AGSLoadableBase(ForSubclassEyesOnly)) at the end passing in an error representing NSUserCancelledError.

Since
100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ doStartLoading:

- (void) doStartLoading: (BOOL)  retrying

Never call this method directly. The framework calls this method on a background thread when loadWithCompletion: (AGSLoadable-p) or retryLoadWithCompletion: (AGSLoadable-p) is called. It is meant to be overriden by subclasses. Subclasses should override this method to load their data and call loadDidFinishWithError: (AGSLoadableBase(ForSubclassEyesOnly)) upon completion, passing in the error if any.

Parameters
retryingflag that is true if this method was called from retryLoadWithCompletion: (AGSLoadable-p).
Since
100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ initWithFileURL:

- (instancetype) initWithFileURL: (NSURL *)  fileURL

Creates a vector tile cache object with a path to a local vector tile package (.vtpk file).

Parameters
fileURLThe URL to a local vector tile package (.vtpk file).
Since
100.2

◆ initWithName:

- (instancetype) initWithName: (NSString *)  name

Creates a vector tile cache object with the name of a local vector tile package (.vtpk file) within the application bundle or shared documents directory.

Parameters
nameThe name of the local vector tile package (same as the name of the .vtpk file without the file extension).
Since
100.2

◆ loadDidFinishWithError:

- (void) loadDidFinishWithError: (nullable NSError *)  error

Only subclasses should call this method in doStartLoading: (AGSLoadableBase(ForSubclassEyesOnly)) and doCancelLoading (AGSLoadableBase(ForSubclassEyesOnly)) when done loading or failed to load.

Since
100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ loadWithCompletion:

- (void) loadWithCompletion: (nullable void(^)(NSError *__nullable error))  completion
requiredinherited

Loads data for the object asynchronously. The completion block is invoked upon completion.

You can call this method any number of times, however only one attempt is made to load the data. If it is already loading, it will just continue to load (i.e. not force a reload). If it has already loaded successfully, the completion block will be invoked right away. If it has already failed to load, the completion block will be invoked right away with error previously encountered. This method supports multiple callers and will call them all back on completion. However, each caller's completion block will be invoked once and only once.

Parameters
completionblock that is invoked when object loads successfully or fails to load. An error is passed to the block if the object fails to load.
Note
The completion block is always invoked on the main thread.
Since
100
See also
- cancelLoad to cancel loading
- retryLoadWithCompletion: to force reload

◆ onLoadStatusChanged

- (void) onLoadStatusChanged

Never call this method directly. The framework calls this method on a background thread when AGSLoadable::loadStatus changes is called. Subclasses can optionally implement this to know when their loading status has changed.

Since
100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ retryLoadWithCompletion:

- (void) retryLoadWithCompletion: (nullable void(^)(NSError *__nullable error))  completion
requiredinherited

Tries to reload when an object has failed to load. This method should be called judiciously. It should be called when:

  1. you didn't have network connectivity earlier when it failed and you want to retry now that you have connectivity
  2. the server was down earlier when it failed and you want to retry
  3. the request is taking too long and you want to cancel it and retry, in which case you will first call cancelLoad and then this method

If the data hasn't started loading, it will start loading. If it is already loading, it will just continue to load. If it has already loaded successfully, calls back right away. If it has already failed to load, tries again. This method supports multiple callers and will call them all back on completion. However, each caller's completion block will be invoked once and only once.

Parameters
completionblock that is invoked when object loads successfully or fails to load. An error is passed to the block if the object fails to load.
Note
The completion block is always invoked on the main thread.
Since
100

◆ vectorTileCacheWithFileURL:

+ (instancetype) vectorTileCacheWithFileURL: (NSURL *)  fileURL

Creates a vector tile cache object with a path to a local vector tile package (.vtpk file).

Parameters
fileURLThe URL to a local vector tile package (.vtpk file).
Returns
A new vector tile cache object.
Since
100.2

◆ vectorTileCacheWithName:

+ (instancetype) vectorTileCacheWithName: (NSString *)  name

Creates a vector tile cache object with the name of a local vector tile package (.vtpk file) within the application bundle or shared documents directory.

Parameters
nameThe name of the local vector tile package (same as the name of the .vtpk file without the file extension).
Returns
A new vector tile cache object.
Since
100.2

Property Documentation

◆ fileURL

- (NSURL*) fileURL
readnonatomicstrong

The file URL of the vector tile package (.vtpk file) being used by this vector tile cache object.

Since
100.2

◆ loadError

- (NSError*) loadError
readnonatomicstronginherited

The error that was encountered during the most recent load operation. Will be nil if the operation succeeded.

Since
100

◆ loadStatus

- (AGSLoadStatus) loadStatus
readrequirednonatomicassigninherited

Status of the load operation.

Since
100

◆ sourceInfo

- (AGSVectorTileSourceInfo*) sourceInfo
readnonatomicstrong

Metadata about the source of vector tiles.

Since
100.2

◆ thumbnail

- (AGSImage*) thumbnail
readnonatomicstrong

The thumbnail image of the cache.

Since
100.2