ArcGIS Runtime SDK for iOS: AGSRequestConfiguration.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSRequestConfiguration.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 
25 #import <Foundation/Foundation.h>
26 
28 
29 
30  //Required for Globals API doc
32 
42 @interface AGSRequestConfiguration : NSObject <NSCopying>
43 
44 #pragma mark -
45 #pragma mark initializers
46 
47 #pragma mark -
48 #pragma mark properties
49 
54 @property (nonatomic, assign, readwrite) NSURLRequestCachePolicy requestCachePolicy;
55 
59 @property (nonatomic, assign, readwrite) NSTimeInterval timeoutInterval;
60 
66 @property (nullable, nonatomic, copy, readwrite) BOOL (^shouldIssueAuthenticationChallenge)(AGSAuthenticationChallenge *challenge);
67 
71 @property (nonatomic, assign, readwrite) BOOL shouldCacheResponse;
72 
76 @property (nullable, nonatomic, copy, readwrite) NSDictionary<NSString*,NSString*> *userHeaders;
77 
81 @property (nonatomic, assign, readwrite) BOOL forcePost;
82 
86 @property (nonatomic, assign, readwrite) BOOL allowsBackgroundSessionForDownloads;
87 
92 @property (nonatomic, assign, readwrite) BOOL allowsCellularAccessForDownloads;
93 
98 @property (nonatomic, assign, readwrite) NSTimeInterval backgroundTimeoutInterval;
99 
100 #pragma mark -
101 #pragma mark methods
102 
107 
113 +(void)setGlobalConfiguration:(AGSRequestConfiguration*)globalConfiguration;
114 
120 +(void)setAdditionalUserAgentInfo:(nullable NSString*)additionalInfo;
121 
125 +(NSString*)additionalUserAgentInfo;
126 
127 @end
128 
129 
141 
155 @property (nullable, nonatomic, strong, readwrite) NSURL *debugLogFileURL;
156 
161 @property (nonatomic, assign, readwrite) BOOL debugLogRequests;
162 
167 @property (nonatomic, assign, readwrite) BOOL debugLogResponses;
168 
173 @property (nonatomic, assign, readwrite) BOOL debugLogIncludeRequestHeaders;
174 
179 @property (nonatomic, assign, readwrite) BOOL debugLogIncludeResponseHeaders;
180 
185 @property (nonatomic, assign, readwrite) BOOL debugLogDeleteBeforeEachRun;
186 
191 @property (nonatomic, assign, readwrite) BOOL debugLogIncludeTimestamp;
192 
197 @property (nonatomic, assign, readwrite) BOOL debugLogIgnoreTiledLayerRequests;
198 
203 @property (nonatomic, assign, readwrite) NSUInteger debugLogResponseTrimThreshold;
204 
205 @end
206 
207 
Networking related configuration of resources useful for debugging.
Definition: AGSRequestConfiguration.h:140
NSURL * debugLogFileURL
Definition: AGSRequestConfiguration.h:155
BOOL debugLogIncludeRequestHeaders
Definition: AGSRequestConfiguration.h:173
NSUInteger debugLogResponseTrimThreshold
Definition: AGSRequestConfiguration.h:203
BOOL debugLogIgnoreTiledLayerRequests
Definition: AGSRequestConfiguration.h:197
BOOL debugLogDeleteBeforeEachRun
Definition: AGSRequestConfiguration.h:185
BOOL debugLogIncludeResponseHeaders
Definition: AGSRequestConfiguration.h:179
BOOL debugLogResponses
Definition: AGSRequestConfiguration.h:167
BOOL debugLogIncludeTimestamp
Definition: AGSRequestConfiguration.h:191
BOOL debugLogRequests
Definition: AGSRequestConfiguration.h:161
Represents an authentication challenge when accessing secured resources.
Definition: AGSAuthenticationChallenge.h:60
Networking related configuration of resources.
Definition: AGSRequestConfiguration.h:42
AGSRequestConfiguration * globalConfiguration()
BOOL shouldCacheResponse
Definition: AGSRequestConfiguration.h:71
NSString * additionalUserAgentInfo()
NSDictionary< NSString *, NSString * > * userHeaders
Definition: AGSRequestConfiguration.h:76
BOOL forcePost
Definition: AGSRequestConfiguration.h:81
BOOL(^ shouldIssueAuthenticationChallenge)(AGSAuthenticationChallenge *challenge)
BOOL allowsCellularAccessForDownloads
Definition: AGSRequestConfiguration.h:92
NSURLRequestCachePolicy requestCachePolicy
Definition: AGSRequestConfiguration.h:54
NSTimeInterval backgroundTimeoutInterval
Definition: AGSRequestConfiguration.h:98
NSTimeInterval timeoutInterval
Definition: AGSRequestConfiguration.h:59
BOOL allowsBackgroundSessionForDownloads
Definition: AGSRequestConfiguration.h:86