AGSLoadableBase(ForSubclassEyesOnly) Category Reference

Description

Information relevant to sublcasses of AGSLoadableBase.

This category organizes the methods that are relevant to subclassing AGSLoadableBase. Although you can adopt the <AGSLoadable> protocol directly in your classes, it will often be easier to subclass AGSLoadableBase. Developers can easily make their objects implement the loadable behavior by paying special attention to the methods in this category.

Here are some guidelines:

• Override doStartLoading: (AGSLoadableBase(ForSubclassEyesOnly)) to load your data. Call loadDidFinishWithError: (AGSLoadableBase(ForSubclassEyesOnly)) upon completion, passing in the error if any.
• Override doCancelLoading (AGSLoadableBase(ForSubclassEyesOnly)) to cancel loading your data. Call loadDidFinishWithError: (AGSLoadableBase(ForSubclassEyesOnly)) at the end passing in an error representing NSUserCancelledError

Since

100

Instance Methods
(void)	- doCancelLoading
(void)	- doStartLoading:
(void)	- loadDidFinishWithError:
(void)	- onLoadStatusChanged

Method Documentation

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: at the end passing in an error representing NSUserCancelledError.

Since

100

Extends class AGSLoadableBase.

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: upon completion, passing in the error if any.

Parameters

retrying

flag that is true if this method was called from retryLoadWithCompletion: (AGSLoadable-p).

Since

100

Extends class AGSLoadableBase.

loadDidFinishWithError:

- (void) loadDidFinishWithError:

(nullable NSError *)

error

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

Since

100

Extends class AGSLoadableBase.

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

Extends class AGSLoadableBase.