ArcGIS Runtime SDK for iOS: AGSKMLDataset Class Reference
ArcGIS Runtime SDK for iOS  100.14
AGSKMLDataset Class Reference

Description

A KML dataset.

Instances of this class represent a KML dataset available in a KML/KMZ file on the web or on disk. It provides an entry point to traverse the tree of KML nodes that make up the KML document.

License Restrictions:
This feature requires a Standard license for production deployment when using local .kml or .kmz file . No license required in Developer mode for testing.

Since
100.4
Inheritance diagram for AGSKMLDataset:
AGSLoadableBase <AGSRemoteResource> AGSObject <AGSLoadable>

Instance Methods

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

Class Methods

(instancetype) + KMLDatasetWithName:
 
(instancetype) + KMLDatasetWithRootNode:
 
(instancetype) + KMLDatasetWithURL:
 

Properties

AGSCredentialcredential
 
NSError * loadError
 
AGSLoadStatus loadStatus
 
void(^ networkLinkMessageHandler )(AGSKMLNetworkLink *networkLink, NSString *message)
 
void(^ nodeBalloonVisibilityChangedHandler )(AGSKMLNode *node, BOOL balloonVisibility)
 
void(^ nodeRefreshStatusChangedHandler )(AGSKMLNode *node, AGSKMLRefreshStatus refreshStatus)
 
AGSRequestConfigurationrequestConfiguration
 
NSArray< AGSKMLNode * > * rootNodes
 
NSURL * URL
 

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

◆ 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

Property Documentation

◆ credential

- (AGSCredential*) credential
readwritenonatomicstronginherited

Security credentials to access the remote resource. Only applicable if the resource is secured.

Since
100

◆ 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

◆ networkLinkMessageHandler

- (void(^ networkLinkMessageHandler) (AGSKMLNetworkLink *networkLink, NSString *message))
readwritenonatomiccopy

Block that is invoked whenever KML network link control message is available. KML network links may specify messages, such as usage guidelines, to be shown once to application end-user. Applications are expected to deliver this message to the end-user, typically in the form of an alert.

Note
The block will be invoked on the same thread on which the event occurred, which could be any arbitrary thread. You need to dispatch any UI related work to the main thread.
Since
100.4

◆ nodeBalloonVisibilityChangedHandler

- (void(^ nodeBalloonVisibilityChangedHandler) (AGSKMLNode *node, BOOL balloonVisibility))
readwritenonatomiccopy

Block that is invoked whenever a KML node's balloon visibility changes.

Note
The block will be invoked on the same thread on which the event occurred, which could be any arbitrary thread. You need to dispatch any UI related work to the main thread.
Since
100.5

◆ nodeRefreshStatusChangedHandler

- (void(^ nodeRefreshStatusChangedHandler) (AGSKMLNode *node, AGSKMLRefreshStatus refreshStatus))
readwritenonatomiccopy

Block that is invoked whenever KML node refresh status changes.

Note
The block will be invoked on the same thread on which the event occurred, which could be any arbitrary thread. You need to dispatch any UI related work to the main thread.
Since
100.4

◆ requestConfiguration

- (AGSRequestConfiguration*) requestConfiguration
readwritenonatomicstronginherited

The AGSRequestConfiguration object which defines the behavior and policies to use when accessing the remote resource. The default will be nil. If it is nil the [AGSRequestConfiguration globalConfiguration] will be used.

Since
100

◆ rootNodes

- (NSArray<AGSKMLNode*>*) rootNodes
readnonatomiccopy

The root nodes in the KML dataset. Typically, a dataset has only one root node, but some might have multiple root nodes. Also, typical KML document will have multiple levels of nested KML nodes. Therefore to accurately traverse through all of the KML node information in a Kml dataset, it is recommended to recursively test all nodes to see if they contain additional child nodes (AGSKMLContainer::childNodes or AGSKMLNetworkLink::childNodes).

Since
100.4

◆ URL

- (NSURL*) URL
readrequirednonatomicstronginherited

The URL of the remote resource.

Since
100