ArcGIS Runtime SDK for iOS: AGSGeotriggerMonitor.h Source File
ArcGIS Runtime SDK for iOS  100.15
AGSGeotriggerMonitor.h
Go to the documentation of this file.
1 /*
2  COPYRIGHT 2022 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 #import <ArcGIS/AGSDefines.h>
30 #import <ArcGIS/AGSCancelable.h>
31 
32 
33 
37 typedef NS_ENUM(NSInteger, AGSGeotriggerMonitorStatus) {
42 };
43 
54 
61 
62 @class AGSGeotrigger;
64 
87 
88 #pragma mark -
89 #pragma mark initializers
90 
91 
92 
97 - (instancetype)initWithGeotrigger:(AGSGeotrigger *)geotrigger;
98 
103 + (instancetype)geotriggerMonitorWithGeotrigger:(AGSGeotrigger *)geotrigger;
104 
105 #pragma mark -
106 #pragma mark properties
107 
111 @property (nonatomic, strong, readonly) AGSGeotrigger *geotrigger;
112 
120 @property (nonatomic, assign, readonly) AGSGeotriggerMonitorStatus status;
121 
156 @property (nullable, nonatomic, strong, readonly) NSError *warning;
157 
158 #pragma mark -
159 #pragma mark methods
160 
169 - (id<AGSCancelable>)startWithCompletion:(nullable void(^)(NSError * _Nullable error))completion;
170 
182 - (void)stop;
183 
184 @end
185 
186 
#define AGS_EXTERN
Definition: AGSDefines.h:28
AGS_EXTERN NSString *const AGSGeotriggerNotificationInfoKey
A user info key used to retrieve the AGSGeotriggerNotificationInfo derived object from the AGSGeotrig...
Definition: AGSGeotriggerMonitor.h:60
AGSGeotriggerMonitorStatus
Definition: AGSGeotriggerMonitor.h:37
@ AGSGeotriggerMonitorStatusStopped
Definition: AGSGeotriggerMonitor.h:38
@ AGSGeotriggerMonitorStatusStarting
Definition: AGSGeotriggerMonitor.h:39
@ AGSGeotriggerMonitorStatusStarted
Definition: AGSGeotriggerMonitor.h:40
@ AGSGeotriggerMonitorStatusFailedToStart
Definition: AGSGeotriggerMonitor.h:41
AGS_EXTERN NSNotificationName const AGSGeotriggerMonitorDidTriggerNotification
Definition: AGSGeotriggerMonitor.h:53
A condition monitored by an AGSGeotriggerMonitor.
Definition: AGSGeotrigger.h:54
An AGSGeotriggerMonitor monitors an AGSGeotrigger condition and, when it is met, results in an AGSGeo...
Definition: AGSGeotriggerMonitor.h:87
AGSGeotriggerMonitorStatus status
Definition: AGSGeotriggerMonitor.h:120
AGSGeotrigger * geotrigger
Definition: AGSGeotriggerMonitor.h:111
NSError * warning
Definition: AGSGeotriggerMonitor.h:156
Provides details about an AGSGeotrigger condition that has been met.
Definition: AGSGeotriggerNotificationInfo.h:45
Definition: AGSObject.h:28
A protocol exposed by operations that allow cancellation.
Definition: AGSCancelable.h:38