ArcGIS Runtime SDK for iOS: AGSLoadable.h File Reference
ArcGIS Runtime SDK for iOS  100.8
AGSLoadable.h File Reference

Go to the source code of this file.

Typedefs

typedef void(^ ags_load_objects_block_t) (BOOL finishedWithNoErrors)
 

Enumerations

enum  AGSLoadStatus {
  AGSLoadStatusLoaded = 0, AGSLoadStatusLoading = 1, AGSLoadStatusFailedToLoad = 2, AGSLoadStatusNotLoaded = 3,
  AGSLoadStatusUnknown = -1
}
 

Functions

AGS_EXTERN void AGSLoadObjects (NSArray< id< AGSLoadable >> *array, _Nullable ags_load_objects_block_t completion)
 
AGS_EXTERN NSString * AGSLoadStatusAsString (AGSLoadStatus loadStatus)
 
AGS_EXTERN AGSLoadStatus AGSLoadStatusFromString (NSString *loadStatus)
 

Variables

AGS_EXTERN NSNotificationName AGSLoadableDidFailToLoadNotification
 
AGS_EXTERN NSNotificationName AGSLoadableDidLoadNotification
 

Typedef Documentation

§ ags_load_objects_block_t

typedef void(^ ags_load_objects_block_t) (BOOL finishedWithNoErrors)

Block that is invoked by AGSLoadObjects() when all the loadable objects are finished loading. finishedWithNoErrors indicates if all the objects loaded sucessfully or if some of them encountered errors.

Since
100

Enumeration Type Documentation

§ AGSLoadStatus

Loading status of an object implementing the AGSLoadable protocol.

Since
100
Enumerator
AGSLoadStatusLoaded 

Loading completed successfully.

AGSLoadStatusLoading 

Loading in progress.

AGSLoadStatusFailedToLoad 

Loading completed with error.

AGSLoadStatusNotLoaded 

Loading not started.

AGSLoadStatusUnknown 

Unknwon.

Function Documentation

§ AGSLoadObjects()

AGS_EXTERN void AGSLoadObjects ( NSArray< id< AGSLoadable >> *  array,
_Nullable ags_load_objects_block_t  completion 
)

Loads an array of AGSLoadable objects. Calls you back once all the objects in the array are loaded. The callback will be invoked with YES (true) if no load errors occurred in any of the objects passed in.

Parameters
arrayof loadable objects which need to be loaded
completionblock that is invoked when all the loadable objects have finished loading
Since
100

§ AGSLoadStatusAsString()

AGS_EXTERN NSString* AGSLoadStatusAsString ( AGSLoadStatus  loadStatus)

Return load status string for AGSLoadStatus.

Parameters
loadStatusThe load status.
Returns
String representation of loadStatus.
Since
100
See also
AGSLoadStatus

§ AGSLoadStatusFromString()

AGS_EXTERN AGSLoadStatus AGSLoadStatusFromString ( NSString *  loadStatus)

Return load status for status string.

Parameters
loadStatusThe string representation of a load status.
Returns
AGSLoadStatus for loadStatus string.
Since
100
See also
AGSLoadStatus

Variable Documentation

§ AGSLoadableDidFailToLoadNotification

AGS_EXTERN NSNotificationName AGSLoadableDidFailToLoadNotification

§ AGSLoadableDidLoadNotification

AGS_EXTERN NSNotificationName AGSLoadableDidLoadNotification