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

Description

A task to sync an offline map.

Instances of this class represent a task that can be used to synchronize changes between feature layers and tables of an offline map and their originating ArcGIS feature services.

See also
AGSOfflineMapTask to take a map offline.
Since
100.1
Inheritance diagram for AGSOfflineMapSyncTask:
AGSLoadableBase AGSObject <AGSLoadable>

Instance Methods

(void) - cancelLoad
 
(id< AGSCancelable >) - checkForUpdatesWithCompletion:
 
(id< AGSCancelable >) - defaultOfflineMapSyncParametersWithCompletion:
 
(void) - doCancelLoading
 
(void) - doStartLoading:
 
(instancetype) - initWithMap:
 
(void) - loadDidFinishWithError:
 
(void) - loadWithCompletion:
 
(AGSOfflineMapSyncJob *) - offlineMapSyncJobWithParameters:
 
(void) - onLoadStatusChanged
 
(void) - retryLoadWithCompletion:
 

Class Methods

(instancetype) + offlineMapSyncTaskWithMap:
 

Properties

NSError * loadError
 
AGSLoadStatus loadStatus
 
AGSMapmap
 
AGSOfflineMapUpdateCapabilitiesupdateCapabilities
 

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

◆ checkForUpdatesWithCompletion:

- (id<AGSCancelable>) checkForUpdatesWithCompletion: (void(^)(AGSOfflineMapUpdatesInfo *__nullable result, NSError *__nullable error))  completion

Asynchronously retrieves AGSOfflineMapUpdatesInfo for the offline map that was used to construct this task. The returned AGSOfflineMapUpdatesInfo object provides high level information on what updates are available for this offline map.

Information is provided on:

  • Online changes that can be applied to update your offline map
  • Local changes from your offline map that can be sent back to the online services

Calling this method provides high-level information on the available updates. It can help you to determine whether to call offlineMapSyncJobWithParameters: immediately, based upon factors such as current disk space and network availability. Examine these properties before starting the potentially time-consuming offline map sync process.

The resulting AGSOfflineMapUpdatesInfo object provides a snap-shot of available updates when this method was called. To check for new updates you need to call this method again.

Parameters
completionBlock that is invoked when the operation finishes. The result parameter is populated if the operation completed successfully, otherwise the error parameter is populated.
Returns
An operation which can be canceled.
Since
100.6

◆ defaultOfflineMapSyncParametersWithCompletion:

- (id<AGSCancelable>) defaultOfflineMapSyncParametersWithCompletion: (void(^)(AGSOfflineMapSyncParameters *__nullable result, NSError *__nullable error))  completion

Generates an AGSOfflineMapSyncParameters object for the map used to construct this task. The parameters will be pre-populated with default values, appropriate for updating the feature data in this offline map.

The default parameters will reflect the mobile geodatabases used by the offline map.

Parameters
completionA block that is invoked when the operation finishes. The result parameter is populated if the operation completed successfully, otherwise the error parameter is populated.
Returns
An operation which can be canceled.
Since
100.6

◆ 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).

◆ initWithMap:

- (instancetype) initWithMap: (AGSMap *)  map

Creates a task with the provided offline map.

Parameters
mapOffline map whose feature layers and tables need to be synced.
Since
100.1

◆ 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

◆ offlineMapSyncTaskWithMap:

+ (instancetype) offlineMapSyncTaskWithMap: (AGSMap *)  map

Creates a task with the provided offline map.

Parameters
mapOffline map whose feature layers and tables need to be synced.
Returns
A new offline map sync task.
Since
100.1

◆ 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

Property Documentation

◆ 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

◆ map

- (AGSMap*) map
readnonatomicstrong

Offline map whose feature layers and tables need to be synced with their originating service.

Since
100.1

◆ updateCapabilities

- (AGSOfflineMapUpdateCapabilities*) updateCapabilities
readnonatomicstrong

Describes the methods used for obtaining updates to the offline map that was used to create this task. You can use this property to determine whether an offline map is configured to use the preplanned scheduled updates workflow (see AGSOfflineMapUpdateCapabilities::supportsScheduledUpdatesForFeatures) or to sync directly with feature services (see OfflineMapUpdateCapabilities.supportsSyncWithFeatureServices).

This property will return nil until the offline map sync task is loaded.

Since
100.6