ArcGIS Runtime SDK for iOS: AGSLocationDataSource.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSLocationDataSource.h
Go to the documentation of this file.
1 /*
2  COPYRIGHT 2021 ESRI
3 
4  All rights reserved under the copyright laws of the United States
5  and applicable international laws, treaties, and conventions.
6 
7  This material is licensed for use under the Esri Master License
8  Agreement (MLA), and is bound by the terms of that agreement.
9  You may redistribute and use this code without modification,
10  provided you adhere to the terms of the MLA and include this
11  copyright notice.
12 
13  See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
14 
15  For additional information, contact:
16  Environmental Systems Research Institute, Inc.
17  Attn: Contracts and Legal Services Department
18  380 New York Street
19  Redlands, California, 92373
20  USA
21 
22  email: contracts@esri.com
23  */
24  //Required for Globals API doc
26 
27 #import <Foundation/Foundation.h>
28 #import <ArcGIS/AGSObject.h>
29 
30 
31 
36 typedef NS_ENUM(NSInteger, AGSLocationDataSourceStatus) {
41 };
42 
43 @class AGSLocation;
45 
55 
56 #pragma mark -
57 #pragma mark initializers
58 
59 
60 #pragma mark -
61 #pragma mark properties
62 
66 @property (nonatomic, assign, readonly) BOOL started;
67 
71 @property (nullable, nonatomic, strong, readonly) NSError *error;
72 
76 @property (nullable, nonatomic, weak, readwrite) id<AGSLocationChangeHandlerDelegate> locationChangeHandlerDelegate;
77 
78 #pragma mark -
79 #pragma mark methods
80 
85 -(void)startWithCompletion:(nullable void(^)(NSError *__nullable error))completion;
86 
90 -(void)stop;
91 
92 @end
93 
101 
106 -(void)doStart;
107 
112 -(void)doStop;
113 
117 -(void)didStartOrFailWithError:(nullable NSError*)error;
118 
122 -(void)didStop;
123 
127 -(void)didUpdateHeading:(double)heading;
128 
132 -(void)didUpdateLocation:(AGSLocation*)location;
133 
134 @end
135 
136 #pragma mark -
137 #pragma mark Location Change Handler Delegate Methods
138 #pragma mark -
139 
152 @optional
153 
159 - (void)locationDataSource:(AGSLocationDataSource *)locationDataSource locationDidChange:(AGSLocation *)location;
160 
166 - (void)locationDataSource:(AGSLocationDataSource *)locationDataSource headingDidChange:(double)heading;
167 
173 - (void)locationDataSource:(AGSLocationDataSource *)locationDataSource statusDidChange:(AGSLocationDataSourceStatus)status;
174 
175 @end
176 
177 
AGSLocationDataSourceStatus
Definition: AGSLocationDataSource.h:36
@ AGSLocationDataSourceStatusStarting
Definition: AGSLocationDataSource.h:38
@ AGSLocationDataSourceStatusStarted
Definition: AGSLocationDataSource.h:39
@ AGSLocationDataSourceStatusStopped
Definition: AGSLocationDataSource.h:37
@ AGSLocationDataSourceStatusFailedToStart
Definition: AGSLocationDataSource.h:40
A category to organize subclassable aspects of AGSLocationDataSource.
Definition: AGSLocationDataSource.h:100
An abstract base class that provides location updates to AGSLocationDisplay.
Definition: AGSLocationDataSource.h:55
BOOL started
Definition: AGSLocationDataSource.h:66
NSError * error
Definition: AGSLocationDataSource.h:71
id< AGSLocationChangeHandlerDelegate > locationChangeHandlerDelegate
Definition: AGSLocationDataSource.h:76
Represents a location update provided by a location datasource.
Definition: AGSLocation.h:73
Definition: AGSObject.h:28
A change handler delegate for AGSLocationDataSource.
Definition: AGSLocationDataSource.h:151