AGSRequest Class Reference


Description

This class provides some simple methods for requesting data from a URL synchronously.

Since:
1.0

List of all members.

Static Public Member Functions

(NSData *) + dataForRequest:error:
(NSData *) + dataForURL:credential:resource:queryParameters:doPOST:error:
(NSData *) + dataForURL:resource:queryParameters:doPOST:error:
(NSURLRequest *) + requestForURL:credential:resource:queryParameters:doPOST:
(void) + setAdditionalUserAgentInfo:
(NSString *) + userAgent

Member Function Documentation

+ (NSData *) dataForRequest: (NSURLRequest *)  request
error: (NSError **)  error 

Requests data synchronously for the specified request.

Parameters:
request object containing url and query parameters
error Information passed back if the request fails
Since:
1.0
+ (NSData *) dataForURL: (NSURL *)  url
credential: (AGSCredential *)  cred
resource: (NSString *)  operation
queryParameters: (NSDictionary *)  query
doPOST: (BOOL)  post
error: (NSError **)  error 

Requests data synchronously from the url with the specified arguments

Parameters:
url to request data from
cred AGSCredential to access the secured resource
operation The specific resource to access at url
query parameters to submit to the url
post Boolean to determine whether to perform a GET or POST
error Information passed back if the request fails
Since:
1.0
+ (NSData *) dataForURL: (NSURL *)  url
resource: (NSString *)  operation
queryParameters: (NSDictionary *)  query
doPOST: (BOOL)  post
error: (NSError **)  error 

Requests data synchronously from the url with the specified arguments

Parameters:
url to request data from
operation The specific resource to access at url
query parameters to submit to the url
post Boolean to determine whether to perform a GET or POST
error Information about the request if it fails
Since:
1.0
+ (NSURLRequest *) requestForURL: (NSURL *)  url
credential: (AGSCredential *)  cred
resource: (NSString *)  operation
queryParameters: (NSDictionary *)  query
doPOST: (BOOL)  post 

Creates a request object for a URL with the specified arguments

Parameters:
url to request data from
cred AGSCredential to be used if the resource is secured
operation The specific resource to access at url
query parameters to submit to the url
post Boolean to determine whether to perform a GET or POST
Since:
1.0
+ (void) setAdditionalUserAgentInfo: (NSString *)  additionalInfo  

Used to set some specific user agent information. This is useful for analytics.

Parameters:
additionalInfo to send along in the user agent string
Since:
1.0
+ (NSString*) userAgent  

Class method to retrieve the user agent string

Since:
1.0