ArcGIS Runtime SDK for iOS
100.15
|
An abstract base class that provides location updates to AGSLocationDisplay
.
Subclasses represent datasources that provide location updates to the mapview's location display.
Instance Methods | |
(void) | - didStartOrFailWithError: |
(void) | - didStop |
(void) | - didUpdateHeading: |
(void) | - didUpdateLocation: |
(void) | - doStart |
(void) | - doStop |
(void) | - startWithCompletion: |
(void) | - stop |
(void) | - stopWithCompletion: |
Properties | |
NSError * | error |
id< AGSLocationChangeHandlerDelegate > | locationChangeHandlerDelegate |
BOOL | started |
AGSLocationDataSourceStatus | status |
- (void) didStartOrFailWithError: | (nullable NSError *) | error |
Subclasses must call this in doStart (AGSLocationDataSource(ForSubclassEyesOnly))
once the datasource has started.
Provided by category AGSLocationDataSource(ForSubclassEyesOnly).
- (void) didStop |
Subclasses must call this in doStop (AGSLocationDataSource(ForSubclassEyesOnly))
once the datasource has stopped.
Provided by category AGSLocationDataSource(ForSubclassEyesOnly).
- (void) didUpdateHeading: | (double) | heading |
Subclasses must call this once they have a new heading.
Provided by category AGSLocationDataSource(ForSubclassEyesOnly).
- (void) didUpdateLocation: | (AGSLocation *) | location |
Subclasses must call this once they have a new location.
Provided by category AGSLocationDataSource(ForSubclassEyesOnly).
- (void) doStart |
Subclasses must implement this method to start the datasource. Once the datasource has started or failed to start it should call didStartOrFailWithError: (AGSLocationDataSource(ForSubclassEyesOnly))
. As updates are received, the datasource should call didUpdateLocation: (AGSLocationDataSource(ForSubclassEyesOnly))
or didUpdateHeading: (AGSLocationDataSource(ForSubclassEyesOnly))
.
Provided by category AGSLocationDataSource(ForSubclassEyesOnly).
- (void) doStop |
Subclasses must implement this method to stop the datasource. Once the datasource has stopped it should call didStop (AGSLocationDataSource(ForSubclassEyesOnly))
Provided by category AGSLocationDataSource(ForSubclassEyesOnly).
- (void) startWithCompletion: | (nullable void(^)(NSError *__nullable error)) | completion |
This is invoked by the location display on the datasource to initiate requesting location updates. Internally this method calls doStart (AGSLocationDataSource(ForSubclassEyesOnly))
which subclasses must implement.
completion | block which will be invoked when the operation completes. If the dataSource failed to start, the error property will be populated. |
- (void) stop |
This is invoked by the location display on the datasource to stop requesting location updates. Internally this method calls doStop (AGSLocationDataSource(ForSubclassEyesOnly))
which subclasses must implement.
stopWithCompletion:
. Provided by category AGSLocationDataSource(AGSDeprecated).
- (void) stopWithCompletion: | (nullable void(^)(void)) | completion |
This is invoked by the location display on the datasource to stop requesting location updates. Internally this method calls doStop (AGSLocationDataSource(ForSubclassEyesOnly))
which subclasses must implement.
|
readnonatomicstrong |
The error that prevented the datasource from starting or was encountered while retrieving a location udpate
|
readwritenonatomicweak |
The delegate which will receive location, heading and status updates from the data source.
|
readnonatomicassign |
YES
if the data source has been started, NO
otherwise.
AGSLocationDataSource::status
. Provided by category AGSLocationDataSource(AGSDeprecated).
|
readnonatomicassign |
The status of the data source.