ArcGIS Runtime SDK for iOS
100.15
|
A datasource for AGSLocationDisplay
based on Core Location.
Instances of this class represent a datasource that provides device location based on Apple's Core Location services.
NSLocationWhenInUseUsageDescription
, NSLocationAlwaysUsageDescription
, or NSLocationAlwaysAndWhenInUseUsageDescription
keys) to permit this functionality. When the datasource is started it will attempt to request when-in-use authorization if the app's authorization status is not determined, otherwise it will reuse the authorization that has already been granted. If authorization is denied, location updates will not be available.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 |
CLLocationManager * | locationManager |
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.
|
readnonatomicstronginherited |
The error that prevented the datasource from starting or was encountered while retrieving a location udpate
|
readwritenonatomicweakinherited |
The delegate which will receive location, heading and status updates from the data source.
|
readnonatomicstrong |
The location manager used by this datasource. You should not call the start/stop methods on the location manager directly (startUpdatingLocation, startUpdatingHeading, stopUpdatingLocation, stopUdpdatingHeading, etc). Also do not assign yourself as the delegate to this location manager.
|
readnonatomicassigninherited |
YES
if the data source has been started, NO
otherwise.
AGSLocationDataSource::status
. Provided by category AGSLocationDataSource(AGSDeprecated).
|
readnonatomicassigninherited |
The status of the data source.